tk.mybatis.mapper.mapperhelper

类 MapperTemplate

java.lang.Object

tk.mybatis.mapper.mapperhelper.MapperTemplate

直接已知子类:

BaseDeleteProvider, BaseInsertProvider, BaseSelectProvider, BaseUpdateProvider, ConditionProvider, EmptyProvider, ExampleProvider, IdsProvider, SpecialProvider, SqlServerProvider

public abstract class MapperTemplate
extends Object

通用Mapper模板类，扩展通用Mapper时需要继承该类

作者:

liuzh

字段概要

字段

限定符和类型	字段和说明
protected Map<String,Class<?>>	entityClassMap
protected Class<?>	mapperClass
protected MapperHelper	mapperHelper
protected Map<String,Method>	methodMap

构造器概要

构造器

构造器和说明
MapperTemplate(Class<?> mapperClass, MapperHelper mapperHelper)

方法概要

限定符和类型	方法和说明
void	addMethodMap(String methodName, Method method) 添加映射方法
org.apache.ibatis.mapping.SqlSource	createSqlSource(org.apache.ibatis.mapping.MappedStatement ms, String xmlSql) 通过xmlSql创建sqlSource
String	dynamicSQL(Object record) 该方法仅仅用来初始化ProviderSqlSource
org.apache.ibatis.scripting.xmltags.IfSqlNode	ExampleValidSqlNode(org.apache.ibatis.session.Configuration configuration) 已过时。
org.apache.ibatis.scripting.xmltags.WhereSqlNode	exampleWhereClause(org.apache.ibatis.session.Configuration configuration) 已过时。 4.x版本会移除该方法
protected org.apache.ibatis.scripting.xmltags.SqlNode	getAllIfColumnNode(Class<?> entityClass) 已过时。 4.x版本会移除该方法
protected org.apache.ibatis.scripting.xmltags.SqlNode	getColumnEqualsProperty(EntityColumn column, boolean first) 已过时。 4.x版本会移除该方法
protected List<org.apache.ibatis.mapping.ParameterMapping>	getColumnParameterMappings(org.apache.ibatis.mapping.MappedStatement ms) 已过时。 4.x版本会移除该方法
protected org.apache.ibatis.scripting.xmltags.SqlNode	getDynamicTableNameNode(Class<?> entityClass) 已过时。 4.x版本会移除该方法
protected org.apache.ibatis.scripting.xmltags.SqlNode	getDynamicTableNameNode(Class<?> entityClass, String parameterName) 已过时。 4.x版本会移除该方法
Class<?>	getEntityClass(org.apache.ibatis.mapping.MappedStatement ms) 获取返回值类型 - 实体类型
String	getIDENTITY()
String	getIDENTITY(EntityColumn column) 获取IDENTITY值的表达式
protected org.apache.ibatis.scripting.xmltags.SqlNode	getIfCacheIsNull(EntityColumn column, org.apache.ibatis.scripting.xmltags.SqlNode columnNode) 已过时。 4.x版本会移除该方法
protected org.apache.ibatis.scripting.xmltags.SqlNode	getIfCacheNotNull(EntityColumn column, org.apache.ibatis.scripting.xmltags.SqlNode columnNode) 已过时。 4.x版本会移除该方法
protected org.apache.ibatis.scripting.xmltags.SqlNode	getIfIsNull(EntityColumn column, org.apache.ibatis.scripting.xmltags.SqlNode columnNode) 已过时。 4.x版本会移除该方法
protected org.apache.ibatis.scripting.xmltags.SqlNode	getIfNotNull(EntityColumn column, org.apache.ibatis.scripting.xmltags.SqlNode columnNode) 已过时。 4.x版本会移除该方法
protected org.apache.ibatis.scripting.xmltags.SqlNode	getIfNotNull(EntityColumn column, org.apache.ibatis.scripting.xmltags.SqlNode columnNode, boolean empty) 已过时。 4.x版本会移除该方法
static Class<?>	getMapperClass(String msId) 根据msId获取接口类
static String	getMethodName(org.apache.ibatis.mapping.MappedStatement ms) 获取执行的方法名
static String	getMethodName(String msId) 获取执行的方法名
protected List<org.apache.ibatis.mapping.ParameterMapping>	getPrimaryKeyParameterMappings(org.apache.ibatis.mapping.MappedStatement ms) 已过时。 4.x版本会移除该方法
protected String	getSeqNextVal(EntityColumn column) 获取序列下个值的表达式
String	getUUID()
boolean	isBEFORE()
boolean	isCheckExampleEntityClass()
boolean	isNotEmpty()
protected void	newSelectKeyMappedStatement(org.apache.ibatis.mapping.MappedStatement ms, EntityColumn column) 新建SelectKey节点
protected void	setResultType(org.apache.ibatis.mapping.MappedStatement ms, Class<?> entityClass) 设置返回值类型 - 为了让typeHandler在select时有效，改为设置resultMap
void	setSqlSource(org.apache.ibatis.mapping.MappedStatement ms) 重新设置SqlSource
protected void	setSqlSource(org.apache.ibatis.mapping.MappedStatement ms, org.apache.ibatis.mapping.SqlSource sqlSource) 重新设置SqlSource，同时判断如果是Jdbc3KeyGenerator，就设置为MultipleJdbc3KeyGenerator
boolean	supportMethod(String msId) 是否支持该通用方法
protected String	tableName(Class<?> entityClass) 获取实体类的表名
org.apache.ibatis.scripting.xmltags.WhereSqlNode	updateByExampleWhereClause(org.apache.ibatis.session.Configuration configuration) 已过时。 4.x版本会移除该方法

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

