从零搭建SpringBoot3一，手动编写一套属于自己风格的代码生成器一键生成系统

原创

工具人

发布于 2023-05-09 15:44:08

4750

发布于 2023-05-09 15:44:08

文章被收录于专栏：中后台可视化开发设计与实现中后台可视化开发设计与实现

简介

虽然 java 的代码生成工具有很多，可是很多时候不是自己喜欢的风格，改起来比较困难，所以我准备从零和大家一起搭建一套基于 springboot3.0 的框架，

这次就先搞定一套代码生成功能，后续再不断的完善其它

我们使用到的三方库：

beelt 模版引擎，用于生成代码。官网：http://ibeetl.com
mybatis-plug 官网：https://www.baomidou.com/

开始

第一步，创建一个 maven 项目，然后在 pom.xml 中引入相关依赖，用到数据库驱动，阿里的数据库连接池等

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>springboot-generate</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>20</maven.compiler.source>
        <maven.compiler.target>20</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.0.6</version>
    </parent>

    <!-- Add typical dependencies for a web application -->
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.alibaba/druid -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.17</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.baomidou/mybatis-plus-boot-starter -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.3.1</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.baomidou/mybatis-plus -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus</artifactId>
            <version>3.5.3.1</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.33</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.ibeetl/beetl -->
        <dependency>
            <groupId>com.ibeetl</groupId>
            <artifactId>beetl-springboot-starter-jdk17</artifactId>
            <version>3.15.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.12</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
    <!-- Package as an executable jar -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

第二步，在 java 文件夹下创建个包 com.light，并在下创建启动入口 Application.java，注意不要直接在 java 下创建，代码

@MapperScan("com.light.business.*.mapper") 
@EnableBeetl //会拦截.btl文件使用Beetl语法解析
@RestController
@SpringBootApplication
public class Application {
    @RequestMapping("/")
    String home() {
        return "Hello World!";
    }

    public static void main(String[] args) throws Exception {
        SpringApplication.run(Application.class, args);
    }
}

第三步，去实现代码生成，思路是通过一个页面（这样可视化，看起来更直观）来展示可以生成的表，选择后调用一个接口生成到项目中所以，我们先来个html用于展示表名以及操作

我们在 resouces 下创建 templates/generate/index.btl 文件，templates是缺省目录，我们就直接用，而index.btl不用.html因为我们用模板引擎。

可以看到，很简单展示一下表名称，然后可以选择提交

<head>
    <meta charset="UTF-8">
    <title>代码自动生成器</title>
</head>
<style>
    body {
        display: flex;
        flex-direction: column;
        align-items: center;
        padding: 25px;
    }
</style>
<body>
    <h1> 欢迎使用 Light 代码一键生成器 </h1>
    <div style="min-width: 450px">
        <div>
            <input type="button" style="margin-right:45px" onclick="selectReverse()" value="反选">
            <input type="button" value="提交并生成代码" onclick="document.tableForm.submit()">
        </div>
        <div style="margin-top: 12px;margin-bottom: 2px">
            <b>请选择要生成的数据表：</b>
        </div>
        <form name="tableForm" method="post" action="index">
            <% 
                for(tableName in tableNames) { 
                    println("<input type='checkbox' name='table' value='" + tableName + "'>" + tableName + "<br>");
                }
            %>
        </form>
    </div>
    <script>
        function selectReverse() {
            let tables = document.getElementsByName("table");
            for (let table of tables) {
                table.checked = !table.checked;
            }
        }
    </script>
</body>

第四步，因为上一步中需要展示表名，所以应该要一个查询表名称的方法，我们在 com.light 下创建 common.generate.service.GenerateService.java，然后添加查询表名的方法

@Autowired
private JdbcTemplate jdbcTemplate;

public List<String> getTableNames(String tableSchema) {
    String sql = "SELECT table_name as tableName FROM INFORMATION_SCHEMA.TABLES\n" +
            "WHERE table_schema = '" + tableSchema + "'";
    return jdbcTemplate.query(sql, new RowMapper<String>() {
        @Override
        public String mapRow(ResultSet resultSet, int i) throws SQLException {
            return resultSet.getString(1);
        }
    });
}

