SpringBoot 整合 Mybatis-plus(一) 简单示例 + 代码生成器

其他 2020-05-14 14:45:37 阅读次数: 0

SpringBoot + Mybatis-plus

准备工作：

  1. 搭建SpringBoot框架项目 如果没有搭建，可查看以下链接【 IDEA SpringBoot 从零搭建(有网络情况下)】
    https://blog.csdn.net/weixin_42862834/article/details/105691377

  2. 如果需要 SpringBoot整合mybatis实现简单CRUD，可查看以下链接【SpringBoot 整合 mybatis 实现简单的CRUD(附：部分代码)】
    https://blog.csdn.net/weixin_42862834/article/details/105691377

目录

一、简单示例

** 目录结构 **

在这里插入图片描述

1、pom文件引入相关依赖

可以直接去Maven Repository 查找需要的依赖包
官网地址： https://mvnrepository.com/

  • 引入Spring Boot Start 父工程

    	<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.7.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

  • springBoot 启动依赖 (使用 Spring Initializer 时，生成pom文件中包含以下依赖)

        <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </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>

  • mybatis-plus 依赖、mysql驱动

    	<!-- mybatis-plus 启动依赖 -->
    <!-- https://mvnrepository.com/artifact/com.baomidou/mybatis-plus-boot-starter -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.3.1</version>
    </dependency>

    <!-- lombok 依赖 -->
    <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.12</version>
        <scope>provided</scope>
    </dependency>

    <!-- mysql 驱动 -->
    <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.20</version>
    </dependency>

2、配置文件

  • application.properties 文件

    server.port=8902
server.servlet.context-path=/demo/mybatis/plus

# mysql 数据源配置
spring.datasource.url=jdbc:mysql://localhost:3306/mysql-plus?serverTimezone=Asia/Shanghai&useSSL=false&useUnicode=true&characterEncoding=utf8&characterSetResults=utf8
spring.datasource.username=root
spring.datasource.password=password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

  • 启动类配置
    添加@MapperScan注解，扫描Mapper 文件夹

    @SpringBootApplication
@MapperScan("com.demo.xiaotianer.mybatis.plus.mapper") // 扫描Mapper文件夹
public class DemoMybatisPlusApplication {

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

}

3、编码(简单测试)

  • 示例：User表

    DROP TABLE IF EXISTS user;

CREATE TABLE user
(
	id BIGINT(20) NOT NULL COMMENT '主键ID',
	name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
	age INT(11) NULL DEFAULT NULL COMMENT '年龄',
	email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
	PRIMARY KEY (id)
);

  • 实体类(此处使用了 Lombok 注解)

    import lombok.Data;

@Data
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

  • mapper类编写

    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.demo.xiaotianer.mybatis.plus.model.User;

public interface UserMapper extends BaseMapper<User> {

}

  • 测试类 (位置 test --> java)

    package com.demo.xiaotianer.mybatis.plus;

import com.demo.xiaotianer.mybatis.plus.mapper.UserMapper;
import com.demo.xiaotianer.mybatis.plus.model.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
public class UserTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        List<User> userList = userMapper.selectList(null);
        for (User user : userList) {
            System.out.println("user: " + user);
        }
    }
}

  • 运行结果
    控制台输出结果如下：
    控制台输出结果

4、简单的 CRUD 测试

https://blog.csdn.net/weixin_42862834/article/details/106081618

二、 代码生成器

AutoGenerator

** 目录结构 **

在这里插入图片描述

1、pom文件依赖

  • 代码生成器依赖

    	<!-- 代码生成器依赖 -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-generator</artifactId>
        <version>3.3.1</version>
   </dependency>

  • 引入模板引擎依赖
    mybatis-plus 支持 Velocity ( 默认)、Freemarker、Beetl， 此处选择了 Freemarker

    	<!-- freemarker 模板引擎依赖 -->
    <!-- https://mvnrepository.com/artifact/org.freemarker/freemarker -->
    <dependency>
        <groupId>org.freemarker</groupId>
        <artifactId>freemarker</artifactId>
        <version>2.3.30</version>
    </dependency>

2、配置编写 MpGenerator.java

  1. 全局配置

        // 1. 全局配置
    GlobalConfig gc = new GlobalConfig()
    
    gc.setAuthor("小天儿");  //作者
    //String projectPath = System.getProperty("user.dir"); //项目Project地址
    //gc.setOutputDir(projectPath + "/src/main/java");  //输出地址
    gc.setOutputDir("D:\\WorkSpace\\xiaotianer-project\\demo-mybatis-plus-generator\\src\\main\\java");  //绝对路径
    gc.setFileOverride(false);  // 是否覆盖同名文件，默认是false
    gc.setIdType(IdType.AUTO);  // 主键策略
    gc.setActiveRecord(true);   // ActiveRecord 模式，默认表名为类名的复数形式
    gc.setEnableCache(false);   // XML 二级缓存
    gc.setBaseResultMap(true);  // XML ResultMap 生成基本的 ResultMap
    gc.setBaseColumnList(false);    // XML ColumnList 生成基本的sql片段
    /* 自定义文件命名， %s 会自动填充表实体属性！ */
    gc.setMapperName("%sDao");
    gc.setXmlName("%sMapper");
    gc.setServiceName("%sService");
    gc.setServiceImplName("%sServiceImpl");
    gc.setControllerName("%sController");

    mpg.setGlobalConfig(gc);

  2. 数据源配置

    	  // 2. 数据源配置
	 DataSourceConfig dsc = new DataSourceConfig();
	 dsc.setDbType(DbType.MYSQL);
	 dsc.setUrl("jdbc:mysql://localhost:3306/school?serverTimezone=Asia/Shanghai&useSSL=false&useUnicode=true&characterEncoding=utf8&characterSetResults=utf8");
	 dsc.setDriverName("com.mysql.cj.jdbc.Driver");
	 dsc.setUsername("root");
	 dsc.setPassword("password");
		
	 mpg.setDataSource(dsc);

  3. 包配置 (可以按需配置生成目录名)
    例如：pc.setMapper("dao"); 这样Dao存放目录就会从默认的mapper变为dao

        PackageConfig pc = new PackageConfig();
    pc.setModuleName(scanner("模块名"));
    pc.setParent("com.demo.xiaotianer.mp.generator"); //package
    mpg.setPackageInfo(pc);

  4. 策略配置

        // 4. 策略配置
    StrategyConfig strategy = new StrategyConfig();strategy.setNaming(NamingStrategy.underline_to_camel);  //表名生成策略 (驼峰)
    strategy.setColumnNaming(NamingStrategy.underline_to_camel);
    //strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
    strategy.setEntityLombokModel(true);    //以lombok注解生成实体类
    strategy.setRestControllerStyle(true);  //controller以RestFlue风格
    // 公共父类
    //strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
    // 写于父类中的公共字段
    strategy.setSuperEntityColumns("id");
    strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
    strategy.setControllerMappingHyphenStyle(true);
    strategy.setTablePrefix("tbl_"); // 表名前缀（自定义）
        
    mpg.setStrategy(strategy);

