纯净、安全、绿色的下载网站

首页|软件分类|下载排行|最新软件|IT学院

当前位置:首页IT学院IT技术 → Mybatis-Plus的使用详解

Mybatis-Plus的使用详解

PG如毓   2020-10-19 我要评论

一、特性

  • 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
  • 损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误 操作

二、使用步骤

1、创建数据库 mybatis_plus,创建表

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

2、创建SpringBoot项目!

3、导入依赖

<!-- 数据库驱动 -->
<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>

4、配置

# 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

5、建实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
 private Long id;
 private String name;
 private Integer age;
 private String email;
}

6、mapper接口

// 在对应的Mapper上面继承基本的类 BaseMapper
@Repository // 代表持久层
public interface UserMapper extends BaseMapper<User> {
 // 所有的CRUD操作都已经编写完成了
 // 你不需要像以前的配置一大堆文件了!
}

7、入口类扫描dao

在主启动类上去扫描我们的mapper包下的所有接口

@MapperScan("com.yn.mapper")

三、配置日志

我们所有的sql现在是不可见的,我们希望知道它是怎么执行的,所以我们必须要看日志!

# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

在这里插入图片描述

配置完毕日志之后,后面的学习就需要注意这个自动生成的SQL,你们就会喜欢上 MyBatis-Plus!

四、CRUD扩展

1、插入操作

@Autowired
 private UserMapper userMapper;

 @Test
 public void testInsert() {
  User user = new User();
  user.setName("张三");
  user.setAge(23);
  user.setEmail("163.com");

  int result = userMapper.insert(user);//帮我们自动生成id
  System.out.println(result);// 受影响的行数
  System.out.println(user);// 发现id会自动回填
 }

在这里插入图片描述

2、主键生成策略

在实体类字段上 @TableId(type = IdType.xxx),一共有六种主键生成策略

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
/*
 @TableId(type = IdType.AUTO)  // 1.数据库id自增 注意:在数据库里字段一定要设置自增!
 @TableId(type = IdType.NONE)  // 2.未设置主键
 @TableId(type = IdType.INPUT)  // 3.手动输入
 @TableId(type = IdType.ID_WORKER) // 4.默认的全局唯一id
 @TableId(type = IdType.UUID)   // 5.全局唯一id uuid
 @TableId(type = IdType.ID_WORKER_STR) // 6.ID_WORKER 字符串表示法
*/
 private Long id;
 private String name;
 private Integer age;
 private String email;
}

3、更新操作

 @Test
 public void testUpdate() {
  User user = new User();
  user.setId(6L);
  user.setName("李四");
  user.setAge(29);
  user.setEmail("qq.com");

  int result = userMapper.updateById(user);
 }

在这里插入图片描述

4、自动填充

创建时间、修改时间!这些个操作一遍都是自动化完成的,我们不希望手动更新!
阿里巴巴开发手册:所有的数据库表:gmt_create、gmt_modified几乎所有的表都要配置上!而且需要自动化!

1. 方式一:数据库级别(工作中不允许你修改数据库)

在表中新增字段 create_time, update_time,
实体类同步

private Date createTime;
private Date updateTime;

以下为操作后的变化

在这里插入图片描述

2. 方式二:代码级别

1、删除数据库的默认值、更新操作!

在这里插入图片描述

2、实体类字段属性上需要增加注解

// 字段添加填充内容
@TableField(fill = FieldFill.INSERT)//插入的时候操作
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)//插入和更新的时候都操作
private Date updateTime

3、编写处理器来处理这个注解即可!