methodMap

protected Map<String,Method> methodMap

entityClassMap

protected Map<String,Class<?>> entityClassMap

mapperClass

protected Class<?> mapperClass

mapperHelper

protected MapperHelper mapperHelper

构造器详细资料

MapperTemplate

public MapperTemplate(Class<?> mapperClass,
                      MapperHelper mapperHelper)

方法详细资料

getMapperClass

public static Class<?> getMapperClass(String msId)

根据msId获取接口类

参数:

msId -

返回:

getMethodName

public static String getMethodName(org.apache.ibatis.mapping.MappedStatement ms)

获取执行的方法名

参数:

ms -

返回:

getMethodName

public static String getMethodName(String msId)

获取执行的方法名

参数:

msId -

返回:

dynamicSQL

public String dynamicSQL(Object record)

该方法仅仅用来初始化ProviderSqlSource

参数:

record -

返回:

addMethodMap

public void addMethodMap(String methodName,
                         Method method)

添加映射方法

参数:

methodName -

method -

getUUID

public String getUUID()

getIDENTITY

public String getIDENTITY()

getIDENTITY

public String getIDENTITY(EntityColumn column)

获取IDENTITY值的表达式

参数:

column -

返回:

isBEFORE

public boolean isBEFORE()

isNotEmpty

public boolean isNotEmpty()

isCheckExampleEntityClass

public boolean isCheckExampleEntityClass()

supportMethod

public boolean supportMethod(String msId)

是否支持该通用方法

参数:

msId -

返回:

setResultType

protected void setResultType(org.apache.ibatis.mapping.MappedStatement ms,
                             Class<?> entityClass)

设置返回值类型 - 为了让typeHandler在select时有效，改为设置resultMap

参数:

ms -

entityClass -

setSqlSource

protected void setSqlSource(org.apache.ibatis.mapping.MappedStatement ms,
                            org.apache.ibatis.mapping.SqlSource sqlSource)

重新设置SqlSource，同时判断如果是Jdbc3KeyGenerator，就设置为MultipleJdbc3KeyGenerator

参数:

ms -

sqlSource -

setSqlSource

public void setSqlSource(org.apache.ibatis.mapping.MappedStatement ms)
                  throws Exception

重新设置SqlSource

参数:

ms -

抛出:

InvocationTargetException

IllegalAccessException

Exception

createSqlSource

public org.apache.ibatis.mapping.SqlSource createSqlSource(org.apache.ibatis.mapping.MappedStatement ms,
                                                           String xmlSql)

通过xmlSql创建sqlSource

参数:

ms -

xmlSql -

返回:

getEntityClass

public Class<?> getEntityClass(org.apache.ibatis.mapping.MappedStatement ms)

获取返回值类型 - 实体类型

参数:

ms -

返回:

getPrimaryKeyParameterMappings

@Deprecated
protected List<org.apache.ibatis.mapping.ParameterMapping> getPrimaryKeyParameterMappings(org.apache.ibatis.mapping.MappedStatement ms)

已过时。 4.x版本会移除该方法

根据对象生成主键映射

参数:

ms -

返回:

getSeqNextVal

protected String getSeqNextVal(EntityColumn column)

获取序列下个值的表达式

参数:

column -

返回:

tableName

protected String tableName(Class<?> entityClass)

获取实体类的表名

参数:

entityClass -

返回:

getDynamicTableNameNode

@Deprecated
protected org.apache.ibatis.scripting.xmltags.SqlNode getDynamicTableNameNode(Class<?> entityClass)

