StrategyConfig (mybatis-plus-generator 3.4.1 API)

java.lang.Object
- com.baomidou.mybatisplus.generator.config.StrategyConfig

```
public class StrategyConfig
extends java.lang.Object
```
策略配置项

从以下版本开始:

2016/8/30

作者:

YangHu, tangguo, hubin

构造器概要

构造器
构造器和说明

StrategyConfig()

构造器
构造器和说明
`StrategyConfig()`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`protected boolean`	`canEqual(java.lang.Object other)`
`boolean`	`containsTablePrefix(java.lang.String tableName)` 已过时。 3.3.2 `startsWithTablePrefix(String)`
`protected void`	`convertSuperEntityColumns(java.lang.Class<?> clazz)` 父类 Class 反射属性转换为公共字段
`boolean`	`equals(java.lang.Object o)`
`NamingStrategy`	`getColumnNaming()`
`java.util.Set<java.lang.String>`	`getExclude()` 需要排除的表名，允许正则表达式当`enableSqlFilter`为true时，正则表达式无效.
`java.util.Set<java.lang.String>`	`getFieldPrefix()` 字段前缀
`java.util.Set<java.lang.String>`	`getInclude()` 需要包含的表名，允许正则表达式（与exclude二选一配置）当`enableSqlFilter`为true时，正则表达式无效.
`LikeTable`	`getLikeTable()` 包含表名
`java.lang.String`	`getLogicDeleteFieldName()` 逻辑删除属性名称
`INameConvert`	`getNameConvert()` 名称转换
`NamingStrategy`	`getNaming()` 数据库表映射到实体的命名策略
`LikeTable`	`getNotLikeTable()` 不包含表名
`java.lang.String`	`getSuperControllerClass()` 自定义继承的Controller类全称，带包名
`java.lang.String`	`getSuperEntityClass()` 自定义继承的Entity类全称，带包名
`java.util.Set<java.lang.String>`	`getSuperEntityColumns()`
`java.lang.String`	`getSuperMapperClass()` 自定义继承的Mapper类全称，带包名
`java.lang.String`	`getSuperServiceClass()` 自定义继承的Service类全称，带包名
`java.lang.String`	`getSuperServiceImplClass()` 自定义继承的ServiceImpl类全称，带包名
`java.util.List<TableFill>`	`getTableFillList()` 表填充字段
`java.util.Set<java.lang.String>`	`getTablePrefix()` 表前缀
`java.lang.String`	`getVersionFieldName()` 乐观锁属性名称
`int`	`hashCode()`
`boolean`	`includeSuperEntityColumns(java.lang.String fieldName)`
`boolean`	`isCapitalMode()` 是否大写命名
`boolean`	`isCapitalModeNaming(java.lang.String word)` 大写命名、字段符合大写字母数字下划线命名
`boolean`	`isChainModel()` 【实体】是否为链式模型（默认 false） ----------------------------------- public User setName(String name) { this.name = name; return this; }
`boolean`	`isControllerMappingHyphenStyle()` 驼峰转连字符 `@RequestMapping("/managerUserActionHistory")` -> `@RequestMapping("/manager-user-action-history")`
`boolean`	`isEnableSqlFilter()` 启用sql过滤，语法不能支持使用sql过滤表的话，可以考虑关闭此开关.
`boolean`	`isEntityBooleanColumnRemoveIsPrefix()` Boolean类型字段是否移除is前缀（默认 false）比如 : 数据库字段名称 : 'is_xxx',类型为 : tinyint.
`boolean`	`isEntityBuilderModel()` 已过时。 3.3.2 `isChainModel()`
`boolean`	`isEntityColumnConstant()` 【实体】是否生成字段常量（默认 false） ----------------------------------- public static final String ID = "test_id";
`boolean`	`isEntityLombokModel()` 【实体】是否为lombok模型（默认 false） document
`boolean`	`isEntitySerialVersionUID()` 实体是否生成 serialVersionUID
`boolean`	`isEntityTableFieldAnnotationEnable()` 是否生成实体时，生成字段注解
`boolean`	`isRestControllerStyle()` 生成 `@RestController` 控制器 `@Controller` -> `@RestController`
`boolean`	`isSkipView()` 是否跳过视图
`StrategyConfig`	`setCapitalMode(boolean isCapitalMode)` 是否大写命名
`StrategyConfig`	`setChainModel(boolean chainModel)` 【实体】是否为链式模型（默认 false） ----------------------------------- public User setName(String name) { this.name = name; return this; }
`StrategyConfig`	`setColumnNaming(NamingStrategy columnNaming)` 数据库表字段映射到实体的命名策略未指定按照 naming 执行
`StrategyConfig`	`setControllerMappingHyphenStyle(boolean controllerMappingHyphenStyle)` 驼峰转连字符 `@RequestMapping("/managerUserActionHistory")` -> `@RequestMapping("/manager-user-action-history")`
`StrategyConfig`	`setEnableSqlFilter(boolean enableSqlFilter)` 启用sql过滤，语法不能支持使用sql过滤表的话，可以考虑关闭此开关.
`StrategyConfig`	`setEntityBooleanColumnRemoveIsPrefix(boolean entityBooleanColumnRemoveIsPrefix)` Boolean类型字段是否移除is前缀（默认 false）比如 : 数据库字段名称 : 'is_xxx',类型为 : tinyint.
`StrategyConfig`	`setEntityBuilderModel(boolean entityBuilderModel)` 已过时。 3.3.2 `setChainModel(boolean)`
`StrategyConfig`	`setEntityColumnConstant(boolean entityColumnConstant)` 【实体】是否生成字段常量（默认 false） ----------------------------------- public static final String ID = "test_id";
`StrategyConfig`	`setEntityLombokModel(boolean entityLombokModel)` 【实体】是否为lombok模型（默认 false） document
`StrategyConfig`	`setEntitySerialVersionUID(boolean entitySerialVersionUID)` 实体是否生成 serialVersionUID
`StrategyConfig`	`setEntityTableFieldAnnotationEnable(boolean entityTableFieldAnnotationEnable)` 是否生成实体时，生成字段注解
`StrategyConfig`	`setExclude(java.lang.String... exclude)`
`StrategyConfig`	`setFieldPrefix(java.lang.String... fieldPrefixs)`
`StrategyConfig`	`setInclude(java.lang.String... include)`
`StrategyConfig`	`setLikeTable(LikeTable likeTable)` 包含表名
`StrategyConfig`	`setLogicDeleteFieldName(java.lang.String logicDeleteFieldName)` 逻辑删除属性名称
`StrategyConfig`	`setNameConvert(INameConvert nameConvert)` 名称转换
`StrategyConfig`	`setNaming(NamingStrategy naming)` 数据库表映射到实体的命名策略
`StrategyConfig`	`setNotLikeTable(LikeTable notLikeTable)` 不包含表名
`StrategyConfig`	`setRestControllerStyle(boolean restControllerStyle)` 生成 `@RestController` 控制器 `@Controller` -> `@RestController`
`StrategyConfig`	`setSkipView(boolean skipView)` 是否跳过视图
`StrategyConfig`	`setSuperControllerClass(java.lang.Class<?> clazz)`
`StrategyConfig`	`setSuperControllerClass(java.lang.String superControllerClass)`
`StrategyConfig`	`setSuperEntityClass(java.lang.Class<?> clazz)` 设置实体父类，该设置自动识别公共字段属性 superEntityColumns 改配置无需再次配置注意！！
`StrategyConfig`	`setSuperEntityClass(java.lang.Class<?> clazz, NamingStrategy columnNaming)` 设置实体父类，该设置自动识别公共字段属性 superEntityColumns 改配置无需再次配置
`StrategyConfig`	`setSuperEntityClass(java.lang.String superEntityClass)` 设置实体父类
`StrategyConfig`	`setSuperEntityColumns(java.lang.String... superEntityColumns)`
`StrategyConfig`	`setSuperMapperClass(java.lang.String superMapperClass)` 自定义继承的Mapper类全称，带包名
`StrategyConfig`	`setSuperServiceClass(java.lang.Class<?> clazz)`
`StrategyConfig`	`setSuperServiceClass(java.lang.String superServiceClass)`
`StrategyConfig`	`setSuperServiceImplClass(java.lang.Class<?> clazz)`
`StrategyConfig`	`setSuperServiceImplClass(java.lang.String superServiceImplClass)`
`StrategyConfig`	`setTableFillList(java.util.List<TableFill> tableFillList)` 表填充字段
`StrategyConfig`	`setTablePrefix(java.lang.String... tablePrefix)`
`StrategyConfig`	`setVersionFieldName(java.lang.String versionFieldName)` 乐观锁属性名称
`boolean`	`startsWithTablePrefix(java.lang.String tableName)` 表名称匹配表前缀
`java.lang.String`	`toString()`

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

