SpringBoot整合Mybatis-Plus

简介

MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

整合

1、引入Mybatis-Plus的jar依赖

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

使用Mybatis-Plus的依赖可以不用在引入mybabtis和jdbc的的依赖

2、创建一个实体类School

/**
* 使用Mybatis-Plus，关联的实体类的字段，必须要在数据表中都存在
* 如果不存在可以，可以使用@TableField(exist = false)标注
*/
//@TableName("")对应数据库中表的名称
public class School implements Serializable {
    @TableId(value="school_id",type = IdType.AUTO ) //标记他是主键自增，不然在使用根据主键操作方法和添加的时候会报错
	private Integer schoolId;
	private String schoolName;
	
    /**
     * 用来表示，该属性在表中不存在，如果表中不存在，并且没有此注解，会报错
     */
    @TableField(exist = false)
    private String name;
	//省略getter和setter方法
}

3、创建一个Mapper继承BaseMapper，Mapper 继承该接口后，无需编写 mapper.xml 文件，即可获得CRUD功能

@Mapper
public interface SchoolMapper extends BaseMapper<School> {
}

4、创建service接口继承IService（顶级的service）

public interface SchoolService extends IService<School> {
}

5、创建一个实现service接口的impl并继承ServiceImpl

@Service
public class SchoolServiceImpl extends ServiceImpl<SchoolMapper, School> implements SchoolService {
}

6、创建一个Controller

@Controller
public class SchoolController {

    @Autowired
    private SchoolService schoolService;

    @RequestMapping(value = "/test",produces = "application/json")
    @ResponseBody
    public List<School> test(){
        List<School> schoolList = schoolService.list();
        System.out.println(schoolList);
        return schoolList;
    }
}

这样就可以打印出数据表中的所有的数据了

分页查询

1、首先要写一个config类

@Configuration
public class MyBatisConfig {

    /**
    * 分页拦截器
    */
    @Bean
    public MybatisPlusInterceptor paginationInterceptor(){
        MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
        PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor();
        mybatisPlusInterceptor.addInnerInterceptor(paginationInnerInterceptor);
        return mybatisPlusInterceptor;
    }
}

2、写一个controller测试一下

@Controller
public class SchoolController {

    @Autowired
    private SchoolService schoolService;

    @RequestMapping(value = "/test",produces = "application/json")
    @ResponseBody
    public Page<School> test(){
        /**
         * current：当前页
         * size：几条数据
         */
        Page<School> school = new Page<>(2,3);
        Page<School> page = schoolService.page(school,null);
        return page;
    }
}

结果如下图

自动填充

开发中，如果每一条数据的添加时间和修改时间，都需要手动的设置的化这样会很影响开发的效率，所以可以使用自动填充，当然数据库也可以设置默认值，但这种方式不推荐使用。

1、在实体类中需要自动填充的字段上添加 @TableField 注解

    //自动填充策略
    @TableField(fill = FieldFill.INSERT)
    private Date createDate;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateDate;

2、写一个组件，注入到ioc容器中

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("createDate",new Date(),metaObject);
        this.setFieldValByName("updateDate",new Date(),metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateDate",new Date(),metaObject);
    }
}

然后重新启动项目，就不在需要每次添加修改的时候设置时间了

逻辑删除

企业开发的，为了防止数据的丢失，一般都采用逻辑删除，只是使用一些限定条件，让一部分人看不见，并不是真正的物理删除。

1、在实体类中需要逻辑删除的字段上添加 @TableLogic 注解

    @TableLogic //逻辑删除
    private Boolean isDelete;

2、注入bean 注意：在mybatis-plus版本3.1.1之后就不在需要注入这个bean了

    @Bean
    public ISqlInjector sqlInjector() {
        return new LogicSqlInjector();
    }

3、配置application.properties文件

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

4、以后执行删除的方法就是逻辑删除，改变的只是你设置逻辑删除的那个字段的值，使用查询方法的时候，也不会查询出来逻辑删除过的数据