0
点赞
收藏
分享

微信扫一扫

Spring Data JPA--根据表生成代码--方法

芥子书屋 2022-02-25 阅读 103
jpa#ifjavaxml


​

简介

​说明​

        我们可以根据已有的表来生成代码（Entity、DAO、Service、Controller），省去手写的时间。MybatisPlus的自动生成代码的工程见：

        本文参考Mybatis-Plus的这种方案，来生成我们JPA相关类。本方案优点如下：


  2. 不依赖于工具。只要有文本编辑器，有JDK，就可以运行。
  3. 可以自定义任意想要的格式。
  4. 每个字段都会把表中的注释给带过来。

​其他人的方案​

 我搜了很多JPA通过表生成代码的文章，但感觉都不好，不如本文这种方式。其他的方案不外乎这三种：


  2. 使用Idea工具（依赖于工具）
  3. 使用Eclipse（依赖于工具）
  4. 使用Maven插件。（不依赖于工具）
  1. 插件：hibernate-tools-maven-plugin

实例

项目结构

Spring Data JPA--根据表生成代码--方法_java

创建表

Spring Data JPA--根据表生成代码--方法_xml_02

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>GenerateCode</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.0</version>
        </dependency>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.30</version>
        </dependency>

        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.30</version>
        </dependency>

        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-simple</artifactId>
            <version>1.7.30</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.21</version>
        </dependency>
    </dependencies>

</project>

自定义格式

Controller

MyController.java.ftl

import org.springframework.web.bind.annotation.RequestMapping;
<#if restControllerStyle>
import org.springframework.web.bind.annotation.RestController;
<#else>
import org.springframework.stereotype.Controller;
</#if>
<#if superControllerClassPackage??>
import ${superControllerClassPackage};
</#if>

<#if restControllerStyle>
@RestController
<#else>
@Controller
</#if>
@RequestMapping("<#if package.ModuleName?? && package.ModuleName != "">/${package.ModuleName}</#if>/<#if controllerMappingHyphenStyle??>${controllerMappingHyphen}<#else>${table.entityPath}</#if>")
<#if kotlin>
class ${table.controllerName}<#if superControllerClass??> : ${superControllerClass}()</#if>
<#else>
    <#if superControllerClass??>
public class ${table.controllerName} extends ${superControllerClass} {
    <#else>
public class ${table.controllerName} {
    </#if>

}
</#if>

Service

MyService.java.ftl

<#if kotlin>
interface ${table.serviceName} : ${superServiceClass}<${entity}>
<#else>
public interface ${table.serviceName} {

}
</#if>

Repository

MyRepository.java.ftl

import ${cfg.jpaSuperRepositoryClassPackage};

@Repository
<#if kotlin>
interface ${table.mapperName} : ${superMapperClass}<${entity}>
<#else>
public interface ${table.mapperName} extends ${superMapperClass}<${entity}, Long>, JpaSpecificationExecutor<${entity}> {
    // 接口的第二个泛型是主键的类型。要按实际修改
}
</#if>

Entity

MyEntity.java.ftl

<#if swagger2>
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
</#if>
<#if entityLombokModel>
import lombok.Data;
import lombok.NoArgsConstructor;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
    <#if chainModel>
import lombok.experimental.Accessors;
    </#if>
</#if>

<#if entityLombokModel>
@Data
@NoArgsConstructor
    <#if chainModel>
@Accessors(chain = true)
    </#if>
</#if>
<#if table.convert>
@Entity(name = "${table.name}")
</#if>
<#if swagger2>
@ApiModel(value="${entity}对象", description="${table.comment!}")
</#if>
<#if superEntityClass??>
public class ${entity} extends ${superEntityClass}<#if activeRecord><${entity}></#if> {
<#elseif activeRecord>
public class ${entity} extends Model<${entity}> {
<#else>
public class ${entity} {
</#if>
<#-- ----------  BEGIN 字段循环遍历  ---------->
<#list table.fields as field>
    <#if field.keyFlag>
        <#assign keyPropertyName="${field.propertyName}"/>
    </#if>
    <#if field.comment!?length gt 0>
        <#if swagger2>
    @ApiModelProperty(value = "${field.comment}")
        <#else>
    // ${field.comment}
        </#if>
    </#if>
    <#if field.keyFlag>
    <#-- 主键 -->
        <#if field.keyIdentityFlag>
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
        <#elseif idType??>
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
        <#elseif field.convert>
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
        </#if>
    <#-- 普通字段 -->
    <#elseif field.fill??>
    <#-- -----   存在字段填充设置   ----->
        <#if field.convert>
    @TableField(value = "${field.annotationColumnName}", fill = FieldFill.${field.fill})
        <#else>
    @TableField(fill = FieldFill.${field.fill})
        </#if>
    <#elseif field.convert>
    @TableField("${field.annotationColumnName}")
    </#if>
<#-- 乐观锁注解 -->
    <#if (versionFieldName!"") == field.name>
    @Version
    </#if>
<#-- 逻辑删除注解 -->
    <#if (logicDeleteFieldName!"") == field.name>
    @TableLogic
    </#if>
    private ${field.propertyType} ${field.propertyName};

</#list>
<#------------  END 字段循环遍历  ---------->
<#if !entityLombokModel>
    <#list table.fields as field>
        <#if field.propertyType == "boolean">
            <#assign getprefix="is"/>
        <#else>
            <#assign getprefix="get"/>
        </#if>
    public ${field.propertyType} ${getprefix}${field.capitalName}() {
        return ${field.propertyName};
    }
        <#if chainModel>
    public ${entity} set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
        <#else>
    public void set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
        </#if>
        this.${field.propertyName} = ${field.propertyName};
        <#if chainModel>
            return this;
        </#if>
    }
    </#list>
</#if>
<#if entityColumnConstant>
    <#list table.fields as field>
     public static final String ${field.name?upper_case} = "${field.name}";