- 构造器详细资料
  - StrategyConfig
```
public StrategyConfig()
```
- 方法详细资料
  - isCapitalModeNaming
```
public boolean isCapitalModeNaming(java.lang.String word)
```
    大写命名、字段符合大写字母数字下划线命名
    
    参数:
    
    word - 待判断字符串
  - containsTablePrefix
```
@Deprecated
public boolean containsTablePrefix(java.lang.String tableName)
```
    已过时。 3.3.2 startsWithTablePrefix(String)
    
    表名称包含指定前缀
    
    参数:
    
    tableName - 表名称
  - startsWithTablePrefix
```
public boolean startsWithTablePrefix(java.lang.String tableName)
```
    表名称匹配表前缀
    
    参数:
    
    tableName - 表名称
    
    从以下版本开始:
    
    3.3.2
  - getColumnNaming
```
public NamingStrategy getColumnNaming()
```
  - setTablePrefix
```
public StrategyConfig setTablePrefix(java.lang.String... tablePrefix)
```
  - includeSuperEntityColumns
```
public boolean includeSuperEntityColumns(java.lang.String fieldName)
```
  - setSuperEntityColumns
```
public StrategyConfig setSuperEntityColumns(java.lang.String... superEntityColumns)
```
  - setInclude
```
public StrategyConfig setInclude(java.lang.String... include)
```
  - setExclude
