SpringBoot集成MyBatisPlus 使用，实战篇

向右看齐 2024-03-22 12:11 187阅读 0赞

文章目录

  • 前言
  • 特性
  • 代码实战
    • mysql 建表语句
    • pom 配置
    • yml配置
    • 代码生成器（神器）
    • 分页配置
    • 公共字段填充（神器）
    • controller 测试代码

前言

MyBatis-Plus （简称 MP）在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

官网地址：
https://baomidou.com/pages/24112f/

在这里插入图片描述

特性

  • 无侵入 ：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
  • 损耗小 ：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作，BaseMapper
  • 强大的 CRUD 操作 ：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求，简单的CRUD操作不用自己编写。
  • 支持 Lambda 形式调用 ：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
  • 支持主键自动生成 ：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
  • 支持 ActiveRecord 模式 ：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
    支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
  • 内置代码生成器 ：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用（自动生成代码）
  • 内置分页插件 ：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
  • 分页插件支持多种数据库 ：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
  • 内置性能分析插件 ：可输出 SQL 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
  • 内置全局拦截插件 ：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

代码实战

mysql 建表语句

使用 mybatisplus 需要先确定表结构，下面就是测试用的表结构。

  1. create table t_user (
  2.     id int (10) primary key auto_increment comment '用户主键',
  3.     username varchar (100) not null comment '用户名称',
  4.     pwd varchar(50) not null comment '密码',
  5.     create_time datetime not null comment '创建时间',
  6.     update_time datetime comment '修改时间'
  7. ) engine = innodb default charset = utf8 collate = utf8_bin comment '用户表';

pom 配置

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <parent>
  5.         <groupId>org.example</groupId>
  6.         <artifactId>springboot-learning-parents</artifactId>
  7.         <version>1.0-SNAPSHOT</version>
  8.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  11.     <groupId>springboot-demo</groupId>
  12.     <artifactId>springboot-mybatisplus</artifactId>
  13.     <version>1.0-SNAPSHOT</version>
  14.     <name>springboot-mybatisplus</name>
  15.     <description>springboot 集成 mybatisplus</description>
  16.     <packaging>jar</packaging>
  18.     <url>https://gitee.com/leo825/springboot-learning-parents.git</url>
  20.     <properties>
  21.         <start-class>com.demo.SpringbootMybatisplusApplication</start-class>
  22.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  23.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  24.         <java.version>1.8</java.version>
  25.         <mybatisplus.version>3.5.1</mybatisplus.version>
  26.         <freemaker.version>2.3.31</freemaker.version>
  27.         <mysql.version>8.0.28</mysql.version>
  28.     </properties>
  30. <dependencies>
  31.         <dependency>
  32.             <groupId>org.springframework.boot</groupId>
  33.             <artifactId>spring-boot-starter</artifactId>
  34.         </dependency>
  35.         <dependency>
  36.             <groupId>org.springframework.boot</groupId>
  37.             <artifactId>spring-boot-starter-web</artifactId>
  38.         </dependency>
  40.         <dependency>
  41.             <groupId>org.projectlombok</groupId>
  42.             <artifactId>lombok</artifactId>
  43.             <optional>true</optional>
  44.         </dependency>
  45.         <dependency>
  46.             <groupId>org.springframework.boot</groupId>
  47.             <artifactId>spring-boot-starter-test</artifactId>
  48.             <scope>test</scope>
  49.         </dependency>
  51. <!-- mybatis-plus 所需依赖  -->
  52.         <dependency>
  53.             <groupId>com.baomidou</groupId>
  54.             <artifactId>mybatis-plus-boot-starter</artifactId>
  55.             <version>${mybatisplus.version}</version>
  56.         </dependency>
  57.         <dependency>
  58.             <groupId>com.baomidou</groupId>
  59.             <artifactId>mybatis-plus-generator</artifactId>
  60.             <version>${mybatisplus.version}</version>
  61.         </dependency>
  62.         <dependency>
  63.             <groupId>org.freemarker</groupId>
  64.             <artifactId>freemarker</artifactId>
  65.             <version>2.3.31</version>
  66.         </dependency>
  68.         <!-- mysql 驱动 -->
  69.         <dependency>
  70.             <groupId>mysql</groupId>
  71.             <artifactId>mysql-connector-java</artifactId>
  72.             <version>${mysql.version}</version>
  73.         </dependency>
  74.     </dependencies>
  76.     <build>
  77.         <plugins>
  78.             <plugin>
  79.                 <groupId>org.springframework.boot</groupId>
  80.                 <artifactId>spring-boot-maven-plugin</artifactId>
  81.             </plugin>
  82.         </plugins>
  83.     </build>
  85. </project>

