Generator (Java Database 1.5.7 API)

java.lang.Object
- com.litongjava.db.activerecord.generator.Generator

```
public class Generator
extends Object
```
生成器 1：生成时会强制覆盖 Base model、MappingKit、DataDictionary，建议不要修改三类文件，在数据库有变化重新生成一次便可 2：生成 Model 不会覆盖已经存在的文件，Model 通常会被人为修改和维护 3：MappingKit 文件默认会在生成 Model 文件的同时生成 4：DataDictionary 文件默认不会生成。只有在设置 setGenerateDataDictionary(true)后，会在生成 Model文件的同时生成 5：可以通过继承 BaseModelGenerator、ModelGenerator、MappingKitGenerator、DataDictionaryGenerator 来创建自定义生成器，然后使用 Generator 的 setter 方法指定自定义生成器来生成 6：生成模板文字属性全部为 protected 可见性，方便自定义 Generator 生成符合。。。。

Field Summary

Fields
Modifier and Type	Field and Description
`protected BaseModelGenerator`	`baseModelGenerator`
`protected DataDictionaryGenerator`	`dataDictionaryGenerator`
`protected Dialect`	`dialect`
`protected boolean`	`generateDataDictionary`
`protected MappingKitGenerator`	`mappingKitGenerator`
`protected MetaBuilder`	`metaBuilder`
`protected ModelGenerator`	`modelGenerator`

Constructor Summary

