Mystpet's Blog

在日常开发中单表的CRUD功能代码重复度很高，也没有什么难度。而这部分代码量往往比较大，开发起来比较费时。

MybatisPlus就时为了简化或者省略单表CRUD开发工作的一个组件。

官方网站如下：MyBatis-Plus

当然，MybatisPlus不仅可以简单化单表操作，还对Mybatis的功能有很多的增强。可以让我们的开发更加简单，高效。

1.1.环境准备

在IDEA中打开给出的资料中的项目

项目结构如下：

接下来导入数据库表：

最后在application.yaml中修改jdbc参数为自己的数据库参数：

yaml

spring:  
  datasource:  
    url: jdbc:mysql://127.0.0.1:3306/mp?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai  
    driver-class-name: com.mysql.cj.jdbc.Driver  
    username: root  
    password: 1234  
logging:  
  level:  
    com.itheima: debug  
  pattern:  
    dateformat: HH:mm:ss

1.2.快速开始

1.2.1.引入依赖

MybatisPlus提供了starter，实现了自动MybatisPlus的自动装配功能，坐标如下：

XML

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

由于这个starter包含对mybatis的自动装配，因此可以完全替换掉Mybatis的starter。

最终，项目的依赖如下：

XML

<dependencies>
  
    <dependency>        
	    <groupId>org.springframework.boot</groupId>  
	    <artifactId>spring-boot-starter</artifactId>  
    </dependency>
        
    <dependency>        
	    <groupId>com.mysql</groupId>  
        <artifactId>mysql-connector-j</artifactId>  
        <scope>runtime</scope>  
    </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>
        
    <dependency>        
	    <groupId>com.baomidou</groupId>  
        <artifactId>mybatis-plus-boot-starter</artifactId>  
        <version>3.5.3.1</version>  
    </dependency>
        
    <dependency>        
	    <groupId>cn.hutool</groupId>  
        <artifactId>hutool-all</artifactId>  
        <version>5.8.11</version>  
    </dependency>
    
    </dependencies>

1.2.2.定义Mapper

为了简化单表CRUD，MybatisPlus提供了一个基础的BaseMapper接口，其中已经实现了单表的CRUD：

将自定义的Mapper实现BaseMapper，就无需自己实现单表CRUD了。

修改mp-demo中的com.itheima.mp.mapper包下的UserMapper接口，让其继承BaseMapper：

java

package com.itheima.mp.mapper;  
  
import com.baomidou.mybatisplus.core.mapper.BaseMapper;  
import com.itheima.mp.domain.po.User;  
import org.apache.ibatis.annotations.Param;  
  
import java.util.List;  
  
public interface UserMapper extends BaseMapper<User> {  
}

1.2.3.测试

新建测试类，编写单元测试，测试基本的CRUD功能：

java

package com.itheima.mp.mapper;  
  
import com.itheima.mp.domain.po.User;  
import org.junit.jupiter.api.Test;  
import org.springframework.beans.factory.annotation.Autowired;  
import org.springframework.boot.test.context.SpringBootTest;  
  
import java.time.LocalDateTime;  
import java.util.List;  
  
@SpringBootTest  
class UserMapperTest {  
  
    @Autowired  
    private UserMapper userMapper;  
  
    @Test  
    void testInsert() {  
        User user = new User();  
        user.setId(5L);  
        user.setUsername("Lucy");  
        user.setPassword("123");  
        user.setPhone("18688990011");  
        user.setBalance(200);  
        user.setInfo("{\"age\": 24, \"intro\": \"英文老师\", \"gender\": \"female\"}");  
        user.setCreateTime(LocalDateTime.now());  
        user.setUpdateTime(LocalDateTime.now());  
        userMapper.insert(user);  
    }  
  
    @Test  
    void testSelectById() {  
        User user = userMapper.selectById(5L);  
        System.out.println("user = " + user);  
    }  
  
  
    @Test  
    void testQueryByIds() {  
        List<User> users = userMapper.selectBatchIds(List.of(1L, 2L, 3L, 4L));  
        users.forEach(System.out::println);  
    }  
  
    @Test  
    void testUpdateById() {  
        User user = new User();  
        user.setId(5L);  
        user.setBalance(20000);  
        userMapper.updateById(user);  
    }  
  
    @Test  
    void testDeleteUser() {  
        userMapper.deleteById(5L);  
    }  
}

普通 MyBatis：

Mapper接口方法
        ↓
XML里的select/insert/update/delete
        ↓
执行SQL

MyBatis-Plus 的 BaseMapper：

BaseMapper里的通用方法
        ↓
MyBatis-Plus启动时自动注入SQL
        ↓
注册到MyBatis的MappedStatement中
        ↓
执行SQL

测试：

3.常见注解

MybatisPlus是如何知道我们要查询的是哪张表，表中有哪些字段的？

原因是UserMapper在继承BaseMapper的时候指定了一个泛型：

泛型中的User就是与数据库对应的PO。

MybatisPlus就是根据PO实体信息来推断出表的信息，从而生成SQL的。默认情况下：

MybatisPlus会把PO实体的类名驼峰转下划线作为表名
MybatisPlus会把PO实体的所有变量名驼峰转下划线作为表的字段名，并根据变量类型推断字段类型
MybatisPlus会把名为id的字段作为主键

