1. 前言

前几天写了篇对于Mybatis Plus代码生成器的文章，不少同学私下问我这个代码生成器是如何运作的，为什么要用到一些模板引擎，所以明天来阐明下代码生成器的流程。

2. 代码生成器的应用场景

咱们在编码中存在很多样板代码，格局较为固定，构造随着我的项目的迭代也比较稳定，而且数量微小，这种代码写多了也没有什么技术含量，在这种状况下代码生成器能够无效进步咱们的效率，其它状况并不适于应用代码生成器。

3. 代码生成器的制作流程

首先咱们要制作模板，把样板代码的固定格局抽出来。而后把动静属性绑定到模板中，就像做填空题一样。所以在这个流程中模板引擎是最合适的。咱们通过应用模板引擎的语法将数据动静地解析到动态模板中去，而后导出为编程中对应的文件就行了。

另外模板引擎有着丰盛的绑定数据的指令集，能够让咱们依据条件动静的绑定数据到模板中去。以Freemarker为例：

三元表达式：

${true ? 'checked': ''}

还有咱们等下要用的遍历列表：

<#list  fields as field>    private ${field.fieldType}  ${field.fieldName};</#list>

在Java开发中咱们罕用的模板引擎有Freemarker、Velocity、Thymeleaf ，随着Web开发中前后端拆散的风行模板引擎的应用场景正在被压缩，然而它仍然是一门有用的技术。

4. 代码生成器演示

接下来，咱们以Freemarker为例写一个简略的代码生成器，来生成POJO类。须要引入Freemarker的依赖。

<dependency>    <groupId>org.freemarker</groupId>    <artifactId>freemarker</artifactId>    <version>2.3.28</version></dependency>

4.1 模板制作

POJO的构造能够分为以下几局部：

java.lang 包无需导入。

所以将这些规定封装到配置类中：

public class JavaProperties {    // 包名    private final String pkg;    // 类名    private final String entityName;    // 属性汇合  须要改写 equals hash 保障名字可不反复 类型可反复    private final Set<Field> fields = new LinkedHashSet<>();    // 导入类的不反复汇合    private final Set<String> imports = new LinkedHashSet<>();    public JavaProperties(String entityName, String pkg) {        this.entityName = entityName;        this.pkg = pkg;    }    public void addField(Class<?> type, String fieldName) {        // 解决 java.lang        final String pattern = "java.lang";        String fieldType = type.getName();        if (!fieldType.startsWith(pattern)) {           // 解决导包            imports.add(fieldType);        }        Field field = new Field();        // 解决成员属性的格局        int i = fieldType.lastIndexOf(".");        field.setFieldType(fieldType.substring(i + 1));        field.setFieldName(fieldName);        fields.add(field);    }    public String getPkg() {        return pkg;    }    public String getEntityName() {        return entityName;    }    public Set<Field> getFields() {        return fields;    }    public Set<String> getImports() {        return imports;    }        /**     * 成员属性封装对象.     */    public static class Field {        // 成员属性类型        private String fieldType;        // 成员属性名称        private String fieldName;        public String getFieldType() {            return fieldType;        }        public void setFieldType(String fieldType) {            this.fieldType = fieldType;        }        public String getFieldName() {            return fieldName;        }        public void setFieldName(String fieldName) {            this.fieldName = fieldName;        }                /**          * 一个类的成员属性 一个名称只能呈现一次          * 咱们能够通过覆写equals hash 办法 而后放入Set         *          * @param o 另一个成员属性         * @return 比拟后果         */        @Override        public boolean equals(Object o) {            if (this == o) return true;            if (o == null || getClass() != o.getClass()) return false;            Field field = (Field) o;            return Objects.equals(fieldName, field.fieldName);        }        @Override        public int hashCode() {            return Objects.hash(fieldType, fieldName);        }    }}

接着就是动态模板entity.ftl

package ${pkg};<#list  imports as impt>import ${impt};</#list>/** * the ${entityName} type * @author felord.cn */public class ${entityName} {<#list  fields as field>    private ${field.fieldType}  ${field.fieldName};</#list>}

这里用到了Freemarker绑定数据的语法，比方List迭代渲染。

4.2 生成器编写

Freemarker通过申明配置并获取模板对象freemarker.template，该对象的process办法能够将动态数据绑定到模板中并导出为文件，最终实现了代码生成器，外围代码如下：

/** * 简略的代码生成器. * * @param rootPath       maven 的  java 目录 * @param templatePath   模板寄存的文件夹 * @param templateName   模板的名称 * @param javaProperties 须要渲染对象的封装 * @throws IOException       the io exception * @throws TemplateException the template exception */public static void autoCodingJavaEntity(String rootPath,                                         String templatePath,                                         String templateName,                                         JavaProperties javaProperties) throws IOException, TemplateException {    // freemarker 配置    Configuration configuration = new Configuration(Configuration.DEFAULT_INCOMPATIBLE_IMPROVEMENTS);    configuration.setDefaultEncoding("UTF-8");    // 指定模板的门路    configuration.setDirectoryForTemplateLoading(new File(templatePath));    // 依据模板名称获取门路下的模板    Template template = configuration.getTemplate(templateName);    // 解决门路问题    final String ext = ".java";    String javaName = javaProperties.getEntityName().concat(ext);    String packageName = javaProperties.getPkg();     String out = rootPath.concat(Stream.of(packageName.split("\\."))            .collect(Collectors.joining("/", "/", "/" + javaName)));         // 定义一个输入流来导出代码文件    OutputStreamWriter outputStreamWriter = new OutputStreamWriter(new FileOutputStream(out));     // freemarker 引擎将动态数据绑定的模板并导出为文件    template.process(javaProperties, outputStreamWriter);}

通过执行以下代码即可生成一个UserEntity的POJO：

// 门路依据本人我的项目的特点调整String rootPath = "C:\\Users\\felord\\IdeaProjects\\codegenerator\\src\\main\\java";String packageName = "cn.felord.code";String templatePath = "C:\\Users\\felord\\IdeaProjects\\codegenerator\\src\\main\\resources\\templates";String templateName = "entity.ftl";JavaProperties userEntity = new JavaProperties("UserEntity", packageName);userEntity.addField(String.class, "username");userEntity.addField(LocalDate.class, "birthday");userEntity.addField(LocalDateTime.class, "addTime");userEntity.addField(Integer.class, "gender");userEntity.addField(Integer.class, "age");autoCodingJavaEntity(rootPath, templatePath, templateName, userEntity);

生成的成果是不是跟手写的差不多：

5. 总结

这就是大部分代码生成器的机制，心愿能够解答一些网友的疑难。多多关注：码农小胖哥 获取更多干货，相干的DEMO可通过公众号回复codegen获取。如果你有疑难能够通过微信MSW_623进行沟通。

关注公众号：Felordcn 获取更多资讯

集体博客：https://felord.cn