添加 getMetaBuilder() 方法

src/main/java/com/jfinal/plugin/activerecord/generator/Generator.java

@@ -31,7 +31,7 @@ import com.jfinal.plugin.activerecord.dialect.Dialect;
  * 6：生成模板文字属性全部为 protected 可见性，方便自定义 Generator 生成符合。。。。
  */
 public class Generator {
-	
+
 	protected Dialect dialect = null;
 	protected MetaBuilder metaBuilder;
 	protected BaseModelGenerator baseModelGenerator;
@@ -39,7 +39,7 @@ public class Generator {
 	protected MappingKitGenerator mappingKitGenerator;
 	protected DataDictionaryGenerator dataDictionaryGenerator;
 	protected boolean generateDataDictionary = false;
-	
+
 	/**
 	 * 构造 Generator，生成 BaseModel、Model、MappingKit 三类文件，其中 MappingKit 输出目录与包名与 Model相同
 	 * @param dataSource 数据源
@@ -51,7 +51,7 @@ public class Generator {
 	public Generator(DataSource dataSource, String baseModelPackageName, String baseModelOutputDir, String modelPackageName, String modelOutputDir) {
 		this(dataSource, new BaseModelGenerator(baseModelPackageName, baseModelOutputDir), new ModelGenerator(modelPackageName, baseModelPackageName, modelOutputDir));
 	}
-	
+
 	/**
 	 * 构造 Generator，只生成 baseModel
 	 * @param dataSource 数据源
@@ -61,7 +61,7 @@ public class Generator {
 	public Generator(DataSource dataSource, String baseModelPackageName, String baseModelOutputDir) {
 		this(dataSource, new BaseModelGenerator(baseModelPackageName, baseModelOutputDir));
 	}
-	
+
 	public Generator(DataSource dataSource, BaseModelGenerator baseModelGenerator) {
 		if (dataSource == null) {
 			throw new IllegalArgumentException("dataSource can not be null.");
@@ -69,16 +69,16 @@ public class Generator {
 		if (baseModelGenerator == null) {
 			throw new IllegalArgumentException("baseModelGenerator can not be null.");
 		}
-		
+
 		this.metaBuilder = new MetaBuilder(dataSource);
 		this.baseModelGenerator = baseModelGenerator;
 		this.modelGenerator = null;
 		this.mappingKitGenerator = null;
 		this.dataDictionaryGenerator = null;
 	}
-	
+
 	/**
-	 * 使用指定 BaseModelGenerator、ModelGenerator 构造 Generator 
+	 * 使用指定 BaseModelGenerator、ModelGenerator 构造 Generator
 	 * 生成 BaseModel、Model、MappingKit 三类文件，其中 MappingKit 输出目录与包名与 Model相同
 	 */
 	public Generator(DataSource dataSource, BaseModelGenerator baseModelGenerator, ModelGenerator modelGenerator) {
@@ -91,14 +91,14 @@ public class Generator {
 		if (modelGenerator == null) {
 			throw new IllegalArgumentException("modelGenerator can not be null.");
 		}
-		
+
 		this.metaBuilder = new MetaBuilder(dataSource);
 		this.baseModelGenerator = baseModelGenerator;
 		this.modelGenerator = modelGenerator;
 		this.mappingKitGenerator = new MappingKitGenerator(modelGenerator.modelPackageName, modelGenerator.modelOutputDir);
 		this.dataDictionaryGenerator = new DataDictionaryGenerator(dataSource, modelGenerator.modelOutputDir);
 	}
-	
+
 	/**
 	 * 设置 MetaBuilder，便于扩展自定义 MetaBuilder
 	 */
@@ -107,7 +107,20 @@ public class Generator {
 			this.metaBuilder = metaBuilder;
 		}
 	}
-	
+
+	/**
+	 * 获取 MetaBuilder 后方便使用其内部方法
+	 *
+	 * <pre>
+	 * 例如：
+	 *   // 调用 skip 方法定制 table 过滤：
+	 *   generator.getMetaBuilder().skip(tableName -> tableName.endsWith("_old"));
+	 * </pre>
+	 */
+	public MetaBuilder getMetaBuilder() {
+		return metaBuilder;
+	}
+
 	/**
 	 * 配置是否生成字段备注，生成的备注会体现在 Base Model 之中
 	 * 默认值为 false
@@ -117,7 +130,7 @@ public class Generator {
 			metaBuilder.setGenerateRemarks(generateRemarks);
 		}
 	}
-	
+
 	/**
 	 * 配置是否生成 view。默认值为 false
 	 */
@@ -126,7 +139,7 @@ public class Generator {
 			metaBuilder.setGenerateView(generateView);
 		}
 	}
-	
+
 	/**
 	 * 切换 TypeMapping
 	 * jfinal 4.9.08 版本新增了 addTypeMapping(...) 可以替代该方法的使用
@@ -134,18 +147,18 @@ public class Generator {
 	public void setTypeMapping(TypeMapping typeMapping) {
 		this.metaBuilder.setTypeMapping(typeMapping);
 	}
-	
+
 	/**
 	 * 为生成器添加类型映射，将数据库反射得到的类型映射到指定类型，
 	 * 从而在生成过程中用指定类型替换数据反射得到的类型
-	 * 
+	 *
 	 * 添加的映射可以覆盖默认的映射，从而可以自由定制映射关系
-	 * 
+	 *
 	 * <pre>
 	 * 例如：
 	 *    generator.addTypeMaping(LocalDateTime.class, LocalDateTime.class)
 	 *    generator.addTypeMaping(LocalDate.class, LocalDate.class)
-	 *    
+	 *
 	 * 例如：
 	 *    generator.addTypeMaping(java.sql.Date.class, LocalDateTime.class)
 	 * </pre>
@@ -154,25 +167,25 @@ public class Generator {
 	public void addTypeMapping(Class<?> from, Class<?> to) {
 		this.metaBuilder.typeMapping.addMapping(from, to);
 	}
-	
+
 	public void removeTypeMapping(Class<?> from) {
 		this.metaBuilder.typeMapping.removeMapping(from);
 	}
-	
+
 	/**
 	 * 与 addTypeMaping(Class<?> from, Class<?> to) 功能一致，保是参数类型不同
-	 * 
+	 *
 	 * 示例：
 	 *    generator.addTypeMaping("java.sql.Date", "java.time.LocalDateTime")
 	 */
 	public void addTypeMapping(String from, String to) {
 		this.metaBuilder.typeMapping.addMapping(from, to);
 	}
-	
+
 	public void removeTypeMapping(String from) {
 		this.metaBuilder.typeMapping.removeMapping(from);
 	}
-	
+
 	/**
 	 * 设置 MappingKitGenerator，便于扩展自定义 MappingKitGenerator
 	 */
@@ -181,7 +194,7 @@ public class Generator {
 			this.mappingKitGenerator = mappingKitGenerator;
 		}
 	}
