XbatisConfig (xbatis-core 1.8.2 API)

java.lang.Object
- cn.xbatis.core.XbatisConfig

public final class XbatisConfig
extends Object

全局配置

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static void`	`addSQLListener(db.sql.api.cmd.listener.SQLListener sqlListener)` 添加SQLListener
`static int`	`getDefaultBatchSize()` 默认1000
`static DbType`	`getDefaultDbType()` 获取默认DbType
`static <T> T`	`getDefaultValue(Class<?> clazz, Class<T> type, String key)` 获取默认值
`static IPagingProcessor`	`getPagingProcessor(DbType dbType)` 获取分页处理器
`static Class<? extends BasicMapper>`	`getSingleMapperClass()` 获取单Mapper的class 用于BasicMapper.withSqlSession方法 statement 拼接
`static SQLBuilder`	`getSQLBuilder()` 设置QUERY SQL BUILDER
`static List<db.sql.api.cmd.listener.SQLListener>`	`getSQLListeners()` 获取所有的SQLListener
`static boolean`	`isColumnUnderline()` 数据库列是否下划线规则默认 true
`static boolean`	`isDefaultValueKeyFormat(String key)`
`static boolean`	`isLogicDeleteSwitchOpen()` 获取逻辑删除开关，默认开启
`static boolean`	`isTableUnderline()` 数据库表是否下划线规则默认 true
`static <T extends db.sql.api.cmd.listener.SQLListener> void`	`removeSQLListener(Class<T> type)` 移除SQLListener
`static void`	`setColumnUnderline(boolean bool)` 数据库列是否下划线规则（必须在项目启动时设置，否则可能永远不会成功）
`static void`	`setDefaultBatchSize(int defaultBatchSize)`
`static void`	`setDefaultDbType(DbType defaultDbType)` 设置默认DbType
`static void`	`setDefaultValue(String key, BiFunction<Class<?>,Class<?>,Object> f)`
`static void`	`setLogicDeleteSwitch(boolean bool)` 设置逻辑删除开关状态（必须在项目启动时设置，否则可能永远false）
`static void`	`setPagingProcessor(DbType dbType, IPagingProcessor pagingProcessor)` 设置分页处理器
`static void`	`setSingleMapperClass(Class<? extends BasicMapper> singleMapperClass)` 设置单Mapper的class 用于BasicMapper.withSqlSession方法 statement 拼接
`static void`	`setSQLBuilder(SQLBuilder sqlBuilder)`
`static void`	`setTableUnderline(boolean bool)` 设置数据库表是否下划线规则（必须在项目启动时设置，否则可能永远不会成功）

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - getDefaultDbType
```
public static DbType getDefaultDbType()
```
    获取默认DbType
    
    返回:
  - setDefaultDbType
```
public static void setDefaultDbType(DbType defaultDbType)
```
    设置默认DbType
    
    参数:
    
    defaultDbType -
  - isColumnUnderline
```
public static boolean isColumnUnderline()
```
    数据库列是否下划线规则默认 true
    
    返回:
    
    列是否是下划线命名规则
  - setColumnUnderline
```
public static void setColumnUnderline(boolean bool)
```
    数据库列是否下划线规则（必须在项目启动时设置，否则可能永远不会成功）
    
    参数:
    
    bool - 列是否下划线命名规则
  - isTableUnderline
```
public static boolean isTableUnderline()
```
    数据库表是否下划线规则默认 true
    
    返回:
    
    是否是下划线规则
  - setTableUnderline
```
public static void setTableUnderline(boolean bool)
```
    设置数据库表是否下划线规则（必须在项目启动时设置，否则可能永远不会成功）
    
    参数:
    
    bool - 是否是下划线规则
  - getDefaultBatchSize
```
public static int getDefaultBatchSize()
```
    默认1000
    
    返回:
    
    批量提交的默认size
  - setDefaultBatchSize
```
public static void setDefaultBatchSize(int defaultBatchSize)
```
  - getSQLBuilder
```
public static SQLBuilder getSQLBuilder()
```
    设置QUERY SQL BUILDER
    
    返回:
    
    返回QuerySQLBuilder
  - setSQLBuilder
```
public static void setSQLBuilder(SQLBuilder sqlBuilder)
```
  - isLogicDeleteSwitchOpen
```
public static boolean isLogicDeleteSwitchOpen()
```
    获取逻辑删除开关，默认开启
    
    返回:
    
    逻辑开关的是否打开
  - setLogicDeleteSwitch
```
public static void setLogicDeleteSwitch(boolean bool)
```
    设置逻辑删除开关状态（必须在项目启动时设置，否则可能永远false）
    
    参数:
    
    bool - 开关状态
  - isDefaultValueKeyFormat
```
public static boolean isDefaultValueKeyFormat(String key)
```
  - setDefaultValue
```
public static void setDefaultValue(String key,
                                   BiFunction<Class<?>,Class<?>,Object> f)
```
  - getDefaultValue
```
public static <T> T getDefaultValue(Class<?> clazz,
                                    Class<T> type,
                                    String key)
```
    获取默认值
    
    类型参数:
    
    T - 类型clazz的泛型
    
    参数:
    
    clazz - 字段所在的class
    
    type - 默认值的类型
    
    key - 默认值的key，key必须以{}包裹，例如:{NOW}
    
    返回:
    
    返回指定类型clazz key的默认值
  - getSingleMapperClass
```
public static Class<? extends BasicMapper> getSingleMapperClass()
```
    获取单Mapper的class 用于BasicMapper.withSqlSession方法 statement 拼接
    
    返回:
    
    单Mapper的class
  - setSingleMapperClass
```
public static void setSingleMapperClass(Class<? extends BasicMapper> singleMapperClass)
```
    设置单Mapper的class 用于BasicMapper.withSqlSession方法 statement 拼接
    
    参数:
    
    singleMapperClass -
  - addSQLListener
```
public static void addSQLListener(db.sql.api.cmd.listener.SQLListener sqlListener)
```
    添加SQLListener
    
    参数:
    
    sqlListener -
  - removeSQLListener
```
public static <T extends db.sql.api.cmd.listener.SQLListener> void removeSQLListener(Class<T> type)
```
    移除SQLListener
    
    参数:
    
    type -
  - getSQLListeners
```
public static List<db.sql.api.cmd.listener.SQLListener> getSQLListeners()
```
    获取所有的SQLListener
    
    返回:
  - setPagingProcessor
```
public static void setPagingProcessor(DbType dbType,
                                      IPagingProcessor pagingProcessor)
```
    设置分页处理器
    
    参数:
    
    dbType - 数据库类型
    
    pagingProcessor - 分页处理器
  - getPagingProcessor
```
public static IPagingProcessor getPagingProcessor(DbType dbType)
```
    获取分页处理器
    
    参数:
    
    dbType - 数据库类型
    
    返回:
    
    分页处理器

类 XbatisConfig

方法概要

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

方法详细资料

getDefaultDbType

setDefaultDbType

isColumnUnderline

setColumnUnderline

isTableUnderline

setTableUnderline

getDefaultBatchSize

setDefaultBatchSize

getSQLBuilder

setSQLBuilder

isLogicDeleteSwitchOpen

setLogicDeleteSwitch

isDefaultValueKeyFormat

setDefaultValue

getDefaultValue

getSingleMapperClass

setSingleMapperClass

addSQLListener

removeSQLListener

getSQLListeners

setPagingProcessor

getPagingProcessor