Constructors
Constructor and Description
`Generator(DataSource dataSource, BaseModelGenerator baseModelGenerator)`
`Generator(DataSource dataSource, BaseModelGenerator baseModelGenerator, ModelGenerator modelGenerator)` 使用指定 BaseModelGenerator、ModelGenerator 构造 Generator 生成 BaseModel、Model、MappingKit 三类文件，其中 MappingKit 输出目录与包名与 Model相同
`Generator(DataSource dataSource, String baseModelPackageName, String baseModelOutputDir)` 构造 Generator，只生成 baseModel
`Generator(DataSource dataSource, String baseModelPackageName, String baseModelOutputDir, String modelPackageName, String modelOutputDir)` 构造 Generator，生成 BaseModel、Model、MappingKit 三类文件，其中 MappingKit 输出目录与包名与 Model相同

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBlacklist(String... tableNames)` 添加要排除的 tableName 到黑名单。使用黑名单功能时，只有处在黑名单中的 table 才会被过滤
`void`	`addExcludedTable(String... excludedTables)` 添加不需要处理的数据表
`void`	`addTypeMapping(Class<?> from, Class<?> to)` 为生成器添加类型映射，将数据库反射得到的类型映射到指定类型，从而在生成过程中用指定类型替换数据反射得到的类型添加的映射可以覆盖默认的映射，从而可以自由定制映射关系
`void`	`addTypeMapping(String from, String to)` 与 addTypeMaping(Class from, Class to) 功能一致，保是参数类型不同示例： generator.addTypeMaping("java.sql.Date", "java.time.LocalDateTime")
`void`	`addWhitelist(String... tableNames)` 添加要生成的 tableName 到白名单。使用白名单功能时，只有处在白名单中的 table 才会参与生成
`void`	`configBaseModelGenerator(Func.F10<BaseModelGenerator> baseModelGenerator)` 配置 BaseModelGenerator
`void`	`configDataDictionaryGenerator(Func.F10<DataDictionaryGenerator> dataDictionaryGenerator)` 配置 DataDictionaryGenerator
`void`	`configMappingKitGenerator(Func.F10<MappingKitGenerator> mappingKitGenerator)` 配置 MappingKitGenerator
`void`	`configMetaBuilder(Func.F10<MetaBuilder> metaBuilder)` 配置 MetaBuilder
`void`	`configModelGenerator(Func.F10<ModelGenerator> modelGenerator)` 配置 ModelGenerator
`void`	`generate()`
`MetaBuilder`	`getMetaBuilder()` 获取 MetaBuilder 后方便使用其内部方法
`void`	`removeBlacklist(String tableName)`
`void`	`removeTypeMapping(Class<?> from)`
`void`	`removeTypeMapping(String from)`
`void`	`removeWhitelist(String tableName)`
`void`	`setBaseModelTemplate(String baseModelTemplate)` 设置用于生成 BaseModel 的模板文件，模板引擎将在 class path 与 jar 包内寻找模板文件默认模板为："/com/litongjava/db/activerecord/generator/base_model_template.jf"
`void`	`setDataDictionaryFileName(String dataDictionaryFileName)` 设置数据字典 DataDictionary 文件输出目录，默认值为 "_DataDictionary.txt"
`void`	`setDataDictionaryGenerator(DataDictionaryGenerator dataDictionaryGenerator)` 设置 DataDictionaryGenerator，便于扩展自定义 DataDictionaryGenerator
`void`	`setDataDictionaryOutputDir(String dataDictionaryOutputDir)` 设置数据字典 DataDictionary 文件输出目录，默认与 modelOutputDir 相同
`void`	`setDialect(Dialect dialect)` 设置数据库方言，默认为 MysqlDialect
`void`	`setFetchFieldAutoIncrement(boolean fetchFieldAutoIncrement)` 配置是否取出字段的自增属性
`void`	`setGenerateChainSetter(boolean generateChainSetter)` 设置 BaseModel 是否生成链式 setter 方法
`void`	`setGenerateDaoInModel(boolean generateDaoInModel)` 设置是否在 Model 中生成 dao 对象，默认生成
`void`	`setGenerateDataDictionary(boolean generateDataDictionary)` 设置是否生成数据字典 Dictionary 文件，默认不生成
`void`	`setGenerateRemarks(boolean generateRemarks)` 配置是否生成字段备注，生成的备注会体现在 Base Model 之中默认值为 false
`void`	`setGenerateView(boolean generateView)` 配置是否生成 view。默认值为 false
`void`	`setMappingKitClassName(String mappingKitClassName)` 设置 MappingKit 类名，默认值为: "_MappingKit"
`void`	`setMappingKitGenerator(MappingKitGenerator mappingKitGenerator)` 设置 MappingKitGenerator，便于扩展自定义 MappingKitGenerator
`void`	`setMappingKitOutputDir(String mappingKitOutputDir)` 设置 MappingKit 文件输出目录，默认与 modelOutputDir 相同，在设置此变量的同时需要设置 mappingKitPackageName
`void`	`setMappingKitPackageName(String mappingKitPackageName)` 设置 MappingKit 文件包名，默认与 modelPackageName 相同，在设置此变的同时需要设置 mappingKitOutputDir
`void`	`setMappingKitTemplate(String mappingKitTemplate)` 设置用于生成 MappingKit 的模板文件，模板引擎将在 class path 与 jar 包内寻找模板文件默认模板为："/com/litongjava/db/activerecord/generator/mapping_kit_template.jf"
`void`	`setMetaBuilder(MetaBuilder metaBuilder)` 设置 MetaBuilder，便于扩展自定义 MetaBuilder
`void`	`setModelTemplate(String modelTemplate)` 设置用于生成 Model 的模板文件，模板引擎将在 class path 与 jar 包内寻找模板文件默认模板为："/com/litongjava/db/activerecord/generator/model_template.jf"
`void`	`setRemovedTableNamePrefixes(String... removedTableNamePrefixes)` 设置需要被移除的表名前缀，仅用于生成 modelName 与 baseModelName 例如表名 "osc_account"，移除前缀 "osc_" 后变为 "account"
`void`	`setTypeMapping(TypeMapping typeMapping)` 切换 TypeMapping jfinal 4.9.08 版本新增了 addTypeMapping(...) 可以替代该方法的使用

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

- Field Detail
  - dialect
```
protected Dialect dialect
```
  - metaBuilder
```
protected MetaBuilder metaBuilder
```
  - baseModelGenerator
```
protected BaseModelGenerator baseModelGenerator
```
  - modelGenerator
```
protected ModelGenerator modelGenerator
```
  - mappingKitGenerator
```
protected MappingKitGenerator mappingKitGenerator
```
  - dataDictionaryGenerator
```
protected DataDictionaryGenerator dataDictionaryGenerator
```
  - generateDataDictionary
```
protected boolean generateDataDictionary
```
- Constructor Detail
  - Generator
```
public Generator(DataSource dataSource,
                 String baseModelPackageName,
                 String baseModelOutputDir,
                 String modelPackageName,
                 String modelOutputDir)
```
    构造 Generator，生成 BaseModel、Model、MappingKit 三类文件，其中 MappingKit 输出目录与包名与 Model相同
    
    Parameters:
    
    dataSource - 数据源
    
    baseModelPackageName - base model 包名
    
    baseModelOutputDir - base mode 输出目录
    
    modelPackageName - model 包名
    
    modelOutputDir - model 输出目录
  - Generator
```
public Generator(DataSource dataSource,
                 String baseModelPackageName,
                 String baseModelOutputDir)
