SpringBoot整合freemarker实现代码生成器

目录

• 一、介绍
• 二、代码实践
• 2.1、首先我们添加 freemarker 依赖包
• 2.2、然后创建一个代码模版
• 2.3、最后生成目标代码
• 三、小结

一、介绍

在实际的软件项目开发过程中，我可以很负责任的跟大家说，如果你真的实际写代码的时间超过5年，你对增删改查这类简单的功能需求开发，可以说已经完全写吐了，至少我就是这种类型的。

但是呢，不可否认，绝大多数的软件功能，向下追随到最基本的单元，也基本都是单表的增、删、改、查！

只是随着用户需求不断增多，原来可能一个张单表就可以搞定的事情，现在可能需要多张表，或者多个库才能搞定，代码层就像堆积木一样，越堆越复杂。

我记得早期做项目的时候，项目每新加一张单表，我都需要在代码层，按照MVC框架的思想，重新编写一套CURD的代码，写完所有的基础的增删改查，至少需要20分钟，手快的情况下，最快也要10分钟。

假如某个新开发的功能，要新增10张表，按照这个时间计算，至少要100分钟，仔细想想，其实你会发现大部分的时间都浪费在这些简单而又重复的编程圈子中去了。

那有没有一个办法，将这些简单的CURD代码，全部都标准化、公共化呢？这样我们的可以省下很多时间来投入业务场景的开发。

答案是肯定的，有！

我记得早期我最先接触的是MybatisGenertor工具包，通过这个工具包，我们可以省去大部分的mybaits中xml文件的curd编写工作。

还有我们所熟悉的JPA，里面有一套公共的持久层动态代理类，它可以自动根据名称生成SQL语句，能为开发省下不少的事情。

但是我这个人比较懒，我想搞一个工具，从controller、service、entity 、dao层，全部的crud代码，包括单元测试类，通过工具自动生成好。

像这样的工具，现在网上也有不少，例如我们所熟悉的Mybatis-plus插件，它就可以做到这一点，也是非常好用。

但是有的公司就不喜欢它，原因也很简单，里面的很多公共方法封装的过于深入，而且很多crud的sql全部都是动态生成，你根本看不到。

总之啊就是一句，不在自己掌控之内的，很多程序员总是带着各种疑虑～～

当然，还有一个明显的疑虑，就是对微服务的开发，不能全面支持，比如你项目采用的是SpringBoot +Dubbo组合来开发，这个时候生成的controller，完全没啥用处，而且还很鸡肋。

因此在这种情况下，你得基于当前的项目软件开发规则，自己开发一套代码生成器，以满足快速开发的需要。

下面我就简单的介绍一下，如何自行开发一套代码生成器，过程如下！

二、代码实践

其实开发一套代码生成器，真没大家想象中的那么复杂，其中用的最重要一项技术，就是利用模板来生成代码，例如我们经常使用的模板引擎freemarker，它就可以帮助我们实现这一点。

2.1、首先我们添加 freemarker 依赖包

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

2.2、然后创建一个代码模版

下面我们以动态创建实体类为例，编写一个实体类的模板entity.java.ftl，其中${}里面定义的是动态变量。

package ${package};

import java.io.Serializable;

/**
 * <p>
 * ${tableComment}
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
public class ${entityClass} implements Serializable {

    private static final long serialVersionUID = 1L;
    
    <#--属性遍历-->
    <#list columns as pro>

    /**
     * ${pro.comment}
     */
    private ${pro.propertyType} ${pro.propertyName};
    </#list>

    <#--属性get||set方法-->
    <#list columns as pro>
    public ${pro.propertyType} get${pro.propertyName?cap_first}() {
        return this.${pro.propertyName};
    }

    public ${entityClass} set${pro.propertyName?cap_first}(${pro.propertyType} ${pro.propertyName}) {
        this.${pro.propertyName} = ${pro.propertyName};
        return this;
    }
    </#list>
}

2.3、最后生成目标代码

最后我们基于freemarker编写一个测试类！

public class CodeGeneratorDemo {

