TableMetaObject (myoss-mybatis 2.1.8.RELEASE API)

java.lang.Object
- app.myoss.cloud.mybatis.table.TableMetaObject

```
public class TableMetaObject
extends Object
```
数据库表结构信息工具类

Since:

2018年4月26日上午10:46:25

Author:

Jerry.Chen

Constructor Summary

Constructors
Constructor and Description

TableMetaObject()

Constructors
Constructor and Description
`TableMetaObject()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addSequenceBean(String sequenceBeanName, Sequence sequence)` 将"序列生成器实例对象"添加到缓存中
`static org.apache.ibatis.mapping.ResultMap`	`builderBaseResultMap(TableInfo tableInfo, org.apache.ibatis.session.Configuration configuration)` 生成实体的 BaseResultMap 对象，表映射结果集。类似 Mapper XML 中效果：
`static String`	`builderSelectAllColumns(TableInfo tableInfo)` 生成 select 查询所有列sql语句，示例如下：
`static StringBuilder`	`builderWhereByListPrimaryKeySql(TableInfo tableInfo, boolean includeLogicDelete)` 生成 where 主键条件sql语句（`includeLogicDelete = false` ，如果表是逻辑删除，会添加逻辑删除的字段），示例如下：
`static StringBuilder`	`builderWhereConditionSql(TableInfo tableInfo, boolean includeLogicDelete)` 生成 where 所有条件sql语句（`includeLogicDelete = false` ，如果表是逻辑删除，会添加逻辑删除的字段），示例如下：
`static StringBuilder`	`builderWhereConditionWithParameterSql(TableInfo tableInfo, boolean includeLogicDelete, String conditionPrefix)` 生成 where 所有条件sql语句（`includeLogicDelete = false` ，如果表是逻辑删除，会添加逻辑删除的字段），带有参数前缀，示例如下：
`static StringBuilder`	`builderWherePrimaryKeySql(TableInfo tableInfo, boolean includeLogicDelete)` 生成 where 主键条件sql语句（`includeLogicDelete = false` ，如果表是逻辑删除，会添加逻辑删除的字段），示例如下：
`static StringBuilder`	`builderWhereWithListPrimaryKeySql(TableInfo tableInfo, boolean includeLogicDelete)` 生成 where 主键条件sql语句（`includeLogicDelete = false` ，如果表是逻辑删除，会添加逻辑删除的字段），示例如下：
`static Class<?>`	`getEntityClassByMapperInterface(Class<?> mapperInterfaceClass)` 根据"mapper interface class" 中的泛型获取"实体类class"
`static List<Field>`	`getFieldList(Class<?> clazz)` 获取 `clazz` Class 中的所有字段，排除 static, transient 字段，包含父类中的字段（重写的字段只会保留一个）
`static Map<String,PropertyDescriptor>`	`getPropertyDescriptorMap(Class<?> beanClass)` 获取 `clazz` Class 中所有的 getter/setter 方法
`static Sequence`	`getSequenceBean(String sequenceBeanName)` 获取缓存中的"序列生成器实例对象"
`static Map<String,Sequence>`	`getSequenceBeanMap()` 获取缓存中的全部"序列生成器实例对象"
`static TableInfo`	`getTableInfo(Class<?> entityClass)` 获取缓存中的"数据库表结构信息"
`static TableInfo`	`getTableInfo(Class<?> entityClass, TableConfig config, org.apache.ibatis.session.Configuration configuration)` 获取缓存中的"数据库表结构信息"，或者获取初始化"数据库表结构信息"
`static TableInfo`	`getTableInfoByMapperInterface(Class<?> mapperInterface, TableConfig config, org.apache.ibatis.session.Configuration configuration)` 获取缓存中的"数据库表结构信息"，或者获取初始化"数据库表结构信息"
`static Map<Class<?>,TableInfo>`	`getTableInfoMap()` 获取缓存中的全部"数据库表结构信息"
`static String`	`getTableName(TableInfo tableInfo)` 获取数据库完整的表名
`static Class<? extends Annotation>`	`resolveAnnotationClassName(String className)` 判断 Annotation Class 是否存在，如果存在，返回 Class 对象

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

- Constructor Detail
  - TableMetaObject
```
public TableMetaObject()
```
- Method Detail
  - resolveAnnotationClassName
```
public static Class<? extends Annotation> resolveAnnotationClassName(String className)
```
    判断 Annotation Class 是否存在，如果存在，返回 Class 对象
    
    Parameters:
    
    className - class full name
    
    Returns:
    
    Annotation Class
  - addSequenceBean