yml配置

  1. # springboot多环境配置
  2. #端口，项目上下文
  3. server:
  4.   port: 8080
  5.   servlet:
  6.     context-path: /springboot-mybatisplus
  8. spring:
  9.   # mysql 数据库连接信息，本地使用 mysql 服务版本为：8.0.28
  10.   datasource:
  11.     username: root
  12.     password: 6tojyh*A3eQ6
  13.     url: jdbc:mysql://localhost:3306/local_test?useSSL=false&useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai&rewriteBatchedStatements=true&allowPublicKeyRetrieval=true
  14.     driver-class-name: com.mysql.cj.jdbc.Driver
  16. # mybatis-plus 配置
  17. mybatis-plus:
  18.   mapper-locations: classpath*:/mapper/**/*.xml
  19.   #实体扫描，多个package用逗号或者分号分隔
  20.   typeAliasesPackage: com.dmo.entity
  21.   global-config:
  22.     #数据库相关配置
  23.     db-config:
  24.       #主键类型  AUTO:"数据库ID自增", INPUT:"用户输入ID", ID_WORKER:"全局唯一ID (数字类型唯一ID)", UUID:"全局唯一ID UUID";
  25.       id-type: AUTO
  26.       #字段策略 IGNORED:"忽略判断",NOT_NULL:"非 NULL 判断"),NOT_EMPTY:"非空判断"
  27.       field-strategy: NOT_NULL
  28.       #驼峰下划线转换
  29.       column-underline: true
  30.       logic-delete-value: -1
  31.       logic-not-delete-value: 0
  32.     banner: false
  33.   #原生配置
  34.   configuration:
  35.     # 打印sql
  36.     log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  37.     map-underscore-to-camel-case: true
  38.     cache-enabled: false
  39.     call-setters-on-nulls: true
  40.     jdbc-type-for-null: 'null'
  42. # 日志输出配置
  43. logging:
  44.   level:
  45.     root: INFO
  46.     org:
  47.       springframework:
  48.         security: WARN
  49.         web: ERROR
  50.     # 设置自己的 mapper 目录 输出sql日志
  51.     com.demo.mapper: debug
  52.   file:
  53.     path: ./logs
  54.     name: './logs/springboot-mybatisplus.log'
  55.   pattern:
  56.     file: '%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}:%L - %msg%n'
  57.     console: '%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}:%L - %msg%n'

代码生成器（神器）

