MyBatisPlus详解

2023-11-27 14:07:14 浏览数 (2)

MyBatisPlus详解

官网链接:链接

简介

MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。 MyBatis 最好的搭档,就像 魂斗罗 中的 1P、2P,基友搭配,效率翻倍。

为什么要学习它呢?

MyBatisPlus可以节省我们大量工作时间,所有的CRUD代码它都可以自动化完成!

特性

支持数据库

架构

快速开始

  1. 创建user表
代码语言:javascript复制
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');
  1. 创建springboot项目,导入依赖
代码语言:javascript复制
<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.6.RELEASE</version>
        <relativePath/>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.3.1.tmp</version>
        </dependency>
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <scope>runtime</scope>
        </dependency>
    </dependencies>

3. 配置 连接数据库

代码语言:javascript复制
spring:
  datasource:
    username: root
    password: 123456
    url: jdbc:mysql://localhost:3306/mybatis_plus?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC&useSSL=false
    driver-class-name: com.mysql.cj.jdbc.Driver
  1. 编写实体类
代码语言:javascript复制
@Data
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}
  1. 编写Mapper类
代码语言:javascript复制
public interface UserMapper extends BaseMapper<User> {

}
  1. 创建启动类
代码语言:javascript复制
@SpringBootApplication
@MapperScan("com.mybatisplus.mybatisplus.mapper")
public class MybatisplusApplication {

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

}
  1. 测试 查询全部用户
代码语言:javascript复制
@SpringBootTest
class MybatisplusApplicationTests {
    @Autowired
    UserMapper mapper;

    @Test
    void contextLoads() {
        List<User> users = mapper.selectList(null);
        users.forEach(System.out::println);//打印输出
    }

}

通过以上几个简单的步骤,我们就实现了 User 表的 CRUD 功能,甚至连 XML 文件都不用编写! 从以上步骤中,我们可以看到集成MyBatis-Plus非常的简单,只需要引入 starter 工程,并配置 mapper 扫描路径即可。 但 MyBatis-Plus 的强大远不止这些功能,想要详细了解 MyBatis-Plus 的强大功能?那就继续往下看吧!(官网原话)

配置日志

所有的sql不可见,我们需要观看sql是怎么执行的

代码语言:javascript复制
#mybatis日志配置
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

CRUD拓展

insert插入

代码语言:javascript复制
@Test
    public void testinsert(){
        User u=new User();
        u.setName("joker_dj");
        u.setAge(18);
        u.setEmail("2332810801@qq.com");
        mapper.insert(u);
    }

ID会自动生成

常见的id生成有

id生成策略 博客:链接

雪花算法

自增ID:对于数据敏感场景不宜使用,且不适合于分布式场景。 GUID:采用无意义字符串,数据量增大时造成访问过慢,且不宜排序。

最高位是符号位,始终为0,不可用。 41位的时间序列,精确到毫秒级,41位的长度可以使用69年。时间位还有一个很重要的作用是可以根据时间进行排序。 10位的机器标识,10位的长度最多支持部署1024个节点。 12位的计数序列号,序列号即一系列的自增id,可以支持同一节点同一毫秒生成多个ID序号,12位的计数序列号支持每个节点每毫秒产生4096个ID序号。 原文:链接

测试不同的主键自增策略

自增策略

代码语言:javascript复制
public enum IdType {
    AUTO(0),//主键自增
    NONE(1),//不使用
    INPUT(2),//手动输入
    ID_WORKER(3),//默认全局唯一Id
    UUID(4),//全局唯一id uuid
    ID_WORKER_STR(5);//字符串表示法
}

update更新

自动填充

创建时间、修改时间、这些操作是自动化完成的,我们不希望手动更新 阿里巴巴手册:所有数据表:gmt_create、gmt_modified几乎所有的表都要配置上!而且需要自动化!

方式一:数据库级别

  1. 在表中新增字段 create_time, update_time

再次测试,同步实体类

运行测试

方式二:代码级别

  1. 删除数据库的默认值
  1. 实体类上增加注解
  1. 编写handler策略
代码语言:javascript复制
@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    /*插入时的填充策略*/
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("填充....");//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("更新....");
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

乐观锁

在面试过程中,我们经常会被问道乐观锁,悲观锁!这个其实非常简单!

乐观锁 : 故名思意十分乐观,它总是认为不会出现问题,无论干什么不去上锁!如果出现了问题, 再次更新值测试 悲观锁:故名思意十分悲观,它总是认为总是出现问题,无论干什么都会上锁!再去操作!

乐观锁实现方式: 取出记录时,获取当前version 更新时,带上这个version 执行更新时, set version = newVersion where version = oldVersion 如果version不对,就更新失败

测试mybatisplus的乐观锁

添加字段 默认值为1

同步实体类

配置乐观锁

代码语言:javascript复制
@EnableTransactionManagement
@Configuration
public class Config {
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

测试乐观锁成功案例

会发现更新操作时默认带上version

失败案例

第二次修改并没有成功

select查询操作

代码语言:javascript复制
@Test
    public void testselect01(){//查询单个用户
        User user = mapper.selectById(1L);
        System.out.println(user);
    }
    @Test
    public void testselect02(){//查询多个用户 批量查询
        List<User> users = mapper.selectBatchIds(Arrays.asList(1, 2, 3));
        users.forEach(System.out::println);
    }
    //条件查询 map方式
    @Test
    public void testselect03(){
        HashMap<String, Object> map = new HashMap<>();
        map.put("name","joker_dj2");//查询字段name为joker_dj2的结果
        map.put("age",18);//查询字段age为18的值
        //...
        List<User> users = mapper.selectByMap(map);
        System.out.println(users);
    }

分页查询

分页插件有很多

