MyBatis-Plus使用——配置yml参数 & 常用的注解@Table，@TableId，@IdType，@TableField，CRUD的API接口

偏执的太偏执、 2024-02-20 11:19 10阅读 0赞

![在这里插入图片描述][c4944339f3014ba49229fd6cd98868c7.jpeg]

## 前言 ##

MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window) 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

本系列博客结合实际应用场景，阐述MyBatis-Plus实际应用中的问题以及使用方法。

本篇博客介绍MyBatis-Plus 的配置，常用的注解，API接口，以及查询的LambdaQueryWrapper的使用方法。

[官网：https://baomidou.com/][https_baomidou.com]

其他关于MyBatis-Plus的博客文章如下：

[MyBatis-Plus多数据源——如何在一个项目中使用多个MySQL数据库][MyBatis-Plus_MySQL]

#### 目录 ####

*  前言
 *  引出
 *  mybatisplus的配置
 *   *  数据源配置
     *  mybatisplus配置
 *  Mybatis-Plus常用注解
 *   *  @Table
     *  @TableId
     *  @IdType
     *  @TableField
     *  @Version
 *  Mybatis-Plus接口API
 *   *  insert
     *  delete
     *  update
     *  select
     *  Lamda的条件LambdaQueryWrapper
     *   *  构建LambdaQueryWrapper对象
         *  常用方法
 *  总结

## 引出 ##

--------------------

1.MyBatis-Plus 的配置；  
2.常用的注解，API接口；  
3.查询的LambdaQueryWrapper的使用方法；

## mybatisplus的配置 ##

ibatis—>mybatis

[MyBatis-Plus (opens new window)][MyBatis-Plus _opens new window]（简称 MP）是一个 [MyBatis (opens new window)][MyBatis _opens new window]的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

![在这里插入图片描述][44ff792094184615b6e0b39789578c62.png]

### 数据源配置 ###

> 基本数据源配置： url、username、password、driver-class-name

spring:
      datasource:
        druid:
          url: jdbc:mysql://localhost:3306/bookshop_db?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai&allowPublicKeyRetrieval=true
          username: root
          password: 1234
          driver-class-name: com.mysql.cj.jdbc.Driver

> 数据源其它配置 inital-size、max-active、min-idle、max-wait等

datasource:
            # 初始化时建立的物理连接数。初始化发生在显式调用init方法，或者第一次getConnection时.
            initial-size: 5
            # 连接池最大物理连接数量。
            max-active: 50
            # 连接池最小物理连接数量。
            min-idle: 5
            # 获取连接时最大等待时间，单位为毫秒。
            # 配置之后，缺省启用公平锁，并发效率会有所下降，若需要可以通过配置useUnfairLock属性为true使用非公平锁。
            max-wait: 6000
            # 是否缓存preparedStatement，也就是PSCache。
            # PSCache对支持游标的数据库性能提升巨大，比如说oracle。在mysql下建议关闭。
            pool-prepared-statements: true
            # 要启用PSCache，其值必须大于0，当大于0时，poolPreparedStatements自动触发修改为true。
            # 在Druid中，不会存在Oracle下PSCache占用内存过多的问题，可以把这个数值配置大一些，比如说100。
            max-pool-prepared-statement-per-connection-size: 20
            # 用来检测连接是否有效的sql，要求是一个查询语句，常用select 'x'。
            # 如果validationQuery为null，testOnBorrow、testOnReturn、testWhileIdle都不会起作用。
            validation-query: select 1 from dual

### mybatisplus配置 ###

#配置数据源
    spring:
      datasource:
        druid:
          url: jdbc:mysql://localhost:3306/book_db?useSSL=false&serverTimezone=Asia/Shanghai&allowPublicKeyRetrieval=true
          username: root
          password: 123
          driver-class-name: com.mysql.cj.jdbc.Driver
          
    #mybatisplus配置
    mybatis-plus:
      global-config:
        db-config:
    	  #配置id自增长
          id-type: auto
      configuration:
        #配置mybatisplus日志
        log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
      mapper-locations: classpath:/mapper/*.mapper.xml      #xml文件的位置(resources下的mapper文件夹)

## Mybatis-Plus常用注解 ##

### [@Table][Table] ###

> 表名注解，标识实体类对应的表。

<table> 
 <thead> 
  <tr> 
   <th align="left">属性</th> 
   <th align="left">类型</th> 
   <th align="left">必须指定</th> 
   <th align="left">默认值</th> 
   <th align="left">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">value</td> 
   <td align="left">String</td> 
   <td align="left">否</td> 
   <td align="left">“”</td> 
   <td align="left">表名：例如 value=”book_tab”</td> 
  </tr> 
  <tr> 
   <td align="left">resultMap</td> 
   <td align="left">String</td> 
   <td align="left">否</td> 
   <td align="left">“”</td> 
   <td align="left">xml 中 resultMap 的 id（用于满足特定类型的实体类对象绑定）</td> 
  </tr> 
  <tr> 
   <td align="left">autoResultMap</td> 
   <td align="left">boolean</td> 
   <td align="left">否</td> 
   <td align="left">false</td> 
   <td align="left">是否自动构建 resultMap 并使用（如果设置 resultMap 则不会进行 resultMap 的自动构建与注入）</td> 
  </tr> 
  <tr> 
   <td align="left">excludeProperty</td> 
   <td align="left">String[]</td> 
   <td align="left">否</td> 
   <td align="left">{}</td> 
   <td align="left">需要排除的属性名 <a href="https://github.com/since" rel="nofollow">@since</a> 3.3.1</td> 
  </tr> 
 </tbody> 
</table>

### [@TableId][TableId] ###

> 主键注解

### [@IdType][IdType] ###

public enum IdType {
        
        AUTO(0),            //数据库自增长，mysql的自增长主键
        NONE(1),            //未设置
        INPUT(2),           //自定义设置
        ASSIGN_ID(3),   //分配 ID(主键类型为 Number(Long 和 Integer)或 String)(since 3.3.0),
                          //使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)
        ASSIGN_UUID(4); //分配 UUID,主键类型为 String(since 3.3.0),
                            //使用接口IdentifierGenerator的方法nextUUID(默认default 方法)
        private final int key;
        private IdType(int key) {
        
            this.key = key;
        }
        public int getKey() {
        
            return this.key;
        }
    }

### [@TableField][TableField] ###

> 数据库不建议使用-号作为分隔符，也不能使用驼峰法作为字段名称。

<table> 
 <thead> 
  <tr> 
   <th align="left">属性</th> 
   <th align="left">类型</th> 
   <th align="left">必须指定</th> 
   <th align="left">默认值</th> 
   <th align="left">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">value</td> 
   <td align="left">String</td> 
   <td align="left">否</td> 
   <td align="left">“”</td> 
   <td align="left">数据库字段名</td> 
  </tr> 
  <tr> 
   <td align="left">update</td> 
   <td align="left">String</td> 
   <td align="left">否</td> 
   <td align="left">“”</td> 
   <td align="left">字段 <code>update set</code> 部分注入，例如：当在version字段上注解<code>update="%s+1"</code> 表示更新时会 <code>set version=version+1</code> （该属性优先级高于 <code>el</code> 属性）</td> 
  </tr> 
  <tr> 
   <td align="left">updateStrategy</td> 
   <td align="left">Enum</td> 
   <td align="left">否</td> 
   <td align="left">FieldStrategy.DEFAULT</td> 
   <td align="left">举例：IGNORED <code>update table_a set column=#{columnProperty}</code></td> 
  </tr> 
  <tr> 
   <td align="left">select</td> 
   <td align="left">boolean</td> 
   <td align="left">否</td> 
   <td align="left">true</td> 
   <td align="left">是否进行 select 查询</td> 
  </tr> 
 </tbody> 
</table>

### [@Version][Version] ###

> 乐观锁注解、标记 `@Version` 在字段上

## Mybatis-Plus接口API ##

> dao接口继承BaseMapper

![在这里插入图片描述][6a69f06a2f8045338259c93fcb99126c.png]

### insert ###

int insert(T entity);

### delete ###

// 根据 entity 条件，删除记录
    int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper);
    // 删除（根据ID 批量删除）
    int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
    // 根据 ID 删除
    int deleteById(Serializable id);
    // 根据 columnMap 条件，删除记录
    int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

### update ###

// 根据 whereWrapper 条件，更新记录
    int update(@Param(Constants.ENTITY) T updateEntity, @Param(Constants.WRAPPER) Wrapper<T> whereWrapper);
    // 根据 ID 修改
    int updateById(@Param(Constants.ENTITY) T entity);

### select ###

// 根据 ID 查询
    T selectById(Serializable id);
    
    // 根据 entity 条件，查询一条记录
    T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    
    // 查询（根据ID 批量查询）
    List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
    
    // 根据 entity 条件，查询全部记录
    List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    
    // 查询（根据 columnMap 条件）
    List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
    
    // 根据 Wrapper 条件，查询全部记录
    List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    
    // 根据 Wrapper 条件，查询全部记录。注意： 只返回第一个字段的值
    List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    
    // 根据 entity 条件，查询全部记录（并翻页）
    IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    
    // 根据 Wrapper 条件，查询全部记录（并翻页）
    IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    
    // 根据 Wrapper 条件，查询总记录数
    Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

### Lamda的条件LambdaQueryWrapper ###

#### 构建LambdaQueryWrapper对象 ####

> **LambdaQueryWrapper** lambda = new **LambdaQueryWrapper**<>();

#### 常用方法 ####

*  eq 相等
 *  in 范围查询
 *  like 模糊查询
 *  likeRight 右侧通配符查询
 *  likeLeft 左侧通配符查询
 *  or() 或
 *  and() 并且

lambdaQueryWrapper.like(User::getUsername,"zh")
                              .or()
                            .likeLeft(User::getName,"张");
    List<User> users = userDao.selectList(lambdaQueryWrapper);

--------------------

## 总结 ##

1.MyBatis-Plus 的配置；  
2.常用的注解，API接口；  
3.查询的LambdaQueryWrapper的使用方法；

[c4944339f3014ba49229fd6cd98868c7.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/ebf7ceced8184a979934ae71c182e4f6.png
[https_baomidou.com]: https://baomidou.com/
[MyBatis-Plus_MySQL]: https://blog.csdn.net/Pireley/article/details/133344286
[MyBatis-Plus _opens new window]: https://github.com/baomidou/mybatis-plus
[MyBatis _opens new window]: https://www.mybatis.org/mybatis-3/
[44ff792094184615b6e0b39789578c62.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/37d35d81181244e392d833af3c919ea7.png
[Table]: https://github.com/Table
[TableId]: https://github.com/TableId
[IdType]: https://github.com/IdType
[TableField]: https://github.com/TableField
[Version]: https://github.com/Version
[6a69f06a2f8045338259c93fcb99126c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/00bf44289e0940eca9f6ce829cbbfaf6.png