使用代码生成器，把以前用于 CURD 的代码一键生成，大大节省了时间提高了效率，把原本1天的工作量，1个小时就能完成。
MybatisPlusGenerator.java

  1. package com.demo.util;
  3. import com.baomidou.mybatisplus.annotation.FieldFill;
  4. import com.baomidou.mybatisplus.generator.FastAutoGenerator;
  5. import com.baomidou.mybatisplus.generator.config.*;
  6. import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
  7. import com.baomidou.mybatisplus.generator.fill.Column;
  9. import java.util.Collections;
  11. /**
  12.  *  MybatisPlusGenerator 代码生成神器
  13.  */
  14. public class MybatisPlusGenerator {
  15.     public static void main(String[] args) {
  16.         // mysql 连接
  17.         FastAutoGenerator.create("jdbc:mysql://localhost:3306/local_test?useSSL=false&useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai&rewriteBatchedStatements=true&allowPublicKeyRetrieval=true", "root", "6tojyh*A3eQ6")
  18.                 .globalConfig(builder -> {
  19.                     builder.author("springBoot-Learning") // 设置作者
  20.                             //.enableSwagger() // 开启 swagger 模式
  21.                             .fileOverride() // 覆盖已生成文件
  22.                             .outputDir(System.getProperty("user.dir")+"/springboot-mybatisplus/src/main/java"); // 指定输出目录
  23.                 })
  24.                 .packageConfig(builder -> {
  25.                     builder.parent("com") // 设置父包名
  26.                             .moduleName("demo") // 设置父包模块名
  27.                             // .service()  // 设置自定义service路径,不设置就是默认路径
  28.                             .pathInfo(Collections.singletonMap(OutputFile.mapperXml, System.getProperty("user.dir") +"/src/main/resources/mapper/")); // 设置mapperXml生成路径
  29.                 })
  30.                 .strategyConfig(builder -> {
  31.                     builder.addInclude("t_user") // 设置需要生成的表名
  32.                             .addTablePrefix("t_", "c_")
  33.                             // 设置自动填充的时间字段
  34.                             .entityBuilder().addTableFills(
  35.                             new Column("create_time", FieldFill.INSERT),new Column("update_time", FieldFill.INSERT_UPDATE))
  36.                     ; // 设置过滤表前缀
  38.                 })
  39.                 .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
  40.                 .execute();
  41.     }
  42. }

生成结果如下：
代码生成

分页配置

  1. package com.demo.config;
  3. import com.baomidou.mybatisplus.annotation.DbType;
  4. import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
  5. import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
  6. import org.springframework.context.annotation.Bean;
  7. import org.springframework.context.annotation.Configuration;
  9. /**
  10.  * mybatisplus 配置
  11.  */
  12. @Configuration
  13. public class MybatisPlusConfig {
  14.     /**
  15.      * 老版本，目前已失效
  16.      * @return
  17.      */
  18.     /**@Bean
  19.     public PaginationInterceptor paginationInterceptor() {
  20.     PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
  21.     return paginationInterceptor;
  22.     }*/
  24. /**
  25.      * 新的分页插件,一缓和二缓遵循mybatis的规则,
  26.      */
  27.     @Bean
  28.     public MybatisPlusInterceptor mybatisPlusInterceptor() {
  29.         MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
  30.         interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
  31.         return interceptor;
  32.     }
  33. }

公共字段填充（神器）

  1. package com.demo.config;
  3. import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
  4. import lombok.extern.slf4j.Slf4j;
  5. import org.apache.ibatis.reflection.MetaObject;
  6. import org.springframework.stereotype.Component;
  8. import java.time.LocalDateTime;
  10. /**
  11.  * 填充公共字段
  12.  *
  13.  */
  14. @Slf4j
  15. @Component
  16. public class MyMetaObjectHandler implements MetaObjectHandler {
  17.     @Override
  18.     public void insertFill(MetaObject metaObject) {
  19.         log.info("start insert fill...");
  20.         this.setFieldValByName("createTime", LocalDateTime.now(), metaObject);
  21.         this.setFieldValByName("updateTime", LocalDateTime.now(), metaObject);
  22.     }
  24.     @Override
  25.     public void updateFill(MetaObject metaObject) {
  26.         log.info("start update fill...");
  27.         this.setFieldValByName("updateTime", LocalDateTime.now(), metaObject);
  28.     }
  29. }

