mybatisplus 开源后端架构 mybatisplus简介

目录

• MybatisPlus超详细介绍

• Mybatis概述
• 版本问题
• 快速开始
• 配置日志
• 插入操作

• 插入测试
• 插入时主键生成策略

• 更新操作

• 自动填充时间
• 插入时添加乐观锁

• 删除操作

• 删除测试
• 逻辑删除

• 查询操作

• 查询测试
• 分页查询
• 条件构造器

• 代码生成器

MybatisPlus超详细介绍

Mybatis概述

官网：https://mp.baomidou.com/.

简介

Mybatis-Plus是一个Mybatis的增强工具，在Mybatis的基础上只做增强不做改变，为简化开发提高效率而生

特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作，BaseMapper
• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求，以后简单的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 操作智能分析阻断，也可自定义拦截规则，预防误操作

版本问题

该文章使用版本为3.0.5，也会将与3.4.0版本的区别

快速开始

官网：https://mp.baomidou.com/guide/.

步骤

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, '[e-mail]'),
(2, 'Jack', 20, '[e-mail]'),
(3, 'Tom', 28, '[e-mail]'),
(4, 'Sandy', 21, '[e-mail]'),
(5, 'Billie', 24, '[e-mail]');

-- 真实开发中，version（乐观锁）、delete（逻辑删除）、gmt_create、gmt_modified

3. 编写项目，初始化项目！使用SpringBoot初始化
4. 导入依赖

<!--数据库驱动-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</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>
</dependency>

如果为3.4.0版本,还需要导入

<dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.3.1.tmp</version>
        </dependency>

说明：我们使用Mybatis-plus可以节省我们大量的代码,尽量不要同时导入mybatis和mybaits-plus！会出现版本差异
5. 连接数据库

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

6. 编写pojo层和dao层

• pojo

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

• dao

@ResponseBody
public interface UserMapper extends BaseMapper<User> {
//继承BaseMpper接口 
//所有的CRUD操作已经编写完成了
}

注意：需要在主启动类上加入MapperScan(“mapper包路径”)

配置日志

我们所有的sql现在是不可见的，我们希望知道他们是怎么执行的,所以我们必须查看日志
配置入下

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

## CRUD操作

插入操作

插入测试

直接使用dao层下UserMapper对象的方法

@Test
public void testInsert(){
    User user = new User();
    user.setName("张三");
    user.setAge(23);
    user.setEmail("[e-mail]");

    int result = userMapper.insert(user);// 帮我们自动生成id
    System.out.println(result); // 受影响的行数
    System.out.println(user); // 发现，id会自动回填
}

插入时主键生成策略

默认策略：ID_WORKER全局唯一id

官方连接：分布式系统唯一id生成方案.

配置主键自增策略步骤

1. 在实体类上加入：@TableId(type=IdType.Auto)
2. 数据库字段设置成自增
3. 测试插入操作

更新操作

测试更新操作

@Test
public void testUpdate(){
		User user = new User();
        //通过条件自动更新动态sql
        user.setId(1413418958639439873L);
        user.setAge(18);
        //updateById传入参数是一个对象
        int i = userDao.updateById(user);
	}

自动填充时间

创建时间,修改时间！这些操作都是自动化完成的，我们不希望手动更新！
阿里巴巴开发手册：所有数据库表：gmt_create、gmr_modified，所有的表都要配置这两个字段,而且需要自动化！

方式一： 数据库级别(工作不推荐使用)

1. 在表中新增字段 create_time, update_time,两个字段默认值填写为：CURRENT_TIMESTAMP，update_time需要勾选根据当前时间戳更新按钮
2. 同步实体类

private Date createTime;
private Date updateTime;

方式二：代码级别(推荐使用)

1. 删除之前数据库的配置
2. 实体类中加入注解

@TableField(fill = FieldFill.INSERT)//字段何时填充
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

3. 编写处理器,通过处理器处理两个字段上的注解,解析其注解
   自定义实现类 MyMetaObjectHandler