```
public StrategyConfig setExclude(java.lang.String... exclude)
```
  - setFieldPrefix
```
public StrategyConfig setFieldPrefix(java.lang.String... fieldPrefixs)
```
  - setSuperEntityClass
```
public StrategyConfig setSuperEntityClass(java.lang.String superEntityClass)
```
    设置实体父类
    
    参数:
    
    superEntityClass - 类全名称
    
    返回:
    
    this
  - setSuperEntityClass
```
public StrategyConfig setSuperEntityClass(java.lang.Class<?> clazz)
```
    设置实体父类，该设置自动识别公共字段
    属性 superEntityColumns 改配置无需再次配置
    
    注意！！字段策略要在设置实体父类之前有效
    
    参数:
    
    clazz - 实体父类 Class
    
    返回:
  - setSuperEntityClass
```
public StrategyConfig setSuperEntityClass(java.lang.Class<?> clazz,
                                          NamingStrategy columnNaming)
```
    设置实体父类，该设置自动识别公共字段
    属性 superEntityColumns 改配置无需再次配置
    
    参数:
    
    clazz - 实体父类 Class
    
    columnNaming - 字段命名策略
    
    返回:
  - setSuperServiceClass
```
public StrategyConfig setSuperServiceClass(java.lang.Class<?> clazz)
```
  - setSuperServiceClass
```
public StrategyConfig setSuperServiceClass(java.lang.String superServiceClass)
```
  - setSuperServiceImplClass
```
public StrategyConfig setSuperServiceImplClass(java.lang.Class<?> clazz)
```
  - setSuperServiceImplClass
