Spring Boot-3.0与Mybatis-plus的整合

新建项目：在pom.xml中添加相关依赖：（完整的pom文件）<?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

鹅纷斐，

5188人浏览 · 2021-02-19 15:06:11

鹅纷斐， · 2021-02-19 15:06:11 发布

新建项目：
在这里插入图片描述
在pom.xml中添加相关依赖：（完整的pom文件）

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.2</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.wxf</groupId>
    <artifactId>springboot-mybatis-plus</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-mybatis-plus</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
        <mysql.version>5.1.49</mysql.version>
        <mybatis-plus.version>3.4.0</mybatis-plus.version>
        <druid.version>1.1.24</druid.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>
        <!--自动生成实体类等信息的依赖插件-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>
        <!--velocity模板引擎-->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.2</version>
        </dependency>
        <!--freemarker模板引擎-->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.30</version>
        </dependency>
        <!--beetl模板引擎-->
        <dependency>
            <groupId>com.ibeetl</groupId>
            <artifactId>beetl</artifactId>
            <version>3.2.1.RELEASE</version>
        </dependency>


        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>${druid.version}</version>
        </dependency>


        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>


            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

配置mybatis-plus-generator插件
添加依赖

<!--在pom.xml文件中的dependencies标签中添加以下内容-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>${mybatis-plus.version}</version>
</dependency>

添加模板引擎依赖

<!--在pom.xml文件中的dependencies标签中添加以下内容，根据需要添加即可-->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.2</version>
</dependency>
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.30</version>
</dependency>
<dependency>
    <groupId>com.ibeetl</groupId>
    <artifactId>beetl</artifactId>
    <version>3.2.1.RELEASE</version>
</dependency>

创建代码生成器

package com.wxf.springbootmybatisplus.util;

import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.sql.*;
import java.util.ArrayList;
import java.util.List;

public class MyBatisPlusCodeGenerator {
    //设置是否启用对所有表生成相应的实体类，默认启用
    private static boolean enableAllTables=true;
    private static String url="jdbc:mysql://localhost:3306/springboot_mybatis_plus?useUnicode=true&useSSL=false&characterEncoding=utf8";
    private static String username="root";
    private static String password="123456";
    private static String driverName = "com.mysql.jdbc.Driver";
    private static String parentPackage = "com.wxf.springbootmybatisplus";
    //自动生成代码的开发者的名字，默认为当前登录用户的用户名
    private static String author = "wxf";
    private static String moduleName = "";
    private static String[] tables;

    static {
        try {
            Class.forName(driverName);
            Connection conn= DriverManager.getConnection(url,username,password);
            DatabaseMetaData md = conn.getMetaData();
            ResultSet rs = md.getTables(conn.getCatalog(), null, null, null);
            StringBuilder sb=new StringBuilder();
            while (rs.next()){
                sb.append(rs.getString(3));
                sb.append(",");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public static void main(String[] args) {
        //代码生成器
        AutoGenerator mpg=new AutoGenerator();
        //全局配置
        GlobalConfig gc=new GlobalConfig();
        //获取项目目录
        String projectPath=System.getProperty("user.dir");
        gc.setOutputDir(projectPath+"/src/main/java");
        gc.setAuthor(author==null?System.getProperty("user.name"):author);
        //是否打开输出目录
        gc.setOpen(false);
        //设置是否覆盖重新生成代码，默认为false，不覆盖
        mpg.setGlobalConfig(gc);

        //数据源配置
        DataSourceConfig dsc=new DataSourceConfig();
        dsc.setUrl(url);
        dsc.setDriverName(driverName);
        dsc.setUsername(username);
        dsc.setPassword(password);
        mpg.setDataSource(dsc);

        //包配置
        PackageConfig pc=new PackageConfig();
        pc.setModuleName(moduleName==null?"bean":moduleName);
        pc.setParent(parentPackage);
        mpg.setPackageInfo(pc);
        //配置entity包名
        pc.setEntity("entity");
        //配置mapper包名
        pc.setMapper("mapper");
        //配置service包名
        pc.setService("service");
        //配置controller包名
        pc.setController("controller");


        //自定义配置
        InjectionConfig cfg=new InjectionConfig() {
            @Override
            public void initMap() {

            }
        };
        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录，自定义目录用");
                if (fileType == FileType.MAPPER) {
                    // 已经生成 mapper 文件判断存在，不想重新生成返回 false
                    return !new File(filePath).exists();
                }
                // 允许生成模板文件
                return true;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);


        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();


        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        //strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        //strategy.setSuperEntityColumns("id");
        strategy.setInclude();
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

配置数据源：

#mysql-druid
spring:
  datasource:
    druid:
      username: root
      password: 123456
      driver-class-name: com.mysql.jdbc.Driver
      url: jdbc:mysql://localhost:3306/springboot_mybatis_plus?useUnicode=true&useSSL=false&characterEncoding=utf8
      initialSize: 5
      minIdle: 5
      maxActive: 20
#mybatis-plus
mybatis-plus:
  mapper-locations: classpath:/mapper/*Mapper.xml
  #实体扫描，多个package用逗号或者分号分隔
  type-aliases-package: com.hnumi.quick.entry
  #主键类型  0:"数据库ID自增", 1:"用户输入ID",2:"全局唯一ID (数字类型唯一ID)", 3:"全局唯一ID UUID";
  global-config:
    id-type: 0
    #驼峰下划线转换
    db-column-underline: true
    #刷新mapper 调试神器
    refresh-mapper: true
  #输出sql日志
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

在controller中添加代码：

@Autowired
    IStudentService studentService;
    @RequestMapping("/list")
    public List<Student> list(){
        return studentService.list();
    }

查询结果：
在这里插入图片描述

-注解名称：@TableName 作用：用于定义表名常用属性：value 属性作用：用于定义表名

注解名称：@TableId 作用：用于定义表的主键常用属性：value，type 属性作用：用于定义主键字段名和主键类型
注解名称：@TableField 作用：定义表的非主键字段常用属性：value，exist，fill 属性作用：非主键字段名，指明是否为数据表的字段，指定字段填充策略
注解名称：@TableLogic 作用：定义表的字段进行逻辑删除常用属性：value，delval 属性作用：定义未删除时字段的值，定义删除时字段的值
注解名称：@Version 作用：用于字段实现乐观锁

主键类型：

IdType.AUTO 主键自增，系统分配，不需要手动输入
IdType.NONE 未设置主键
IdType.INPUT 需要自己输入主键值。
IdType.ASSIGN_ID 系统分配ID，用于数值型数据（Long，对应 mysql 中 BIGINT 类型）
IdType.ASSIGN_UUID 系统分配 UUID，用于字符串型数据（String，对应 mysql 中 varchar(32) 类型）。

字段填充策略：