```
public static void addSequenceBean(String sequenceBeanName,
                                   Sequence sequence)
```
    将"序列生成器实例对象"添加到缓存中
    
    Parameters:
    
    sequenceBeanName - 序列的 Spring Bean 实例名称
    
    sequence - 序列生成器实例对象
  - getSequenceBean
```
public static Sequence getSequenceBean(String sequenceBeanName)
```
    获取缓存中的"序列生成器实例对象"
    
    Parameters:
    
    sequenceBeanName - 序列的 Spring Bean 实例名称
    
    Returns:
    
    序列生成器实例对象
  - getSequenceBeanMap
```
public static Map<String,Sequence> getSequenceBeanMap()
```
    获取缓存中的全部"序列生成器实例对象"
    
    Returns:
    
    全部"序列生成器实例对象"
  - getTableInfoMap
```
public static Map<Class<?>,TableInfo> getTableInfoMap()
```
    获取缓存中的全部"数据库表结构信息"
    
    Returns:
    
    全部"数据库表结构信息"
  - getTableInfo
```
public static TableInfo getTableInfo(Class<?> entityClass)
```
    获取缓存中的"数据库表结构信息"
    
    Parameters:
    
    entityClass - 实体类class
    
    Returns:
    
    数据库表结构信息
  - getEntityClassByMapperInterface
```
public static Class<?> getEntityClassByMapperInterface(Class<?> mapperInterfaceClass)
```
    根据"mapper interface class" 中的泛型获取"实体类class"
    
    Parameters:
    
    mapperInterfaceClass - mapper interface class
    
    Returns:
    
    实体类class
  - getTableInfoByMapperInterface
```
public static TableInfo getTableInfoByMapperInterface(Class<?> mapperInterface,
                                                      TableConfig config,
                                                      org.apache.ibatis.session.Configuration configuration)
```
    获取缓存中的"数据库表结构信息"，或者获取初始化"数据库表结构信息"
    
    Parameters:
    
    mapperInterface - mapper interface class
    
    config - MyBatis Table 全局配置；实体类映射数据库表的全局配置
    
    configuration - MyBatis 全局配置
    
    Returns:
    
    数据库表结构信息
  - getTableInfo
```
public static TableInfo getTableInfo(Class<?> entityClass,
                                     TableConfig config,
                                     org.apache.ibatis.session.Configuration configuration)
```
    获取缓存中的"数据库表结构信息"，或者获取初始化"数据库表结构信息"
    
    Parameters:
    
    entityClass - 实体类class
    
    config - MyBatis Table 全局配置；实体类映射数据库表的全局配置
    
    configuration - MyBatis 全局配置
    
    Returns:
    
    数据库表结构信息
  - getFieldList
```
public static List<Field> getFieldList(Class<?> clazz)
```
    获取 clazz Class 中的所有字段，排除 static, transient 字段，包含父类中的字段（重写的字段只会保留一个）
    
    Parameters:
    
    clazz - 反射类
    
    Returns:
    
    所有字段信息
  - getPropertyDescriptorMap
```
public static Map<String,PropertyDescriptor> getPropertyDescriptorMap(Class<?> beanClass)
```
    获取 clazz Class 中所有的 getter/setter 方法
    
    Parameters:
    
    beanClass - 反射类
    
    Returns:
    
    clazz 所有的 getter/setter 方法
  - getTableName
```
public static String getTableName(TableInfo tableInfo)
```
    获取数据库完整的表名
    
    Parameters:
    
    tableInfo - 数据库表结构信息
    
    Returns:
    
    catalog.schema.tableName
  - builderBaseResultMap
```
public static org.apache.ibatis.mapping.ResultMap builderBaseResultMap(TableInfo tableInfo,
                                                                       org.apache.ibatis.session.Configuration configuration)
```
    生成实体的 BaseResultMap 对象，表映射结果集。类似 Mapper XML 中效果：
```
 <resultMap id="BaseResultMap" type="entityClass package">
   <id column="id" jdbcType="BIGINT" property="id" />
 </resultMap>
 
```
    Parameters:
    
    tableInfo - 数据库表结构信息
    
    configuration - Mybatis configuration
    
    Returns:
    
    BaseResultMap 对象
  - builderSelectAllColumns
```
public static String builderSelectAllColumns(TableInfo tableInfo)
```
    生成 select 查询所有列sql语句，示例如下：