```
    构造 Generator，只生成 baseModel
    
    Parameters:
    
    dataSource - 数据源
    
    baseModelPackageName - base model 包名
    
    baseModelOutputDir - base mode 输出目录
  - Generator
```
public Generator(DataSource dataSource,
                 BaseModelGenerator baseModelGenerator)
```
  - Generator
```
public Generator(DataSource dataSource,
                 BaseModelGenerator baseModelGenerator,
                 ModelGenerator modelGenerator)
```
    使用指定 BaseModelGenerator、ModelGenerator 构造 Generator 生成 BaseModel、Model、MappingKit 三类文件，其中 MappingKit 输出目录与包名与 Model相同
- Method Detail
  - configMetaBuilder
```
public void configMetaBuilder(Func.F10<MetaBuilder> metaBuilder)
```
    配置 MetaBuilder
  - configBaseModelGenerator
```
public void configBaseModelGenerator(Func.F10<BaseModelGenerator> baseModelGenerator)
```
    配置 BaseModelGenerator
  - configModelGenerator
```
public void configModelGenerator(Func.F10<ModelGenerator> modelGenerator)
```
    配置 ModelGenerator
  - configMappingKitGenerator
```
public void configMappingKitGenerator(Func.F10<MappingKitGenerator> mappingKitGenerator)
```
    配置 MappingKitGenerator
  - configDataDictionaryGenerator
```
public void configDataDictionaryGenerator(Func.F10<DataDictionaryGenerator> dataDictionaryGenerator)
```
    配置 DataDictionaryGenerator
  - setMetaBuilder
```
public void setMetaBuilder(MetaBuilder metaBuilder)
```
    设置 MetaBuilder，便于扩展自定义 MetaBuilder
  - getMetaBuilder
```
public MetaBuilder getMetaBuilder()
```
    获取 MetaBuilder 后方便使用其内部方法
```
 例如：
   // 调用 skip 方法定制 table 过滤：
   generator.getMetaBuilder().skip(tableName -> tableName.endsWith("_old"));
 
```
  - setGenerateRemarks
```
public void setGenerateRemarks(boolean generateRemarks)
```
    配置是否生成字段备注，生成的备注会体现在 Base Model 之中默认值为 false
  - setGenerateView
```
public void setGenerateView(boolean generateView)
```
    配置是否生成 view。默认值为 false
  - setFetchFieldAutoIncrement
```
public void setFetchFieldAutoIncrement(boolean fetchFieldAutoIncrement)
```
    配置是否取出字段的自增属性
  - setTypeMapping
```
public void setTypeMapping(TypeMapping typeMapping)
```
    切换 TypeMapping jfinal 4.9.08 版本新增了 addTypeMapping(...) 可以替代该方法的使用
  - addTypeMapping
```
public void addTypeMapping(Class<?> from,
                           Class<?> to)
```
    为生成器添加类型映射，将数据库反射得到的类型映射到指定类型，从而在生成过程中用指定类型替换数据反射得到的类型添加的映射可以覆盖默认的映射，从而可以自由定制映射关系
```
 例如：
    generator.addTypeMaping(LocalDateTime.class, LocalDateTime.class)
    generator.addTypeMaping(LocalDate.class, LocalDate.class)

 例如：
    generator.addTypeMaping(java.sql.Date.class, LocalDateTime.class)
 
```
    以上配置在生成 base model 时碰到 Date 类型时会生成为 LocalDateTime 类型
  - removeTypeMapping
```
public void removeTypeMapping(Class<?> from)
```
  - addTypeMapping
```
public void addTypeMapping(String from,
                           String to)
