2021-10-27 MybatisPlus学习笔记

最新推荐文章于 2023-06-25 17:53:03 发布

XJun0

最新推荐文章于 2023-06-25 17:53:03 发布

阅读量194

点赞数

分类专栏：学习笔记文章标签： java maven intellij-idea

本文链接：https://blog.csdn.net/xiaojun6/article/details/121002618

版权

学习笔记专栏收录该内容

3 篇文章 0 订阅

订阅专栏

MybatisPlus

简介

MyBatis-Plus（简称 MP）是一个 MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

官网：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://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)
);
###########################################################
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、编写项目，使用SpringBoot初始化，勾选Web

导入依赖

<!--        数据库驱动-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!--        lombok-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.3.4</version>
</dependency>

连接数据库

#连接数据库
spring:
  datasource:
    username: root
    password: ********
    url: jdbc:mysql://127.0.0.1:3306/mybatis?useSSL=true&serverTimezone=Hongkong&useUnicode=true&characterEncoding=utf-8
    driver-class-name: com.mysql.cj.jdbc.Driver

编写UserMapper接口,继承BaseMapper类

@Mapper //使用Mybatis_plus只需要在对应的Mapper上继承基本的类BaseMapper
public interface UserMapper extends BaseMapper<User> {
    //所有的CRUD已编写完成
    //不需要像以前一样
}

编写实体类，需要使用注解==@TableName==设置实体类对应的数据库

@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName("mybatis_plus.user")	//设置实体的数据库名！！！！
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

在主启动类上添加注释==@MapperScan(“com.xjun.mapper”)==扫描Mapper

@SpringBootApplication
@MapperScan("com.xjun.mapper")      //只添加了这个注释
public class MybatisPlusApplication {

    public static void main(String[] args) {
        SpringApplication.run(MybatisPlusApplication.class, args);
    }
}

测试成功

@SpringBootTest
class MybatisPlusApplicationTests {
    //继承了BaseMapper，所有的方法都来自父类
    @Autowired
    private UserMapper userMapper;
    @Test
    void contextLoads() {
        List<User> userList = userMapper.selectList(null);
        userList.forEach(System.out::println);
    }
}

配置日志

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

CURD拓展

插入操作

Insert插入

@Test
void testInsert(){
    User user = new User("潇君", 3, "1429752364@qq.com");
    int result = userMapper.insert(user);
    System.out.println(result);
    System.out.println(user);
}

发现自动帮我们设置了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。具体实现的代码可以参看https://github.com/twitter/snowflake。雪花算法支持的TPS可以达到419万左右（2^22*1000）。