    public static void main(String[] args) throws IOException, TemplateException {
        Map<String, Object> objectMap = new HashMap<>();
        //定义包路径
        objectMap.put("package", "com.example.test");
        //定义实体类
        objectMap.put("entityClass", "Student");

        //定义实体类属性
        List<Map<String, Object>> columns = new ArrayList<>();
        //姓名字段
        Map<String, Object> column1 = new HashMap<>();
        column1.put("propertyType", "String");
        column1.put("propertyName", "name");
        column1.put("comment", "姓名");
        columns.add(column1);
        //年龄字段
        Map<String, Object> column2 = new HashMap<>();
        column2.put("propertyType", "Integer");
        column2.put("propertyName", "age");
        column2.put("comment", "年龄");
        columns.add(column2);

        //定义类的属性
        objectMap.put("columns", columns);
        //定义作者
        objectMap.put("author", "张三");
        //定义创建时间
        objectMap.put("date", new SimpleDateFormat("yyyy-MM-dd").format(new Date()));
        //定义类描述
        objectMap.put("tableComment", "学生信息");

        //生产目标代码
        Configuration configuration = new Configuration(Configuration.VERSION_2_3_23);
        configuration.setDefaultEncoding(Charset.forName("UTF-8").name());
        configuration.setClassForTemplateLoading(CodeGeneratorDemo.class, "/");
        Template template = configuration.getTemplate("/templates/entity.java.ftl");
        FileOutputStream fileOutputStream = new FileOutputStream(new File("../src/main/java/com/example/generator/Student.java"));
        template.process(objectMap, new OutputStreamWriter(fileOutputStream, Charset.forName("UTF-8").name()));
        fileOutputStream.close();
        System.out.println("文件创建成功");

    }
}

运行程序，输出的文件结果如下！

package com.example.test;

import java.io.Serializable;

/**
 * <p>
 * 学生信息
 * </p>
 *
 * @author 张三
 * @since 2021-08-22
 */
public class Student implements Serializable {

    private static final long serialVersionUID = 1L;
    

    /**
     * 姓名
     */
    private String name;

    /**
     * 年龄
     */
    private Integer age;

    public String getName() {
        return this.name;
    }

    public Student setName(String name) {
        this.name = name;
        return this;
    }
    public Integer getAge() {
        return this.age;
    }

    public Student setAge(Integer age) {
        this.age = age;
        return this;
    }
}

与预期的效果一致，成功生成！

以上就是生成代码最核心的部分，首先编写一套模板，把需要填充的信息全部定义成动态变量，然后在代码中，通过map数据格式，使用freemarker进行填充！

例如小编我就是采用这种方式，首先把要通过工具生成的代码，全部通过模板方式定义好。

然后通过连接数据库的方式，把需要自动生成的表结构查询出来，封装成数据渲染参数，最后传入到freemarker中去，非常简单、快速的生成与自己预期想要的代码，所有单表的crud全部一步到位！

下面这个就是小编，基于当前项目定制开发的一款代码生成器，项目采用SpringBoot + Dubbo框架开发，没有Controller层，截图中所有的代码全部都是采用代码生成器生成的，直接通过单元测试就可以运行，开发的时候非常快！

由于开发的代码生成器工具，代码有点过多，因此不便于通过文章分享给大家，有需要的朋友，可以访问如下链接获取：https://github.com/justdojava/springboot-example-generator

三、小结

代码生成器，对于擅长以业务开发为主的程序员来说，绝对是一个巨大的福利，它能很明显的减轻开发人员的工作量，并且提升开发效率，能腾出更多的时间专注业务开发。

实际上，目前网上已经有很多的成熟、稳定的代码生成器，mybatis-plus就是其中一个使用非常广泛的代码生成器，对于以单体web开发为主的项目，它完全满足要求。

当然，如果当下你没有合适的代码生成器，不妨自己试试开发一款属于自己的代码生成器，同样也可以加倍提升开发效率。

以上就是SpringBoot整合freemarker实现代码生成器的详细内容，更多关于SpringBoot freemarker代码生成器的资料请关注我们其它相关文章！