但很多情况下，默认实现与实际场景不符，因此MybatisPlus提供了一些注解便于我们声明表信息。

1.3.1.@TableName

示例：

Java

@TableName("user")
public class User {
    private Long id;
    private String name;
}

TableName注解除了指定表名以外，还可以指定很多其它属性：

属性	类型	必须指定	默认值	描述
value	String	否	""	表名
schema	String	否	""	schema
keepGlobalPrefix	boolean	否	false	是否保持使用全局的 tablePrefix 的值（当全局 tablePrefix 生效时）
resultMap	String	否	""	xml 中 resultMap 的 id（用于满足特定类型的实体类对象绑定）
autoResultMap	boolean	否	false	是否自动构建 resultMap 并使用（如果设置 resultMap 则不会进行 resultMap 的自动构建与注入）
excludeProperty	String[]	否	{}	需要排除的属性名 @since 3.3.1

1.3.2.@TableId

示例：

Java

@TableName("user")
public class User {
    @TableId
    private Long id;
    private String name;
}

TableId注解支持两个属性：

属性	类型	必须指定	默认值	描述
value	String	否	""	表名
type	Enum	否	IdType.NONE	指定主键类型

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 方法)

这里比较常见的有三种：

AUTO：利用数据库的id自增长
INPUT：手动生成id
ASSIGN_ID：雪花算法生成Long类型的全局唯一id，这是默认的ID策略

1.3.3.@TableField

示例：

Java

@TableName("user")
public class User {
    @TableId
    private Long id;
    private String name;
    private Integer age;
    @TableField("is_married")
    private Boolean isMarried;
    @TableField("`concat`")
    private String concat;
}

一般情况下不需要给字段添加@TableField注解，一些特殊情况除外：

成员变量名与数据库字段名不一致
成员变量是以isXXX命名，按照JavaBean的规范，MybatisPlus识别字段时会把is去除，这就导致与数据库不符。
成员变量名与数据库一致，但是与数据库的关键字冲突。使用@TableField注解给字段名添加转义字符：``

支持的其它属性如下：


属性	类型	必填	默认值	描述
value	String	否	""	数据库字段名
exist	boolean	否	true	是否为数据库表字段
condition	String	否	""	字段 where 实体查询比较条件，有值设置则按设置的值为准，没有则为默认全局的 %s=#{%s}，参考(opens new window)
update	String	否	""	字段 update set 部分注入，例如：当在version字段上注解update="%s+1" 表示更新时会 set version=version+1 （该属性优先级高于 el 属性）
insertStrategy	Enum	否	FieldStrategy.DEFAULT	举例：NOT_NULL insert into table_a() values ()
updateStrategy	Enum	否	FieldStrategy.DEFAULT	举例：IGNORED update table_a set column=#
whereStrategy	Enum	否	FieldStrategy.DEFAULT	举例：NOT_EMPTY where
fill	Enum	否	FieldFill.DEFAULT	字段自动填充策略
select	boolean	否	true	是否进行 select 查询
keepGlobalFormat	boolean	否	false	是否保持使用全局的 format 进行处理
jdbcType	JdbcType	否	JdbcType.UNDEFINED	JDBC 类型 (该默认值不代表会按照该值生效)
typeHandler	TypeHander	否		类型处理器 (该默认值不代表会按照该值生效)
numericScale	String	否	""	指定小数点后保留的位数

1.4.常见配置

MybatisPlus也支持基于yaml文件的自定义配置，详见官方文档：使用配置 | MyBatis-Plus

大多数配置都有默认值，因此无需配置，单还有一些是没有默认值的，例如：

实体类的别名扫描包
全局id类型

YAML

mybatis-plus:
  type-aliases-package: com.itheima.mp.domain.po
  global-config:
    db-config:
      id-type: auto # 全局id类型为自增长

MyBatisPlus也支持手写SQL的，而mapper文件的读取地址可以自己配置：

YAML

mybatis-plus:
  mapper-locations: "classpath*:/mapper/**/*.xml" # Mapper.xml文件地址，当前这个是默认值。

可以看到默认值是classpath*:/mapper/**/*.xml，也就是说我们只要把mapper.xml文件放置这个目录下就一定会被加载。

1.短信登录

2.商户查询缓存

3.优惠卷秒杀

4.达人探店

5.好友关注

6.附近商铺

7.用户签到

8.UV统计

项目

项目

1.1.环境准备

1.2.快速开始

1.2.1.引入依赖

1.2.2.定义Mapper

1.2.3.测试

3.常见注解

1.3.1.@TableName

1.3.2.@TableId

1.3.3.@TableField

1.4.常见配置

1.1.环境准备 ​

1.2.快速开始 ​

1.2.1.引入依赖 ​

1.2.2.定义Mapper ​

1.2.3.测试 ​

3.常见注解 ​

1.3.1.@TableName ​

1.3.2.@TableId ​

1.3.3.@TableField ​

1.4.常见配置 ​

1.1.环境准备

1.2.快速开始

1.2.1.引入依赖

1.2.2.定义Mapper

1.2.3.测试

3.常见注解

1.3.1.@TableName

1.3.2.@TableId

1.3.3.@TableField

1.4.常见配置