狂神说--Mybatisplus笔记整理
特性
官网:https://baomidou.com/
- 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
- 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作
快速入门
地址:https://baomidou.com/guide/quick-start.html#%E5%88%9D%E5%A7%8B%E5%8C%96%E5%B7%A5%E7%A8%8B
步骤
1.创建数据库 mp
2.创建数据库
创建表
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)
);
插入数据
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>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
dependency>
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-boot-starterartifactId>
<version>3.4.3.1version>
dependency>
说明:我们使用mybatis-plus 可以节省我们大量的代码,尽量不要同时导入mybatis和mybatis-plus因为版本有差异!
5.连接数据库!这一步和mybatis相同!
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: root
url: jdbc:mysql://localhost:3306/mp?useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=Asia/Shangha
6.传统的方式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接口
import com.baomidou.mybatisplus.core.mapper.BaseMapper; import com.codeyuaiiao.pojo.User; import org.springframework.stereotype.Repository; //在对应的mapper上面继承基本的类 BaseMapper @Repository//代表持久层 @Mapper public interface UserMapper extends BaseMapper<User> { //所有CRUD操作都已经编写完成了 //你不需要向以前一样配置一大堆文件了! } -
测试类中测试
@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:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
CRUD扩展
添加操作
@Test
public void testInsert(){
User user = new User();
user.setName("codeyuaiiao");
user.setAge(3);
user.setEmail("[email protected]");
int result = userMapper.insert(user);
System.out.println(result);
System.out.println(user);
}
注意点:数据库插入的id默认值为:全局的唯一id
主键ID生成策略
默认使用雪花算法（3.4.3.1版本）
分布式系统唯一id生成:https://www.cnblogs.com/haoxinyue/p/5208136.html
雪花算法(Twitter的snowflake算法)
snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0.可以保证几乎全球唯一
主键自增
// @TableId(type = IdType.AUTO)//主键自增，数据库的字段也必须设置为自增
// @TableId(type = IdType.NONE)//该类型为未设置主键类型
// @TableId(type = IdType.INPUT)//手动输入id
//以下2种类型、只有当插入对象ID 为空，才自动填充。
// @TableId(type = IdType.ASSIGN_UUID)//UUID，全局唯一。主键类型为 String，缺点字符串逐渐不易检索
// @TableId(type = IdType.ASSIGN_ID)//默认使用雪花算法 ，主键类型为 Long 或 String
private Long id;
注意：
实体类字段上@TableId(type = IdType.AUTO)，数据库字段一定要是自增!
修改操作
动态sql
注意:updateById()参数是 一个对象!
//测试更新
@Test
public void testUpdate(){
User user = new User();
user.setId(2L);
user.setName("阿峧不是山交");
// 注意:updateById()参数是 一个对象!
int i = userMapper.updateById(user);
System.out.println(i);
}
所有的sql都是动态帮你配置的
时间属性自动填充
创建时间 . 修改时间! 这些个操作都是自动化完成的,我们不希望手动更新!
阿里巴巴开发手册:所有的数据库表:gmt_create .gmt_modified几乎所有的表都要配置上!而且需要自动化!
方式一:数据库级别
1.在表中新增字段 create_time , update_time
2.再次测试插入方法,我们需要先把实体类同步
private Data creatTime;
private Data updateTime;
再次更新查看结果即可
方式二:代码级别
1.删除数据库默认值
2.实体类字段属性上添加注解
//记住用util包下的Date!!
//字段添加填充内容
//添加用户时添加时间（需要在MyMetaObjectHandler类配置）
@TableField(fill = FieldFill.INSERT)
private Date createTime;
//添加用户或更新用户时添加时间（需要在MyMetaObjectHandler类配置）
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
3.编写处理器来处理这个注解
package com.codeyuaiiao.handler;
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.... ");
this.setFieldValByName("createTime",new Date(),metaObject);
this.setFieldValByName("updateTime",new Date(),metaObject);
}
//更新时的填充策略
@Override
public void updateFill(MetaObject metaObject) {
log.info("Start update fill.... ");
this.setFieldByName("updateTime",new Date(),metaObject);
}
}
4.测试插入
5测试更新,观察时间即可!
乐观锁&悲观锁
乐观锁：OptimisticLockerInnerInterceptor
//测试乐观锁（需要在MybatisPlusConfig类配置）
@Test
public void testOptimisticLockerInner(){
//乐观锁进行修改前会先查询，取出version的值，
//然后进行修改更新信息的时候会比较version的值是否和之前查询的时候的version值一致
//如果是一致则修改更新信息并且version的值+1
//如果不是则修改信更新息失败
//线程一
User user = this.userMapper.selectById(1L);
user.setName("zfStart1111");
user.setEmail("123123123");
//线程二，模拟插队操作
User user2 = this.userMapper.selectById(1L);
user2.setName("zfStart2222");
user2.setEmail("22222");
this.userMapper.updateById(user2);
//有乐观锁的存在，在被其他线程插队的情况下，修改更新信息失败
this.userMapper.updateById(user);
}
MybatisPlusConfig.java配置
//扫描我们的mapper文件夹
@MapperScan("com.zhang.mapper")
@Configuration
@EnableTransactionManagement//事务
public class MybatisPlusConfig {
//mybatisPlus3.4.3.1写法
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//注册乐观锁插件
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return interceptor;
}
}
查询操作
//查询所有用户
@Test
void testSelectAll() {
List<User> userList = this.userMapper.selectList(null);
for (User user : userList) {
System.out.println(user);
}
}
//通过id查询用户
@Test
public void testSelectById(){
User user = this.userMapper.selectById(1L);
System.out.println(user);
//一次通过多个id查询多个用户
List<User> userList = this.userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
for (User user2 : userList) {
System.out.println(user2);
}
}
//按条件查询之一，使用Map,可以进行多个参数查询
@Test
public void testSelectByBatchIds(){
HashMap<String, Object> map = new HashMap<>();
//自定义要查询的条件
map.put("name","zf");
map.put("age","11");
List<User> userList = this.userMapper.selectByMap(map);
for (User user : userList) {
System.out.println(user);
}
}
//模糊查询
@Test
public void testLike(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.likeLeft("name","zf"); //name like '%zf'
List<User> userList = this.userMapper.selectList(wrapper);
for (User user : userList) {
System.out.println(user);
}
}
分页查询
MybatisPlusConfig.java加入分页插件配置
//扫描我们的mapper文件夹
@MapperScan("com.zhang.mapper")
@Configuration
@EnableTransactionManagement//事务
public class MybatisPlusConfig {
//mybatisPlus3.4.3.1写法
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//注册乐观锁插件
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
//分页插件 我们使用的是mysql数据库
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}
测试方法
//分页查询（需要在MybatisPlusConfig类配置）
@Test
public void testPage(){
//参数一：当前页，
//参数二：页面大小
Page<User> page = new Page<User>(2,3);
Page<User> userPage = this.userMapper.selectPage(page, null);
List<User> userList = userPage.getRecords();
for (User user : userList) {
System.out.println(user);
}
}
删除操作
//删除操作，通过id
@Test
public void testDeleteById(){
//通过id删除
this.userMapper.deleteById(1);
//通过多个id,一次删除多个数据
ArrayList list = new ArrayList();
list.add(1412443203587612674L);
list.add(1412438085752348675L);
this.userMapper.deleteBatchIds(list);
}
//测试条件删除，通过map
@Test
public void testDeleteByMap(){
HashMap<String, Object> map = new HashMap<>();
map.put("name","z1111113f");
this.userMapper.deleteByMap(map);
}
逻辑删除
物理删除：从数据库中直接移除
逻辑删除：在数据库中没有被移除，而是通过一个变量让他生效！deleted=0 --> deleted=1
管理员可以查看被删除的记录！防止数据的丢失！类似于回收站！
1、在数据库表中增加一个deleted字段（默认值为0）
2、实体类中添加属性
@TableLogic // 逻辑删除
private Integer deleted;
3、配置（mybatisplus3.4.3.1版本）
mybatis-plus:
# 配置逻辑删除
global-config:
db-config:
logic-delete-field: deleted # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置实体类字段上加上@TableLogic注解)
logic-delete-value: 1 # 逻辑已删除值(默认为 1)
logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
4、测试（走的是更新操作,不是删除操作，会将deleted字段设置为1，逻辑上删除）
//测试条件删除，通过map
@Test
public void testDeleteByMap(){
HashMap<String, Object> map = new HashMap<>();
map.put("name","z1111113f");
this.userMapper.deleteByMap(map);
}
执行 SQL 分析打印
我们在平时的开发中,会遇到一些慢sql.
MP也提供了性能分析插件,如果超过这个时间就停止运行!
条件构造器
十分重要：wrapper
我们写一些复杂的sql就可以使用它来代替！
package com.zhang;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.zhang.mapper.UserMapper;
import com.zhang.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
/**
* @author ZhangFeng
* @version 1.0
* @description
* @date 2021/7/8
*/
@SpringBootTest
public class WrapperTest {
@Autowired
private UserMapper userMapper;
//条件查询
@Test
void testGe(){
//查询name和邮箱不为空，年龄大于12岁的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();//和map有点相似
wrapper.isNotNull("name").isNotNull("email").ge("age",12);//大于等于 greater是大于，equal是等于
userMapper.selectList(wrapper).forEach(System.out::println);
}
//条件查询
@Test
public void testEq(){
//查询名字为zf
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name","zf");
User user = this.userMapper.selectOne(wrapper);
System.out.println(user);
}
//时间范围查询
@Test
//测试时间范围
void testQueryOrderByCreateTime() throws ParseException {
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
Date fromCreateTime = sdf.parse("2014-03-02");
Date toCreateTime = new Date();
QueryWrapper<Order> wrapper = new QueryWrapper<>();
wrapper.between("create_time",fromCreateTime,toCreateTime);
List<Order> orderList = orderMapper.selectList(wrapper)
for (Order order : orderList) {
System.out.println(order.getOrderId());
}
}
//查询年龄在10-20岁之间
@Test
void testBetWeen(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age",10,20);//区间
List<User> userList = this.userMapper.selectList(wrapper);//查询到的用户集合
for (User user : userList) {
System.out.println(user);
}
}
//模糊查询
@Test
public void testLike(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.likeLeft("name","zf"); //name like '%zf'
List<User> userList = this.userMapper.selectList(wrapper);
for (User user : userList) {
System.out.println(user);
}
}
//内查询(可以多表联查)
@Test
public void testInSql(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.inSql("id","select id from user where id <20");
List<User> users = this.userMapper.selectList(wrapper);
for (User user : users) {
System.out.println(user);
}
}
//排序
@Test
public void testOrderBy(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
//通过id进行降序排序
wrapper.orderByDesc("id");
List<User> users = this.userMapper.selectList(wrapper);
for (User user : users) {
System.out.println(user);
}
}
代码生成器
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-boot-starterartifactId>
<version>3.4.3.1version>
dependency>
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-generatorartifactId>
<version>3.4.1version>
dependency>
<dependency>
<groupId>org.apache.velocitygroupId>
<artifactId>velocity-engine-coreartifactId>
<version>2.0version>
dependency>
<dependency>
<groupId>io.springfoxgroupId>
<artifactId>springfox-boot-starterartifactId>
<version>3.0.0version>
dependency>
<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
dependency>
文件
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("ZhangFeng");//设置作者
gc.setOpen(false);//是否打开资源管理器
gc.setFileOverride(false);// 是否覆盖原来生成的
gc.setServiceName("%sService");// 去Service的I前缀
gc.setIdType(IdType.ASSIGN_ID);//雪花算法自动生成id
gc.setDateType(DateType.ONLY_DATE);//日期格式
gc.setSwagger2(true);//配置swagger
mpg.setGlobalConfig(gc);//全局配置
//2、设置数据源
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/mp?useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=Asia/Shanghai");
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("MybatisPlus");
pc.setParent("com.zhang");
pc.setEntity("entity");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("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 createTime = new TableFill("create_time", FieldFill.INSERT);
TableFill updateTime = new TableFill("update_time", FieldFill.INSERT_UPDATE);
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(createTime); tableFills.add(updateTime);
strategy.setTableFillList(tableFills);
// 乐观锁
strategy.setVersionFieldName("version");
strategy.setRestControllerStyle(true);//controller是Restful风格
strategy.setControllerMappingHyphenStyle(true);// localhost:8080/hello_id_2
mpg.setStrategy(strategy);//全局配置
//执行全局配置
mpg.execute();
}
}