SpringBoot整合MybatisPlus（详细版）

news2024/9/23 21:23:38

MybatisPlus简介

1. MybatisPlus

2. 特点

SpringBoot整合MybatisPlus

1. 新建SpringBoot工程

2. 数据准备

3. 引入依赖

4. 配置文件

5. 用MyBatisX-Generator生成代码

整体结构

User类

UserMapper

UserServiceImpl

UserController类

测试

查询用户表中全部信息

根据用户ID查找信息

添加用户信息

根据ID修改用户信息

控制台输出

MybatisPlus简介

1. MybatisPlus

MyBatis-Plus 是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。它继承了 MyBatis 的所有特性，并且加入了强大的功能，例如自动填充、逻辑删除、乐观锁、性能分析等。

2. 特点

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑

损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作。

强大的 CRUD 操作：内置==通用 Mapper==、通用 Service，仅仅通过少量配置即可实现单表大部分 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

SpringBoot整合MybatisPlus

1. 新建SpringBoot工程

2. 数据准备

创建表

DROP TABLE IF EXISTS `user`;

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

插入数据

DELETE FROM `user`;

INSERT INTO `user` (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');

3. 引入依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.7</version>
</dependency>

4. 配置文件


server:
  port: 8080

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/test
    username: root
    password: 123456


mybatis-plus:
  mapper-locations: classpath*:mapper/*.xml
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

5. 用MyBatisX-Generator生成代码

MyBatisX-Generator 旨在通过自动化生成代码来减少开发者在 CRUD 操作中的重复工作，从而提高开发效率。

整体结构

User类

@TableName(value ="user")
@Data
public class User implements Serializable {
    /**
     * 主键ID
     */
    @TableId(value = "id")
    private Long id;

    /**
     * 姓名
     */
    @TableField(value = "name")
    private String name;

    /**
     * 年龄
     */
    @TableField(value = "age")
    private Integer age;

    /**
     * 邮箱
     */
    @TableField(value = "email")
    private String email;

    @TableField(exist = false)
    private static final long serialVersionUID = 1L;
}

UserMapper

# UserMapper继承BaseMapper
public interface UserMapper extends BaseMapper<User> {

}

#  UserService继承IService
public interface UserService extends IService<User> {

}

UserServiceImpl

# UserServiceImpl继承ServiceImpl

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User>
    implements UserService{

}

UserController类

这里解释一下，因为我之前整合了Swagger2，所以这里的@Api注解是Swagger2的，具体的可以参考一下我的另外一篇SpringBoot整合Swagger2+定时器

@RestController
@RequestMapping("/user")
@Api(tags = "用户管理")  //使用在接口类上，对接口类的说明
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping("/list")
    @ApiOperation(value = "查询所有用户") // 接口方法的说明
    public R list(){
        List<User> list = userService.list();
        return new R(200,"success",list);
    }

    @GetMapping("/ById")
    @ApiOperation(value = "根据ID查询用户")
    @ApiImplicitParams(
            @ApiImplicitParam(name = "id",value = "用户id",required = true ,dataType = "int")
    )
    public  R ById(Integer id){
        User user = userService.getById(id);
        if (user != null){
            return new R(200,"success",user);
        }else {
            return new R(500,"fail",null);
        }
    }

    /**
     * 插入学生信息
     * @param user
     */
    @PostMapping("/insert")
    @ApiOperation(value = "添加用户")
    @ApiImplicitParams(
            @ApiImplicitParam(name = "user",value = "用户信息",required = true ,dataType = "User")
    )
    public R insertInfo(@RequestBody User user){
        boolean save = userService.save(user);
        if (save){
            return new R(200,"success",user);
        }
        return new R(500,"fail",null);
    }

    /**
     * 根据id更新学生表信息
     * @param user
     */
    @PutMapping("/update")
    @ApiOperation(value = "根据ID修改用户")
    @ApiImplicitParams(
            @ApiImplicitParam(name = "user",value = "用户信息",required = true ,dataType = "User")
    )
    public R updateById(@RequestBody User user){
        boolean save = userService.updateById(user);
        if (save){
            return new R(200,"success",null);
        }
        return new R(500,"fail",null);
    }

    /**
     * 根据id删除学生信息
     * @param id
     */
    @DeleteMapping("/delete")
    @ApiOperation(value = "根据ID删除用户")
    @ApiImplicitParams(
            @ApiImplicitParam(name = "id",value = "用户id",required = true ,dataType = "int")
    )
    public R deleteById(String id){
        boolean b = userService.removeById(id);
        if (b){
            return new R(200,"success",null);
        }
        return new R(500,"fail",null);
    }

}

启动程序

测试

这里使用Apipost插件进行测试

查询用户表中全部信息

根据用户ID查找信息

添加用户信息

根据ID修改用户信息

根据用户ID删除

控制台输出

同时添加日志使内容更详细，使用的是StdOutImpl日志。

# Mybatis-Plus配置
mybatis-plus:
  # 指定Mapper接口的位置，这里使用classpath*表示加载所有匹配的资源，mapper/*.xml表示 mapper 目录下所有以 .xml 结尾的文件
  mapper-locations: classpath*:mapper/*.xml
  configuration:
    # 设置Mybatis的日志实现类为控制台输出
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl