mybatis-plus入门总结
1.为什么要学习MyBatisPlus?
- 可以节省我们大量的时间
- 所有的crud代码都可以自动生成
- JPA， tk-mapper，MyBatisPuls都可以实现自动生成CRUD
2.Mybatis的简介
官网 ：https://baomidou.com/guide/
MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
特性
- 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
- 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作
3.MybatisPlus快速入门
1.添加数据
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)
);
-- 执行SQL脚本
DELETE FROM user;
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');
2.初始化工程
可以使用 Spring lnitializer快速的初始化一个Spring Boot工程
3.添加依赖
<dependencies>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-testartifactId>
<scope>testscope>
dependency>
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-boot-starterartifactId>
<version>3.0.5version>
dependency>
<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
<version>5.1.47version>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
dependency>
dependencies>
4.编写实体类
package com.xjggb.entity;
import lombok.Data;
@Data
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
5.编写Mapper接口
package com.xjggb.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.xjggb.entity.User;
/*
* 不想在启动类添加包扫描可以添加这个注解 @Repository//代表持久层
* 已经实现CRUD功能了
* */
public interface UserMapper extends BaseMapper<User> {
}
6.编写service业务层
import com.xjggb.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class UserServlce {
@Autowired
private UserMapper userMapper;
/*
* 查询全部数据
* */
public List<User> selectList(){
return userMapper.selectList(null);
}
}
7.编写controller层
package com.xjggb.controller;
import com.xjggb.entity.User;
import com.xjggb.service.UserServlce;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
@RestController
public class UserCotroller {
@Autowired
private UserServlce userServlce;
/*
* 查询全部数据
* */
@GetMapping("/hello")
public List<User> selectList(){
return userServlce.selectList() ;
}
}
小结：
- 通过以上的简单步骤就实现了User表的CRUD功能，
- 连XML文件都不需要写
- 以上步骤可以看出集成Mybatis-Plus非常的简单只需要引入依赖配置mapper的配置路径扫描，继承BaseMapper<>
- MybatisPlus的强大不止这些，想要详细的了解他的强大功能，慢慢的往下看
4.配置日志
#配置日志
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
小结：
- 亲配置完日志你会爱上Mybatis-Plus
5.CRUD扩展
1.插入数据
@Test
public void show01(){
User user = new User();
user.setName("行健乖乖霸");
user.setAge(18);
user.setEmail("[email protected]");
// 插入数据
mapper.insert(user);
}
注意点：数据库插入的id默认值为：雪花id
2.主键生成策列
-
自动增长
优点： 1）简单，代码方便，性能可以接受。 2）数字ID天然排序，对分页或者需要排序的结果很有帮助。 缺点： 1）不同数据库语法和实现不同，数据库迁移的时候或多数据库版本支持的时候需要处理。 2）在单个数据库或读写分离或一主多从的情况下，只有一个主库可以生成。有单点故障的风险。 3）在性能达不到要求的情况下，比较难于扩展。（不适用于海量高并发） 4）如果遇见多个系统需要合并或者涉及到数据迁移会相当痛苦。 5）分表分库的时候会有麻烦。 6）并非一定连续，类似MySQL，当生成新ID的事务回滚，那么后续的事务也不会再用这个ID了。这个在性能和连续性的折中。如果为了保证连续，必须要在事务结束后才能生成ID，那性能就会出现问题。 7）在分布式数据库中，如果采用了自增主键的话，有可能会带来尾部热点。分布式数据库常常使用range的分区方式，在大量新增记录的时候，IO会集中在一个分区上，造成热点数据。 -
UUID
优点： 1）简单，代码方便。 2）生成ID性能非常好，基本不会有性能问题。 3）全球唯一，在遇见数据迁移，系统数据合并，或者数据库变更等情况下，可以从容应对 缺点： 1）没有排序，无法保证趋势递增。 2）UUID往往是使用字符串存储，查询的效率比较低。 3）存储空间比较大，如果是海量数据库，就需要考虑存储量的问题。 4）传输数据量大 5）不可读。 -
Redis生成id
优点： 1）不依赖于数据库，灵活方便，且性能优于数据库。 2）数字ID天然排序，对分页或者需要排序的结果很有帮助。 缺点： 1）如果系统中没有Redis，还需要引入新的组件，增加系统复杂度。 2）需要编码和配置的工作量比较大。 -
Twitter的snowflake算法(分布式id：雪花id)
snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。具体实现的代码可以参看https://github.com/twitter/snowflake。雪花算法支持的TPS可以达到419万左右（2^22*1000）。
优点： 1）不依赖于数据库，灵活方便，且性能优于数据库。 2）ID按照时间在单机上是递增的。 缺点： 1）在单机上是递增的，但是由于涉及到分布式环境，每台机器上的时钟不可能完全同步，在算法上要解决时间回拨的 问题。 -
利用zookeeper生成唯一ID
zookeeper主要通过其znode数据版本来生成序列号，可以生成32位和64位的数据版本号，客户端可以使用这个版本号来作为唯一的序列号。 很少会使用zookeeper来生成唯一ID。主要是由于需要依赖zookeeper，并且是多步调用API，如果在竞争较大的情况下，需要考虑使用分布式锁。因此，性能在高并发的分布式环境下，也不甚理想。
3.主键自增
1.修改实体类
@Data
public class User {
// 对应的数据库中的主键（UUID,自增id redis zookeeper 雪花id）
@TableId(type = IdType.AUTO) //配置主键自增
private Long id;
private String name;
private Integer age;
private String email;
}
2.修改数据库自增
3.测试
@Test
public void show01(){
User user = new User();
user.setName("行健乖乖霸");
user.setAge(18);
user.setEmail("[email protected]");
// 插入数据
mapper.insert(user);
}
4.结果
5.IdType的源码解析
public enum IdType {
AUTO(0),//数据库ID自增
NONE(1),//该类型为未设置主键类型
INPUT(2),//用户输入ID
//该类型可以通过自己注册自动填充插件进行填充
//以下3种类型、只有当插入对象ID 为空，才自动填充。
ID_WORKER(3),//全局唯一ID (idWorker) 也是默认的id类型
UUID(4),//全局唯一ID (UUID)
ID_WORKER_STR(5);//字符串全局唯一ID (idWorker 的字符串表示)
小结：
- 了解了主键策列的优缺点
- 掌握了Mybatis-plus对主键的集成
4.更新数据
1.测试代码
/*
* 测试更新
* */
@Test
public void show02(){
User user = new User();
user.setId(1403046980736827394L);
user.setName("我乃是行健乖乖霸");
// 注意updateById参数是一个对象
mapper.updateById(user);
}
小结：
- sql的更新是动态的他会根据参数进行拼接
5.自动填充
- 实现元对象处理器接口：com.baomidou.mybatisplus.core.handlers.MetaObjectHandler
- 注解填充字段
@TableField(.. fill = FieldFill.INSERT)生成器策略部分也可以配置！
1.给数据库添加字段
2.添加实体类
// 添加字段自动填充 一定要用util包下的DATE
@TableField(fill = FieldFill.INSERT)
private Date creatTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
}
3.编写类实现实现com.baomidou.mybatisplus.core.handlers.MetaObjectHandler接口
@Slf4j
@Component //交给Spring容器进行管理
public class MyMetaObjecHandler implements MetaObjectHandler {
//插入填充策列
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert 自动填充开始了");
this.setFieldValByName("creatTime",new Date(),metaObject);
this.setFieldValByName("updateTime",new Date(),metaObject);
}
//更新填充策列
@Override
public void updateFill(MetaObject metaObject) {
log.info("start update 自动填充开始了 ");
this.setFieldValByName("updateTime",new Date(),metaObject);
}
}
4.测试
/*
* 插入数据
* */
@Test
public void show01(){
User user = new User();
user.setName("行健乖乖霸");
user.setAge(18);
user.setEmail("[email protected]");
// 插入数据
mapper.insert(user);
}
/*
* 测试更新
* */
@Test
public void show02(){
User user = new User();
user.setId(1403046980736827394L);
user.setName("我乃是行健乖乖霸");
user.setAge(23);
user.setEmail("[email protected]");
// 注意updateById参数是一个对象
mapper.updateById(user);
}
5.结果
- FieldFill源码解析
public enum FieldFill {
/**
* 默认不处理
*/
DEFAULT,
/**
* 插入填充字段
*/
INSERT,
/**
* 更新填充字段
*/
UPDATE,
/**
* 插入和更新填充字段
*/
INSERT_UPDATE
}
注意事项：
1.填充原理是直接给entity的属性设置值!!!
2.注解则是指定该属性在对应情况下必有值,如果无值则入库会是null
3.MetaObjectHandler提供的默认方法的策略均为:如果属性有值则不覆盖,如果填充值为null则不填充
4.字段必须声明TableField注解,属性fill选择对应策略,该声明告知Mybatis-Plus需要预留注入SQL字段
5填充处理器MyMetaObjectHandler在 Spring Boot 中需要声明@Component或@Bean注入
6要想根据注解FieldFill.xxx和字段名以及字段类型来区分必须使用父类的strictInsertFill或者strictUpdateFill方法
7不需要根据任何来区分可以使用父类的fillStrategy方法
小结：
-
了解时间的自动填充
-
在属性中添加注解@TableField(fill = FieldFill.INSERT)
-
实现接口com.baomidou.mybatisplus.core.handlers.MetaObjectHandler
-
重写两个方法：insertFill(MetaObject metaObject) updateFill(MetaObject metaObject)
6.逻辑删除
1.添加字段
2.实体类添加字段
//逻辑删除
@TableLogic
private Integer deleted;
3.添加配置文件
mybatis-plus:
global-config:
db-config:
logic-not-delete-value: 0 #逻辑与删除（默认为1）
logic-delete-value: 1 # 逻辑为删除（默认为0）
4.注册逻辑删除
@Configuration
public class MyLogicDeleteHandler {
// 注册删除逻辑
@Bean
public ISqlInjector sqlInjector(){
return new LogicSqlInjector();
}
}
5.测试
/*
* 逻辑删除
* */
@Test
public void show04(){
int i = mapper.deleteById(1403046980736827394L);
System.out.println("i = " + i);
}
/*
* 根据id查询
* */
@Test
public void show05(){
User user = mapper.selectById(1403046980736827394L);
System.out.println(user);
}
6.结果
小结：
逻辑删除是假删除，把是否删除字段状态改为被删状态，数据库仍然有这条数据
7.查询操作
/*
* 根据id查询
* */
@Test
public void show05(){
User user = mapper.selectById(1403046980736827394L);
System.out.println(user);
}
/*
* 测试批量查询
* */
@Test
public void show06(){
List<Long> longs = Arrays.asList(1403046980736827395L, 1403046980736827396L, 1403046980736827393L);
List<User> users = mapper.selectBatchIds(longs);
users.forEach(System.out::println);
}
/*
* 按查询条件查询
* */
@Test
public void show(){
HashMap<String, Object> map = new HashMap<>();
// 添加条件
map.put("name","小果说java");
map.put("age","18");
List<User> users = mapper.selectByMap(map);
users.forEach(o-> System.out.println("o = " + o));
}
8分页查询
1.注册分页插件
// 注册分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
return paginationInterceptor;
}
2.测试
@Test
public void show07(){
Page<User> userPage = new Page<>(2,5);
mapper.selectPage(userPage,null);
List<User> records = userPage.getRecords();
records.forEach(o-> System.out.println("o = " + o));
}
3.结果
9.乐观锁
当要更新一条记录的时候，希望这条记录没有被别人更新
乐观锁实现方式：
- 取出记录时，获取当前version
- 更新时，带上这个version
- 执行更新时， set version = newVersion where version = oldVersion
- 如果version不对，就更新失败
1.注册乐观锁组件
// 注册乐观锁插件
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
2.实体类添加属性
@Version // 乐观锁的version注解
private Integer version;
3.测试
// 测试乐观锁失败!多线程下
@Test
public void testVersionFall(){
// 线程1
User user1 = mapper.selectById(1L);
user1.setName("fan111");
user1.setAge(14);
// 线程2
User user2 = mapper.selectById(1L);
user2.setName("fan222");
user2.setAge(24);
mapper.updateById(user2);
//自旋锁来多次尝试提交！
mapper.updateById(user1); //如果没有乐观锁就会覆盖插队线程的值
}
6.性能分析插件
我们平时开发会遇到一些慢sql
Mybatis-Plus提供了性能插件，如果超过了这个时间就会停止运行
1.注入插件
//性能分析插件
@Bean
@Profile({
"dev","test"}) //设置dev 和 test环境开启
public PerformanceInterceptor performanceInterceptor(){
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
performanceInterceptor.setMaxTime(1); //单位是毫秒（ms）
performanceInterceptor.setFormat(true);
return performanceInterceptor;
}
2.编写配置文件
#设置开发环境
profiles:
active: dev
3.测试
@Test
public void show06(){
List<Long> longs = Arrays.asList(1403046980736827395L, 1403046980736827396L, 1403046980736827393L);
List<User> users = mapper.selectBatchIds(longs);
users.forEach(System.out::println);
}
4.结果
5.sql执行过长请执行优化
//获取数据
public List getRecords() {
return this.records;
}
//后去总记录数
public long getTotal() {
return this.total;
}
public long getSize() {
return this.size;
}
public long getCurrent() {
return this.current;
}
7.条件构造器
@Test
public void show9(){
// 查询邮箱不为空的用户 查询用户不为空的用户 年龄大于18
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 添加条件
QueryWrapper<User> ge = wrapper.isNotNull("name").isNotNull("email").ge("age", 18);
mapper.selectList(ge).forEach(o-> System.out.println("o = " + o));
}
/*
* 根据名字查询
* */
@Test
public void show10(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
QueryWrapper<User> ge = wrapper.ge("name", "小果说java");
List<User> users = mapper.selectList(ge);
System.out.println("users = " + users);
}
/*
* 查询年龄在16~到30间
* */
@Test
public void show11(){
QueryWrapper<User> userQueryWrapper = new QueryWrapper<>();
// 添加条件
userQueryWrapper.between("age",16,30);
Integer integer = mapper.selectCount(userQueryWrapper);
System.out.println("=============="+integer);
}
/*
* 模糊查询
* */
@Test
public void show12(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.likeRight("email","test");
List<User> users = mapper.selectList(wrapper);
users.forEach(p-> System.out.println("p = " + p));
}
8.代码生成器
package com.xjggb;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import java.util.ArrayList;
public class Test {
public static void main(String[] args) {
// 需要构建一个 代码自动生成器 对象
AutoGenerator mpg = new AutoGenerator();
// 配置策略
// 1、全局配置
GlobalConfig gc = new GlobalConfig();
// String projectPath = System.getProperty("user.dir");
String projectPath = "D:\\mybatis-plus\\hello-mybatis-plus-02";
gc.setOutputDir(projectPath+"/src/main/java");
gc.setAuthor("小果说"); gc.setOpen(false);
gc.setFileOverride(false);
// 是否覆盖
gc.setServiceName("%sService");
// 去Service的I前缀
gc.setIdType(IdType.ID_WORKER);
gc.setDateType(DateType.ONLY_DATE);
gc.setSwagger2(true);
mpg.setGlobalConfig(gc);
//2、设置数据源
DataSourceConfig dsc = new DataSourceConfig();
// dsc.setUrl("jdbc:mysql://localhost:3306/kuang_community? useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
dsc.setUrl("jdbc:mysql://192.168.93.222:3306/user_day?useSSL=false&useUnicode=true&characterEncoding=utf-8");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("root");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
//3、包的配置
PackageConfig pc = new PackageConfig();
//只需要改实体类名字 和包名 还有 数据库配置即可
pc.setModuleName("blog"); pc.setParent("com.xjggb");
pc.setEntity("entity"); pc.setMapper("mapper");
pc.setService("service"); pc.setController("controller");
mpg.setPackageInfo(pc);
//4、策略配置
StrategyConfig strategy = new StrategyConfig();
// 设置要映射的表名 可以添加多个
strategy.setInclude("user");
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// 自动Lombok
strategy.setEntityLombokModel(true);
strategy.setLogicDeleteFieldName("deleted");
// 自动填充配置
TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(gmtCreate); tableFills.add(gmtModified);
strategy.setTableFillList(tableFills);
/* // 乐观锁
strategy.setVersionFieldName("version");
strategy.setRestControllerStyle(true);
strategy.setControllerMappingHyphenStyle(true);*/
// localhost:8080/hello_id_2
mpg.setStrategy(strategy);
mpg.execute(); //执行
}
}
9.Mybatis-Plus xml配置
mybatis-plus:
mapper-locations: mapper/*.xml
global-config:
db-config:
# 主键策略
id-type: auto
# 表名前缀
table-prefix: t
# 表名是否使用下划线间隔，默认：是
table-underline: true
# 添加mybatis配置文件路径
config-location: mybatis-config.xml
# 配置实体类包地址
type-aliases-package: org.ywb.demo.pojo
# 驼峰转下划线
configuration:
map-underscore-to-camel-case: true
小结：
- 使用Mybatis-Plus简化开发
- 大大的提高了开发速度