-	
+
 	/**
 	 * 设置 DataDictionaryGenerator，便于扩展自定义 DataDictionaryGenerator
 	 */
@@ -190,30 +203,30 @@ public class Generator {
 			this.dataDictionaryGenerator = dataDictionaryGenerator;
 		}
 	}
-	
+
 	/**
 	 * 设置数据库方言，默认为 MysqlDialect
 	 */
 	public void setDialect(Dialect dialect) {
 		this.dialect = dialect;
 	}
-	
+
 	/**
 	 * 设置用于生成 BaseModel 的模板文件，模板引擎将在 class path 与 jar 包内寻找模板文件
-	 * 
+	 *
 	 * 默认模板为："/com/jfinal/plugin/activerecord/generator/base_model_template.jf"
 	 */
 	public void setBaseModelTemplate(String baseModelTemplate) {
 		baseModelGenerator.setTemplate(baseModelTemplate);
 	}
-	
+
 	/**
 	 * 设置 BaseModel 是否生成链式 setter 方法
 	 */
 	public void setGenerateChainSetter(boolean generateChainSetter) {
 		baseModelGenerator.setGenerateChainSetter(generateChainSetter);
 	}
-	
+
 	/**
 	 * 设置需要被移除的表名前缀，仅用于生成 modelName 与  baseModelName
 	 * 例如表名  "osc_account"，移除前缀 "osc_" 后变为 "account"
@@ -221,39 +234,39 @@ public class Generator {
 	public void setRemovedTableNamePrefixes(String... removedTableNamePrefixes) {
 		metaBuilder.setRemovedTableNamePrefixes(removedTableNamePrefixes);
 	}
-	
+
 	/**
 	 * 添加要生成的 tableName 到白名单。使用白名单功能时，只有处在白名单中的 table 才会参与生成
 	 */
 	public void addWhitelist(String... tableNames) {
 		metaBuilder.addWhitelist(tableNames);
 	}
-	
+
 	public void removeWhitelist(String tableName) {
 		metaBuilder.removeWhitelist(tableName);
 	}
-	
+
 	/**
 	 * 添加要排除的 tableName 到黑名单。使用黑名单功能时，只有处在黑名单中的 table 才会被过滤
 	 */
 	public void addBlacklist(String... tableNames) {
 		metaBuilder.addBlacklist(tableNames);
 	}
