MyBatis-Plus 介绍和使用

最新推荐文章于 2024-08-17 18:33:23 发布

zhou_zhao_xu

最新推荐文章于 2024-08-17 18:33:23 发布

阅读量929

点赞数

分类专栏： mybatis spring java

本文链接：https://blog.csdn.net/zhou_zhao_xu/article/details/119168809

版权

本文介绍了MyBatis-Plus 3.4.3.1的集成步骤和主要功能，包括通用CRUD操作、QueryWrapper条件构造器、ActiveRecord模式、代码生成器、分页插件、执行分析插件和乐观锁插件等，旨在简化数据库操作并提高开发效率。

摘要由CSDN通过智能技术生成

1. 简介

本文使用 mybatis-plus 版本 3.4.3.1

1.1 MyBatis-Plus 介绍

MyBatis-Plus(简称MP)，是一个 MyBatis 的增强工具包，只做增强不做改变，为简化开发工作、提高生产效率而生。

愿景
我们的愿景是成为 MyBatis 最好的搭档，就像魂斗罗中的 1P、2P，基友搭配，效率翻倍。

1.2 代码及文档发布地址

官网地址：https://baomidou.com
GitHub地址：https://github.com/baomidou/mybatis-plus
Gitee地址：https://gitee.com/baomidou/mybatis-plus
官方文档地址：https://baomidou.com/guide/

2. 集成 MyBatis-Plus

2.1 创建测试库表

-- 创建库
CREATE DATEBASE mp DEFAULT CHARACTER SET utf8 ;
-- 使用库
use mp;
-- 创建表
CREATE TABLE tbl_employee(
  `id` INT NOT NULL AUTO_INCREMENT,
  `last_name` VARCHAR(45) NULL,
  `email` VARCHAR(45) NULL,
  `gender` CHAR(1) NULL,
  `age` INT NULL,
  PRIMARY KEY (`id`));
insert into mp.tbl_employee(last_name,email,gender,age) values('Tom','tom@163.com',1,22);
insert into mp.tbl_employee(last_name,email,gender,age) values('Jerry','jerry@163.com',0,25);
insert into mp.tbl_employee(last_name,email,gender,age) values('Black','black@163.com',1,30);
insert into mp.tbl_employee(last_name,email,gender,age) values('White','white@163.com',0,35);

创建 Spring Boot 项目

2.2 创建 JavaBean

/**
 * @data: 2021/7/28 11:19 PM
 *
 * Mybatis-Plus 会默认使用实体类的类名到数据库中找对应的表
 * 如果表名和实体类类名不一致时，可以使用 @TableName 指定表名
 */
@Data
@ToString
@TableName("tbl_employee")
public class Employee {
   

    /**
     * @TableId
     *  value: 指定表中的主键列名，如果实体类属性名和列名一致，可以省略不指定
     *  type: 指定主键策略
     */
    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    @TableField(value = "last_name")
    private String lastName;
    private String email;
    private Integer gender;
    private Integer age;
}

2.3 依赖配置

pom 依赖

<?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.3</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.zzx.mp</groupId>
    <artifactId>mp01</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>mp01</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.3.1</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.2.6</version>
        </dependency>
        <dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

加入 Mybatis 的全局配置文件 mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    
</configuration>

加入 logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>

    <!--mybatis log configure-->
    <logger name="com.zzx.mp.mapper" level="DEBUG"/>
    <logger name="java.sql.Connection" level="DEBUG"/>
    <logger name="java.sql.Statement" level="DEBUG"/>
    <logger name="java.sql.PreparedStatement" level="DEBUG"/>

    <!-- 日志输出级别 -->
    <root level="DEBUG">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

配置 yaml 配置文件

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mp?rewriteBatchedStatements=true&useUnicode=true&characterEncoding=utf-8&characterSetResults=UTF-8&autoReconnect=true&allowMultiQueries=true&useSSL=false
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: 123456
mybatis-plus:
  mapper-locations: classpath:/mapper/**/*.xml
  type-aliases-package: com.zzx.mp.beans
  
logging:
  level:
    com.zzx.mp.mapper: debug

2.4 测试数据库连接

@SpringBootTest
@Slf4j
class Mp01ApplicationTests {
   

