一文吃透SpringBoot整合mybatis-plus（保姆式教程）-灵析社区

首先创建一个 SpringBoot 项目，具体创建步骤可以参见我的上一篇博文：SpringBoot 项目的创建与启动。

手动整合 mybatis-plus 详解

1、引入依赖

在 pom.xml 文件中添加相关依赖，代码如下：
<?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.5.12</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>cn.kgc</groupId>
    <artifactId>springboot04</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot04</name>
    <description>springboot04</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <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>
        </dependency>
        <!--引入mybatis-plus依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>
        <!--引入mysql依赖-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--引入druid连接池依赖-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.9</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

2、创建基本目录结构

在新创建的springboot项目中的cn.kgc.springboot04包下创建如下图所示的目录结构，再在resources目录下创建mapper目录。

3、配置 application.yml

将下图中 application.properties 文件改为 application.yml 风格的文件

在application.yml文件中添加相关配置，配置代码如下：

server:
  port: 8888
spring:
  #配置数据源
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource
    url: jdbc:mysql:///java2218?serverTimezone=UTC&useSSL=false&characterEncoding=UTF-8
    username: root
    password: huanghuang
#配置mybatis-plus
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    map-underscore-to-camel-case: true
  type-aliases-package: cn.kgc.springboot04.entity
  mapper-locations: classpath:mapper/*.xml

4、在 entity 包下创建实体类

创建一个实体类 Admin，代码如下：

package cn.kgc.springboot04.entity;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import lombok.experimental.Accessors;

@Data
@TableName("admin")
@Accessors(chain = true)
public class Admin {
  @TableId(type = IdType.AUTO)
  private long adminId;
  @TableField("adminName")
  private String adminName;
  private long adminPassword;
  @TableField(exist = false)
  private String  sex;
}

@TableName(“admin”)：指定实体类对应数据库中表的名字，Admin类默认对应的表名为admin，当类名不为Admin时，添加此注解可解决此问题。

@Accessors(chain = true) ：通过链式调用完成对象创建；如：Admin admin = new Admin().setAdminName(“小明”).setAdminPassword(123456);

@TableId(type = IdType.AUTO) ：指定主键自增策略，如果数据库为给主键添加自增属性，通过此注解可以添加自增功能。

@TableField(“adminName”)：当实体类的属性名与数据库的字段名不一致时，使用此注解可以指定属性名对应数据库中的哪个字段对应。

@TableField(exist = false)：指定当前属性在数据库中不存在对应的字段忽略该字段的操作。

5、创建 Mapper 接口

创建 AdminMapper 接口，使其继承 BaseMapper 类实现ORM操作，代码如下：

package cn.kgc.springboot04.mapper;

import cn.kgc.springboot04.entity.Admin;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;

public interface AdminMapper extends BaseMapper<Admin> {
}

其中，BaseMapper提供了常用的CRUD、分页、批量操作等方法。

6、创建 Mapper.xml 文件

创建 AdminMapper.xml 文件，使其的 namespace 为 AdminMapper 接口的路径地址，代码如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="cn.kgc.springboot04.mapper.AdminMapper">

</mapper>

7、创建 Service 接口

创建 AdminService 接口，使其继承 IService 类，代码如下：

package cn.kgc.springboot04.service;

import cn.kgc.springboot04.entity.Admin;
import com.baomidou.mybatisplus.extension.service.IService;

public interface AdminService extends IService<Admin> {
}

8、创建 ServiceImpl 实现类

创建 AdminServiceImpl 实现类，使其继承 ServiceImpl 类以及继承 AdminService 接口，代码如下：

package cn.kgc.springboot04.service.impl;

import cn.kgc.springboot04.entity.Admin;
import cn.kgc.springboot04.mapper.AdminMapper;
import cn.kgc.springboot04.service.AdminService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;

@Service
public class AdminServiceImpl extends ServiceImpl<AdminMapper, Admin> implements AdminService {
}

9、创建 Controller 控制类

创建 AdminController 控制类，代码如下：
package cn.kgc.springboot04.controller;

import cn.kgc.springboot04.entity.Admin;
import cn.kgc.springboot04.service.AdminService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
@RequestMapping("admin")
public class AdminController {

    @Autowired
    AdminService adminService;

    //查询所有管理员
    @RequestMapping("list")
    public List<Admin> getList(){
        return adminService.list();
    }

    //增加或者修改一条数据
    @RequestMapping("savaOrUpdate")
    public String insertOne(Admin admin){
        boolean save = adminService.saveOrUpdate(admin);
        return ""+save;
    }

    //删除一条数据
    @RequestMapping("delete")
    public String deleteOne(Integer id){
        boolean b = adminService.removeById(id);
        return ""+b;
    }
}

10、测试

下面，我们就一一测试不同接口的运行效果吧！

【1】查询所有数据：在浏览器输入（http://localhost:8888/admin/list ）

测试结果如下：

【2】插入一条数据：在浏览器输入（http://localhost:8888/admin/savaOrUpdate?adminname=赵敏&adminpassword=123456）

测试结果如下：

添加数据后，数据库数据显示如下：

【3】修改一条数据：在浏览器输入（http://localhost:8888/admin/savaOrUpdate?adminname=赵敏&adminpassword=888888&adminid=1006）

测试结果如下：

修改数据后，数据库数据显示如下：

【4】删除一条数据：在浏览器输入（http://localhost:8888/admin/delete?id=1006）

测试结果如下：

如下图，删除数据后，数据库的这条记录便不存在了。

自动整合 mybatis-plus 详解

1、引入依赖

在 pom.xml 文件中添加相关依赖，代码如下：
<?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.5.12</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>cn.kgc</groupId>
    <artifactId>springboot05</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot05</name>
    <description>springboot05</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <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>
        </dependency>
        <!--引入mybatis-plus依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>
        <!--引入mysql依赖-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--引入druid连接池依赖-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.9</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

2、配置 application.yml

将下图中 application.properties 文件改为 application.yml 风格的文件

在application.yml文件中添加相关配置，配置代码如下：

server:
  port: 9999
spring:
  #配置数据源
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource
    url: jdbc:mysql:///java2218?serverTimezone=UTC&useSSL=false&characterEncoding=UTF-8
    username: root
    password: huanghuang
#配置mybatis-plus
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    map-underscore-to-camel-case: true
  type-aliases-package: cn.kgc.springboot04.entity
  mapper-locations: classpath:mapper/*.xml