MyBatis-Plus学习记录

（空白格）

已于 2022-07-30 22:06:51 修改

阅读量824

点赞数

文章标签： mybatis 学习 java

于 2022-07-28 22:29:22 首次发布

本文链接：https://blog.csdn.net/wang54188a/article/details/126043593

版权

本文介绍了MyBatis-Plus，一个MyBatis的增强工具，提供无侵入、损耗小的特性，支持Lambda形式调用、主键自动生成、分页插件等功能。详细讲解了配置、基本CRUD操作、常用注解和构造器的使用，以及如何进行分页查询。通过示例展示了如何插入数据、配置应用日志和使用IService接口。

摘要由CSDN通过智能技术生成

附上 MyBatis-Plus官网开头

一.简介

二、特性

三、部分配置

1.配置application.yml文件

2.在application.yml中配置日志输出

一.简介

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.配置application.yml文件

spring: 
    # 配置数据源信息 
    datasource: 
        # 配置数据源类型 
        type: com.zaxxer.hikari.HikariDataSource 
        # 配置连接数据库信息 
        driver-class-name: com.mysql.cj.jdbc.Driver 
        url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf- 8&useSSL=false                 
        username: root 
        password: 123456

2.在application.yml中配置日志输出

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

四、基本CRUD

1.BaseMapper

MyBatis-Plus内置的基本的CRUD可通过dao中的接口继承BaseMapper<T>来实现，BaseMapper代码如下：

public interface BaseMapper<T> extends Mapper<T> {

    /**
     * 插入一条记录
     *
     * @param entity 实体对象
     */
    int insert(T entity);

    /**
     * 根据 ID 删除
     *
     * @param id 主键ID
     */
    int deleteById(Serializable id);

    /**
     * 根据 columnMap 条件，删除记录
     *
     * @param columnMap 表字段 map 对象
     */
    int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

    /**
     * 根据 entity 条件，删除记录
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
     */
    int delete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 删除（根据ID 批量删除）
     *
     * @param idList 主键ID列表(不能为 null 以及 empty)
     */
    int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

    /**
     * 根据 ID 修改
     *
     * @param entity 实体对象
     */
    int updateById(@Param(Constants.ENTITY) T entity);

    /**
     * 根据 whereEntity 条件，更新记录
     *
     * @param entity        实体对象 (set 条件值,可以为 null)
     * @param updateWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
     */
    int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);

    /**
     * 根据 ID 查询
     *
     * @param id 主键ID
     */
    T selectById(Serializable id);

    /**
     * 查询（根据ID 批量查询）
     *
     * @param idList 主键ID列表(不能为 null 以及 empty)
     */
    List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

    /**
     * 查询（根据 columnMap 条件）
     *
     * @param columnMap 表字段 map 对象
     */
    List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

    /**
     * 根据 entity 条件，查询一条记录
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件，查询总记录数
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 entity 条件，查询全部记录
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录
     * <p>注意： 只返回第一个字段的值</p>
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 entity 条件，查询全部记录（并翻页）
     *
     * @param page         分页查询条件（可以为 RowBounds.DEFAULT）
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    <E extends IPage<T>> E selectPage(E page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录（并翻页）
     *
     * @param page         分页查询条件
     * @param queryWrapper 实体对象封装操作类
     */
    <E extends IPage<Map<String, Object>>> E selectMapsPage(E page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
}

2.举例插入insert()：

@Test 
public void testInsert(){ 
    User user = new User(null, "张三", 20, "zhangsan@qq.com"); 
    int result = userMapper.insert(user); 
    System.out.println("插入条数为："+result);
}

返回结果result为1，其中null为id字段，MyBatis-Plus会通过雪花算法生成id

3.IService

MyBatis-Plus中有接口 IService<T> 和其实现类 ServiceImpl < TDao , T > ，封装了常见的业务层逻辑。详情查看源码IService和ServiceImpl。

可通过Service接口继承IService提供基础功能，Impl类继承ServiceImpl实现基础功能

userService.count() //总记录条数

另外记录今天犯的java基础错误

Arrays.asList（）它是将数组转化成集合的方法，返回固定长度的List集合

注意：创建之后的list集合是不支持改变集合的操作的比如add，remove，会报错。支持遍历操作，因为它的长度是固定的，不能改变。

若想改变list集合，改用常规方法List<T> list = new ArrayList<>;

五、常用注解

1.@TableName

默认操作的表名是与实体类类名一致的，倘若不一致会报错。
@TableName用于实体类上的注解，即可解决实体类类型的类名和要操作的表的表名不一致的问题

也可通过yml全局配置来解决

2.@TableId

@TableId将实体类中的属性标识为主键

3.@TableField

@TableField用于实体类中属性上的注解，解决属性与数据库表中的字段不一致

4.@TableLogic

@TableLogic逻辑删除，与真实删除不同，它会删除数据库当中的值。测试删除功能背后真正执行的是修改，修改被打上注解的字段，之后再测试查询功能会发现被修改的数据不会被查询到。

@TableLogic
@ApiModelProperty(value = "删除标记,1:已删除,0:正常")
private String isDeleted;

六、常用构造器

1.AbstractWrapper

官方说明：QueryWrapper(LambdaQueryWrapper) 和UpdateWrapper(LambdaUpdateWrapper) 的父类用于生成 sql 的 where 条件, entity 属性也用于生成 sql 的 where 条件
注意: entity 生成的 where 条件与使用各个 api 生成的 where 条件没有任何关联行为

此类详情可见官方文档

allEq 全部等于；
eq等于；
ne不等于；
gt大于；详见官网

2.QueryWrapper

官方说明:

继承自 AbstractWrapper ,自身的内部属性 entity 也用于生成 where 条件
及 LambdaQueryWrapper, 可以通过 new QueryWrapper().lambda() 方法获取

3.UpdateWrapper

七、分页插件

使用MyBatis-Plus自带分页插件需要添加配置类

@Configuration 
@MapperScan("com.atguigu.mybatisplus.mapper")  
public class MybatisPlusConfig { 

@Bean 
public MybatisPlusInterceptor mybatisPlusInterceptor() { 
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();         
    interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); 
    return interceptor; 
    } 
}

测试类

@Test 
public void testSelectPageVo(){ 
    //设置分页参数 
    Page<User> page = new Page<>(1, 5); 
    userMapper.selectPageVo(page, 20); 
    //获取分页数据 
    List<User> list = page.getRecords(); 
    list.forEach(System.out::println); 
    System.out.println("当前页："+page.getCurrent()); 
    System.out.println("每页显示的条数："+page.getSize()); 
    System.out.println("总记录数："+page.getTotal()); 
    System.out.println("总页数："+page.getPages()); 
    System.out.println("是否有上一页："+page.hasPrevious()); 
    System.out.println("是否有下一页："+page.hasNext()); 
}