@Slf4j
@Component//加入spring容器
public class MuMetaObjecHandler implements MetaObjectHandler {
 // 插入时的填充策略
 @Override
 public void insertFill(MetaObject metaObject) {
 log.info("start insert fill.....");
 // setFieldValByName(String 字段名, Object 要插入的值, MetaObject meateObject);
 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、乐观锁

乐观锁 : 故名思意十分乐观,它总是认为不会出现问题,无论干什么不去上锁!如果出现了问题,再次更新值测试,给所有的记录加一个version

悲观锁:故名思意十分悲观,它总是认为总是出现问题,无论干什么都会上锁!再去操作!

乐观锁实现方式:

  • 取出记录时,获取当前 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的乐观锁插件

1、给数据库中增加version字段!

在这里插入图片描述

2、实体类加对应的字段

@Version //乐观锁Version注解
private Integer version;

3、注册组件

// 扫描的 mapper 文件夹
@MapperScan("com.yn.mapper")
@EnableTransactionManagement
@Configuration // 配置类
public class MyBatisPlusConfig {
 // 注册乐观锁插件
 @Bean
 public OptimisticLockerInterceptor optimisticLockerInterceptor() {
  return new OptimisticLockerInterceptor();
 }
}

3、测试

 // 测试乐观锁成功!
 @Test
 public void testOptimisticLocker() {
  // 1、查询用户信息
  User user = userMapper.selectById(1L);
  // 2、修改用户信息
  user.setName("kuangshen");
  user.setEmail("24736743@qq.com");
  // 3、执行更新操作
  userMapper.updateById(user);
 }

 // 测试乐观锁失败!多线程下
 @Test
 public void testOptimisticLocker2() {
  // 线程 1
  User user = userMapper.selectById(1L);
  user.setName("kuangshen111");
  user.setEmail("24736743@qq.com");
  // 模拟另外一个线程执行了插队操作
  User user2 = userMapper.selectById(1L);
  user2.setName("kuangshen222");
  user2.setEmail("24736743@qq.com");
  userMapper.updateById(user2);

  // 自旋锁来多次尝试提交!
  userMapper.updateById(user); // 如果没有乐观锁就会覆盖插队线程的值!
 }

在这里插入图片描述

6、查询操作

 // 测试查询
 @Test
 public void testSelectById() {
  User user = userMapper.selectById(1L);
  System.out.println(user);
 }

 // 测试批量查询!
 @Test
 public void testSelectByBatchId() {
  List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
  users.forEach(System.out::println);
 }

 // 按条件查询之一使用map操作
 @Test
 public void testSelectByBatchIds() {
  HashMap<String, Object> map = new HashMap<>();
  // 自定义要查询
  map.put("name", "狂神说Java");
  map.put("age", 3);
  List<User> users = userMapper.selectByMap(map);
  users.forEach(System.out::println);
 }

7、分页查询

1.配置拦截器组件

// 扫描的 mapper 文件夹
@MapperScan("com.yn.mapper")
@EnableTransactionManagement
@Configuration // 配置类
public class MyBatisPlusConfig {
 // 注册乐观锁插件
 @Bean
 public OptimisticLockerInterceptor optimisticLockerInterceptor() {
  return new OptimisticLockerInterceptor();
 }

 //分页插件
 @Bean
 public PaginationInterceptor paginationInterceptor() {
  return new PaginationInterceptor();
 }
}

2.直接使用Page对象即可

 // 测试分页查询
 @Test
 public void testPage() {
  // 参数一:当前页
  // 参数二:页面大小
  // 使用了分页插件之后,所有的分页操作也变得简单的!
  Page<User> page = new Page<>(2, 3);
  userMapper.selectPage(page, null);
  page.getRecords().forEach(System.out::println);
  System.out.println(page.getTotal());
 }

8、删除操作

// 测试删除
 @Test
 public void testDeleteById() {
  userMapper.deleteById(1240620674645544965L);
 }

 // 通过id批量删除
 @Test
 public void testDeleteBatchId() {
  userMapper.deleteBatchIds(Arrays.asList(1240620674645544961L, 1240620674645544962L));
 }

 // 通过map删除
 @Test
 public void testDeleteMap() {
  HashMap<String, Object> map = new HashMap<>();
  map.put("name", "狂神说Java");
  userMapper.deleteByMap(map);
 }

9、逻辑删除

物理删除 :从数据库中直接移除

逻辑删除 :再数据库中没有被移除,而是通过一个变量来让他失效! deleted = 0 => deleted = 1

管理员可以查看被删除的记录!防止数据的丢失,类似于回收站!

逻辑删除步骤:
1、在数据表中增加一个 deleted 字段

在这里插入图片描述

2、实体类中增加属性

 @TableLogic //逻辑删除
 private Integer deleted;

3、配置!

 // 逻辑删除组件!
 @Bean
 public ISqlInjector sqlInjector() {
  return new LogicSqlInjector();
 }
# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

3、查看!

在这里插入图片描述

在这里插入图片描述

10、性能分析插件

我们在平时的开发中,会遇到一些慢sql。
作用:性能分析拦截器,用于输出每条 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() {
  // 参数是一个 Wrapper ,条件构造器,这里我们先不用 null
  // 查询全部用户
  List<User> users = userMapper.selectList(null);
  users.forEach(System.out::println);
 }

在这里插入图片描述

11、条件构造器

我们写一些复杂的sql就可以使用它来替代!

@SpringBootTest
public class WrapperTest {

 @Autowired
 private UserMapper userMapper;

 //1、测试一,记住查看输出的SQL进行分析
 @Test
 void test1() {
  // 查询name不为空的用户,并且邮箱不为空的用户,年龄大于等于12
  QueryWrapper<User> wrapper = new QueryWrapper<>();
  wrapper
    .isNotNull("name")
    .isNotNull("email")
    .ge("age", 12);
  userMapper.selectList(wrapper).forEach(System.out::println); // 和我们刚才学习的map对比一下
 }

 //2、测试二
 @Test
 void test2() {
  // 查询名字狂神说
  QueryWrapper<User> wrapper = new QueryWrapper<>();
  wrapper.eq("name", "狂神说");
  User user = userMapper.selectOne(wrapper); // 查询一个数据,出现多个结果使用List或者 Map
  System.out.println(user);
 }

 //3、区间查询
 @Test
 void test3() {
  // 查询年龄在 20 ~ 30 岁之间的用户
  QueryWrapper<User> wrapper = new QueryWrapper<>();
  wrapper.between("age", 20, 30); // 区间
  Integer count = userMapper.selectCount(wrapper);// 查询结果数
  System.out.println(count);
 }

 //4、模糊查询
 @Test
 void test4() {
  // 查询年龄在 20 ~ 30 岁之间的用户
  QueryWrapper<User> wrapper = new QueryWrapper<>();
  // 名字中不包含e的 和 邮箱t%
  wrapper
    .notLike("name", "e")
    .likeRight("email", "t");
  List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
  maps.forEach(System.out::println);
 }

 //5、模糊查询
 @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);
 }