    </#list>
</#if>
<#if activeRecord>
    @Override
    protected Serializable pkVal() {
    <#if keyPropertyName??>
        return this.${keyPropertyName};
    <#else>
        return null;
    </#if>
    }
</#if>
<#if !entityLombokModel>
    @Override
    public String toString() {
    return "${entity}{" +
    <#list table.fields as field>
        <#if field_index==0>
            "${field.propertyName}=" + ${field.propertyName} +
        <#else>
            ", ${field.propertyName}=" + ${field.propertyName} +
        </#if>
    </#list>
    "}";
    }
</#if>
}

提供主类

package com.example.generate;

import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.HashMap;
import java.util.Map;

public class Generate {
    private static final String url = "jdbc:mysql://127.0.0.1:3306/blog" +
            "?useUnicode=true&characterEncoding=utf8" +
            "&allowPublicKeyRetrieval=True&useSSL=false" +
            "&serverTimezone=Asia/Shanghai";
    private static final String userName    = "root";
    private static final String password    = "222333";
    private static final String tableName   = "t_blog";
    private static final String tablePrefix = "t_";

    // 演示例子
    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator autoGenerator = new AutoGenerator();

        // 全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        globalConfig.setOutputDir(projectPath + "/src/main/java");
        globalConfig.setAuthor("xxx");
        globalConfig.setFileOverride(false);  //默认就是false
        globalConfig.setOpen(false);
        // gc.setBaseResultMap(true); // mapper.xml 生成 ResultMap
        // gc.setBaseColumnList(true); // mapper.xml 生成 ColumnList

        // 自定义文件命名，注意 %s 会自动填充表实体属性！
        globalConfig.setMapperName("%sRepository");
        // gc.setXmlName("%sDao");
        globalConfig.setServiceName("%sService");
        globalConfig.setServiceImplName("%sServiceImpl");
        globalConfig.setControllerName("%sController");
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        autoGenerator.setGlobalConfig(globalConfig);

        // 数据源配置
        DataSourceConfig dataSourceConfig = new DataSourceConfig();

        dataSourceConfig.setUrl(url);
        // dsc.setSchemaName("public");
        dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSourceConfig.setUsername(userName);
        dataSourceConfig.setPassword(password);
        autoGenerator.setDataSource(dataSourceConfig);

        // 包配置
        PackageConfig packageConfig = new PackageConfig();
        // pc.setParent("com.example.generate.out");
        // pc.setModuleName("xxx");
        packageConfig.setMapper("repository");
        packageConfig.setParent("com.example.generate." + tableName.substring(tablePrefix.length()));
        autoGenerator.setPackageInfo(packageConfig);

        //自定义配置
        InjectionConfig customConfig = new InjectionConfig() {
            @Override
            public void initMap() {
                Map<String, Object> map = new HashMap<>();
                map.put("jpaSuperRepositoryClassPackage",
                        "org.springframework.data.jpa.repository.JpaRepository");
                this.setMap(map);
            }
        };
        autoGenerator.setCfg(customConfig);

        // 配置自定义输出模板
        TemplateConfig templateConfig = new TemplateConfig();
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        templateConfig.setController("templates_mp/MyController.java");
        templateConfig.setService("templates_mp/MyService.java");
        templateConfig.setServiceImpl("templates_mp/MyServiceImpl.java");
        templateConfig.setMapper("templates_mp/MyRepository.java");
        templateConfig.setEntity("templates_mp/MyEntity.java");
        templateConfig.setXml(null);
        autoGenerator.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig.setNaming(NamingStrategy.underline_to_camel);
        strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel);
        strategyConfig.setSuperMapperClass("JpaRepository");
        //strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategyConfig.setEntityLombokModel(true);
        strategyConfig.setRestControllerStyle(true);

        // 公共父类
        // strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        // strategy.setSuperEntityColumns("id");

        // 表名
        strategyConfig.setInclude(tableName);
        strategyConfig.setTablePrefix(tablePrefix);
        strategyConfig.setControllerMappingHyphenStyle(true);

        autoGenerator.setStrategy(strategyConfig);
        autoGenerator.setTemplateEngine(new FreemarkerTemplateEngine());
        autoGenerator.execute();
    }
}

运行主类

运行之前

Spring Data JPA--根据表生成代码--方法_xml_03

运行之后（红框中是新生成的文件）

Spring Data JPA--根据表生成代码--方法_xml_04

其他网址

​

​​Spring Boot JPA生成实体类的3种方法​​

SpringBoot学习录（2）- SpringBoot、JPA之生成实体类

​​springboot-jpa: 根据实体类自动生成controller service 实现类以及Dao​​


举报

相关推荐

Spring Data JPA--多表关联查询--实例

spring数据库hibernatejava

Spring Data JPA--注解--实体关联--使用/教程

数据库javaJPAspring一对多

Spring Data JPA--动态查询--Specification--使用

spring数据库sqlhibernatejava

Spring Data JPA--自定义SQL--方法/教程/实例

hibernate数据库sqlspring

Spring boot整合jpa（一），根据表生成实体

springjava学习之路工作生活Java 杂谈Java

Spring Data JPA使用必备(二)：Spring Data JPA方法命名规则实现SQL自动生成

springsqljava

Spring Data Jpa 接口方法名

JPADataJavaPython后端开发

Spring Data JPA

加载hibernate实体类编程语言

Spring data jpa

实体类编程语言

【ORM】——JPA，Hibernate，Spring Data JPA

jpahibernatespring data jpaorm框架数据库编程语言
0 条评论