第五步，我们在 com.light 下创建common.generate.controller.GenerateController，来用于访问，如果有选择了表，就会调用生成功能

@Value("${spring.datasource.url}")
private String databaseUrl;
@Autowired
private GenerateService generateService;
//引入包的前缀
private static String comPath = "com.light.business";
//文件生成的路径
private static String[] filePath = new String[]{ System.getProperty("user.dir"), "src", "main", "java", "com", "light", "business" };

@RequestMapping(value = "/index")
public ModelAndView index(String[] table) throws IOException {
    String schema = databaseUrl.substring(databaseUrl.lastIndexOf("/") + 1, databaseUrl.indexOf("?"));

    if (table != null) {
        generateService.generation(Util.addFileSeparator(filePath), comPath, schema, Arrays.asList(table));
    }

    ModelAndView view = new ModelAndView();
    view.setViewName("/generate/index.btl");
    view.addObject("tableNames", generateService.getTableNames(schema));
    return view;
}

第六步，可以看到核心就是 service 的 generation 方法，所以在 GenerateService.java 中添加方法

public void generation(String filePath, String comPath, String schema, List<String> tableNames) throws IOException {
    //我们在 resouces下创建个 beetl-back-end 用于放模板
    ClasspathResourceLoader resourceLoader = new ClasspathResourceLoader("beetl-back-end");
    Configuration cfg = Configuration.defaultConfiguration();
    //加载模板组
    GroupTemplate gt = new GroupTemplate(resourceLoader, cfg);
    //获取表以及其字段等信息
    List<TableInfo> tableInfoList = getTableInfoList(schema, tableNames);

    System.out.println("generate start");
    for (TableInfo tableInfo: tableInfoList) {
        //生成PO...
        doPo(gt, tableInfo, comPath, filePath);
        doVo(gt, tableInfo, comPath, filePath);

        doMapperJava(gt, tableInfo, comPath, filePath);
        doMapperXml(gt, tableInfo, comPath, filePath);

        doService(gt, tableInfo, comPath, filePath);
        doController(gt, tableInfo, comPath, filePath);
    }
    System.out.println("generate over");
}

其它代码就不贴出来了，开源的，可以自己到 github 上。

当前可以生成 controller, service, mapjava, mapxml, PO, VO

思考

预留了根据注释生成对应字段的枚举功能，因为还在思考如何才合理。那么是否还可以根据数据字段信息来生成校验功能呢？或者你认为还有什么是需要生成的呢？然后我们再来继续扩展

使用

下载项目后，配置 application.yml 中的数据库连接

启动项目后在浏览器中输入 http://localhost:8888/generate/index 即可访问代码生成入口，我们全选后点击提交

然后就完成了，可以看到项目的 com.light 下创建了个 business 目录，里面就是生成的代码了，所有的功能就已经完成了

如果添加表或修改了表，点击需要的表重新生成即可，PO、VO等会覆盖生成，具体在 com.light.common.generate.Config.java 中配置了

测试

由于我们从零开始创建的，所以还没有 swagger 等等，postman 一个一个测试太慢了，所以我们这里借助前端自动生成功能来测试

由于前端是在线生成，所以访问本地存在跨域问题，那们在本地我们先允许任何域访问，在com.light.common下创建 config.CustomCorsConfiguration.java，简单配置：

@Configuration
public class CustomCorsConfiguration implements WebMvcConfigurer {
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                // 放行哪些原始域
                .allowedOrigins("*")
                // 放行哪些请求方式
                .allowedMethods("*")
                // 放行哪些原始请求头部信息
                .allowedHeaders("*");
    }
}

重启项目

打开前端代码生成器网站：https://light2f.com 到我的项目下，点击 AI创建项目，输入数据库信息或者导入数据库结构