高效开发 &玩转 mybatisPlus

青衣画白扇
332 阅读3分钟

这是我参与「掘金日新计划 · 8 月更文挑战」的第22天，点击查看活动详情

mybatis.png

前言

mybaisPlus是mybatis的增强，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。在实际开发中可以极大的提高我们的开发效率，并且很受欢下面我们一起使用一下。

特性

  • 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
  • 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

使用 MyBatisPlus

首先引入依赖（就不贴其他的依赖了）

<dependency><!-- Mybatis 这里的版本根据自己的需要引入-->
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.3.2</version>
</dependency>
<dependency><!-- 分页插件-->
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
</dependency>

配置文件 yml

mybatis-plus:
  mapper-locations: classpath*:/mapper/***Mapper.xml #配置xml的扫描地址
  map-underscore-to-camel-case: true # 开启驼峰转换 例如：user_name 实体类中是userName
  global-config:
    #数据库相关配置
    db-config:
      #主键类型  AUTO:"数据库ID自增", INPUT:"用户输入ID", ID_WORKER:"全局唯一ID (数字类型唯一ID)", UUID:"全局唯一ID UUID";
      id-type: AUTO
  configuration: #日志打印
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

创建实体类

@Data
@TableName("sys_user")
public class SysUser extends PublicField implements Serializable{

    private static final long serialVersionUID = 1L;
    
    @TableId(value = "id" ,type = IdType.AUTO) //设置表的主键以及为自增
    private Integer id;
    /**
     * 管理员姓名
     */
    @TableField(value = "sys_user_name") 这个是用来映射表的字段和实体类的字段
    private String username;
    /**
    * 邮箱地址
    */
    @TableField(exist = false) //这个写法是忽略这个字段即 数据表中没有此字段
    private String sysUserEmail;
    
    
    /**
    * 性别
    */
    @TableField(value = "sex") 
    private SexEnum sexEnum;
}

创建mapper接口 继承mybatisPlus提供的统一baseMapper(这个接口中有提供的CRUD) 可以直接使用。在接口上添加@Mapper 交给spring管理 相比较于@MapperScan 粒度更加细@MapperScan通过指定mapper所在的路径在项目启动时就可以全部扫描到。

@Mapper 
public interface UserMapper extends BaseMapper<SysUser> {
}

点进BaseMapper中就可以看到为我们默认提供的方法了 image.png 在resources 文件夹下 创建mapper.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- 这里的 namespace 指向的是上面我们创建的接口的地址 用来处理一些复杂的业务sql-->
<mapper namespace="com.xk.bugvip.base.mapper.UserMapper"> 

</mapper>

image.png

调用自带的查询方法获取数据

public R getList(ListVo parm) {
    //查询条件构造器
     QueryWrapper<SysUser> queryWrapper = getWhere(parm.getSearchObj());
     //设置分页数据
     PageHelper.startPage(parm.getPage(),parm.getLimit());
     //调用自带的 selectList方法获取数据
     Page<SysUser> tenantUsers = (Page<SysUser>) baseMapper.selectList(queryWrapper);
     return R.ok().data("data",tenantUsers);
}
//动态拼装 搜索条件
private QueryWrapper<SysUser> getWhere(Object searchObj) {
    QueryWrapper<SysUser> queryWrapper = new QueryWrapper<>();
    if(!ObjectUtils.isEmpty(searchObj)){
        String searchObjstr= JSON.toJSONString(searchObj);
        SysUser stu = JSONObject.parseObject(searchObjstr, SysUser.class);
        if(!StringUtils.isEmpty(stu.getUsername())){
            queryWrapper.like("sys_user_name",stu.getUsername());
        }
    }
    return  queryWrapper;
}

当然 MybatisPlus提供的条件构造器也是可以 Lambda 表达式来写的

private LambdaQueryWrapper<SysUser> getWhere(Object searchObj) {
    LambdaQueryWrapper<SysUser> lambdaQueryWrapper = new LambdaQueryWrapper<>();
    if(!ObjectUtils.isEmpty(searchObj)){
        String searchObjstr= JSON.toJSONString(searchObj);
        SysUser stu = JSONObject.parseObject(searchObjstr, SysUser.class);
        if(!StringUtils.isEmpty(stu.getUsername())){
        //更好的 防止我们将字段名写错 当然后面还能继续.ge 等条件
           lambdaQueryWrapper.like(SysUser::getUsername,stu.getUsername());
        }
    }
    return  lambdaQueryWrapper;
}

通用枚举 创建枚举类添加 注解 @EnumValue 将注解所标识的属性值存储到数据库中

@Getter
public enum SexEnum {
        MALE(1,"男"),
        FEMALE(2,"女");
    @EnumValue //将注解所标识的属性值存储到数据库中
    private Integer sex;
    private String sexName;

    SexEnum(Integer sex, String sexName) {
        this.sex = sex;
        this.sexName = sexName;
    }
}

还需要在配置文件中配置扫描枚举的路径，这样使用就没有问题了

type-enums-package: com.xk.bugvip.utils.enums

代码生成器 以及 MetaObjectHandler自动填充公共字段 在之前的文章中都有
实践是检验真理的唯一准则，感兴趣的可以去试试呀！明天见咯 😃😃😃😃

avatar
文章
阅读
粉丝