```
public StrategyConfig setSuperServiceImplClass(java.lang.String superServiceImplClass)
```
  - setSuperControllerClass
```
public StrategyConfig setSuperControllerClass(java.lang.Class<?> clazz)
```
  - setSuperControllerClass
```
public StrategyConfig setSuperControllerClass(java.lang.String superControllerClass)
```
  - convertSuperEntityColumns
```
protected void convertSuperEntityColumns(java.lang.Class<?> clazz)
```
    父类 Class 反射属性转换为公共字段
    
    参数:
    
    clazz - 实体父类 Class
  - isEntityBuilderModel
```
@Deprecated
public boolean isEntityBuilderModel()
```
    已过时。 3.3.2 isChainModel()
    
    是否为构建者模型
    
    返回:
    
    是否为构建者模型
  - setEntityBuilderModel
```
@Deprecated
public StrategyConfig setEntityBuilderModel(boolean entityBuilderModel)
```
    已过时。 3.3.2 setChainModel(boolean)
    
    设置是否为构建者模型
    
    参数:
    
    entityBuilderModel - 是否为构建者模型
    
    返回:
    
    this
  - getSuperEntityColumns
```
public java.util.Set<java.lang.String> getSuperEntityColumns()
```
  - isCapitalMode
```
public boolean isCapitalMode()
```
    是否大写命名
  - isSkipView
```
public boolean isSkipView()
```
    是否跳过视图
  - getNameConvert
```
public INameConvert getNameConvert()
```
    名称转换
  - getNaming
```
public NamingStrategy getNaming()
```
    数据库表映射到实体的命名策略
  - getTablePrefix
```
public java.util.Set<java.lang.String> getTablePrefix()
```
    表前缀
  - getFieldPrefix
```
public java.util.Set<java.lang.String> getFieldPrefix()
```
    字段前缀
  - getSuperEntityClass
```
public java.lang.String getSuperEntityClass()
```
    自定义继承的Entity类全称，带包名
  - getSuperMapperClass
```
public java.lang.String getSuperMapperClass()
```
    自定义继承的Mapper类全称，带包名
  - getSuperServiceClass
```
public java.lang.String getSuperServiceClass()
```
    自定义继承的Service类全称，带包名
  - getSuperServiceImplClass
```
public java.lang.String getSuperServiceImplClass()
```
    自定义继承的ServiceImpl类全称，带包名
  - getSuperControllerClass
```
public java.lang.String getSuperControllerClass()
```
    自定义继承的Controller类全称，带包名
  - getInclude
```
public java.util.Set<java.lang.String> getInclude()
```
    需要包含的表名，允许正则表达式（与exclude二选一配置）
    当enableSqlFilter为true时，正则表达式无效.
  - getExclude
```
public java.util.Set<java.lang.String> getExclude()
```
    需要排除的表名，允许正则表达式
    当enableSqlFilter为true时，正则表达式无效.
  - isEntitySerialVersionUID
```
public boolean isEntitySerialVersionUID()
```
    实体是否生成 serialVersionUID
  - isEntityColumnConstant
```
public boolean isEntityColumnConstant()
```
    【实体】是否生成字段常量（默认 false）
    -----------------------------------
    public static final String ID = "test_id";
  - isChainModel
```
public boolean isChainModel()
```
    【实体】是否为链式模型（默认 false）
    -----------------------------------
    public User setName(String name) { this.name = name; return this; }
    
    从以下版本开始:
    
    3.3.2
  - isEntityLombokModel
```
public boolean isEntityLombokModel()
```
    【实体】是否为lombok模型（默认 false）
    document
  - isEntityBooleanColumnRemoveIsPrefix
```
public boolean isEntityBooleanColumnRemoveIsPrefix()
```
    Boolean类型字段是否移除is前缀（默认 false）
    比如 : 数据库字段名称 : 'is_xxx',类型为 : tinyint. 在映射实体的时候则会去掉is,在实体类中映射最终结果为 xxx
  - isRestControllerStyle
