mybatisplus学习笔记
Mybatisplus小结
#简介
什么是mybatisplus：
MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 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 操作智能分析阻断，也可自定义拦截规则，预防误操作
支持数据库支持数据库
- mysql 、mariadb 、oracle 、db2 、h2 、hsql 、sqlite 、postgresql 、sqlserver 、presto 、Gauss 、Firebird
- Phoenix 、clickhouse 、Sybase ASE 、 OceanBase 、达梦数据库 、虚谷数据库 、人大金仓数据库 、南大通用数据库
快速入门
地址：https://mp.baomidou.com/guide/quick-start.html#初始化工程
使用第三方组件的基本步骤：
- 导入对应的依赖
- 研究依赖如何配置
- 代码如何编写
- 提高扩展技术能力
步骤
-
创建数据夸 mybatis_pius
-
创建user表
DROP TABLE IF EXISTS user; CREATE TABLE `user` ( `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT, `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间', `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '最后修改时间', `mobile` bigint(11) DEFAULT NULL COMMENT '手机号', `status` tinyint(3) unsigned NOT NULL DEFAULT '0' COMMENT '状态，0 正常、1 锁定、2 删除', `is_admin` tinyint(3) unsigned NOT NULL DEFAULT '0' comment '是否管理员:0,不是 1,是 （默认不是管理员） ', PRIMARY KEY (`id`), UNIQUE KEY `uni_mobile` (`mobile`) USING BTREE ) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4 comment '用户账号信息表'; -- 真实开发中，version（乐观锁）、deleted（逻辑删除）、gmt_create、gmt_modified -
编写项目，初始化项目 使用springboot
-
导入依赖
<dependency> <groupId>mysqlgroupId> <artifactId>mysql-connector-javaartifactId> dependency> <dependency> <groupId>org.projectlombokgroupId> <artifactId>lombokartifactId> dependency> <dependency> <groupId>com.baomidougroupId> <artifactId>mybatis-plus-boot-starterartifactId> <version>3.0.5version> dependency>说明：我们使用 mybatis-plus 可以节省我们大量的代码，尽量不要同时导入 mybatis 和 mybatisplus！版本的差异！
-
数据库配置，和mybatis一样
# mysql 5 驱动不同 com.mysql.jdbc.Driver # mysql 8 驱动不同com.mysql.cj.jdbc.Driver、需要增加时区的配置 serverTimezone=GMT%2B8 spring.datasource.username=root spring.datasource.password=123456 spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver -
传统方式（mybatis）和使用mybatisp之后的区别
（连接mybatis，配置mapper.xml文件）-service-controller
使用了mybatisplus之后
-
pojo
@Data @EqualsAndHashCode(callSuper = false) @Accessors(chain = true) @ApiModel(value="ActivityConf对象", description="活动配置表") public class ActivityConf implements Serializable { private static final long serialVersionUID = 1L; @ApiModelProperty(value = "自增ID") @TableId(value = "id", type = IdType.AUTO) private Long id; @ApiModelProperty(value = "创建时间") private Date createdAt; @ApiModelProperty(value = "最后修改时间") private Date modifiedAt; @ApiModelProperty(value = "活动开始时间") private Date activityStartTime; @ApiModelProperty(value = "活动结束时间") private Date activityEndTime; @ApiModelProperty(value = "领取活动奖励开始时间") private Date awardStartTime; @ApiModelProperty(value = "领取活动奖励结束时间") private Date awardEndTime; @ApiModelProperty(value = "活动场次编号") private Integer issue; @ApiModelProperty(value = "挑战开始时间") private Date challengeStartTime; @ApiModelProperty(value = "挑战结束时间") private Date challengeEndTime; @ApiModelProperty(value = "活动介绍") private String activityDescribe; }
-
mapper接口
import com.kuang.sw.blog.pojo.ActivityConf; import com.baomidou.mybatisplus.core.mapper.BaseMapper; /** ** 活动配置表 Mapper 接口 *
* * @author mantou * @since 2020-10-21 */ // 在对应的Mapper上面继承基本的类 BaseMapper @Repository // 代表持久层 public interface ActivityConfMapper extends BaseMapper<ActivityConf> { // 所有的CRUD操作都已经编写完成了 // 你不需要像以前的配置一大堆文件了！ } -
注意点，我们需要在主启动类上去扫描我们的mapper包下的所有接口
-
@MapperScan(“com.kuang.mapper”)
思考问题？
- SQL谁帮我们写的 ? MyBatis-Plus 都写好了
- 方法哪里来的？ MyBatis-Plus 都写好了
配置日志
我们所有的sql现在是不可见的，我们希望知道它是怎么执行的，所以我们必须要看日志！
# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
配置完毕日志之后，后面的学习就需要注意这个自动生成的SQL，你们就会喜欢上 MyBatis-Plus！
CRUD扩展
Insert 插入
// 测试插入
@Test
public void testInsert(){
User user = new User();
user.setName("狂神说Java");
user.setAge(3);
user.setEmail("[email protected]");
int result = userMapper.insert(user); // 帮我们自动生成id
System.out.println(result); // 受影响的行数
System.out.println(user); // 发现，id会自动回填
}
数据库插入的id的默认值为：全局的唯一id
主键生成策略
默认 ID_WORKER 全局唯一id
分布式系统唯一id生成：https://www.cnblogs.com/haoxinyue/p/5208136.html
雪花算法
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_WORKER(3), // 默认的全局唯一id UUID(4), // 全局唯一id uuid ID_WORKER_STR(5); //ID_WORKER 字符串表示法 }更新操作
// 测试更新 @Test public void testUpdate(){ User user = new User(); // 通过条件自动拼接动态sql user.setId(6L); user.setName("关注公众号：狂神说"); user.setAge(18); // 注意：updateById 但是参数是一个 对象！ int i = userMapper.updateById(user); System.out.println(i); }
所有的sql都是自动帮你动态配置的！
自动填充
创建时间、修改时间！这些个操作一遍都是自动化完成的，我们不希望手动更新！ 阿里巴巴开发手册：所有的数据库表：gmt_create、gmt_modified几乎所有的表都要配置上！而且需 要自动化！
方式一：数据库级别（工作中不允许你修改数据库）
- 在表中新增字段 create_time, update_time
- 再次测试插入方法，我们需要先把实体类同步！
private LocalDateTime createTime;
private LocalDateTime updateTime;
-
再次更新查看结果即可
方式二：代码级别
-
删除数据库的默认值、更新操作
-
实体类字段属性上需要增加注解
// 字段添加填充内容 @TableField(fill = FieldFill.INSERT) private LocalDateTime createTime; @TableField(fill = FieldFill.INSERT_UPDATE) private LocalDateTime 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 // 一定不要忘记把处理器加到IOC容器中！ 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 = newVersion where version = oldVersion
- 如果version不对，就更新失败
乐观锁：1、先查询，获得版本号 version = 1
-- A
update user set name = "kuangshen", version = version + 1
where id = 2 and version = 1
-- B 线程抢先完成，这个时候 version = 2，会导致 A 修改失败！
update user set name = "kuangshen", version = version + 1
where id = 2 and version = 1
测试一下MP的乐观锁插件
- 给数据库中增加version字段
-
我们实体类加对应的字段
@Version //乐观锁Version注解 private Integer version; -
注册组件
// 扫描我们的 mapper 文件夹
@MapperScan("com.kuang.mapper")
@EnableTransactionManagement
@Configuration // 配置类
public class MyBatisPlusConfig {
// 注册乐观锁插件
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
}
分页操作
分页在网站使用的十分之多！
-
分页在网站使用的十分之多！
-
pageHelper 第三方插件
-
MP 其实也内置了分页插件
如何使用
- 配置拦截器组件即可
// 分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
-
直接使用Page对象即可！
// 测试分页查询 @Test public void testPage(){ // 参数一：当前页 // 参数二：页面大小 // 使用了分页插件之后，所有的分页操作也变得简单的！ Page<User> page = new Page<>(2,5); userMapper.selectPage(page,null); page.getRecords().forEach(System.out::println); System.out.println(page.getTotal()); }删除操作
-
根据 id 删除记录
// 测试删除 @Test public void testDeleteById(){ userMapper.deleteById(1240620674645544965L); } // 通过id批量删除 @Test public void testDeleteBatchId(){ userMapper.deleteBatchIds(Arrays.asList(1240620674645544961L,124062067464554496 2L)); } // 通过map删除 @Test public void testDeleteMap(){ HashMap<String, Object> map = new HashMap<>(); map.put("name","狂神说Java"); userMapper.deleteByMap(map); }我们在工组中，其实都是逻辑删除
逻辑删除
物理删除 ：从数据库中直接移除
逻辑删除 ：再数据库中没有被移除，而是通过一个变量来让他失效！ deleted = 0 => deleted = 1
管理员可以查看被删除的记录！防止数据的丢失，类似于回收站！
测试一下：
-
在数据表中增加一个 deleted 字段
-
实体类中增加属性
@TableLogic //逻辑删除 private Integer deleted; -
配置
-
-
# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
-
测试一下
记录依旧在数据库，但是值确已经变化了！
条件构造器
简单介绍一下，关键是平时多用用就好，很简单的
十分重要：Wrapper
我们写一些复杂的sql就可以使用它来替代！
代码自动生成器
dao、pojo、service、controller都给我自己去编写完成！ AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、 Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。
package com.kuang;
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 CodeGenerator {
public static void main(String[] args) {
// 需要构建一个 代码自动生成器 对象
AutoGenerator mpg = new AutoGenerator();
// 配置策略
// 1、全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("mantou");
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://172.27.83.133:3306/planet?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("tom_user");
dsc.setPassword("Ipk21n8aKv8wX5Ro1fvm");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
//3、包的配置
PackageConfig pc = new PackageConfig();
pc.setModuleName("blog");
pc.setParent("com.kuang.sw");
pc.setEntity("pojo");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");
mpg.setPackageInfo(pc);
//4、策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("activity_conf"); // 设置要映射的表名
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true); // 自动lombok；
strategy.setLogicDeleteFieldName("deleted");
// 自动填充配置
TableFill gmtCreate = new TableFill("updated_at", FieldFill.INSERT);
TableFill gmtModified = new TableFill("updated_at", 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(); //执行
}
}
