Mybatis-Plus详解

最新推荐文章于 2024-05-11 17:48:25 发布

Richard_lca

最新推荐文章于 2024-05-11 17:48:25 发布

阅读量499

点赞数

分类专栏：微服务文章标签： mybatis java

本文链接：https://blog.csdn.net/Richard606/article/details/114436847

版权

微服务专栏收录该内容

4 篇文章 0 订阅

订阅专栏

Mybatis-Plus详解

概述

在这里插入图片描述

官网：https://mp.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

步骤：

1、创建数据库

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这些字段

DELETE FROM user;

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');

3、初始化项目，导入相关依赖

<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-boot-starter</artifactId>
  <version>3.4.2</version>
</dependency>
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <scope>runtime</scope>
</dependency>
<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <optional>true</optional>
</dependency>

4、配置数据源

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql:///mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
    username: root
    password: root

5、创建实体类

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

6、创建Mapper接口，继承BaseMapper

@Repository
public interface UserMapper extends BaseMapper<User> {
}

7、测试查询

/**
     * 测试查询所有
     */
@Test
public void testSelect() {
  userMapper.selectList(null).forEach(System.out::println);
}


/*
User(id=1, name=Jone, email=test1@baomidou.com, age=18)
User(id=2, name=Jack, email=test2@baomidou.com, age=20)
User(id=3, name=Tom, email=test3@baomidou.com, age=28)
User(id=4, name=Sandy, email=test4@baomidou.com, age=21)
User(id=5, name=Billie, email=test5@baomidou.com, age=24)
*/

注意点，我们需要在主启动类上去扫描我们的mapper包下的所有接口 @MapperScan(“com.richard.mapper”)

配置日志输出

# 配置日志 控制台输出
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

CRUD扩展

插入操作

Insert插入

@Test
public void testInsert() {
  User user = new User();
  user.setName("张三");
  user.setAge(15);
  user.setEmail("123@123.com");
  int insert = userMapper.insert(user);
  //受影响的行数
  System.out.println("insert = " + insert);
  //自动生成的id
  System.out.println("Id = " + user.getId());
}

数据库插入的id的默认值为：全局唯一id（雪花算法）

主键生成策略

默认ID_WORKER 全局唯一

分布式系统唯一ID生成方案汇总: http://www.cnblogs.com/haoxinyue/p/5208136.html

雪花算法：

snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是:使用41bit作为毫秒数，10bit作为机器的ID(5个bit是数据中心，5个bit的机器ID)，12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID)，最后还有一个符号位，永远是0。可以保证几乎全球唯一!

主键自增

需要以下配置：

1、实体类字段上==@TableId(type = IdType.AUTO)==

2、数据库中的字段一定要是自增的

3、再次插入测试即可

其他策略解释：

//基于Mybatis-plus 3.4.2
public enum IdType {
    /**
     * 数据库ID自增
     * <p>该类型请确保数据库设置了 ID自增 否则无效</p>
     */
    AUTO(0),
    /**
     * 该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)
     */
    NONE(1),
    /**
     * 用户输入ID
     * <p>该类型可以通过自己注册自动填充插件进行填充</p>
     */
    INPUT(2),

    /* 以下3种类型、只有当插入对象ID 为空，才自动填充。 */
    /**
     * 分配ID (主键类型为number或string）,
     * 默认实现类 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(雪花算法)
     *
     * @since 3.3.0
     */
    ASSIGN_ID(3),
    /**
     * 分配UUID (主键类型为 string)
     * 默认实现类 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(UUID.replace("-",""))
     */
    ASSIGN_UUID(4),
    /**
     * @deprecated 3.3.0 please use {@link #ASSIGN_ID}
     */
    @Deprecated
    ID_WORKER(3),
    /**
     * @deprecated 3.3.0 please use {@link #ASSIGN_ID}
     */
    @Deprecated
    ID_WORKER_STR(3),
    /**
     * @deprecated 3.3.0 please use {@link #ASSIGN_UUID}
     */
    @Deprecated
    UUID(4);

    private final int key;

    IdType(int key) {
        this.key = key;
    }
}

更新操作

@Test
public void testUpdate() {
  User user = new User()
    .setId(6L)
    .setEmail("456@456.com")
    .setName("李四")
    .setAge(18);
  int i = userMapper.updateById(user);
  System.out.println(i);
}