```
public boolean isRestControllerStyle()
```
    生成 @RestController 控制器
```
      @Controller -> @RestController
 
```
  - isControllerMappingHyphenStyle
```
public boolean isControllerMappingHyphenStyle()
```
    驼峰转连字符
```
      @RequestMapping("/managerUserActionHistory") -> @RequestMapping("/manager-user-action-history")
 
```
  - isEntityTableFieldAnnotationEnable
```
public boolean isEntityTableFieldAnnotationEnable()
```
    是否生成实体时，生成字段注解
  - getVersionFieldName
```
public java.lang.String getVersionFieldName()
```
    乐观锁属性名称
  - getLogicDeleteFieldName
```
public java.lang.String getLogicDeleteFieldName()
```
    逻辑删除属性名称
  - getTableFillList
```
public java.util.List<TableFill> getTableFillList()
```
    表填充字段
  - isEnableSqlFilter
```
public boolean isEnableSqlFilter()
```
    启用sql过滤，语法不能支持使用sql过滤表的话，可以考虑关闭此开关.
    
    从以下版本开始:
    
    3.3.1
  - getLikeTable
```
public LikeTable getLikeTable()
```
    包含表名
    
    从以下版本开始:
    
    3.3.0
  - getNotLikeTable
```
public LikeTable getNotLikeTable()
```
    不包含表名
    
    从以下版本开始:
    
    3.3.0
  - setCapitalMode
```
public StrategyConfig setCapitalMode(boolean isCapitalMode)
```
    是否大写命名
    
    返回:
    
    this.
  - setSkipView
```
public StrategyConfig setSkipView(boolean skipView)
```
    是否跳过视图
    
    返回:
    
    this.
  - setNameConvert
```
public StrategyConfig setNameConvert(INameConvert nameConvert)
```
    名称转换
    
    返回:
    
    this.
  - setNaming
```
public StrategyConfig setNaming(NamingStrategy naming)
```
    数据库表映射到实体的命名策略
    
    返回:
    
    this.
  - setColumnNaming
```
public StrategyConfig setColumnNaming(NamingStrategy columnNaming)
```
    数据库表字段映射到实体的命名策略
    未指定按照 naming 执行
    
    返回:
    
    this.
  - setSuperMapperClass
```
public StrategyConfig setSuperMapperClass(java.lang.String superMapperClass)
```
    自定义继承的Mapper类全称，带包名
    
    返回:
    
    this.
  - setEntitySerialVersionUID
```
public StrategyConfig setEntitySerialVersionUID(boolean entitySerialVersionUID)
```
    实体是否生成 serialVersionUID
    
    返回:
    
    this.
  - setEntityColumnConstant
```
public StrategyConfig setEntityColumnConstant(boolean entityColumnConstant)
```
    【实体】是否生成字段常量（默认 false）
    -----------------------------------
    public static final String ID = "test_id";
    
    返回:
    
    this.
  - setChainModel
```
public StrategyConfig setChainModel(boolean chainModel)
```
    【实体】是否为链式模型（默认 false）
    -----------------------------------
    public User setName(String name) { this.name = name; return this; }
    
    返回:
    
    this.
    
    从以下版本开始:
    
    3.3.2
  - setEntityLombokModel
```
public StrategyConfig setEntityLombokModel(boolean entityLombokModel)
```
    【实体】是否为lombok模型（默认 false）
    document
    
    返回:
    
    this.
  - setEntityBooleanColumnRemoveIsPrefix
```
public StrategyConfig setEntityBooleanColumnRemoveIsPrefix(boolean entityBooleanColumnRemoveIsPrefix)
```
    Boolean类型字段是否移除is前缀（默认 false）
    比如 : 数据库字段名称 : 'is_xxx',类型为 : tinyint. 在映射实体的时候则会去掉is,在实体类中映射最终结果为 xxx
    
    返回:
    
    this.
  - setRestControllerStyle