-	
+
 	public void removeBlacklist(String tableName) {
 		metaBuilder.removeBlacklist(tableName);
 	}
-	
+
 	/**
 	 * 添加不需要处理的数据表
 	 */
 	public void addExcludedTable(String... excludedTables) {
 		metaBuilder.addExcludedTable(excludedTables);
 	}
-	
+
 	/**
 	 * 设置用于生成 Model 的模板文件，模板引擎将在 class path 与 jar 包内寻找模板文件
-	 * 
+	 *
 	 * 默认模板为："/com/jfinal/plugin/activerecord/generator/model_template.jf"
 	 */
 	public void setModelTemplate(String modelTemplate) {
@@ -261,7 +274,7 @@ public class Generator {
 			modelGenerator.setTemplate(modelTemplate);
 		}
 	}
-	
+
 	/**
 	 * 设置是否在 Model 中生成 dao 对象，默认生成
 	 */
@@ -270,17 +283,17 @@ public class Generator {
 			modelGenerator.setGenerateDaoInModel(generateDaoInModel);
 		}
 	}
-	
+
 	/**
 	 * 设置是否生成数据字典 Dictionary 文件，默认不生成
 	 */
 	public void setGenerateDataDictionary(boolean generateDataDictionary) {
 		this.generateDataDictionary = generateDataDictionary;
 	}
-	
+
 	/**
 	 * 设置用于生成 MappingKit 的模板文件，模板引擎将在 class path 与 jar 包内寻找模板文件
-	 * 
+	 *
 	 * 默认模板为："/com/jfinal/plugin/activerecord/generator/mapping_kit_template.jf"
 	 */
 	public void setMappingKitTemplate(String mappingKitTemplate) {
@@ -288,7 +301,7 @@ public class Generator {
 			this.mappingKitGenerator.setTemplate(mappingKitTemplate);
 		}
 	}
-	
+
 	/**
 	 * 设置 MappingKit 文件输出目录，默认与 modelOutputDir 相同，
 	 * 在设置此变量的同时需要设置 mappingKitPackageName
@@ -298,7 +311,7 @@ public class Generator {
 			this.mappingKitGenerator.setMappingKitOutputDir(mappingKitOutputDir);
 		}
 	}
-	
+
 	/**
 	 * 设置 MappingKit 文件包名，默认与 modelPackageName 相同，
 	 * 在设置此变的同时需要设置 mappingKitOutputDir
@@ -308,7 +321,7 @@ public class Generator {
 			this.mappingKitGenerator.setMappingKitPackageName(mappingKitPackageName);
 		}
 	}
-	
+
 	/**
 	 * 设置 MappingKit 类名，默认值为: "_MappingKit"
 	 */
@@ -317,7 +330,7 @@ public class Generator {
 			this.mappingKitGenerator.setMappingKitClassName(mappingKitClassName);
 		}
 	}
-	
+
 	/**
 	 * 设置数据字典 DataDictionary 文件输出目录，默认与 modelOutputDir 相同
 	 */
@@ -326,7 +339,7 @@ public class Generator {
 			this.dataDictionaryGenerator.setDataDictionaryOutputDir(dataDictionaryOutputDir);
 		}
 	}
-	
+
 	/**
 	 * 设置数据字典 DataDictionary 文件输出目录，默认值为 "_DataDictionary.txt"
 	 */
@@ -335,33 +348,33 @@ public class Generator {
 			dataDictionaryGenerator.setDataDictionaryFileName(dataDictionaryFileName);
 		}
 	}
-	
+
 	public void generate() {
 		if (dialect != null) {
 			metaBuilder.setDialect(dialect);
 		}
-		
+
 		long start = System.currentTimeMillis();
 		List<TableMeta> tableMetas = metaBuilder.build();
 		if (tableMetas.size() == 0) {
 			System.out.println("TableMeta 数量为 0，不生成任何文件");
 			return ;
 		}
-		
+
 		baseModelGenerator.generate(tableMetas);
-		
+
 		if (modelGenerator != null) {
 			modelGenerator.generate(tableMetas);
 		}
-		
+
 		if (mappingKitGenerator != null) {
 			mappingKitGenerator.generate(tableMetas);
 		}
-		
+
 		if (dataDictionaryGenerator != null && generateDataDictionary) {
 			dataDictionaryGenerator.generate(tableMetas);
 		}
-		
+
 		long usedTime = (System.currentTimeMillis() - start) / 1000;
 		System.out.println("Generate complete in " + usedTime + " seconds.");
 	}