/**
所有的SQL都是自动生成的
==>  Preparing: UPDATE user SET name=?, email=?, age=? WHERE id=?
==> Parameters: 李四(String), 456@456.com(String), 18(Integer), 6(Long)
<==    Updates: 1
*/

自动填充

阿里巴巴开发手册:所有的数据库表:gmt_create、gmt_modified几乎所有的表都要配置上!而且需要自动化!

方式一：数据库级别实现（工作中一般不允许你修改数据库）

1、在表中添加gmt_create、gmt_modified字段，并设置默认值为current_timestamp，设置修改时间自动更新

2、在实体类中添加相应的属性

/**
     * 创建时间
     */
private Date gmtCreate;
/**
     * 修改时间
     */
private Date gmtModified;

3、再次更新查看结果即可
在这里插入图片描述

方式二：代码级别实现

1、实体类字段上添加@TableField注解

/**
     * 创建时间
     */
@TableField(fill = FieldFill.INSERT)
private Date gmtCreate;
/**
     * 修改时间
     */
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmtModified;

2、编写处理器来处理这个注解

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    /**
     * 插入时的填充策略
     *
     * @param metaObject 元数据
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("添加时自动填充字段数据...");
        setFieldValByName("gmtCreate", new Date(), metaObject);
        setFieldValByName("gmtModified", new Date(), metaObject);
    }

    /**
     * 更新时的填充策略
     *
     * @param metaObject 元数据
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("更新时自动填充字段数据...");
        setFieldValByName("gmtModified", new Date(), metaObject);
    }
}

3、测试添加和修改

乐观锁

乐观锁：顾名思义，十分乐观，总是认为不会出现问题，无论干什么都不去上锁，如果出现问题，再次更新值进行测试

悲观锁：顾名思义，十分悲观，总是认为会出现问题，无论干什么都上锁，在进行操作

乐观锁实现方式：

取出记录时，获取当前记录version字段的值
更新时，带上这个version条件
执行更新时，set version = newVersion where version = oldVersion
如果version不一致，则更新失败

# 乐观锁： 先查询，获得版本号version = 1
-- 假设：
-- A线程准备执行
update user set name = "richard",version = version + 1 
where id = 2 and version = 1

-- B线程抢先A线程完成修改，此时version已经为2了，会导致A修改失败！
update user set name = "richard",version = version + 1 
where id = 2 and version = 1

测试使用Mybatis-plus的乐观锁插件

1、在数据库中添加version字段，默认值设为1

2、在实体类中添加相应字段，添加@Version注解

/**
     * 乐观锁
     */
@Version
private Integer version;

3、注册乐观锁插件

@Configuration
@EnableTransactionManagement
@MapperScan("com.richard.mapper")
public class MybatisPlusConfig {

    /**
     * 注册乐观锁插件
     *
     * @return MybatisPlusInterceptor
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
    }
}

4、测试

/**
     * 测试乐观锁更新失败
     */
@Test
public void test2() {
  //模拟多线程操作
  //线程一
  User user = userMapper.selectById(8L);
  user.setName("王五8");

  //模拟另一个线程插队操作
  User user2 = userMapper.selectById(8L);
  user2.setName("王五9");
  userMapper.updateById(user2);

  //线程一此时提交会失败
  userMapper.updateById(user);
}


==>  Preparing: UPDATE user SET name=?, email=?, age=?, gmt_create=?, gmt_modified=?, version=? WHERE id=? AND version=?
==> Parameters: 王五9(String), 456@456.com(String), 101(Integer), 2021-03-05 12:35:22.0(Timestamp), 2021-03-06 09:23:51.946(Timestamp), 4(Integer), 8(Long), 3(Integer)
<==    Updates: 1
  
  
==>  Preparing: UPDATE user SET name=?, email=?, age=?, gmt_create=?, gmt_modified=?, version=? WHERE id=? AND version=?
==> Parameters: 王五8(String), 456@456.com(String), 101(Integer), 2021-03-05 12:35:22.0(Timestamp), 2021-03-06 09:23:51.967(Timestamp), 4(Integer), 8(Long), 3(Integer)
<==    Updates: 0

查询操作

/**
     * 根据id查询
     */
@Test
public void testSelectById() {
  User user = userMapper.selectById(1);
  System.out.println(user);
}

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

/**
     * 根据map按条件查询
     */
@Test
public void testSelectByMap() {
  HashMap<String, Object> map = new HashMap<>();
  map.put("name", "Jone");
  List<User> users = userMapper.selectByMap(map);
  users.forEach(System.out::println);
}

分页查询

Mybatis-plus内置了分页插件！

1、注册分页插件

/**
     * 注册插件
     *
     * @return MybatisPlusInterceptor
     */
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
  MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
  //分页插件
  interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
  //乐观锁
  interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
  return interceptor;
}