```
 id, name, code
 
```
    Parameters:
    
    tableInfo - 数据库表结构信息
    
    Returns:
    
    sql语句
  - builderWhereConditionSql
```
public static StringBuilder builderWhereConditionSql(TableInfo tableInfo,
                                                     boolean includeLogicDelete)
```
    生成 where 所有条件sql语句（includeLogicDelete = false ，如果表是逻辑删除，会添加逻辑删除的字段），示例如下：
```
 <where>
  <if test="id != null">
    and id = #{id}
  </if>
  AND is_deleted = 'N'
 </where>
 
```
    Parameters:
    
    tableInfo - 数据库表结构信息
    
    includeLogicDelete - 是否不过滤掉已经被标记为逻辑删除（Column.logicDelete()）的数据
    
    Returns:
    
    sql语句
  - builderWhereConditionWithParameterSql
```
public static StringBuilder builderWhereConditionWithParameterSql(TableInfo tableInfo,
                                                                  boolean includeLogicDelete,
                                                                  String conditionPrefix)
```
    生成 where 所有条件sql语句（includeLogicDelete = false ，如果表是逻辑删除，会添加逻辑删除的字段），带有参数前缀，示例如下：
```
 <where>
  <if test="conditionPrefix.id != null">
    and id = #{conditionPrefix.id}
  </if>
  AND is_deleted = 'N'
 </where>
 
```
    Parameters:
    
    tableInfo - 数据库表结构信息
    
    includeLogicDelete - 是否不过滤掉已经被标记为逻辑删除（Column.logicDelete()）的数据
    
    conditionPrefix - 参数前缀
    
    Returns:
    
    sql语句
  - builderWherePrimaryKeySql
```
public static StringBuilder builderWherePrimaryKeySql(TableInfo tableInfo,
                                                      boolean includeLogicDelete)
```
    生成 where 主键条件sql语句（includeLogicDelete = false ，如果表是逻辑删除，会添加逻辑删除的字段），示例如下：
```
 <where>
  AND id = #{id}
  AND is_deleted = 'N'
 </where>
 
```
    Parameters:
    
    tableInfo - 数据库表结构信息
    
    includeLogicDelete - 是否不过滤掉已经被标记为逻辑删除（Column.logicDelete()）的数据
    
    Returns:
    
    sql语句
  - builderWhereByListPrimaryKeySql
```
public static StringBuilder builderWhereByListPrimaryKeySql(TableInfo tableInfo,
                                                            boolean includeLogicDelete)
```
    生成 where 主键条件sql语句（includeLogicDelete = false ，如果表是逻辑删除，会添加逻辑删除的字段），示例如下：
```
 <where>
  AND id in
  <foreach collection="ids" item="item" separator="," open="(" close=")">
    #{item}
  </foreach>
  AND is_deleted = 'N'
 </where>
 
```
    Parameters:
    
    tableInfo - 数据库表结构信息
    
    includeLogicDelete - 是否不过滤掉已经被标记为逻辑删除（Column.logicDelete()）的数据
    
    Returns:
    
    sql语句
  - builderWhereWithListPrimaryKeySql
```
public static StringBuilder builderWhereWithListPrimaryKeySql(TableInfo tableInfo,
                                                              boolean includeLogicDelete)
```
    生成 where 主键条件sql语句（includeLogicDelete = false ，如果表是逻辑删除，会添加逻辑删除的字段），示例如下：
```
 <where>
  AND id in
  <foreach collection="ids" item="item" separator="," open="(" close=")">
    #{item}
  </foreach>
  AND is_deleted = 'N'
 </where>
 
```
    Parameters:
    
    tableInfo - 数据库表结构信息
    
    includeLogicDelete - 是否不过滤掉已经被标记为逻辑删除（Column.logicDelete()）的数据
    
    Returns:
    
    sql语句

Class TableMetaObject

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TableMetaObject

Method Detail

resolveAnnotationClassName

addSequenceBean

getSequenceBean

getSequenceBeanMap

getTableInfoMap

getTableInfo

getEntityClassByMapperInterface

getTableInfoByMapperInterface

getTableInfo

getFieldList

getPropertyDescriptorMap

getTableName

builderBaseResultMap

builderSelectAllColumns

builderWhereConditionSql

builderWhereConditionWithParameterSql

builderWherePrimaryKeySql

builderWhereByListPrimaryKeySql

builderWhereWithListPrimaryKeySql