MyBatis-Plus
MyBatis-Plus概述
需要基础:学习过Spring、SpringMVC、Mybatis
为什么要学习它呢?MyBatisPlus可以节省我们大量的工作时间,所有的CRUD代码都可以自动化完成!
JPA、tk-mapper、MyBatisPlus
1、简介
是什么? Mybatis本来就是简化JDBC操作的!
官网:MyBatis-Plus
MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
框架结构
2、快速开始
官方文档:快速开始 | MyBatis-Plus
使用第三方组件:
1、导入对应依赖
2、研究依赖如何配置
3、代码如何编写?
4、提高拓展技术能力!
步骤
1、创建数据库mybatis_plus
2、创建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)
);
-- 真实开发中,version(乐观锁)、deleted(逻辑删除)、gmt_create、gmt_modified
其对应的数据库 Data 脚本如下:
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]');
3、编写项目,初始化项目!使用springboot初始化,删除多余文件
4、导入依赖
<!--数据库驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--Lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!--mybatis-plus-->
<!--mybatis-plus是自己开发的,并非官方的-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
说明:我们使用mybatis-plus可以节省我们大量的代码,尽量不要同时导入 mybatis 和 mybatis-plus !
5、连接数据库!这一步和 mybatis 相同!
# mysql 8
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
6、传统方式pojo-dao(连接mybatis,配置mapper.xml文件)-service-controller
6、使用了mybatis-plus之后
-
pojo
@Data @AllArgsConstructor @NoArgsConstructor public class User { private Long id; // 注意类型是Long,不然用到雪花算法,会产生0 private String name; private Integer age; private String email; }
-
mapper接口
// 在对应的Mapper上面继承基本的类 BaseMapper @Repository // 代表持久层 public interface UserMapper extends BaseMapper<User> { // 所有的CRUD操作已经编写完成 // 不需要像以前一样配置一大堆文件了 }
BaseMapper<>中已经实现了简单的CRUD,我们只需要继承 BaseMapper 并传入引用类型我们就可以直接父类调用方法
-
启动类添加
@MapperScan
,扫描mapper文件夹@MapperScan("com.dt.mapper") // 扫描 mapper 文件夹 @SpringBootApplication public class MybatisPlusApplication { public static void main(String[] args) { SpringApplication.run(MybatisPlusApplication.class, args); } }
-
测试类测试下是否能使用
@SpringBootTest class MybatisPlusApplicationTests { @Autowired private UserMapper userMapper; @Test void contextLoads() { // 参数是个Wapper,条件构造器,没有条件就写null // 查询全部用户 List<User> userList = userMapper.selectList(null); userList.forEach(System.out::println); } }
思考?
- SQL谁帮我们写的? Mybatis-plus帮我们写好了
- 方法哪里来的? Mybatis-plus都写好了,查看BaseMapper的源码就明白了
3、配置日志
我们现在所有的sql是不可见的,我们希望知道它是怎么执行的,所以我们必须要看日志!
# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
配置完毕日志之后,后面的学习就需要注意这个自动生成的SQL,你们就会喜欢上 MyBatis-Plus!
4、CRUD扩展
4.1、Insert插入
// 测试插入
@Test
void testInsert() {
User user = new User();
user.setName("Dt");
user.setAge(18);
user.setEmail("[email protected]");
int result = userMapper.insert(user); // 帮我们自带生成Id
System.out.println(result); // result为受影响行数
System.out.println(user); // 发现,id会自动回填
}
数据库插入的id的默认值为:全局的唯一id
4.2、主键生成策略
默认 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。可以保证几乎全球唯一! 具体实现的代码可以参看:https://github.com/twitter/snowflake。
主键自增:
因为我们数据库的user表是没有配置自增的
我们需要配置主键自增;
-
实体类字段上添加
@TableId(type = IdType.AUTO)
@Data @AllArgsConstructor @NoArgsConstructor public class User { // 对应数据库中的主键(uuid、自增id、雪花算法、redis) @TableId(type = IdType.AUTO) private Long id; // 注意类型是Long,不然用到雪花算法,会产生0 private String name; private Integer age; private String email; }
-
数据库字段一定要自增
- 再次测试插入即可!
其余的源码解释
public enum IdType {
AUTO(0), //数据库id自增
NONE(1), // 未设置主键
INPUT(2), // 手动输入
ID_WORKER(3), // 默认的全局唯一id
UUID(4), // 全局唯一id uuid
ID_WORKER_STR(5); // ID_WORKER 字符串表示法
}
测试 手动输入id
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
@TableId(type = IdType.INPUT) // 一旦开启手动输入id之后,就需要自己配置id了
private String name;
private Integer age;
private String email;
}
需要手动设置id,否则为null
手动设置id
@Test
void testInsert() {
User user = new User();
user.setId(6L);
user.setName("Dt");
user.setAge(18);
user.setEmail("[email protected]");
int result = userMapper.insert(user); // 帮我们自带生成Id
System.out.println(result); // result为受影响行数
System.out.println(user); // 发现,id会自动回填
}
4.3、Update更新
@Test
void testUpdate() {
User user = new User();
// 通过条件自动拼装动态sql
user.setId(6L);
user.setName("KyDestroy");
user.setAge(21);
// 注意:方法名是updateById 但参数是一个 对象!
int result = userMapper.updateById(user);
System.out.println(result);
}
发现 所有的sql都是自动帮我们动态配置的!
4.4、自动填充
创建时间、修改时间! 这些个操作一般都是自动化完成的,我们不希望手动更新!
阿里巴巴开发手册:所有的数据库表:gmt_create、gmt_modified几乎所有的表都要配置上!而且需要自动化!
方式一:数据库级别(工作中不允许你修改数据库)
1、在表中新增字段 create_time,update_time
注意:MySQL5.5这样设置会报错,datatime在mysql5.6之后的版本才支持根据时间戳更新
2、再次测试插入方法,我们需要先把实体类同步!
private Date createTime;
private Date updateTime;
3、再次更新查看结果即可
方式二:代码级别
1、删除数据库的默认值、更新操作!
2、实体类字段属性上需要增加注解
// 字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
3、编写处理器来处理这个注解即可!(建立一个handler包)
@Slf4j
@Component // 把处理器添加到IOC容器中
public class MyMetaObjectHandler implements MetaObjectHandler {
// 插入时的填充策略
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill ....");
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);
}
}
4、测试插入
5、测试更新、观察时间即可!(时间不是北京时间注意连接语句用serverTimezone=GMT%2B8
)
4.5、乐观锁
在面试过程中,我们经常会被问道乐观锁,悲观锁!这个其实非常简单
乐观锁 : 故名思意十分乐观,它总是认为不会出现问题,无论干什么不去上锁!如果出现了问题,再次更新值测试
悲观锁:故名思意十分悲观,它总是认为总是出现问题,无论干什么都会上锁!再去操作!
乐观锁实现方式:
- 取出记录时,获取当前 version
- 更新时,带上这个version
- 执行更新时, set version = newVersion where version = oldVersion
- 如果version不对,就更新失败
乐观锁:1、先查询,获得版本号 version = 1
-- A
update user set name="Dt", version = version + 1
where id = 2 and version = 1
-- B 线程抢先完成,这个时候 version = 2,会导致 A 修改失败!
update user set name="Dt", version = version + 1
where id = 2 and version = 1
CAS的机制是自旋锁(乐观锁的一种)
测试一下MP的乐观锁插件
1、给数据库中增加version字段!
)
2、我们实体类加对应的字段
@Version // 乐观锁version注解
private Integer version;
3、注册组件(建立一个config包)
@EnableTransactionManagement
@MapperScan("com.dt.mapper")
@Configuration
public class MyBatisPlusConfig {
// 注册乐观锁插件
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
}
4、测试下成功案例和失败案例
// 测试乐观锁成功案例
@Test
void testOptimisticLocker() {
// 1、查询用户信息
User user = userMapper.selectById(1L);
// 2、修改用户信息
user.setName("Dt");
user.setEmail("[email protected]");
// 3、执行更新操作
userMapper.updateById(user);
}
// 测试乐观锁失败案例
@Test
void testOptimisticLocker2() {
// 线程 1
User user = userMapper.selectById(1L);
user.setName("Dt111");
user.setEmail("[email protected]");
// 模拟另外一个线程执行插队操作
User user2 = userMapper.selectById(1L);
user2.setName("Dt222");
user2.setEmail("[email protected]");
userMapper.updateById(user2);
userMapper.updateById(user); // 如果没有乐观锁就会覆盖插队线程的值
}
失败案例:(解决方案:可以使用自旋锁来尝试多次提交)
4.6、Select查询
4.6.1、批量查询
// 批量查询
@Test
void testSelectByID() {
List<User> userList = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
userList.forEach(System.out::println);
}
4.6.2、条件查询
// 条件查询 map
@Test
void testSelectByBatchIds() {
HashMap<String, Object> map = new HashMap<>();
// 自定义查询
map.put("name", "Dt");
map.put("age", 18);
List<User> userList = userMapper.selectByMap(map);
userList.forEach(System.out::println);
}
4.6.3、分页查询
分页在网站使用的十分之多!
分页方式:
- 原始的 limit 进行分页
- pageHelper 第三方插件
- MP 其实也内置了分页插件!
如何使用!
1、配置拦截器组件即可
@MapperScan("com.dt.mapper")
@Configuration
public class MyBatisPlusConfig {
// 分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();;
}
}
2、直接使用Page对象即可!
// 测试分页查询
@Test
void testPage() {
// 参数一:current 当前页
// 参数二:size 页面大小
// 使用了分页插件之后,所有的分页操作也变得简单的!
Page<User> page = new Page<>(1, 5);
userMapper.selectPage(page, null);
page.getRecords().forEach(System.out::println);
System.out.println(page.getTotal()); // page.getTotal() 总共有多少页
}
发现: 分页插件的底层还是 limit
4.7、delete删除
1、根据 id 删除记录
// 测试删除
@Test
void testDeleteById() {
userMapper.deleteById(1548320342353760262L);
}
2、根据 id 批量删除记录
// 通过id批量删除
@Test
void testDeleteBatchIds() {
userMapper.deleteBatchIds(Arrays.asList(1548320342353760260L, 1548320342353760259L));
}
3、根据 map 删除记录
// 通过map删除
@Test
void testDeleteByMap() {
HashMap<String, Object> map = new HashMap<>();
map.put("name", "Dt");
userMapper.deleteByMap(map);
}
我们在工作中会遇到一些问题:逻辑删除!
4.7.1、逻辑删除
物理删除 :从数据库中直接移除
逻辑删除 :再数据库中没有被移除,而是通过一个变量来让他失效! deleted = 0 ==>> deleted = 1
管理员可以查看被删除的记录!防止数据的丢失,类似于回收站!
测试一下:
1、在数据表中增加一个 deleted 字段
2、实体类中增加属性
@TableLogic // 逻辑删除
private Integer deleted;
3、配置文件
- application
# 逻辑删除
# 逻辑已删除值(默认为 1)
mybatis-plus.global-config.db-config.logic-delete-value=1
# 逻辑未删除值(默认为 0)
mybatis-plus.global-config.db-config.logic-not-delete-value=0
- MyBatisPlusConfig
// 逻辑删除组件!
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
4、测试下删除!
记录依旧在数据库,但是值确已经变化了!
测试查询!
以上的所有CRUD操作及其扩展操作,我们都必须精通掌握!会大大提高你的工作和写项目的效率!
5、性能分析插件
我们在平时的开发中,会遇到一些慢SQL。测试! druid,
作用:性能分析拦截器,用于输出每条 SQL 语句及其执行时间
MP也提供性能分析插件,如果超过这个时间就停止运行!
1、导入插件
/**
* SQL执行效率插件
*/
@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启,保证我们的效率
public PerformanceInterceptor performanceInterceptor() {
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
performanceInterceptor.setMaxTime(100); // ms设置sql执行的最大时间,如果超过了则不执行
performanceInterceptor.setFormat(true); // 是否格式化代码
return performanceInterceptor;
}
记住,要在SpringBoot中配置环境为dev或者 test 环境!
# 设置开发环境
spring.profiles.active=dev
2、测试使用!
@Test
void contextLoads() {
// 参数是个Wapper,条件构造器,没有条件就写null
// 查询全部用户
List<User> userList = userMapper.selectList(null);
userList.forEach(System.out::println);
}
使用性能分析插件,可以帮助我们提高效率!
注:该功能在3.2.0以后被抛弃
6、条件构造器
十分重要:Wrapper
我们写一些复杂的sql就可以使用它来替代!
建立一个测试类:WrapperTest
6.1、ge 和 isNotNull
测试一,记住查看输出的SQL进行分析ge是大于等于
@SpringBootTest
public class WrapperTest {
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
// 查询name不为空的用户,并且邮箱不为空的用户,年龄大于等于12岁的
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper
.isNotNull("name")
.isNotNull("email")
.ge("age", 21);
userMapper.selectList(wrapper).forEach(System.out::println); // 和我们刚才学习的map对比一下
}
}
6.2、eq
测试二,记住查看输出的SQL进行分析eq是等于
@Test
void test2() {
// 查询名字
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name", "KyDestroy"); // 查询一个数据,出现多个结果使用List或者 Map
User user = userMapper.selectOne(wrapper);
System.out.println(user);
}
6.3、between
测试三,记住查看输出的SQL进行分析between .. and ..
@Test
void test3() {
// 查询年龄在20到30岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age", 20, 30); // 区间
Integer count = userMapper.selectCount(wrapper); // 查询结果数
System.out.println(count);
}
6.4、notLike 和 likeRight
测试四,记住查看输出的SQL进行分析模糊查询 notLike likeRight
// 模糊查询
@Test
void test4() {
// 查询名字不包含t和邮件以t开头的
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper
.notLike("name", "t") // %e%
.likeRight("email", "t"); // t%
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
6.5、inSql
测试五子查询:inSql("id", "select id from table where id < 3")
--->id in (select id from table where id < 3)
// 子查询
@Test
void test5() {
QueryWrapper<User> wrapper = new QueryWrapper<>();
// id 在子查询里查询出来的
wrapper.inSql("id", "select id from user where id < 3");
List<Object> objects = userMapper.selectObjs(wrapper);
objects.forEach(System.out::println);
}
6.6、orderByAsc
测试六升序排序:orderByAsc("age")
--->order by age ASC
// 测试6
@Test
void test6() {
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 根据年龄升序排序
wrapper.orderByAsc("age");
List<User> userList = userMapper.selectList(wrapper);
userList.forEach(System.out::println);
}
其余的去看官方文档也一样会使用了:条件构造器 | MyBatis-Plus
7、代码自动生成器
dao、pojo、service、controller都给我自己去编写完成!
AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。
3.0.7版本移除 对 mybatis-plus-generator 包的依赖,自己按需引入,尽在还需要导入模板依赖
<!-- 模板引擎 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.0</version>
</dependency>
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 KuangCode {
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("狂神说");
gc.setOpen(false); // 生成完毕后是否打开文件夹
gc.setFileOverride(false); // 是否覆盖
gc.setServiceName("%sService"); // 去Service的I前缀
gc.setIdType(IdType.ID_WORKER); // 主键策略全局唯一
gc.setDateType(DateType.ONLY_DATE); // 日期时间
gc.setSwagger2(true); // 是否配置Swagger文档
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.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
//3、包的配置
PackageConfig pc = new PackageConfig();
pc.setModuleName("blog");
pc.setParent("com.kuang"); //两个加起来就是 com.kuang.blog
pc.setEntity("entity"); // 设置实体类包的名字
pc.setMapper("mapper"); // 设置mapper类包的名字
pc.setService("service"); //设置service类包的名字
pc.setController("controller"); // 设置controller类包的名字
mpg.setPackageInfo(pc);
//4、策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("blog_tags","course","links","sys_settings","user_record","user_say"); // 设置要映射的表名,可以设置多个
strategy.setNaming(NamingStrategy.underline_to_camel); // 名字下划线装驼峰
strategy.setColumnNaming(NamingStrategy.underline_to_camel); // 列名下划线转驼峰
strategy.setEntityLombokModel(true); // 自动lombok;
strategy.setLogicDeleteFieldName("deleted"); // 逻辑删除的名字
// 自动填充配置
TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT); // gmt_create为自动填充字段名
TableFill gmtModified = new TableFill("gmt_modified",FieldFill.INSERT_UPDATE); // gmt_modified为自动填充字段名
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(gmtCreate);
tableFills.add(gmtModified);
strategy.setTableFillList(tableFills);
// 乐观锁
strategy.setVersionFieldName("version");
strategy.setRestControllerStyle(true); //是否开启controller的rest使用风格
strategy.setControllerMappingHyphenStyle(true); //localhost:8080/hello_id_2
mpg.setStrategy(strategy);
mpg.execute(); //执行
}
}
标签:MybatisPlus,void,userMapper,笔记,user,new,com,id
From: https://www.cnblogs.com/RetainXiao/p/16651848.html