2、测试

/**
     * 测试分页插件
     */
@Test
public void testPage() {
  //参数一：当前页
  //参数二：每页显示的条数
  Page<User> page = new Page<>(3, 2);
  userMapper.selectPage(page, null);
  page.getRecords().forEach(System.out::println);
  System.out.println("总条数==>" + page.getTotal());
}

删除操作

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

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

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

逻辑删除

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

逻辑删除：数据库中不移除，通过一个字段来让这条记录失效！

deleted = 0 ==> deleted = 1

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

步骤：

1、在数据表中添加一个deleted字段，默认值为0

2、在实体类中添加相应字段，添加@TableLogic注解

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

4、application.yaml中添加配置

mybatis-plus:
  global-config:
    db-config:
      logic-delete-value: 1 # 逻辑删除值
      logic-not-delete-value: 0 # 逻辑未删除值
      logic-delete-field: deleted # 逻辑删除字段

5、测试

/**
     * 测试逻辑删除
     */
@Test
public void testLogicDelete() {
  int i = userMapper.deleteById(8);
  System.out.println(i);
}

// UPDATE user SET deleted=1 WHERE id=? AND deleted=0

记录依然在数据库，但是deleted的值已经变化了

查询的时候回自动过滤被逻辑删除的字段

条件构造器

需要构造复杂SQL，就可以使用条件构造器Wrapper

详解见官网：https://mp.baomidou.com/guide/wrapper.html#abstractwrapper

测试一：查询name不为空，并且邮箱不为空的用户，年龄大于等于12

/**
     * 查询name不为空，并且邮箱不为空，年龄大于等于12的用户
     */
@Test
public void test1() {
  QueryWrapper<User> wrapper = new QueryWrapper<>();
  wrapper.isNotNull("name")
    .isNotNull("email")
    .ge("age", 12);
  List<User> users = userMapper.selectList(wrapper);
  users.forEach(System.out::println);
}

测试二：查询年龄在 20 ~ 30 岁之间的用户数量

/**
     * 查询年龄在 20 ~ 30 岁之间的用户数量
     */
@Test
public void test2() {
  QueryWrapper<User> wrapper = new QueryWrapper<>();
  wrapper.between("age", 20, 30);
  Integer integer = userMapper.selectCount(wrapper);
  System.out.println("count==>" + integer);
}

代码自动生成器

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、

Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

/**
 * @author Richard
 * 2021/3/6 10:47 上午
 */
@SpringBootTest
public class AutoGeneratorTest {

    @Test
    public void testAutoGenerator() {
        //创建生成器对象
        AutoGenerator generator = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("Richard");
        gc.setOpen(false);
        //是否覆盖已有文件
        gc.setFileOverride(true);
        //实体属性 Swagger2 注解
        gc.setSwagger2(true);
        //时间类型策略
        gc.setDateType(DateType.ONLY_DATE);
        //id生成策略
        gc.setIdType(IdType.AUTO);
        generator.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setDbType(DbType.MYSQL);
        dsc.setUrl("jdbc:mysql:///mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        generator.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        //模块名
        //pc.setModuleName("");
        pc.setParent("com.richard");
        generator.setPackageInfo(pc);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        //表名
        strategy.setInclude("user");
        //驼峰转换
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //lombok
        strategy.setEntityLombokModel(true);
        //RestController
        strategy.setRestControllerStyle(true);
        //逻辑删除字段
        strategy.setLogicDeleteFieldName("deleted");
        strategy.setControllerMappingHyphenStyle(true);
        // 自动填充配置
        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.setTablePrefix(pc.getModuleName() + "_");
        generator.setStrategy(strategy);

        //执行生成
        generator.execute();
    }
}

Richard_lca

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Mybatis-Plus详解

Mybatis-Plus详解概述[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Ua6VB4rG-1615004821916)(/Users/richard/Desktop/CSDN/img/image-20210303203140504.png)]官网：https://mp.baomidou.com/特性：无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作强大的 CRUD
复制链接

扫一扫