Spring Boot整合Mybatis-Plus

一、概述

Spring Boot 是目前非常流行的 Java Web 框架之一，而 MyBatis-Plus 是在 MyBatis 基础上进行封装的一款增强工具，提供了丰富的功能来简化开发，特别是在 CRUD 操作方面。Spring Boot 整合 Mybatis-Plus 可以让开发者以最简便的方式实现数据库操作，减少了大量的 boilerplate 代码，提高了开发效率。

二、Mybatis-Plus 简介

MyBatis-Plus 是 MyBatis 的增强工具，主要目的是简化开发中的常见操作，尤其是 CRUD 操作。它为 MyBatis 提供了很多有用的功能，如：

• 自动生成 CRUD 代码
• 分页插件
• 乐观锁插件
• SQL 性能分析插件
• 多租户插件等

通过 MyBatis-Plus，开发者无需编写繁琐的 XML 配置文件或者手动实现 CRUD 方法，可以通过一行注解即可实现数据的增、删、改、查。

三、Spring Boot 与 Mybatis-Plus 的集成步骤

1. 创建 Spring Boot 项目

首先，在 Spring Initializr 创建一个 Spring Boot 项目。可以选择以下依赖：

• Spring Web
• Spring Data JPA（可选，如果要使用 JPA）
• MyBatis Framework
• Lombok（简化代码）
• MyBatis-Plus

可以通过 Spring Initializr 网址（https://start.spring.io/）来生成一个基础项目，选择所需要的依赖。

2. 添加依赖

在 pom.xml 文件中加入 MyBatis-Plus 的相关依赖。

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Mybatis-Plus -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.0</version>
    </dependency>

    <!-- MySQL 驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>

    <!-- Lombok -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <scope>provided</scope>
    </dependency>
</dependencies>

注意：

• mybatis-plus-boot-starter 是 MyBatis-Plus 的官方启动器。
• mysql-connector-java 是 MySQL 数据库的驱动。
• lombok 是一个 Java 库，用于简化代码，尤其是在实体类中自动生成 getter/setter 和构造函数等。

3. 配置文件

在 application.yml 或 application.properties 中配置数据源，下面以 application.yml 为例：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/my_database?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
    username: root
    password: password
    driver-class-name: com.mysql.cj.jdbc.Driver
  mybatis-plus:
    # 配置 Mybatis-Plus 扫描的包路径
    mapper-locations: classpath:/mapper/*.xml
    type-aliases-package: com.example.demo.entity

配置文件说明：

• spring.datasource.url：数据库连接地址。
• spring.datasource.username：数据库用户名。
• spring.datasource.password：数据库密码。
• mybatis-plus.mapper-locations：MyBatis 映射文件的位置。
• mybatis-plus.type-aliases-package：实体类的包路径。

4. 创建实体类

在项目中创建实体类，以 User 为例：

package com.example.demo.entity;

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

@Data
@TableName("user")  // 映射到数据库中的 user 表
public class User {

    @TableId  // 表示该字段是主键
    private Long id;

    private String name;

    private Integer age;

    private String email;
}

• @TableName 注解指定了实体类映射的表名。
• @TableId 注解标识了主键。

5. 创建 Mapper 接口

创建一个 Mapper 接口来访问数据库，继承自 BaseMapper<T>，该接口将提供 CRUD 操作的各种方法。

package com.example.demo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.demo.entity.User;

public interface UserMapper extends BaseMapper<User> {
}

BaseMapper 提供了常见的数据库操作方法，如 insert, delete, select, update 等。

6. 创建 Service 层

在 Service 层中，我们可以直接使用 MyBatis-Plus 提供的 ServiceImpl 类，避免编写重复的 CRUD 操作代码。

package com.example.demo.service;

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import org.springframework.stereotype.Service;

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

ServiceImpl 是 MyBatis-Plus 提供的一个基础实现类，已经为你提供了很多常见的 CRUD 方法。

7. 创建 Controller 层

在 Controller 层中，注入 UserService，然后使用它提供的方法进行数据操作。

package com.example.demo.controller;

import com.example.demo.entity.User;
import com.example.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @PostMapping
    public boolean save(@RequestBody User user) {
        return userService.save(user);
    }

    @GetMapping("/{id}")
    public User getById(@PathVariable Long id) {
        return userService.getById(id);
    }

    @GetMapping
    public List<User> list() {
        return userService.list();
    }

    @PutMapping
    public boolean update(@RequestBody User user) {
        return userService.updateById(user);
    }

    @DeleteMapping("/{id}")
    public boolean delete(@PathVariable Long id) {
        return userService.removeById(id);
    }
}

在上述 Controller 中：

• save 方法：保存用户。
• getById 方法：根据 ID 获取用户。
• list 方法：获取所有用户。
• update 方法：更新用户信息。
• delete 方法：删除用户。

8. 启动应用

确保数据库中已经创建了 user 表，并且数据库连接配置正确。运行 Spring Boot 应用，在浏览器或 Postman 中测试 RESTful API。

四、Mybatis-Plus 提供的功能

1. 分页查询

MyBatis-Plus 提供了分页插件，可以很方便地进行分页查询：

package com.example.demo.service;

import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public Page<User> getUserPage(int pageNum, int pageSize) {
        Page<User> page = new Page<>(pageNum, pageSize);
        return userMapper.selectPage(page, null);
    }
}

Page 类提供了分页查询的功能，通过传入页码和每页条数，就能得到分页的结果。

2. 乐观锁插件

MyBatis-Plus 还提供了乐观锁插件，在高并发情况下避免数据冲突。配置非常简单，只需要在实体类中添加一个版本号字段：

package com.example.demo.entity;

import com.baomidou.mybatisplus.annotation.Version;
import lombok.Data;

@Data
public class User {

    private Long id;

    private String name;

    private Integer age;

    private String email;

    @Version  // 标识版本号字段
    private Integer version;
}

配置好后，MyBatis-Plus 会在更新时自动处理版本号，确保乐观锁的实现。

五、总结

通过整合 MyBatis-Plus，Spring Boot 开发中的数据库操作变得更加简单和高效。MyBatis-Plus 提供了很多有用的功能来简化开发过程，减少了重复代码，提高了开发效率。通过本文的介绍，相信大家可以快速上手并运用 MyBatis-Plus 来开发高效的数据库操作。