已过时。 4.x版本会移除该方法

获取表名 - 支持动态表名

参数:

entityClass -

返回:

getDynamicTableNameNode

@Deprecated
protected org.apache.ibatis.scripting.xmltags.SqlNode getDynamicTableNameNode(Class<?> entityClass,
                                                                                           String parameterName)

已过时。 4.x版本会移除该方法

获取表名 - 支持动态表名，该方法用于多个入参时，通过parameterName指定入参中实体类的@Param的注解值

参数:

entityClass -

parameterName -

返回:

getIfNotNull

@Deprecated
protected org.apache.ibatis.scripting.xmltags.SqlNode getIfNotNull(EntityColumn column,
                                                                                org.apache.ibatis.scripting.xmltags.SqlNode columnNode)

已过时。 4.x版本会移除该方法

返回if条件的sqlNode

一般类型：<if test="property!=null">columnNode</if>

参数:

column -

columnNode -

返回:

getIfNotNull

@Deprecated
protected org.apache.ibatis.scripting.xmltags.SqlNode getIfNotNull(EntityColumn column,
                                                                                org.apache.ibatis.scripting.xmltags.SqlNode columnNode,
                                                                                boolean empty)

已过时。 4.x版本会移除该方法

返回if条件的sqlNode

一般类型：<if test="property!=null">columnNode</if>

参数:

column -

columnNode -

empty - 是否包含!=''条件

返回:

getIfIsNull

@Deprecated
protected org.apache.ibatis.scripting.xmltags.SqlNode getIfIsNull(EntityColumn column,
                                                                               org.apache.ibatis.scripting.xmltags.SqlNode columnNode)

已过时。 4.x版本会移除该方法

返回if条件的sqlNode

一般类型：<if test="property==null">columnNode</if>

参数:

column -

返回:

getIfCacheNotNull

@Deprecated
protected org.apache.ibatis.scripting.xmltags.SqlNode getIfCacheNotNull(EntityColumn column,
                                                                                     org.apache.ibatis.scripting.xmltags.SqlNode columnNode)

已过时。 4.x版本会移除该方法

返回if条件的sqlNode

一般类型：<if test="property!=null">columnNode</if>

参数:

column -

返回:

getIfCacheIsNull

@Deprecated
protected org.apache.ibatis.scripting.xmltags.SqlNode getIfCacheIsNull(EntityColumn column,
                                                                                    org.apache.ibatis.scripting.xmltags.SqlNode columnNode)

已过时。 4.x版本会移除该方法

返回if条件的sqlNode

一般类型：<if test="property_cache!=null">columnNode</if>

参数:

column -

返回:

getColumnEqualsProperty

@Deprecated
protected org.apache.ibatis.scripting.xmltags.SqlNode getColumnEqualsProperty(EntityColumn column,
                                                                                           boolean first)

已过时。 4.x版本会移除该方法

获取 [AND] column = #{property}

参数:

column -

first -

返回:

getAllIfColumnNode

@Deprecated
protected org.apache.ibatis.scripting.xmltags.SqlNode getAllIfColumnNode(Class<?> entityClass)

已过时。 4.x版本会移除该方法

获取所有列的where节点中的if判断列

参数:

entityClass -

返回:

getColumnParameterMappings

@Deprecated
protected List<org.apache.ibatis.mapping.ParameterMapping> getColumnParameterMappings(org.apache.ibatis.mapping.MappedStatement ms)

已过时。 4.x版本会移除该方法

根据对象生成所有列的映射

参数:

ms -

返回:

newSelectKeyMappedStatement

protected void newSelectKeyMappedStatement(org.apache.ibatis.mapping.MappedStatement ms,
                                           EntityColumn column)

新建SelectKey节点

参数:

ms -

column -

ExampleValidSqlNode

@Deprecated
public org.apache.ibatis.scripting.xmltags.IfSqlNode ExampleValidSqlNode(org.apache.ibatis.session.Configuration configuration)

已过时。

exampleWhereClause

@Deprecated
public org.apache.ibatis.scripting.xmltags.WhereSqlNode exampleWhereClause(org.apache.ibatis.session.Configuration configuration)

已过时。 4.x版本会移除该方法

Example查询中的where结构

参数:

configuration -

返回:

updateByExampleWhereClause

@Deprecated
public org.apache.ibatis.scripting.xmltags.WhereSqlNode updateByExampleWhereClause(org.apache.ibatis.session.Configuration configuration)

已过时。 4.x版本会移除该方法

Example-Update中的where结构

参数:

configuration -

返回: