MybatisPlus笔记

菜鸡小Li
306 阅读7分钟

一、快速入门

官方文档：mp.baomidou.com/

步骤：

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)
);
2.1、插入测试数据
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、利用IDEA创建一个项目（这里具体的细节就不说了）

4、导入依赖

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

特别注意：使用Mybatis-plus可以大量的节约我们的代码，但是尽量不要同时导入mybatis和mybatis-plus依赖！

5、连接数据库

spring.datasource.username=root
spring.datasource.password=426457
spring.datasource.url=jdbc:mysql://localhost:3306/work?useSSl=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

6、使用了mybatis-plus之后就不用再去编写Service、Impl、和mapper了

pojo

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    @TableId(type = IdType.AUTO)
    private long id;
    private String name;
    private int age;
    private String email;
    @Version
    private int version;

    @TableLogic//逻辑删除
    private int deleted;
}

mapper接口

@Repository  //代表是持久层
public interface UserMapper extends BaseMapper<User> {

}

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

@MapperScan("com.lyw.Mapper")  //扫描Mapper文件夹
@SpringBootApplication
public class MybatisPlusApplication {

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

在测试类中进行测试

@SpringBootTest
class MybatisPlusApplicationTests {
    @Autowired
    UserMapper userMapper;
 
    @Test
    void contextLoads() {
        // 查询全部用户
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }
}

二、配置日志

既然我们不需要自己气编写sql语句了，要想知道sql是怎么执行的，就需要打开日志

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

配置完成之后就可以查看内部自动生成的sql语句是什么样子的了

三、增、删、改、查

1、增（insert）

@Test
public void testInsert() {
    User user = new User();
    user.setName("Dainel");
    user.setAge(3);
    user.setEmail("daniel@alibaba.com");
 
    int result = userMapper.insert(user);// 帮我们自动生成id
    System.out.println(result);// 受影响的行数
    System.out.println(user);// 发现: id自动回填
}

以上插入时并没有设置id的值（前提时设置了id自增）

image.png

image.png 其余的源码解释

public enum IdType {
    AUTO(0), // 数据库id自增
    NONE(1), // 未设置主键
    INPUT(2), // 手动输入，自己写id
    ID_WORKER(3), // 默认的全局唯一id
    UUID(4), // 全局唯一id uuid
    ID_WORKER_STR(5); // ID_WORKER 字符串表示法
}

2、更新操作

@Test
    /*更新操作*/
void updateUser() {
    // 查询到要更新的用户
    User user = userMapper.selectById(7);
    // 要更新的值
    user.setName("demo");
    user.setAge(21);
    // 执行更新
    userMapper.updateById(user);
}

3、自动填充

通常我们在操作创建时间和更改时间时，是不希望手动去更改的这时候我们就需要使用自动填充

方式一、直接更改数据库设置

1、在表中新增字段 create_time,update_time；注意将更新的时间戳勾选

image.png

2、再次测试插入方法（别忘了更新实体类）

image.png

方式二、更改代码

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

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

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

3、编写处理器来处理这个注解即可:handler/MyMetaObjectHandler

package com.kuang.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 ...");
        // setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject)
        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、乐观锁

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

悲观锁：顾名思义，它总是认为总是出现问题，无论干什么都上锁！再去操作！

乐观锁实现方式：

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

测试：

1、数据库中增加一个version字段，初始值为1

2、在实体类中增加version注解

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

3、编写配置config/MybatisPlusConfig

@Configuration
public class MybatisPlusConfig {
    // 注册乐观锁
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInnerInterceptor(){
        return new OptimisticLockerInterceptor();
    }
}

测试：

成功：将2号的姓名改为lipu。查看version的变化

@Test
void OptimisticLock() {
    // 查询到要进行更新的用户
    User user = userMapper.selectById(2);
    // 修改用户的属性
    user.setName("lipu");
    user.setAge(28);
    // 提交更新
    userMapper.updateById(user);
}

image.png

失败：在多线程的情况下

// 测试乐观锁失败!多线程下
@Test
public void testVersionFall() {
    // 线程1
    User user1 = userMapper.selectById(9);
    user1.setName("fan111");
    user1.setAge(14);
    // 线程2
    User user2 = userMapper.selectById(9);
    user2.setName("fan222");
    user2.setAge(24);
    userMapper.updateById(user2);
    //自旋锁来多次尝试提交！
    userMapper.updateById(user1); //如果没有乐观锁就会覆盖插队线程的值
}

image.png

5、查询（select）

// 测试查询
@Test
public void testSelectById(){
    User user = userMapper.selectById(1);
    System.out.println(user);
}
 
// 批量查询
@Test
public void testSelectByBatchIds(){
    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","Dainel");
    map.put("age","6");
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

6、分页查询

在网页中分页经常使用，以下是几种常见的方式

  • 原始使用limit进行分页
  • pageHelper第三方插件
  • MybatisPlus内置了分页插件

使用MybatisPlus内置了分页插件

1、配置分页插件

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

2、编写分页查询语句

// 分页查询
@Test
void selectLimit() {
    Page<User> page = new Page<User>(2, 5);
    // 获取通过分页查询到的记录条数
    page.getRecords().forEach(System.out::println);
    // 查询
    userMapper.selectPage(page, null);
    // 查询总记录条数
    System.out.println("总计数条数：" + page.getTotal());
}

image.png

7、删除（delete）

// 测试删除
@Test
public void testdelete(){
    userMapper.deleteById(6L);
}
 
// 测试批量删除
@Test
public void testdeleteBatchId(){
    userMapper.deleteBatchIds(Arrays.asList(1,14));
}
 
//通过map删除
@Test
public void testDeleteByMap(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","KUANG");
    userMapper.deleteByMap(map);
}

8、逻辑删除

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

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

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

步骤：

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

2、修改实体类

// 表逻辑删除
@TableLogic
private int deleted;

3、添加配置

// 逻辑删除组件
public ISqlInjector sqlInjector(){
    return new LogicSqlInjector();
}

4、添加properties里的配置

# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

5、测试

// 逻辑删除
@Test
void deleteLogic() {
    userMapper.deleteById(1);
}

image.png

删除成功

image.png

再次查询1号用户，查询结果为0

image.png

四、性能分析插件

在平时的开发过程中，会遇到一些慢sql的问题。 性能分析插件的作用就是用于输出每条sql语句及其执行时间，如果超过这个时间，就停止运行。 1、导入插件

// SQL执行效率插件
@Bean
@Profile({"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 selectLimit() {
    Page<User> page = new Page<User>(1, 5);
    // 获取通过分页查询到的记录条数
    page.getRecords().forEach(System.out::println);
    // 查询
    userMapper.selectPage(page, null);
    // 查询总记录条数
    System.out.println("总计数条数：" + page.getTotal());
}

image.png

只要超出时间，就会抛出异常。

使用性能分析插件可以提高效率，新版本MP已经移除该拆件了，可以使用druid

五、代码生成器

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

需要用到的pom依赖

<dependencies>
        <!--swagger依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

        <!-- 模板引擎 -->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.0</version>
        </dependency>
        <!--导入mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.5</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

测试代码

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 java.util.ArrayList;
 
// 代码自动生成器
public class zhixiCode {
    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);
 
        // 去掉IService的I前缀(正则)
        gc.setServiceName("%sService");
 
        // 设置字段
        gc.setIdType(IdType.ID_WORKER);
        gc.setDateType(DateType.ONLY_DATE);
        // 配置swagger
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);
 
        //2、设置数据源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://182.92.209.212:3306/mybatis_plus?useSSL=true&useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("密码");
        // 数据库类型
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);
 
        //3、包的配置(只需要改实体类名字 和包名 还有 数据库配置即可)
        PackageConfig pc = new PackageConfig();
 
        // 模块名
        pc.setModuleName("blog");
        // 设置类放在哪个包下
        pc.setParent("com.kuang");
        // 设置实体类
        pc.setEntity("entity");
        // 设置mapper
        pc.setMapper("mapper");
        // 设置services层
        pc.setService("service");
        // 设置controller层
        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);
        // 自动lombok；
        strategy.setEntityLombokModel(true);
        // 设置逻辑删除列名
        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(); //执行
    }
}

image.png

这就是MP的强大之处！！

avatar
文章
阅读
粉丝