MyBatis-Plus:官网
MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window) 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
愿景
我们的愿景是成为 MyBatis 最好的搭档,就像 魂斗罗 中的 1P、2P,基友搭配,效率翻倍。
特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
快速入门
地址:快速开始
使用第三方组件:
- 导入对应的依赖
- 研究依赖如何配置
- 代码如何编写
- 提高扩展技术能力
步骤
- 创建数据库
mybatis_plus
- 创建
user
表并导入数据
DROP TABLE IF EXISTS user;
CREATE TABLE user
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
age INT(11) 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');
- 创建一个spring boot项目导入依赖
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.20</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.2</version>
</dependency>
说明:我们使用mybatis-plus可以节省我们大量的代码,尽量不要同时导入mybatis和mybatis-plus!版本差异!
- 连接数据库,这一步和mybatis相同!
# mysql5
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?userSSL=true&useUnicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
- 创建实体类
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
- 编写Mapper接口
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.itzhao.pojo.User;
import org.apache.ibatis.annotations.Mapper;
// 在对应的mapper上面继承基本的类BAseMapper
@Mapper // 代表持久层
public interface UserMapper extends BaseMapper<User> {
// 所有的CRUD操作都已经编写完成了
// 不需要像以前一样配置一大堆文件了
}
- 注意点在启启动类加入扫描注解
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@MapperScan("com.itzhao.mapper")
@SpringBootApplication
public class MybatisplusApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisplusApplication.class, args);
}
}
- 编写测试类
import com.itzhao.mapper.UserMapper;
import com.itzhao.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
@SpringBootTest
class MybatisplusApplicationTests {
// 继承了BaseMapper,所有的方法都来自父类,我们也可以编写自己的扩展方法
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
// 查询全部用户
// 参数是一个Wrapper,条件构造器,这里我们先用null
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}
配置日志
# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
这样不仅仅有输出的结果,还能看到执行的sql
CRUD扩展
插入测试及雪花算法
添加功能
@Test
public void addUser() {
User user = new User();
user.setAge(18);
user.setEmail("1184546287@qq.com");
user.setName("赵毅梵");
int insert = userMapper.insert(user);
System.out.println(insert);
}
数据库插入的id的默认值为:全局的唯一id
主键生成策略
雪花算法:
snowflake是Twitter开源的分布式ID生成算法,结果是一个long类型的ID。其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID),12bit作为毫秒内的流水帐号(意味着每个节点在每毫秒可以产生4096个ID),最后还有一个符号位,永远是0。
主键自增
配置主键自增的步骤:
- 实体类字段上
@TableId(type = IdType.AUTO)
- 数据库字段一定要是自增!
其余的源码解释
public enum IdType {
AUTO(0), // 数据库id自增
NONE(1), // 未设置主键
INPUT(2), // 手动输入,需要自己写id
ASSIGN_ID(3), // 默认的全局唯一id
ASSIGN_UUID(4), // 全局唯一id uuid
ID_WORKER_STR(3) // ID_WORKER 字符串表示法
}
更新操作
@Test
public void textUpdate() {
// 通过条件自动拼接动态SQL
User user = new User();
user.setId(1L);
user.setName("赵毅梵");
int i = userMapper.updateById(user);
System.out.println(user);
System.out.println(i);
}
所有的sql都是自动帮你动态配置的
自动填充
创建时间、修改时间!这些个操作都是自动化完成的,我们不希望手动更新!
阿里巴巴开发手册:所有的数据库表:gmt_create、gmt_modified几乎所有的表都要配置上!而且需要自动化!
方式一:数据库级别(工作中不允许你修改数据库)
- 在表中新增字段:create_time、update_time
- 同步实体类,再次测试插入方法
private Date createTime;
private Date updateTime;
- 再次查看更新结果
方式二:代码级别
- 删除数据库的默认值、更新操作
- 实体类字段属性上需要增加注解
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
- 编写处理器来处理这个注解即可!
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.util.Date;
@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
// 插入时的填充策略
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill...");
// setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject)
this.setFieldValByName("createTime", new Date(), metaObject);
this.setFieldValByName("updateTime", new Date(), metaObject);
}
// 更新时的填充策略
@Override
public void updateFill(MetaObject metaObject) {
log.info("start update fill...");
this.setFieldValByName("updateTime", new Date(), metaObject);
}
}
- 插入测试,更新测试,观察时间即可!
乐观锁
乐观锁:顾名思义十分乐观,它总是认为不会出现问题,无论干什么不去上锁!如果出现了问题,再次更新值测试
悲观锁:顾名思义十分悲观,它总是认为总是出现问题,无论干什么都会上锁!再去操作
乐观锁实现方式:
- 取出记录时,获取当前version
- 更新时,带上这个version
- 执行更新时, set version = new Version where version = oldVersion
- 如果version不对,就更新失败
-- 线程A
update user set name = "yifan", version = version = 1
where id = 2 and version = 1
-- 线程B 线程B抢先完成,这个时候version = 2,会导致A修改失败!
update user set name = "yifan", version = version = 1
where id = 2 and version = 1
测试一下MP的乐观锁插件
- 给数据库增加
version
字段,默认值设为1 - 实体类添加对应的字段
@Version // 乐观锁Version注解
private Integer version;
- 注册组件
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
// 扫描到mapper文件夹
@MapperScan("com.itzhao.mapper")
@EnableTransactionManagement
// 配置类
@Configuration
public class MyBatisPlusConfig {
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
}
- 测试
测试乐观锁成功
@Test
public void testOptimisticLocker() {
// 1、查询用户信息
User user = userMapper.selectById(1L);
// 修改用户信息
user.setName("遗憾不是例外");
// 执行更新操作
userMapper.updateById(user);
}
测试乐观锁失败!多线程下
@Test
public void testOptimisticLocker2() {
User user = userMapper.selectById(2L);
user.setName("赵毅梵");
User user2 = userMapper.selectById(2L);
user2.setName("爱意随风起");
userMapper.updateById(user2);
userMapper.updateById(user);
}
查询操作
// 测试查询
@Test
public void testSelectById() {
User user = userMapper.selectById(1L);
System.out.println(user);
}
// 测试批量查询
@Test
public void testSelectByBrandId() {
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
// 按条件查询之一使用map操作
@Test
public void testSelectByMap() {
HashMap<String, Object> objectObjectHashMap = new HashMap<>();
objectObjectHashMap.put("name", "遗憾不是例外");
List<User> users = userMapper.selectByMap(objectObjectHashMap);
users.forEach(System.out::println);
}
分页查询
分页在网站的使用十分之多
- 原始的
limit
进行分页 pageHelper
第三方插件- MP其实也内置了分页插件
如何使用
- 配置拦截器组件
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
- 使用page对象
@Test
public void testPage() {
// 参数一:当前页
// 参数二:页面大小
Page<User> userPage = new Page<>(1, 5);
IPage<User> userIPage = userMapper.selectPage(userPage, null);
userIPage.getRecords().forEach(System.out::println);
System.out.println(userIPage.getTotal());
}
删除操作
管理员可以查看被删除的记录!防止数据丢失,类似于回收站!
步骤
- 新增表字段:
deleted
- 实体类增加属性
@TableLogic // 逻辑删除
private Integer deleted;
- 配置application文件
mybatis-plus.global-config.db-config.logic-delete-field=flag # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
mybatis-plus.global-config.db-config.logic-delete-value=1 # 逻辑已删除值(默认为 1)
mybatis-plus.global-config.db-config.logic-not-delete-value=0 # 逻辑未删除值(默认为 0)
- 测试