 //排序
 @Test
 void test6() {
  QueryWrapper<User> wrapper = new QueryWrapper<>();
  // 通过id进行排序
  wrapper.orderByDesc("id");
  List<User> users = userMapper.selectList(wrapper);
  users.forEach(System.out::println);
 }

}

12、代码自动生成器

AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。

测试:

package com.yn;

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 org.springframework.boot.test.context.SpringBootTest;

import java.util.ArrayList;


public class Code {

 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前缀,生成的server就没有前缀了
  gc.setIdType(IdType.ID_WORKER); //id生成策略
  gc.setDateType(DateType.ONLY_DATE);//日期的类型
  gc.setSwagger2(true);//自动配置Swagger文档
  mpg.setGlobalConfig(gc);
  //2、设置数据源
  DataSourceConfig dsc = new DataSourceConfig();
  dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
  dsc.setDriverName("com.mysql.cj.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.yn");//放在哪个包下
  pc.setEntity("entity");//实体类的包名字
  pc.setMapper("mapper");//dao的包字
  pc.setService("service");//server的包名
  pc.setController("controller");//controller的包名
  mpg.setPackageInfo(pc);
  //4、策略配置
  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 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); //controller中链接请求:localhost:8080/hello_id_2
  mpg.setStrategy(strategy);

  mpg.execute(); //执行
 }
}

报错的可以导一下这个包

 <dependency>
   <groupId>org.apache.velocity</groupId>
   <artifactId>velocity-engine-core</artifactId>
   <version>2.0</version>
  </dependency>

相关文章

猜您喜欢

网友评论

Copyright 2020 www.QB5200.com 【亲宝软件园】 版权所有 软件发布

声明:所有软件和文章来自软件开发商或者作者 如有异议 请与本站联系 点此查看联系方式