ID上可以添加的类型

    /**
     * 数据库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);

自增

更新操作

Update更新

@Test
void testUpdate(){
    User user = new User(1452473044103221250L,"New潇君", 3, "1429752364@qq.com");
    userMapper.updateById(user);
}

所有的SQL，MybatisPlus会帮我们自动动态配置！

自动填充

创建时间、修改时间，这些内容都是自动化完成的，我们不希望手动更新时间。

阿里巴巴开发手册：所有的数据库表：gmt_create、gmt_modified，必须配置这两个字段，而且自动化

方式一：数据库级别（工作中不建议使用）

1、在表中新增字段 create_time,update_time 默认CURRENT_TIMESTAMP当前时间

同步实体类

private Date createTime;
private Date updateTime;

再次测试更新方法

方式二：代码级别

1、首先删除数据的默认值和更新操作

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

//字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private LocalDateTime createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private LocalDateTime updateTime;

3、编写处理器，来处理注解

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    //插入时的填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");
        this.setFieldValByName("createTime",LocalDateTime.now(),metaObject);
    }
    //更新时的填充策略
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.setFieldValByName("updateTime",LocalDateTime.now(),metaObject);
    }
}

乐观锁

当要更新一条记录的时候，希望这条记录没有被别人更新
乐观锁实现方式：

取出记录时，获取当前version
更新时，带上这个version
执行更新时， set version = newVersion where version = oldVersion
如果version不对，就更新失败

1、新增字段Version乐观锁，默认值为1

2、实体类添加字段

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

3、组件注册

@EnableTransactionManagement
@Configuration
public class MybatisPlusConfig {
    @Bean
    //MybatisPlusInterceptor 拦截器主体
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        //乐观锁插件
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
    }
}

查询操作

//使用ID查询
@Test
public void testSelectById(){
    User user = userMapper.selectById(1L);
    System.out.println(user);
}
//批量查询
@Test
public void testSelectBatchIds(){
    List<User> userList = userMapper.selectBatchIds(Arrays.asList(1,2,3));
    userList.forEach(System.out::println);
}
//按条件查询之一 使用Map操作
@Test
public void testSelectByMap(){
    HashMap<String, Object> map = new HashMap<>();
    //自定义查询条件
    map.put("name","潇君");
    map.put("age",3);
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

分页查询

1、原始的Limit进行分页

2、PageHelper第三方插件

3、MybatisPlus内置的分页插件

使用

1、配置拦截器组件

@EnableTransactionManagement
@Configuration
public class MybatisPlusConfig {
    //MybatisPlusInterceptor 拦截器主体
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        //乐观锁插件
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        //分页插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

2、测试

@Test
public void testPage(){
    //参数一：当前页
    //参数二：页面显示个数
    Page<User> page = new Page<>(1,5);
    userMapper.selectPage(page,null);
    page.getRecords().forEach(System.out::println);
}

删除操作

//测试删除
@Test
public void testDeleteById(){
    userMapper.deleteById(1452473044103221250L);
}
//测试批量删除
@Test
public void testDeleteBatchIds(){
    userMapper.deleteBatchIds(Arrays.asList(1452473044103221251L,1452473044103221252L));
}
@Test
public void testDeleteByMap(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","XJun");
    userMapper.deleteByMap(map);
}

逻辑删除

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

逻辑删除：在数据库中没有被移除，而是通过一个变量让他失效！deleted=0=>deleted=1

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

官方说明:

只对自动注入的sql起效:

插入: 不作限制
查找: 追加where条件过滤掉已删除数据,且使用 wrapper.entity 生成的where条件会忽略该字段
更新: 追加where条件防止更新到已删除数据,且使用 wrapper.entity 生成的where条件会忽略该字段
删除: 转变为更新

例如:

删除: update user set deleted=1 where id = 1 and deleted=0
查找: select id,name,deleted from user where deleted=0

字段类型支持说明:

支持所有数据类型(推荐使用 Integer,Boolean,LocalDateTime)
如果数据库字段使用datetime,逻辑未删除值和已删除值支持配置为字符串null,另一个值支持配置为函数来获取值如now()

附录:

逻辑删除是为了方便数据恢复和保护数据本身价值等等的一种方案，但实际就是删除。
如果你需要频繁查出来看就不应使用逻辑删除，而是以一个状态去表示。

测试

1、在数据表中增加deleted字段

2、实体类中添加字段。

@TableLogic //逻辑删除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)

4、测试删除

其实并没有删除，只是将deleted改为1

但是查询的时候会自动拼接where deleted=0，无法查看被逻辑删除的内容，管理员可以查看。

性能分析插件

**官网教程：**https://mp.baomidou.com/guide/p6spy.html

该插件有性能损耗，不建议生产环境使用。

该功能依赖 p6spy 组件，完美的输出打印 SQL 及执行时长 3.1.0 以上版本

1、添加Maven依赖

<dependency>
    <groupId>p6spy</groupId>
    <artifactId>p6spy</artifactId>
    <version>最新版本</version>
</dependency>

2、更改数据库配置为P6spy的驱动

#数据库连接配置
spring:
  datasource:
    username: root
    password: ********							#URL改为p6spy	
    url: jdbc:p6spy:mysql://127.0.0.1:3306/mybatis?						useSSL=true&serverTimezone=Hongkong&useUnicode=true&characterEncoding=utf-8
    driver-class-name: com.p6spy.engine.spy.P6SpyDriver			#更改驱动
#    driver-class-name: com.mysql.cj.jdbc.Driver

3、配置文件spy.properties

#3.2.1以上使用
modulelist=com.baomidou.mybatisplus.extension.p6spy.MybatisPlusLogFactory,com.p6spy.engine.outage.P6OutageFactory
#3.2.1以下使用或者不配置
#modulelist=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
# 自定义日志打印
logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger
#日志输出到控制台
appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger
# 使用日志系统记录 sql
#appender=com.p6spy.engine.spy.appender.Slf4JLogger
# 设置 p6spy driver 代理
deregisterdrivers=true
# 取消JDBC URL前缀
useprefix=true
# 配置记录 Log 例外,可去掉的结果集有error,info,batch,debug,statement,commit,rollback,result,resultset.
excludecategories=info,debug,result,commit,resultset
# 日期格式
dateformat=yyyy-MM-dd HH:mm:ss
# 实际驱动可多个
#driverlist=org.h2.Driver
# 是否开启慢SQL记录
outagedetection=true
# 慢SQL记录标准 2 秒
outagedetectioninterval=2

4、测试使用：

显示执行时间和执行的SQL语句

条件构造器

用的时候去官网看看吧：https://mp.baomidou.com/guide/wrapper.html

代码自动生成器

dao、pojo、service、controller都给我自己去编写完成！

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

测试：

package com.kuang;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
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 java.util.ArrayList;
// 代码自动生成器
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("潇君");
        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);
        //2、设置数据源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/kuang_community?
                   useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
                   dsc.setDriverName("com.mysql.cj.jdbc.Driver");
                   dsc.setUsername("root");
                   dsc.setPassword("123456");
                   dsc.setDbType(DbType.MYSQL);
                   mpg.setDataSource(dsc);
                   //3、包的配置
                   PackageConfig pc = new PackageConfig();
                   pc.setModuleName("blog");
                   pc.setParent("com.xjun");
                   pc.setEntity("entity");
                   pc.setMapper("mapper");
                   pc.setService("service");
                   pc.setController("controller");
                   mpg.setPackageInfo(pc);
                   //4、策略配置
                   StrategyConfig strategy = new StrategyConfig();
                   strategy.setInclude("blog_tags","course","links","sys_settings","user_record","
                                       user_say"); // 设置要映射的表名
                                       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); //
                                       localhost:8080/hello_id_2
                                       mpg.setStrategy(strategy);
                                       mpg.execute(); //执行
                                       }
                                       }

XJun0

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
2021-10-27 MybatisPlus学习笔记

MybatisPlus简介MyBatis-Plus（简称 MP）是一个 MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。官网：https://mp.baomidou.com/（最全的文档）特性无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分
复制链接

扫一扫