mybatis-plus
注:学习自狂神
MyBatisPlus概述
为什么要学习它呢?MyBatisPlus可以节省我们大量工作时间,所有的CRUD代码它都可以自动化完成!
简介
是什么? MyBatis 本来就是简化 JDBC 操作的! 官网:https://mp.baomidou.com/ ,简化 MyBatis !
特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作, BaseMapper
- 强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求, 以后简单的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 操作智能分析阻断,也可自定义拦截规则,预防误 操作
快速入门
地址:https://mp.baomidou.com/guide/quick-start.html#初始化工程
使用第三方组件:
- 导入对应的依赖
- 研究依赖如何进行配置
- 代码如何编写
- 提高扩展的技术能力
步骤
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) );
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');
-- 真实开发中,version(乐观锁)、deleted(逻辑删除)、gmt_create、gmt_modified
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 和 mybatisplus!版本的差异!
5. 连接数据库!这一步和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
传统方式pojo-dao(连接mybatis,配置mapper.xml文件)service-controller
6. 使用mybatis-plus之后
- pojo
@Data
@AllArgsConstructor
@NoArgsConstructor public class User {
private Long id;
private String name;
private Integer age; private String email;
}
- mapper接口(@MapperScan("com.sj.springbootmybatispuls.mapper")将其扫入进去!
@Repository
public interface UserMapper extends BaseMapper<User> {
//自带了CRUD
}
- 测试类中测试
@MapperScan("com.sj.springbootmybatispuls.mapper"
@SpringBootTest
class MybatisPlusApplicationTests {
// 继承了BaseMapper,所有的方法都来自己父类 // 我们也可以编写自己的扩展方法!
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
// 参数是一个 Wrapper ,条件构造器,这里我们先不用 null
// 查询全部用户
List<User> users = userMapper.selectList(null); users.forEach(System.out::println);
}
}
思考?
- SQL谁帮我们写的?MyBatis-Plus都写好了
- 方法哪来的!也是MyBatis都写好的
配置日志
sql不可见需要配置日志,来查看执行的!
# 配置日志
mybatis-plus.configuration.logimpl=org.apache.ibatis.logging.stdout.StdOutImpl
CRUD扩展
插入操作insert
@Test
public void insert(){
User user = new User();
user.setId(6);
user.setName("狂神说Java");
user.setAge(3);
user.setEmail("24736743@qq.com");
int insert = userMapper.insert(user);
System.out.println(insert);
主键生成策略
介绍俩个:
- 默认 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),
NONE(1),
INPUT(2),
ASSIGN_ID(3),
ASSIGN_UUID(4),
/** @deprecated */
@Deprecated
ID_WORKER(3),
/** @deprecated */
@Deprecated
ID_WORKER_STR(3),
/** @deprecated */
@Deprecated
UUID(4);
更新操作
@Test
public void testUpdate() {
User user = new User();
//通过条件自动拼接动态sql
user.setId(6);
user.setName("关注公众号:狂神说");
user.setAge(18);
// 注意:updateById 但是参数是一个 对象!
int i = userMapper.updateById(user);
System.out.println(i); }
}
所有的sql都是自动帮你动态配置的!
自动填充
创建时间、修改时间!这些个操作一遍都是自动化完成的,我们不希望手动更新!
阿里巴巴开发手册:所有的数据库表:gmt_create、gmt_modified几乎所有的表都要配置上!而且需 要自动化!
- 数据库级别(工作中不会让你修改数据库1)
- 代码界别
- 实体类同步
private Date createTime;
private Date updateTime;
3. 在实体类属性上面添加注解
@TableField(fill = FieldFill.INSERT)
private Date creatTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
5. 编写处理器来处理这个注解即可!
@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill.....");
this.setFieldValByName("creatTime",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);
}
}
注意:
数据库需要写creat_Time,update_Time,但是实体类写上creatTime,updateTime。
乐观锁和悲观锁
乐观锁:顾名思义十分乐观,他总认为不会出事,如果出现问题,
再次更新值测试!
悲观锁:十分悲观,它总认为出现问题,无论干嘛都上锁!再去操作!
我们这里主要讲解乐观锁机制!
乐观锁实现方式:
- 取出记录时,获取当前的version
- 更新时,带上version
- 执行跟新是,set version = newVersion whereversion = oldVersion
- 如果verison不正确,就跟新失败!
乐观锁:1.先查询,获取版本号 version = 1
--A
update user set name = "sj" ,version = version + 1
where id = 2 and version = 1
--B
update user set name = "sj",version = version + 1
where id = 2 and version = 1
测试一下MP 乐观锁插件
- 给数据库添加一个version字段!默认值取一
- 我们实体类加对应的字段
@Version
private Integer version;
- 配置乐观锁
@MapperScan("com.sj.springbootmybatispuls.mapper")
@EnableTransactionManagement
@Configuration
public class MybatisPlusConfig {
//注册乐观锁插件
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor(){
return new OptimisticLockerInterceptor();
}
}
- 测试
@Test
public void testUpdate() {
User user = userMapper.selectById(1);
user.setName("关注公众号:狂神说");
user.setAge(18);
// 注意:updateById 但是参数是一个 对象!
int i = userMapper.updateById(user);
System.out.println(i); }
}
- 切记 一定要先查出来后更新;update自身带锁。直接update不会出现并发修改问题。乐观锁是先查询在修改,where条件是
version = 查询出来的version值,商品ID为传入的商品ID,整条update语句为
Update 商品表 set 库存 = 库存 - 购买量 ,version = 查询version值+1 where version = #{查询的version值} and 商品ID= #
查询操作
//测试查询
@Test
public void testSelectById(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
@Test
public void testSelectByBatchIds(){
HashMap<String,Object> map = new HashMap<>();
map.put("name","sj");
map.put("age",3);
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
}
分页查询
分页在网站使用十分之多!
- 原始的limit进行分页
- pageHalper第三方插件
- MP内置了分页插件!
如何使用
- 配置拦截器组件即可
//分页插件
@Bean
public PaginationInterceptor paginationInterceptor(){
return new PaginationInterceptor();
}
- 直接使用Page对象进行即可!
@Test
public void testPage(){
//参数一:当前页
//参数二:页面大小
//使用分页插件之后,所有的分页操作也变得简单的!
Page<User> page = new Page<>(2,5);
Page<User> page1 = userMapper.selectPage(page, null);
page.getRecords().forEach(System.out::println);
System.out.println(page.getTotal());
}
删除操作
- 根据id删除数据
@Test
public void testDeleteById(){
userMapper.deleteById(1);
}
@Test
public void testDeletedBatchId(){
userMapper.deleteBatchIds(Arrays.asList(1,2,3));
}
@Test
public void testDeleteMap(){
HashMap<String,Object> map = new HashMap<>();
map.put("name","sj");
userMapper.deleteByMap(map);
}
##### 逻辑删除
==**物理删除==:**从数据库中直接删除
==**逻辑删除==:**再数据库中没有被移除,而是通过一个变量来让他失效!delete = 0 =》delete = 1
管理员可以查看被删除的记录!防止数据丢失,类似于回收站!
测试:
1. 在数据表中增加一个deleted字段
2. 添加依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus- extension</artifactId>
<version>3.0.5</version>
</dependency>
3. 在实体类中增添属性
@TableLogic//逻辑删除
private Integer deleted;
4. 配置
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
5. 测试一下删除!
@Test
public void testDeleteById1(){
userMapper.deleteById(1);
}
6.结果
注意:3.1.1开始不再需要图片中的这步,yml配置如果和默认一样不需要配置
性能分析插件
我们平时开发中,会遇到一些慢的sql。测试!druid。。。
作用:性能分析拦截器,用于输出每条sql语句及其执行时间
MP也提供了性能分析插件,如果超过这个时间就会立刻停止运行!
注意:在3.2之后移除自带插件,推荐使用第三方,druid。
条件构造器
十分重要:Wrapper
我们写一些复杂的sql就可以使用它来替代~!
- 测试一,记住查看输出的SQL进行分析
@Test
void testWrapper(){
//查询name不为空的用户,并且邮箱不为空的用户,年龄大于等于12
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.isNotNull("name")
.isNotNull("email")
.ge("age",12);
userMapper.selectList(wrapper).forEach(System.out::println);
//对比以前map学习。
}
- 测试二,记住查看输出的SQL进行分析
@Test
void test2(){
//查询名字
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name","sj");
User user = userMapper.selectOne(wrapper);//查询一个数据,出现多个结果使用List或者Map
System.out.println(user);
}
- 测试三,记住查看输出sql进行分析
@Test
void test3(){
//查询年级在20~30岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age",20,30);
List<Map<String,Object>> maps = userMapper.selectCount(wrapper);
maps.forEach(System.out::println);
}
- 测试三,记住查看输出的SQL进行分析
// 模糊查询
@Test void test4(){
// 查询年龄在 20 ~ 30 岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 左和右 t% wrapper
.notLike("name","e")
.likeRight("email","t");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper); maps.forEach(System.out::println); }
- 测试五记住查看输出的SQL进行分析
// 模糊查询
@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); }
- 测试六 记住查看输出的SQL进行分析
//测试六
@Test void test6(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 通过id进行排序
wrapper.orderByAsc("id");
List<User> users = userMapper.selectList(wrapper); users.forEach(System.out::println); }
代码自动生成器
AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。
1. 添加pom的依赖
<!-- mybatisPlus 代码生成器 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.1.tmp</version>
</dependency>
<!-- mybatisPlus Velocity 模版引擎 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.2</version>
</dependency>
<!-- mybatisPlus Freemarker 模版引擎 -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.29</version>
</dependency>
2. 代码生成
public static void main(String[] args) {
//需要构建一个 代码自动生成器 对象
AutoGenerator mpg = new AutoGenerator();
//配置策略
//1.全局配置
GlobalConfig gc = new GlobalConfig();
String property = System.getProperty("user.dir");//获取当前的工作路径
gc.setOutputDir(property + "/src/main/java");
gc.setAuthor("sj");
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);
//设置数据源
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/mybatis-puls?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
//包配置
PackageConfig pc = new PackageConfig();
pc.setParent("com.sj");
pc.setEntity("entity");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");
mpg.setPackageInfo(pc);
//策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("user");
strategy.setNaming(NamingStrategy.underline_to_camel); //转化驼峰命名
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true); // 自动lombok
strategy.setLogicDeleteFieldName("deleted");//逻辑删除
//自动填充配置
TableFill createTime = new TableFill("creat_time", FieldFill.INSERT);
TableFill updateTime= new TableFill("update_time", FieldFill.INSERT_UPDATE);
ArrayList<TableFill> list = new ArrayList<>();
list.add(createTime);
list.add(updateTime);
strategy.setTableFillList(list);
//乐观锁
strategy.setVersionFieldName("version");
strategy.setRestControllerStyle(true);
strategy.setControllerMappingHyphenStyle(true);//localhost:8080/hello_id_2
mpg.setStrategy(strategy);
mpg.execute();//执行