    @Autowired
    DataSource dataSource;

    @Test
    void testDataSource() throws SQLException {
   
        System.out.println("------------ dataSource " + dataSource);
        Connection connection = dataSource.getConnection();
        System.out.println("------------ connection " + connection);
    }

}

3. MyBatis-Plus 简单及QueryWrapper的使用

3.1 通用CRUD

实现方式：

基于 MyBatis
需要编写mapper接口，并手动编写CRUD方法
提供mapper.xml文件，并手动编写每个方法对应的SQL语句

基于 MyBatis-Plus
只需要创建mapper接口，并继承BaseMapper接口，就可以使用MyBatis-Plus完成需要的所有操作，甚至不需要创建SQL映射文件

注解解释

MyBatis-Plus注解官网解释：https://mp.baomidou.com/guide/annotation.html#

注意：插入操作时，如果没有设置主键值，MyBatis-Plus 会自动帮我们生成主键
可以通过下面IdType的值设置主键策略

IdType	值	描述
	AUTO	数据库ID自增
	NONE	无状态,该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)
	INPUT	insert前自行set主键值
	ASSIGN_ID	分配ID(主键类型为Number(Long和Integer)或String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)
	ASSIGN_UUID	分配UUID,主键类型为String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默认default方法)
	~~ID_WORKER~~	分布式全局唯一ID 长整型类型(please use ASSIGN_ID)
	~~UUID~~	32位UUID字符串(please use ASSIGN_UUID)
	~~ID_WORKER_STR~~	分布式全局唯一ID 字符串类型(please use ASSIGN_ID)

@TableName
Mybatis-Plus 会默认使用实体类的类名到数据库中找对应的表
如果表名和实体类类名不一致时，可以使用 @TableName 指定表名

@TableId
value: 指定表中的主键列名，如果实体类属性名和列名一致，可以省略不指定
type: 指定主键策略

@TableField
value: 指定数据库表中的字段值，如果实体类属性名和列名一致，可以省略不指定
exist: 是否为数据库表字段,如果数据库表中不存在此字段设置为 false，默认为true
全局策略配置
注意：使用全局策略配置前缀和主键类型后，在实体类中就可以不用配置 @TableName、@TableId了
mybatis-plus:
  mapper-locations: classpath:/mapper/**/*.xml
  type-aliases-package: com.zzx.mp.beans
  # mybatis-plus 全局策略配置
  global-config:
    db-config:
      # 配置表名前缀
      table-prefix: tbl_
      # 配置主键类型
      id-type: auto
- 插入数据获取主键值
MyBatis-Plus在插入数据时会自动获取当前数据的主键值

3.2 插入操作

编写 mapper

package com.zzx.mp.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.zzx.mp.beans.Employee;
import org.apache.ibatis.annotations.Mapper;

/**
 * @data: 2021/7/28 11:23 PM
 *
 * 使用 MyBatis-Plus 完成基本的CRUD，只要继承 BaseMapper<T>接口即可
 * BaseMapper<T> : 泛型指定的就是当前mapper接口所操作的实体类类型
 */
@Mapper
public interface EmployeeMapper extends BaseMapper<Employee> {
   

}

// 插入一条记录
int insert(T entity);

测试

    @Autowired
    private EmployeeService employeeService;
    
    /**
     * 通用 插入操作
     */
    @Test
    void testCommonInsert(){
   
        Employee employee = new Employee();
        employee.setLastName("王八");
        employee.setEmail("wangba@163.com");
        //employee.setGender(1);
        //employee.setAge(20);

        int insert = employeeMapper.insert(employee);
        System.out.println(insert);
        // 获取当前数据在数据库中的主键
        System.out.println(employee.getId());
    }

3.3 更新操作

// 根据 whereWrapper 条件，更新记录
int update(@Param(Constants.ENTITY) T updateEntity, @Param(Constants.WRAPPER) Wrapper<T> whereWrapper);
// 根据 ID 修改
int updateById(@Param(Constants.ENTITY) T entity);

测试

    @Test
    void testCommonUpdate() {
   
        Employee employee =<

最低0.47元/天解锁文章

zhou_zhao_xu

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录