@Component
@Slf4j
public class MyHandler implements MetaObjectHandler {
    /**
     * 如果解析到的注解为插入时填充,即执行下面代码 将该字段赋值当前时间
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("insert fill...");
        //setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject) {
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }

    /**
     * 如果解析到的注解为更新时填充,即执行下面代码 将该字段赋值当前时间
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("update fill...");
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

4. 测试

插入时添加乐观锁

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

乐观锁作用：可以解决超卖问题,但缺点也是很明显，就是下单会出现失败情况,但是处理并发能力强

乐观锁实现方式：

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

实现步骤：

1. 给数据库添加version字段
2. 在实体类中加入相应字段

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

3. 注册组件，进行配置

@Configuration
@EnableTransactionManagement
@MapperScan("com.chanv.mapper")
public class MyBatisPlusConfig {
    //注册乐观锁插件
    @Bean
    public OptimisticLockerInnerInterceptor optimisticLockerInnerInterceptor(){
        return new OptimisticLockerInnerInterceptor();
    }
}

4. 测试

删除操作

删除测试

@Test
public void testDeleteById(){
    userMapper.deleteById(1L);
}

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

//通过map删除
@Test
public void testDeleteById(){
    userMapper.deleteById(1L);
}

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

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

逻辑删除

物理删除：从数据库中直接移除
逻辑删除：在数据库中没有被移除,而是通过一个变量来让他失效！deleted=0 -> deleted=1

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

实现步骤：

1. 在数据库中增加一个deleted字段
2. 实体类中增加属性

@TableLogic
private Integer deleted;

3. 在yml文件中进行配置

mybatis-plus:  
  global-config:
    db-config:
      logic-delete-value: 1      #已经删除显示为1
      logic-not-delete-value: 0  #没有删除显示为0

4. 如果为3.0.5版本,需要实现配置类，3.4.0版本不需要配置

/**
     * 逻辑删除插件
     */
    @Bean
    public ISqlInjector sqlInjector() {
        return new LogicSqlInjector();
    }

5. 测试

查询操作

查询测试

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

    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

分页查询

分页有许多实现方法：

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

MP内置分页插件实现步骤：

1. 在配置类中配置分页插件

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

2. 测试时使用page对象进行查询

//测试分页查询
    @Test
    public void testPage(){
        //参数一：当前页
        //参数二：页面大小
        //使用了分页插件之后，所有的分页操作也变得简单了！
        Page<User> page = new Page<>(2, 5);
        userMapper.selectPage(page, null);
        page.getRecords().forEach(System.out::println);
        System.out.println(page.getTotal());
    }
}

条件构造器

使用Wapper对象进行条件构造

测试：

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

    @Test
    void Test2(){
        //查询名字等于贾羽圣222的
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name","贾羽圣222");
        User user = userDao.selectOne(wrapper);  //查询一个数据 出现多个结果使用list或者Map
        System.out.println(user);
    }

    @Test
    void Test3(){
        //查询年龄在20到30岁之间的用户
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age",20,30);
        Integer integer = userDao.selectCount(wrapper);//查询结果数
        System.out.println(integer);
    }

    @Test
    void Test4(){
        //查询年龄在20到30岁之间的用户
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age",20,30);
        Integer integer = userDao.selectCount(wrapper);//查询结果数
        System.out.println(integer);
    }

    /**
     * 模糊查询
     */
    @Test
    void Test5(){
        //查询年龄在20到30岁之间的用户
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.notLike("name","e")
        .likeRight("email",1);
        List<Map<String, Object>> list = userDao.selectMaps(wrapper);
        list.forEach(System.out::println);
    }


    /**
     * in查询
     */
    @Test
    void Test6(){
        //查询年龄在20到30岁之间的用户
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //id在子查询中查出
        wrapper.inSql("id","select id from user where id < 3 ");
        List<Object> objects = userDao.selectObjs(wrapper);
        objects.forEach(System.out::println);
    }
    @Test
    void Test7(){
        //查询年龄在20到30岁之间的用户
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //id在子查询中查出
        User user  = new User();
        user.setAge(3);
        wrapper.setEntity(user);
        List<Map<String, Object>> list = userDao.selectMaps(wrapper);
        list.forEach(System.out::println);
    }
    @Test
    void Test8(){
        //查询年龄在20到30岁之间的用户
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.select("age"); //设置查找到的字段
        List<Map<String, Object>> list = userDao.selectMaps(wrapper);
        list.forEach(System.out::println);
    }

代码生成器

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

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

注意: 3.4.0必须导入包：

<dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.3.1.tmp</version>
        </dependency>

测试：

public class ShengCode {
    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("JiaYuSheng");
        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/mybatis_plus?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("user");
        pc.setParent("com.sheng");
        pc.setEntity("pojo");
        pc.setMapper("dao");
        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.UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(createTime);
        tableFills.add(updateTime);
        strategy.setTableFillList(tableFills);
        //乐观锁
        strategy.setVersionFieldName("version");
        strategy.setRestControllerStyle(true); //开启驼峰命名格式
        strategy.setControllerMappingHyphenStyle(true);     //localhost:8080/hello_id_2
        mpg.setStrategy(strategy);

        mpg.execute();  //执行代码构造器
    }
}

自动生成代码后service层讲解

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
    //不用在进行mapper注入
    /**
     * UserServiceImpl继承ServiceImpl
     * 1.在ServiceImpl中已经完成Mapper对象的注入，在UserServiceImpl可以直接使用
     * 2.在ServiceImpl中也帮我们提供了crud方法，基本的一些crud方法在UserServiceImpl不需要定义
     */
}