```
public StrategyConfig setRestControllerStyle(boolean restControllerStyle)
```
    生成 @RestController 控制器
```
      @Controller -> @RestController
 
```
    返回:
    
    this.
  - setControllerMappingHyphenStyle
```
public StrategyConfig setControllerMappingHyphenStyle(boolean controllerMappingHyphenStyle)
```
    驼峰转连字符
```
      @RequestMapping("/managerUserActionHistory") -> @RequestMapping("/manager-user-action-history")
 
```
    返回:
    
    this.
  - setEntityTableFieldAnnotationEnable
```
public StrategyConfig setEntityTableFieldAnnotationEnable(boolean entityTableFieldAnnotationEnable)
```
    是否生成实体时，生成字段注解
    
    返回:
    
    this.
  - setVersionFieldName
```
public StrategyConfig setVersionFieldName(java.lang.String versionFieldName)
```
    乐观锁属性名称
    
    返回:
    
    this.
  - setLogicDeleteFieldName
```
public StrategyConfig setLogicDeleteFieldName(java.lang.String logicDeleteFieldName)
```
    逻辑删除属性名称
    
    返回:
    
    this.
  - setTableFillList
```
public StrategyConfig setTableFillList(java.util.List<TableFill> tableFillList)
```
    表填充字段
    
    返回:
    
    this.
  - setEnableSqlFilter
```
public StrategyConfig setEnableSqlFilter(boolean enableSqlFilter)
```
    启用sql过滤，语法不能支持使用sql过滤表的话，可以考虑关闭此开关.
    
    返回:
    
    this.
    
    从以下版本开始:
    
    3.3.1
  - setLikeTable
```
public StrategyConfig setLikeTable(LikeTable likeTable)
```
    包含表名
    
    返回:
    
    this.
    
    从以下版本开始:
    
    3.3.0
  - setNotLikeTable
```
public StrategyConfig setNotLikeTable(LikeTable notLikeTable)
```
    不包含表名
    
    返回:
    
    this.
    
    从以下版本开始:
    
    3.3.0
  - equals
```
public boolean equals(java.lang.Object o)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object

类 StrategyConfig

构造器概要

方法概要

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

构造器详细资料

StrategyConfig

方法详细资料

isCapitalModeNaming

containsTablePrefix

startsWithTablePrefix

getColumnNaming

setTablePrefix

includeSuperEntityColumns

setSuperEntityColumns

setInclude

setExclude

setFieldPrefix

setSuperEntityClass

setSuperEntityClass

setSuperEntityClass

setSuperServiceClass

setSuperServiceClass

setSuperServiceImplClass

setSuperServiceImplClass

setSuperControllerClass

setSuperControllerClass

convertSuperEntityColumns

isEntityBuilderModel

setEntityBuilderModel

getSuperEntityColumns

isCapitalMode

isSkipView

getNameConvert

getNaming

getTablePrefix

getFieldPrefix

getSuperEntityClass

getSuperMapperClass

getSuperServiceClass

getSuperServiceImplClass

getSuperControllerClass

getInclude

getExclude

isEntitySerialVersionUID

isEntityColumnConstant

isChainModel

isEntityLombokModel

isEntityBooleanColumnRemoveIsPrefix

isRestControllerStyle

isControllerMappingHyphenStyle

isEntityTableFieldAnnotationEnable

getVersionFieldName

getLogicDeleteFieldName

getTableFillList

isEnableSqlFilter

getLikeTable

getNotLikeTable

setCapitalMode

setSkipView

setNameConvert

setNaming

setColumnNaming

setSuperMapperClass

setEntitySerialVersionUID

setEntityColumnConstant

setChainModel

setEntityLombokModel

setEntityBooleanColumnRemoveIsPrefix

setRestControllerStyle

setControllerMappingHyphenStyle

setEntityTableFieldAnnotationEnable

setVersionFieldName

setLogicDeleteFieldName

setTableFillList

setEnableSqlFilter

setLikeTable

setNotLikeTable

equals

canEqual

hashCode