*** 附： MpGenerator.java 整体代码如下

package com.demo.xiaotianer.mp.generator;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
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.util.ArrayList;
import java.util.List;
import java.util.Scanner;

/**
 *  代码生成器展示
 */
public class MpGenerator {

    /**
     * <p>
     * 读取控制台内容
     * </p >
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotEmpty(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 1. 全局配置
        GlobalConfig gc = new GlobalConfig();

        gc.setAuthor("小天儿");  //作者
        String projectPath = System.getProperty("user.dir"); //项目Project地址
        //gc.setOutputDir(projectPath + "/src/main/java");  //输出地址
        gc.setOutputDir("D:\\WorkSpace\\xiaotianer-project\\demo-mybatis-plus-generator\\src\\main\\java");  //绝对路径
        gc.setFileOverride(false);  // 是否覆盖同名文件，默认是false
        gc.setIdType(IdType.AUTO);  // 主键策略
        gc.setActiveRecord(true);   // ActiveRecord 模式，默认表名为类名的复数形式
        gc.setEnableCache(false);   // XML 二级缓存
        gc.setBaseResultMap(true);  // XML ResultMap 生成基本的 ResultMap
        gc.setBaseColumnList(false);    // XML ColumnList 生成基本的sql片段
        /* 自定义文件命名， %s 会自动填充表实体属性！ */
        gc.setMapperName("%sDao");
        gc.setXmlName("%sMapper");
        gc.setServiceName("%sService");
        gc.setServiceImplName("%sServiceImpl");
        gc.setControllerName("%sController");

        mpg.setGlobalConfig(gc);

        // 2. 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setDbType(DbType.MYSQL);
        dsc.setUrl("jdbc:mysql://localhost:3306/school?serverTimezone=Asia/Shanghai&useSSL=false&useUnicode=true&characterEncoding=utf8&characterSetResults=utf8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("password");

        mpg.setDataSource(dsc);

        // 3. 包配置
        PackageConfig pc = new PackageConfig();
        pc.setParent("com.demo.xiaotianer.mp.generator");
        mpg.setPackageInfo(pc);

        // 4. 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);  //表名生成策略 (驼峰)
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);    //以lombok注解生成实体类
        strategy.setRestControllerStyle(true);  //controller以RestFlue风格
        // 公共父类
        //strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix("tbl_"); //表名前缀

        mpg.setStrategy(strategy);


        // 5. 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 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;
                //由于projectPath 获取的是 项目地址，实际使用的为model，所以使用全地址替代
                return "D:\\WorkSpace\\xiaotianer-project\\demo-mybatis-plus-generator\\src\\main\\resources\\mapper"
                        + "/" + 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);

        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute(); // 运行
    }

}

3、运行

  1. 运行前目录结构
    在这里插入图片描述
  2. 运行 MpGenerator.java 文件，输入库表中已存在表名
    在这里插入图片描述
  3. 回车，生成文件中…
    在这里插入图片描述
  4. 生成文件后目录结构
    在这里插入图片描述

运行 成 功 ~ ~ 撒 花 ~ ~

小天儿er
原创文章 13 获赞 1 访问量 924
关注 私信

猜你喜欢

转载自blog.csdn.net/weixin_42862834/article/details/105951106
今日推荐
中国码农的“35岁魔咒”
蘭雅 CorelDRAW 插件 2024.5.1 国际劳动节版，免费下载
Arc Browser for Windows 1.0 正式 GA
90后程序员开发视频搬运软件、不到一年获利超 700 万，结局很刑！
《美国对全球网络空间安全与发展的威胁和破坏》报告发布
周排行
[编程题]学英语
[codeforces 1288A] Deadline 约数+模
Python的web开发
Docker在Centos 7上的部署
python编码
解决Ubuntu16.04 fatal error: json/json.h: No such file or directory
mysql并发插入
rest接口如何适应jsonp的方案
linux 终端上网设置
高数——等号两边同时求导、积分的解释
每日归档
更多
2024-05-04(7)
2024-05-03(19)
2024-05-02(0)
2024-05-01(4)
2024-04-30(1)
2024-04-29(40)
2024-04-28(0)
2024-04-27(56)
2024-04-26(39)
2024-04-25(22)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022