MyBaitsPlus基础知识(狂神说笔记)
MyBaitsPlus简介
为什么学习它呢?因为可大量节省我们的工作时间,所有的CRUD代码他都可以完成。
JPA、tk-mapper、MyBaitsPlus市面上流行的三类工具
MyBaitsPlus是Mybaits的增强工具,在MyBaits的基础上只做增强,不做改变。为简化开发、提高效率而生
快速入门
-
导入依赖
<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.4.1</version> </dependency>
说明:尽量不要同时导入mybaits和mybaits-plus,可能会存在版本的差异
-
在对应的Dao层继承BaseMapper接口
public interface UserDao extends BaseMapper<User> { }
-
基本操作
-查询操作
userDao.selectList(null) #查询所有 userDao.selectById(id) #根据id查询 userDao.selectBatchIds(ids) #根据ids(集合)批量查询 userDao.selectByMap(map) 根据条件查询 Map<String, Object>,map.put("key", value) userDao.selectPage(page, null); 分页查询 Page<User> page = new Page<>(current,size);
删除操作
userDao.deleteById(id) #根据id删除 userDao.deleteByMap(map) #根据条件删除 userDao.deleteBatchIds(ids) #根据ids批量删除
userDao.insert(user) #插入一条数据
userDao.updateById(user) #更新操作 动态拼接sql,只修改更改的部分
扩展
日志配置
配置日志是为了输出sql语句,方便排错
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
主键生成策略
使用这种方法不仅数据库会生成id值,并且会返写给User类中的id
public enum IdType {
AUTO(0),
NONE(1),
INPUT(2),
ASSIGN_ID(3),
ASSIGN_UUID(4),
ID_WORKER(3),
ID_WORKER_STR(3),
UUID(4);
}
- 雪花算法
@TableId(type = IdType.ID_WORKER)
private Long id;
- 主键自增
@TableId(type = IdType.AUTO)
private Long id;
并且数据库字段一定要是自增,否则会报错!
- UUID
- redis
- zookeeper
自动填充
方式一:数据库级别
方式二:数据库级别
-
删除数据的默认值、更新操作
-
实体类字段加上注解
@TableField(fill = FieldFill.INSERT) private Date createTime; @TableField(fill = FieldFill.INSERT_UPDATE) private Date updateTime;
-
编写处理器来处理这个注解
@Component public class MyMetaObjectHandler implements MetaObjectHandler { @Override public void insertFill(MetaObject metaObject) { log.info("start insert fill ...."); this.setFieldValByName("createdTime", LocalDateTime.now(), metaObject); //或者 this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用) // 或者 this.strictUpdateFill(metaObject, "createTime", () -> LocalDateTime.now(), LocalDateTime.class); // 起始版本 3.3.3(推荐) // 或者 this.fillStrategy(metaObject, "createTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug) } @Override public void updateFill(MetaObject metaObject) { log.info("start update fill ...."); this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐) // 或者 this.strictUpdateFill(metaObject, "updateTime", () -> LocalDateTime.now(), LocalDateTime.class); // 起始版本 3.3.3(推荐) // 或者 this.fillStrategy(metaObject, "updateTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug) } }
乐观锁
乐观锁:十分乐观,总是认为不会出现什么问题,无论干什么都不会去上锁。如果出现了问题,就更新值再次操作。
悲观锁:十分悲观,总是认为会出现问题,无论干什么都会去上锁。
乐观锁的实现机制:
- 取出记录时,获取当前version
- 更新时,带上这个version
- 执行更新时, set version = newVersion where version = oldVersion
- 如果version不对,就更新失败
简单使用:
-
数据库增加version字段(int类型,默认为1)
-
实体类增加对应字段
@Version private Integer version;
3:注册组件
分页插件
三种常见方式:
- 原始的limit进行分页
- pageHelper第三方插件
- MP内置了分页插件
使用mybaits-plus的分页插件
- 配置拦截器组件
@Configuration
@MapperScan("com.baomidou.cloud.service.*.mapper*")
public class MybatisPlusConfig {
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor;
}
}
- 直接使用Page对象
Page<User> page = new Page<>(2,5);
userDao.selectPage(page, null);
逻辑删除
物理删除:从数据库中直接删除
逻辑删除:并未真正删除,而是通过一个变量让它失效。deleted=0->deleted=1
1:数据库增加deleted字段(int类型,默认为0)
2:实体类增加对应字段。
@TableLogic
private Integer deleted;
3:配置
mybatis-plus:
global-config:
db-config:
logic-delete-field: flag # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
logic-delete-value: 1 # 逻辑已删除值(默认为 1)
logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
说明:逻辑删除的删除操作是update操作
性能分析插件
作用:性能分析拦截器,用于输出每条sql语句及其执行时间。
1:导入插件
2:测试使用
条件构造器
- 测试一
查询name不为空、email不为空、年龄大于12的用户
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.isNotNull("name")
.isNotNull("email")
.ge("age", 12);
userDao.selectList(queryWrapper);
- 测试二
查询名字为狂神说的用户
queryWrapper.eq("name", "狂神说");
userDao.selectOne(queryWrapper);
- 测试三
查询年龄在20-30岁之间的用户
queryWrapper.between("age", 20, 30);
userDao.selectCount(queryWrapper);
- 测试四
查询名字中不包含e、且以t开头的用户
queryWrapper.notLike("name", "e")
.likeRight("email", "t");
List<Map<String, Object>> maps = userDao.selectMaps(queryWrapper);
- 测试五
子查询
queryWrapper.inSql("id", "select id from user where id < 5");
- 测试六
排序
queryWrapper.orderByDesc("id");
代码生成器
AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。
测试:
package com.wangxiaobao.snow.wrpa;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
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.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import java.util.ArrayList;
/**
* <p>
* 代码生成器演示
* </p>
*/
public class MPGenerator {
/**
* <p>
* MySQL 生成演示
* </p>
*/
public static void main(String[] args) {
AutoGenerator mpg = new AutoGenerator ();
// 选择 freemarker 引擎,默认 Veloctiy
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
// 全局配置
GlobalConfig gc = new GlobalConfig();
gc.setAuthor("YangSha");
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath+"/src/main/java");
gc.setFileOverride(false);// 是否覆盖同名文件,默认是false
gc.setActiveRecord(true);// 不需要ActiveRecord特性的请改为false
gc.setEnableCache(false);// XML 二级缓存
gc.setBaseResultMap(true);// XML ResultMap
gc.setBaseColumnList(false);// XML columList
/* 自定义文件命名,注意 %s 会自动填充表实体属性! */
gc.setMapperName("%sDao");
gc.setXmlName("%sMapper");
gc.setServiceName("%sService");
gc.setServiceImplName("%sServiceImpl");
gc.setControllerName("%sController");
gc.setEntityName("%sModel");
gc.setSwagger2(true);
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setDbType(DbType.MYSQL);
// dsc.setTypeConvert(new MySqlTypeConvert() {
// // 自定义数据库表字段类型转换【可选】
// @Override
// public DbColumnType processTypeConvert(String fieldType) {
// System.out.println("转换类型:" + fieldType);
// // 注意!!processTypeConvert 存在默认类型转换,如果不是你要的效果请自定义返回、非如下直接返回。
// return super.processTypeConvert(fieldType);
// }
// });
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("****");
dsc.setPassword("****");
dsc.setUrl("jdbc:mysql://****:3306/snow_wrpa_test?useUnicode=true&characterEncoding=utf8");
mpg.setDataSource(dsc);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
// strategy.setCapitalMode(true);// 全局大写命名 ORACLE 注意
strategy.setTablePrefix(new String[] { "rpa_" });// 此处可以修改为您的表前缀
strategy.setNaming(NamingStrategy.underline_to_camel);// 表名生成策略
strategy.setInclude(new String[] { "rpa_license" }); // 需要生成的表
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true); // 自动lombok;
strategy.setLogicDeleteFieldName("deleted");
// 乐观锁
strategy.setVersionFieldName("version");
strategy.setRestControllerStyle(true);
// strategy.setExclude(new String[]{"test"}); // 排除生成的表
// 自定义实体父类
// strategy.setSuperEntityClass("com.baomidou.demo.TestEntity");
// 自定义实体,公共字段
// strategy.setSuperEntityColumns(new String[] { "test_id", "age" });
// 自定义 mapper 父类
// strategy.setSuperMapperClass("com.baomidou.demo.TestMapper");
// 自定义 service 父类
// strategy.setSuperServiceClass("com.baomidou.demo.TestService");
// 自定义 service 实现类父类
// strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl");
// 自定义 controller 父类
// strategy.setSuperControllerClass("com.baomidou.demo.TestController");
// 【实体】是否生成字段常量(默认 false)
// public static final String ID = "test_id";
// strategy.setEntityColumnConstant(true);
// 【实体】是否为构建者模型(默认 false)
// public User setName(String name) {this.name = name; return this;}
// strategy.setEntityBuilderModel(true);
mpg.setStrategy(strategy);
// 包配置
PackageConfig packageConfig = new PackageConfig();
packageConfig.setParent("com.wangxiaobao.snow.wrpa.license")
.setMapper("daos")
.setEntity("daos/entity")
.setService("service")
.setController("controller")
.setXml("mapper");
mpg.setPackageInfo(packageConfig);
// 自动填充配置
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);
// 执行生成
mpg.execute();
// 打印注入设置【可无】
// System.err.println(mpg.getCfg().getMap().get("abc"));
}
}