```
    与 addTypeMaping(Class from, Class to) 功能一致，保是参数类型不同示例： generator.addTypeMaping("java.sql.Date", "java.time.LocalDateTime")
  - removeTypeMapping
```
public void removeTypeMapping(String from)
```
  - setMappingKitGenerator
```
public void setMappingKitGenerator(MappingKitGenerator mappingKitGenerator)
```
    设置 MappingKitGenerator，便于扩展自定义 MappingKitGenerator
  - setDataDictionaryGenerator
```
public void setDataDictionaryGenerator(DataDictionaryGenerator dataDictionaryGenerator)
```
    设置 DataDictionaryGenerator，便于扩展自定义 DataDictionaryGenerator
  - setDialect
```
public void setDialect(Dialect dialect)
```
    设置数据库方言，默认为 MysqlDialect
  - setBaseModelTemplate
```
public void setBaseModelTemplate(String baseModelTemplate)
```
    设置用于生成 BaseModel 的模板文件，模板引擎将在 class path 与 jar 包内寻找模板文件默认模板为："/com/litongjava/db/activerecord/generator/base_model_template.jf"
  - setGenerateChainSetter
```
public void setGenerateChainSetter(boolean generateChainSetter)
```
    设置 BaseModel 是否生成链式 setter 方法
  - setRemovedTableNamePrefixes
```
public void setRemovedTableNamePrefixes(String... removedTableNamePrefixes)
```
    设置需要被移除的表名前缀，仅用于生成 modelName 与 baseModelName 例如表名 "osc_account"，移除前缀 "osc_" 后变为 "account"
  - addWhitelist
```
public void addWhitelist(String... tableNames)
```
    添加要生成的 tableName 到白名单。使用白名单功能时，只有处在白名单中的 table 才会参与生成
  - removeWhitelist
```
public void removeWhitelist(String tableName)
```
  - addBlacklist
```
public void addBlacklist(String... tableNames)
```
    添加要排除的 tableName 到黑名单。使用黑名单功能时，只有处在黑名单中的 table 才会被过滤
  - removeBlacklist
```
public void removeBlacklist(String tableName)
```
  - addExcludedTable
```
public void addExcludedTable(String... excludedTables)
```
    添加不需要处理的数据表
  - setModelTemplate
```
public void setModelTemplate(String modelTemplate)
```
    设置用于生成 Model 的模板文件，模板引擎将在 class path 与 jar 包内寻找模板文件默认模板为："/com/litongjava/db/activerecord/generator/model_template.jf"
  - setGenerateDaoInModel
```
public void setGenerateDaoInModel(boolean generateDaoInModel)
```
    设置是否在 Model 中生成 dao 对象，默认生成
  - setGenerateDataDictionary
```
public void setGenerateDataDictionary(boolean generateDataDictionary)
```
    设置是否生成数据字典 Dictionary 文件，默认不生成
  - setMappingKitTemplate
```
public void setMappingKitTemplate(String mappingKitTemplate)
```
    设置用于生成 MappingKit 的模板文件，模板引擎将在 class path 与 jar 包内寻找模板文件默认模板为："/com/litongjava/db/activerecord/generator/mapping_kit_template.jf"
  - setMappingKitOutputDir
```
public void setMappingKitOutputDir(String mappingKitOutputDir)
```
    设置 MappingKit 文件输出目录，默认与 modelOutputDir 相同，在设置此变量的同时需要设置 mappingKitPackageName
  - setMappingKitPackageName
```
public void setMappingKitPackageName(String mappingKitPackageName)
```
    设置 MappingKit 文件包名，默认与 modelPackageName 相同，在设置此变的同时需要设置 mappingKitOutputDir
  - setMappingKitClassName
```
public void setMappingKitClassName(String mappingKitClassName)
```
    设置 MappingKit 类名，默认值为: "_MappingKit"
  - setDataDictionaryOutputDir
```
public void setDataDictionaryOutputDir(String dataDictionaryOutputDir)
```
    设置数据字典 DataDictionary 文件输出目录，默认与 modelOutputDir 相同
  - setDataDictionaryFileName
```
public void setDataDictionaryFileName(String dataDictionaryFileName)
```
    设置数据字典 DataDictionary 文件输出目录，默认值为 "_DataDictionary.txt"
  - generate
```
public void generate()
```

Class Generator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dialect

metaBuilder

baseModelGenerator

modelGenerator

mappingKitGenerator

dataDictionaryGenerator

generateDataDictionary

Constructor Detail

Generator

Generator

Generator

Generator

Method Detail

configMetaBuilder

configBaseModelGenerator

configModelGenerator

configMappingKitGenerator

configDataDictionaryGenerator

setMetaBuilder

getMetaBuilder

setGenerateRemarks

setGenerateView

setFetchFieldAutoIncrement

setTypeMapping

addTypeMapping

removeTypeMapping

addTypeMapping

removeTypeMapping

setMappingKitGenerator

setDataDictionaryGenerator

setDialect

setBaseModelTemplate

setGenerateChainSetter

setRemovedTableNamePrefixes

addWhitelist

removeWhitelist

addBlacklist

removeBlacklist

addExcludedTable

setModelTemplate

setGenerateDaoInModel

setGenerateDataDictionary

setMappingKitTemplate

setMappingKitOutputDir

setMappingKitPackageName

setMappingKitClassName

setDataDictionaryOutputDir

setDataDictionaryFileName

generate