tk.mybatis.mapper.generator.TemplateFilePlugin Maven / Gradle / Ivy
/*
* The MIT License (MIT)
*
* Copyright (c) 2014-2017 [email protected]
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package tk.mybatis.mapper.generator;
import org.mybatis.generator.api.GeneratedJavaFile;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.api.dom.java.JavaVisibility;
import org.mybatis.generator.internal.ObjectFactory;
import org.mybatis.generator.internal.util.StringUtility;
import tk.mybatis.mapper.generator.file.GenerateByListTemplateFile;
import tk.mybatis.mapper.generator.file.GenerateByTemplateFile;
import tk.mybatis.mapper.generator.formatter.ListTemplateFormatter;
import tk.mybatis.mapper.generator.formatter.TemplateFormatter;
import tk.mybatis.mapper.generator.model.TableClass;
import tk.mybatis.mapper.generator.model.TableColumnBuilder;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.URL;
import java.util.*;
/**
* 每一个模板都需要配置一个插件，可以配置多个
*
*
* <plugin type="xxx.TemplateFilePlugin">
* <property name="targetProject" value="src/main/java"/>
* <property name="targetPackage" value="com.xxx.controller"/>
* <property name="templatePath" value="template/controller.ftl"/>
* <property name="fileName" value="XXXController.java"/>
* <property name="templateFormatter" value="xxx.FreemarkerTemplateFormatter"/>
* </plugin>
*
*
* @author liuzh
* @since 3.4.5
*/
public class TemplateFilePlugin extends PluginAdapter {
/**
* 默认的模板格式化类
*/
public static final String DEFAULT_TEMPLATEFORMATTER = "tk.mybatis.mapper.generator.formatter.FreemarkerTemplateFormatter";
/**
* 单个文件模式
*/
private String singleMode;
/**
* 项目路径（目录需要已经存在）
*/
private String targetProject;
/**
* 生成的包（路径不存在则创建）
*/
private String targetPackage;
/**
* 模板路径
*/
private String templatePath;
/**
* 模板内容
*/
private String templateContent;
/**
* 文件名模板，通过模板方式生成文件名，包含后缀
*/
private String fileName;
/**
* 模板生成器
*/
private Object templateFormatter;
private String templateFormatterClass;
private Set cacheTables;
/**
* 列转换为字段
*
* @param introspectedColumn
* @return
*/
public static Field convertToJavaBeansField(IntrospectedColumn introspectedColumn) {
FullyQualifiedJavaType fqjt = introspectedColumn.getFullyQualifiedJavaType();
String property = introspectedColumn.getJavaProperty();
Field field = new Field();
field.setVisibility(JavaVisibility.PRIVATE);
field.setType(fqjt);
field.setName(property);
return field;
}
/**
* 读取文件
*
* @param inputStream
* @return
* @throws IOException
*/
protected String read(InputStream inputStream) throws IOException {
BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream));
StringBuffer stringBuffer = new StringBuffer();
String line = reader.readLine();
while (line != null) {
stringBuffer.append(line).append("\n");
line = reader.readLine();
}
return stringBuffer.toString();
}
@Override
public boolean validate(List warnings) {
boolean right = true;
if (!StringUtility.stringHasValue(fileName)) {
warnings.add("没有配置 \"fileName\" 文件名模板，因此不会生成任何额外代码!");
right = false;
}
if (!StringUtility.stringHasValue(templatePath)) {
warnings.add("没有配置 \"templatePath\" 模板路径，因此不会生成任何额外代码!");
right = false;
} else {
try {
URL resourceUrl = null;
try {
resourceUrl = ObjectFactory.getResource(templatePath);
} catch (Exception e) {
warnings.add("本地加载\"templatePath\" 模板路径失败，尝试 URL 方式获取!");
}
if (resourceUrl == null) {
resourceUrl = new URL(templatePath);
}
InputStream inputStream = resourceUrl.openConnection().getInputStream();
templateContent = read(inputStream);
inputStream.close();
} catch (IOException e) {
e.printStackTrace();
warnings.add("读取模板文件出错: " + e.getMessage());
right = false;
}
}
if (!StringUtility.stringHasValue(templateFormatterClass)) {
templateFormatterClass = DEFAULT_TEMPLATEFORMATTER;
warnings.add("没有配置 \"templateFormatterClass\" 模板处理器，使用默认的处理器!");
}
try {
templateFormatter = Class.forName(templateFormatterClass).newInstance();
} catch (Exception e) {
warnings.add("初始化 templateFormatter 出错:" + e.getMessage());
right = false;
}
if (!right) {
return false;
}
int errorCount = 0;
if (!StringUtility.stringHasValue(targetProject)) {
errorCount++;
warnings.add("没有配置 \"targetProject\" 路径!");
}
if (!StringUtility.stringHasValue(targetPackage)) {
errorCount++;
warnings.add("没有配置 \"targetPackage\" 路径!");
}
if (errorCount >= 2) {
warnings.add("由于没有配置任何有效路径，不会生成任何额外代码!");
return false;
}
return true;
}
@Override
public List contextGenerateAdditionalJavaFiles(IntrospectedTable introspectedTable) {
List list = new ArrayList();
TableClass tableClass = TableColumnBuilder.build(introspectedTable);
if ("TRUE".equalsIgnoreCase(singleMode)) {
list.add(new GenerateByTemplateFile(tableClass, (TemplateFormatter) templateFormatter, properties, targetProject, targetPackage, fileName, templateContent));
} else {
cacheTables.add(tableClass);
}
return list;
}
@Override
public List contextGenerateAdditionalJavaFiles() {
List list = new ArrayList();
if (cacheTables != null && cacheTables.size() > 0) {
list.add(new GenerateByListTemplateFile(cacheTables, (ListTemplateFormatter) templateFormatter, properties, targetProject, targetPackage, fileName, templateContent));
}
return list;
}
@Override
public void setProperties(Properties properties) {
super.setProperties(properties);
this.singleMode = properties.getProperty("singleMode", "true");
if (!"TRUE".equalsIgnoreCase(singleMode)) {
this.cacheTables = new LinkedHashSet();
}
this.targetProject = properties.getProperty("targetProject");
this.targetPackage = properties.getProperty("targetPackage");
this.templatePath = properties.getProperty("templatePath");
this.fileName = properties.getProperty("fileName");
this.templateFormatterClass = properties.getProperty("templateFormatter");
}
}