controller 测试代码

  1. package com.demo.controller;
  3. import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
  4. import com.baomidou.mybatisplus.core.metadata.IPage;
  5. import com.baomidou.mybatisplus.core.toolkit.StringUtils;
  6. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  8. import com.demo.base.Result;
  9. import com.demo.entity.User;
  10. import com.demo.service.IUserService;
  11. import org.springframework.beans.factory.annotation.Autowired;
  12. import org.springframework.web.bind.annotation.GetMapping;
  13. import org.springframework.web.bind.annotation.RequestMapping;
  15. import org.springframework.web.bind.annotation.RestController;
  17. import java.util.List;
  19. /**
  20.  * controller 测试
  21.  *
  22.  */
  23. @RestController
  24. @RequestMapping("/user")
  25. public class UserController {
  27.     /**
  28.      * 构造方法注入
  29.      */
  30.     @Autowired
  31.     IUserService userService;
  33. /**
  34.      * 保存数据
  35.      *
  36.      * @return
  37.      */
  38.     @GetMapping("/save")
  39.     public Result save() {
  40.         User user = new User();
  41.         user.setUsername("miaolinlin");
  42.         user.setPwd("121212");
  43.         userService.save(user);
  44.         return new Result().ok(user);
  45.     }
  47.     /**
  48.      * 修改数据
  49.      *
  50.      * @param id
  51.      * @return
  52.      */
  53.     @GetMapping("/update")
  54.     public Result update(Integer id) {
  55.         User user = new User();
  56.         user.setId(id);
  57.         user.setPwd("1111111111");
  58.         userService.updateById(user);
  59.         return new Result().ok("{}");
  60.     }
  62.     @GetMapping("/list")
  63.     public Result list() {
  64.         // 返回所有
  65.         List<User> list = userService.list();
  66.         return new Result().ok(list);
  67.     }
  69.     @GetMapping("/listByContion")
  70.     public Result listByContion() {
  71.         /**
  72.          * 条件查询， 通过QueryWrapper来实现查询的条件：
  73.          * eq: 代表相等
  74.          * like: 模糊匹配
  75.          * orderBy: 排序
  76.          * in, notin
  77.          * 大于，小于，between等
  78.          */
  79.         List<User> list = userService.list(new LambdaQueryWrapper<User>()
  80.                 // 查询年龄=11的
  81.                 .eq(User::getUsername, "miao")
  82.                 // 模糊匹配
  83.                 .like(User::getPwd, "%111%")
  84.                 // 排序，按照创建时间
  85.                 .orderByDesc(User::getCreateTime)
  86.         );
  87.         return new Result().ok(list);
  88.     }
  90.     /**
  91.      * 根据id获取数据
  92.      *
  93.      * @param id
  94.      * @return
  95.      */
  96.     @GetMapping("/getById")
  97.     public Result getById(Integer id) {
  98.         User user = userService.getById(id);
  99.         return new Result().ok(user);
  100.     }
  102.     /**
  103.      * 删除数据
  104.      *
  105.      * @param id
  106.      * @return
  107.      */
  108.     @GetMapping("/delete")
  109.     public Result delete(Integer id) {
  110.         userService.removeById(id);
  111.         return new Result().ok("success");
  112.     }
  114.     /**
  115.      * 分页查询
  116.      *
  117.      * @param pageNum
  118.      * @param pageSize
  119.      * @param name
  120.      * @return
  121.      */
  122.     @GetMapping("/page")
  123.     public Result page(int pageNum, int pageSize, String name) {
  124.         IPage<User> page = new Page<>(pageNum, pageSize);
  126.         IPage<User> page1 = userService.page(page, new LambdaQueryWrapper<User>()
  127.                 // 主要演示这里可以加条件。在name不为空的时候执行
  128.                 .like(StringUtils.isNotEmpty(name), User::getUsername, "%" + name + "%"));
  130.         return new Result().ok(page1);
  131.     }
  132. }

发表评论

表情：
评论列表 （有 0 条评论，187人围观）

还没有评论，来说两句吧...

相关阅读