MapperHelper (estateplat-common 1.2.4-SNAPSHOT API)

java.lang.Object
- cn.gtmap.estateplat.core.support.mybatis.mapper.MapperHelper

```
public class MapperHelper
extends Object
```
处理主要逻辑，最关键的一个类

项目地址 : https://github.com/abel533/Mapper

Author:

liuzh

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MapperHelper.IdentityDialect
IDENTITY的可选值

Nested Classes
Modifier and Type	Class and Description
`static class`	`MapperHelper.IdentityDialect` IDENTITY的可选值

Constructor Summary

Constructors
Constructor and Description

MapperHelper()
默认构造方法

MapperHelper(Properties properties)
带配置的构造方法

Constructors
Constructor and Description
`MapperHelper()` 默认构造方法
`MapperHelper(Properties properties)` 带配置的构造方法

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getBEFORE()` 获取SelectKey的Order
`String`	`getIDENTITY()` 获取主键自增回写SQL
`String`	`getPrefix()` 获取表前缀，带catalog或schema
`String`	`getSeqFormat()` 获取序列格式化模板
`String`	`getSpringVersion()` 获取Spring版本号
`String`	`getTableName(Class<?> entityClass)` 获取表名
`String`	`getUUID()` 获取UUID生成规则
`void`	`initMapper()` Spring初始化方法，使用Spring时需要配置init-method="initMapper"
`boolean`	`isMapperMethod(String msId)` 判断当前的接口方法是否需要进行拦截
`boolean`	`isNotEmpty()`
`boolean`	`isSpring()` 是否为Spring4.x以上版本
`boolean`	`isSpring4()` 是否为Spring4.x以上版本
`void`	`processConfiguration(org.apache.ibatis.session.Configuration configuration)` 配置完成后，执行下面的操作处理configuration中全部的MappedStatement
`void`	`registerMapper(Class<?> mapperClass)` 注册通用Mapper接口
`void`	`registerMapper(String mapperClass)` 注册通用Mapper接口
`void`	`setCatalog(String catalog)` 设置全局的catalog,默认为空，如果设置了值，操作表时的sql会是catalog.tablename
`void`	`setIDENTITY(String IDENTITY)` 主键自增回写方法,默认值MYSQL,详细说明请看文档
`void`	`setMappers(String[] mappers)` 方便Spring注入
`void`	`setNotEmpty(boolean notEmpty)`
`void`	`setOrder(String order)` 主键自增回写方法执行顺序,默认AFTER,可选值为(BEFORE\|AFTER)
`void`	`setProperties(Properties properties)` 配置属性
`void`	`setSchema(String schema)` 设置全局的schema,默认为空，如果设置了值，操作表时的sql会是schema.tablename 如果同时设置了catalog,优先使用catalog.tablename
`void`	`setSeqFormat(String seqFormat)` 序列的获取规则,使用{num}格式化参数，默认值为{0}.nextval，针对Oracle 可选参数一共3个，对应0,1,2,分别为SequenceName，ColumnName, PropertyName
`void`	`setSqlSessions(org.apache.ibatis.session.SqlSession[] sqlSessions)` 针对Spring注入需要处理的SqlSession
`void`	`setSqlSource(org.apache.ibatis.mapping.MappedStatement ms)` 重新设置SqlSource
`void`	`setUUID(String UUID)` 设置UUID生成策略配置UUID生成策略需要使用OGNL表达式默认值32位长度:@java.util.UUID@randomUUID().toString().replace("-", "")

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MapperHelper
```
public MapperHelper()
```
    默认构造方法
  - MapperHelper
```
public MapperHelper(Properties properties)
```
    带配置的构造方法
    
    Parameters:
    properties -
- Method Detail
  - setSqlSessions
```
public void setSqlSessions(org.apache.ibatis.session.SqlSession[] sqlSessions)
```
    针对Spring注入需要处理的SqlSession
    
    Parameters:
    sqlSessions -
  - isNotEmpty
```
public boolean isNotEmpty()
```
  - setNotEmpty
```
public void setNotEmpty(boolean notEmpty)
```
  - initMapper
```
public void initMapper()
```
    Spring初始化方法，使用Spring时需要配置init-method="initMapper"
  - isSpring4
```
public boolean isSpring4()
```
    是否为Spring4.x以上版本
    
    Returns:
  - isSpring
```
public boolean isSpring()
```
    是否为Spring4.x以上版本
    
    Returns:
  - getSpringVersion
```
public String getSpringVersion()
```
    获取Spring版本号
    
    Returns:
  - registerMapper
```
public void registerMapper(Class<?> mapperClass)
```
    注册通用Mapper接口
    
    Parameters:
    mapperClass -
    
    Throws:
    
    Exception
  - registerMapper
```
public void registerMapper(String mapperClass)
```
    注册通用Mapper接口
    
    Parameters:
    mapperClass -
    
    Throws:
    
    Exception
  - setMappers
```
public void setMappers(String[] mappers)
```
    方便Spring注入
    
    Parameters:
    mappers -
  - setOrder
```
public void setOrder(String order)
```
    主键自增回写方法执行顺序,默认AFTER,可选值为(BEFORE|AFTER)
    
    Parameters:
    order -
  - setCatalog
```
public void setCatalog(String catalog)
```
    设置全局的catalog,默认为空，如果设置了值，操作表时的sql会是catalog.tablename
    
    Parameters:
    catalog -
  - setSchema
```
public void setSchema(String schema)
```
    设置全局的schema,默认为空，如果设置了值，操作表时的sql会是schema.tablename
    如果同时设置了catalog,优先使用catalog.tablename
    
    Parameters:
    schema -
  - getPrefix
```
public String getPrefix()
```
    获取表前缀，带catalog或schema
    
    Returns:
  - getUUID
```
public String getUUID()
```
    获取UUID生成规则
    
    Returns:
  - setUUID
```
public void setUUID(String UUID)
```
    设置UUID生成策略
    配置UUID生成策略需要使用OGNL表达式
    默认值32位长度:@java.util.UUID@randomUUID().toString().replace("-", "")
    
    Parameters:
    UUID -
  - getIDENTITY
```
public String getIDENTITY()
```
    获取主键自增回写SQL
    
    Returns:
  - setIDENTITY
```
public void setIDENTITY(String IDENTITY)
```
    主键自增回写方法,默认值MYSQL,详细说明请看文档
    
    Parameters:
    IDENTITY -
  - getBEFORE
```
public boolean getBEFORE()
```
    获取SelectKey的Order
    
    Returns:
  - getSeqFormat
```
public String getSeqFormat()
```
    获取序列格式化模板
    
    Returns:
  - setSeqFormat
```
public void setSeqFormat(String seqFormat)
```
    序列的获取规则,使用{num}格式化参数，默认值为{0}.nextval，针对Oracle
    可选参数一共3个，对应0,1,2,分别为SequenceName，ColumnName, PropertyName
    
    Parameters:
    seqFormat -
  - getTableName
```
public String getTableName(Class<?> entityClass)
```
    获取表名
    
    Parameters:
    entityClass -
    
    Returns:
  - isMapperMethod
```
public boolean isMapperMethod(String msId)
```
    判断当前的接口方法是否需要进行拦截
    
    Parameters:
    msId -
    
    Returns:
  - setSqlSource
```
public void setSqlSource(org.apache.ibatis.mapping.MappedStatement ms)
```
    重新设置SqlSource
    
    Parameters:
    ms -
  - setProperties
```
public void setProperties(Properties properties)
```
    配置属性
    
    Parameters:
    properties -
  - processConfiguration
```
public void processConfiguration(org.apache.ibatis.session.Configuration configuration)
```
    配置完成后，执行下面的操作
    处理configuration中全部的MappedStatement
    
    Parameters:
    configuration -

Class MapperHelper

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MapperHelper

MapperHelper

Method Detail

setSqlSessions

isNotEmpty

setNotEmpty

initMapper

isSpring4

isSpring

getSpringVersion

registerMapper

registerMapper

setMappers

setOrder

setCatalog

setSchema

getPrefix

getUUID

setUUID

getIDENTITY

setIDENTITY

getBEFORE

getSeqFormat

setSeqFormat

getTableName

isMapperMethod

setSqlSource

setProperties

processConfiguration