如何基于数据库表实现自动生成分层样板代码(JPA版)

如何基于数据库表实现自动生成分层样板代码(JPA版)

问题

如何基于数据库表自动生成Entity、Dao、Service、Controller层样板代码，数据持久层框架采用 Spring Data JPA 。

方案

通过读取数据库表元数据（表名称及说明、字段名称、类型、说明等）自动生成 Entity 、Dao 、Service、Controller 层样板代码。

1.引入依赖

<!-- 自动生成代码工具所需依赖 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.22</version>
    <scope>runtime</scope>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.16</version>
    <optional>true</optional>
</dependency>
    
<!-- 为了避免生成的代码报错，引入 Spring 相关依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

---

2.获取数据库表元数据

通过SQL查询语句，获取指定数据库的数据表及数据字段信息，数据表支持模糊匹配，实现批量获取。

/** 获取表元数据语句 */
private static final String TABLE_SQL = "SELECT TABLE_NAME,TABLE_COMMENT FROM information_schema.TABLES " +
        "WHERE TABLE_SCHEMA='" + CodeGenTool.DATABASE + "' AND TABLE_TYPE='BASE TABLE' AND TABLE_NAME LIKE '%s';";

/** 获取字段元数据语句 */
private static final String COLUMN_SQL = "SELECT table_name AS tableName, column_name AS columnName, data_type AS dataType, " +
        "column_comment AS columnComment, column_key AS columnKey, extra AS extra FROM information_schema.columns " +
        "WHERE table_schema ='" + CodeGenTool.DATABASE + "' AND table_name = '%s' ORDER BY table_name ASC, ordinal_position ASC;";

3.将查询结果的数据库字段类型转换为Java数据类型

public static String sqlType2JavaType(String sqlType) {
        if (sqlType.equalsIgnoreCase("bit")) {
            return "Boolean";
        } else if (sqlType.equalsIgnoreCase("tinyint")) {
            return "Byte";
        } else if (sqlType.equalsIgnoreCase("smallint")) {
            return "Short";
        } else if (sqlType.equalsIgnoreCase("int") || sqlType.equalsIgnoreCase("INT UNSIGNED")) {
            //INT UNSIGNED无符号整型
            return "Integer";
        } else if (sqlType.equalsIgnoreCase("bigint")) {
            return "Long";
        } else if (sqlType.equalsIgnoreCase("float")) {
            return "Float";
        }
        //...
        else {
            System.out.println("can't support sql type:"+sqlType);
        }
}

4.编写生成Entity、Dao、Service、ServiceImpl、Controller模板文件类

详情见代码仓库 “code-gen” 。

使用方式

com.chen.solution.code.gen.CodeGenTool.main

 /** 指定 生成文件输出模块名 */
public static String modulePath = "code-gen";

/** 指定 模块 package */
public static String modulePackage = "com.chen.solution.code.gen.web";


/** 指定 数据库连接配置 */
public static final String DATABASE = "sample";
public static final String URL = "jdbc:mysql://127.0.0.1:3306/"+DATABASE;
public static final String USERNAME = "root";
public static final String PASSWORD = "root";
public static final String DRIVER = "com.mysql.cj.jdbc.Driver";

/** 指定 作者名字 */
public static String authorName = "ChenTian";

执行 main() 方法，文件会生成到 modulePath 指定的项目中，默认可以设置本项目。

注意事项

暂只支持 Mysql ，不支持复合主键，数据表必须有主键，主键如果不是自增及Integer类型，会默认使用 uuid 注解。

自动生成的代码会依赖通用实现的 BaseController,BaseService,BaseSerivceImpl,BaseDao 样板代码，这部分可以放到项目的 common-lib 模块中被不同微服务模块共同依赖，该部分代码可以减少通用方法实现，提升开发速度。

代码仓库

https://gitee.com/chentian114/solution-springboot

公众号