mybatis-plus 极简使用指北

官网地址：https://mybatis.plus

该东东对myBatis原有功能无改变，仅做增强。

 

添加依赖

 <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.0.6</version>
 </dependency>

      如果已经依赖 mybatis 需先移除；

      最新版为3.2.0，但出现 java.lang.NoClassDefFoundError: org/mybatis/logging/LoggerFactory 异常，暂未解决；

      如果需要使用代码生成器，再增加下面的依赖：

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

 </dependency>

 <dependency>
        <groupId>org.freemarker</groupId>
        <artifactId>freemarker</artifactId>
        <version>2.3.29</version>
 </dependency>

 

配置

    在mainCLass中增加注释： @MapperScan("com.akulaku.coupon.mapper")  指向我们存放mapper的路径

 

注解

    在model类中增加注解：@TableName(value = "t_coupon") 指明该模型关联的表名

    更多注解请参照 https://mybatis.plus/guide/annotation.html#tablename

 

mapper

    创建 interface 如：

public interface CouponMapper extends BaseMapper<Coupon> {}      注意红色字体为我们ORM的model类；

在service方法中引用该mapper后调用该父类方法实现基础的CRUD操作，具体参考：

https://mybatis.plus/guide/crud-interface.html#mapper-crud-%E6%8E%A5%E5%8F%A3

 

亦可构造wrapper实现较为复杂的查询，具体api参照：https://mybatis.plus/guide/wrapper.html  如：

public CouponCommonResponse delCoupon(CouponRequest couponRequest) throws Exception {
    QueryWrapper<Coupon> wrapper = new QueryWrapper<>();
    wrapper.eq("id",couponRequest.getId());
    couponMapper.delete(wrapper);
    return CouponCommonResponse.success();
}

 

亦可如mybatis般自定义sql，如：

public interface CouponMapper extends BaseMapper<Coupon> {
    @Select("SELECT * FROM t_coupon where id = #{id}")
    Coupon selectCouponById(@Param("id") Long id);
}

 

亦可配置xml实现更复杂的逻辑，与原mybatis无异；

 

分页插件

    创建config类，如：

@Configuration
public class MybatisPlusConfig {@Bean
public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();return paginationInterceptor;}}

 

    调用如：

import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.conditions.segments.MergeSegments;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;

public CouponCommonResponse selectCouponPage(Long uid,long current, long size){
    Page<Coupon> page = new Page<>(current, size);
    IPage<Coupon> couponIPage = couponMapper.selectPage(page, new QueryWrapper<Coupon>().eq("uid", uid));
    System.out.println("总条数 ------> " + couponIPage.getTotal());
    System.out.println("当前页数 ------> " + couponIPage.getCurrent());
    System.out.println("当前每页显示数 ------> " + couponIPage.getSize());
    System.out.println("----- baseMapper 自带分页 ------");
    return CouponCommonResponse.success(couponIPage);
}

 

SQL执行效率插件

    在config类中增加：

@Bean
@Profile({"dev","test"})public PerformanceInterceptor performanceInterceptor() {return new PerformanceInterceptor().setMaxTime(100).setFormat(Boolean.TRUE);
}

 

由于该插件较影响性能，所以仅开发和测试环境启用，该插件在3.2.0版本起被弃用；

MaxTime 为全局的单条SQL执行最大时长阈值，单位为毫秒，如果执行时间超过这个值就会抛出异常，此时我们需要优化该操作。

 

代码生成器

     MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，但对于我们可能只有在自下而上的开发模式中将mysql表生成Entity时有用。参考：https://mybatis.plus/guide/generator.html#%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B