  1. 原始的limit进行1分页
  2. pageHelper第三方插件
  3. MybatisPlus内置插件

如何使用 配置config

代码语言:javascript复制
//分页插件
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }

直接使用即可

代码语言:javascript复制
//分页插件
    @Test
    public void testPage(){
        //参数一:当前页
        //参数二:页面大小
        Page<User> objectPage = new Page<>(1, 5);//第1页,5行数据
        mapper.selectPage(objectPage, null);//分页查询 条件为null
        objectPage.getTotal();//获取总记录数
        objectPage.getRecords();//获取数据
        objectPage.getRecords().forEach(System.out::println);//打印输出
    }

删除操作

代码语言:javascript复制
 //删除操作 根据ID删除 单个
    @Test
    public void Testdelete(){
        mapper.deleteById(5L);
    }
    @Test//批量删除
    public void testdelete02(){
        mapper.deleteBatchIds(Arrays.asList(1,2,3));//删除id为1 2 3 的用户
    }
    //通过map操作
    @Test
    public void testmapdelete(){
        HashMap<String, Object> map = new HashMap<>();
        map.put("name","joker_dj2");//删除name为joker_dj2的用户
        mapper.deleteByMap(map);
    }

逻辑删除

  1. 物理删除:从数据库直接移除
  2. 逻辑移除:在数据库中没有直接删除,而是通过一个变量让他失效 场景: 管理员可以查看被删除的数据,防止数据丢失,类似于回收站

使用: 3. 在数据库中增加一个delete字段 默认值为0

  1. 实体类同步
  1. 配置逻辑删除

测试删除

可以看到,测试的是删除操作,实际上走的是更新操作,并不是删除操作 测试查询 会跟上where deleted=0的sql 非管理员

性能分析插件

我们在平时的开发中,会遇到一些慢sql。测试! druid, 作用:性能分析拦截器,用于输出每条 SQL 语句及其执行时间 mybatisplus也提供性能分析插件,如果超过这个时间就停止运行!

使用

  1. 导入插件
  1. 配置项目为测试环境

条件构造器

Wrapper十分重要 复杂的sql就靠它

使用

  1. 判断空
代码语言:javascript复制
//查询name不为空,并且邮箱不为空的用户,年龄大于18的用户
    @Test
    public void testwrapper(){
        QueryWrapper<User> Wrapper = new QueryWrapper<>();
        Wrapper
                .isNotNull("name")//查询不为空的用户
                .isNotNull("email")//箱不为空
                .ge("age",19);//年龄大于18的用户 19>18
        ;
        mapper.selectList(Wrapper);
    }

2. 等于,模糊查询

代码语言:javascript复制
 @Test
    public void  test01(){//查询一个name等于joker_dj的用户
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name","joker_dj");
        mapper.selectOne(wrapper);
    }
    @Test
    public void test02(){//查询年龄在18-21的用户个数
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age",18,21);
        Integer integer = mapper.selectCount(wrapper);
        System.out.println(integer);
    }
    @Test
    public void test03(){//模糊查询
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .notLike("name","j")//查询姓名不包含j的用户
                .likeRight("email","t") //左和右likeLeft '%t' likeRight 't%'
        ;
        List<Map<String, Object>> maps = mapper.selectMaps(wrapper);
        maps.forEach(System.out::println);
    }
  1. 子查询
  1. 排序

代码生成器

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

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

  1. 导入依赖
代码语言:javascript复制
<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.6.RELEASE</version>
        <relativePath/>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!--mybatis和mybatisplus最好只导入其中一个-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.5</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.2.0</version>
        </dependency>
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.1</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.19</version>
        </dependency>
    </dependencies>
  1. 编写生成器代码
代码语言:javascript复制
 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("joker_dj");//设置作者
        gc.setOpen(false);//是否打开资源管理器
        gc.setFileOverride(false); // 是否覆盖
        gc.setServiceName("%sService"); // 去Service的I前缀
        gc.setIdType(IdType.AUTO);//设置主键的算法 //对应数据的主键(uuid,自增ID,雪花算法,redis,zookeeper)
        gc.setDateType(DateType.ONLY_DATE);//日期类型
        gc.setSwagger2(true);//是否配置Swagger2
        mpg.setGlobalConfig(gc);
        //2、设置数据源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT+8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        dsc.setDbType(DbType.MYSQL);//配置数据库类型 mysql
        mpg.setDataSource(dsc);
        //3、包的配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("codegeneration");//模块名称
        pc.setParent("com.dj");//配置工程包名称
        pc.setEntity("entity");//配置entity的包名
        pc.setMapper("mapper");//配置mapper的包名
        pc.setService("service");//配置service的包名
        pc.setController("controller");//配置controller的包名
        mpg.setPackageInfo(pc);//配置包
        //4、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("user"); 设置映射的表名 多个表strategyConfig.setInclude("user","cloud","...");
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);//字段名转驼峰命名
        strategy.setEntityLombokModel(true); // 自动lombok;
        strategy.setLogicDeleteFieldName("deleted");//逻辑删除的字段名称
        // 自动填充配置
        TableFill create_time = new TableFill("create_time", FieldFill.INSERT);//自动填充更新的字段
        TableFill update_time = new TableFill("update_time", FieldFill.INSERT_UPDATE);//自动更新的字段
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(create_time);//创建的策略
        tableFills.add(update_time);//更新的策略
        strategy.setTableFillList(tableFills);
        // 乐观锁
        strategy.setVersionFieldName("version");
        strategy.setRestControllerStyle(true);
        strategy.setControllerMappingHyphenStyle(true);
        mpg.setStrategy(strategy);
        mpg.execute(); //执行
    }

0 人点赞