首页 MySQL

✨mybatis-plus 是现在我们经常使用的插件，极大的提高了我们开发的效率。这篇文章就总结一下，mybatis-plus 的基础操作。


# 常用注解

# @TableName

这个注解用在类上，声明当前类关联的表名称，可以配置下列属性：

属性类型必须指定默认值描述
valueString否""表名
schemaString否""schema
keepGlobalPrefixboolean否false是否保持使用全局的 tablePrefix 的值 (如果设置了全局 tablePrefix 且自行设置了 value 的值)
resultMapString否""xml 中 resultMap 的 id
autoResultMapboolean否false是否自动构建 resultMap 并使用 (如果设置 resultMap 则不会进行 resultMap 的自动构建并注入)

# @TableId

  • 描述：主键注解
属性类型必须指定默认值描述
valueString否""主键字段名
typeEnum否IdType.NONE主键类型，通过 IdType 枚举指定
  • IdType 的枚举项：
值描述
AUTO数据库 ID 自增
NONE无状态，该类型为未设置主键类型 (注解里等于跟随全局，全局里约等于 INPUT)
INPUTinsert 前自行 set 主键值
ASSIGN_ID分配 ID (主键类型为 Number (Long 和 Integer) 或 String)(since 3.3.0), 使用接口 IdentifierGenerator 的方法 nextId (默认实现类为 DefaultIdentifierGenerator 雪花算法)
ASSIGN_UUID分配 UUID, 主键类型为 String (since 3.3.0), 使用接口 IdentifierGenerator 的方法 nextUUID (默认 default 方法)

# @TableField

  • 描述：字段注解 (非主键)
  • 属性：
属性类型必须指定默认值描述
valueString否""字段名
elString否""映射为原生 #{ ... } 逻辑，相当于写在 xml 里的 #{ ... } 部分
existboolean否true是否为数据库表字段
conditionString否""字段 where 实体查询比较条件，有值设置则按设置的值为准，没有则为默认全局的 %s=#{%s} , 参考
updateString否""字段 update set 部分注入，例如：update="% s+1"：表示更新时会 set version=version+1 (该属性优先级高于 el 属性)
insertStrategyEnumNDEFAULT举例：NOT_NULL: insert into table_a(column) values (#{columnProperty})
updateStrategyEnumNDEFAULT举例：IGNORED: update table_a set column=#{columnProperty}
whereStrategyEnumNDEFAULT举例：NOT_EMPTY: where column=#{columnProperty}
fillEnum否FieldFill.DEFAULT字段自动填充策略
selectboolean否true是否进行 select 查询
keepGlobalFormatboolean否false是否保持使用全局的 format 进行处理
jdbcTypeJdbcType否JdbcType.UNDEFINEDJDBC 类型 (该默认值不代表会按照该值生效)
typeHandlerClass<? extends TypeHandler>否UnknownTypeHandler.class类型处理器 (该默认值不代表会按照该值生效)
numericScaleString否""指定小数点后保留的位数

# BaseMapper 的 CRUD

在 MybatisPlus 中，BaseMapper 中定义了一些常用的 CRUD 方法，当我们自定义的 Mapper 接口继承 BaseMapper 后即可拥有了这些方法。


# 新增

// 插入一条记录
int insert(T entity);

# 参数说明

类型参数名描述
Tentity实体对象

# 删除

# 方法：

// 根据 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);

# #参数说明

类型参数名描述
Wrapperwrapper实体对象封装操作类（可以为 null）
Collection<? extends Serializable>idList主键 ID 列表 (不能为 null 以及 empty)
Serializableid主键 ID
Map<String, Object>columnMap表字段 map 对象

# 修改

# 方法：

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

# 参数：

类型参数名描述
Tentity实体对象 (set 条件值，可为 null)
WrapperupdateWrapper实体对象封装操作类（可以为 null, 里面的 entity 用于生成 where 语句）


# 查询单个

# 方法列表:

// 根据 ID 查询
T selectById(Serializable id);
// 根据 entity 条件，查询一条记录
T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

# 参数说明

类型参数名描述
Serializableid主键 ID
WrapperqueryWrapper实体对象封装操作类（可以为 null）

# 查询集合

# 方法列表：

// 查询（根据 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);

# 示例：

1）根据 id 集合查询：

@Test
public void testQueryByIdList(){
    // 根据 ID 查询
    List<User> list = userMapper.selectBatchIds(Arrays.asList(1L, 2L, 3L));
    list.forEach(System.out::println);
}

2）根据 wrapper 查询：

@Test
public void testQueryByWrapper(){
    // 定义 wrapper
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    // 模糊
    wrapper.like("name", "o")
        // 范围
        .le("age", 30)
        // 排序
        .orderByAsc("age");
    // 查询
    List<User> list = userMapper.selectList(wrapper);
    list.forEach(System.out::println);
}
生成的 sql：
SELECT id,name,email,age FROM user WHERE (name LIKE ? AND age <= ?) ORDER BY age ASC

# 分页查询
// 根据 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);
分页查询需要引入额外的插件才能生效。
# 引入分页插件
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MybatisConfig {
    /**
     * 注册 mybatis plus 的分页插件
     */
    @Bean
    public MybatisPlusInterceptor paginationInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor();
        // 数据库类型
        paginationInnerInterceptor.setDbType(DbType.MYSQL);
        // 溢出总页数后是进行处理 (默认是否)
        paginationInnerInterceptor.setOverflow(true);
        // 设置最大单页限制数量，默认 500 条，-1 不受限制
        paginationInnerInterceptor.setMaxLimit(500L);
        interceptor.addInnerInterceptor(paginationInnerInterceptor);
        return interceptor;
    }
}
# 测试分页
代码：
@Test
public void testPageQuery(){
    // 分页条件
    Page<User> page = new Page<>();
    // 当前页
    page.setCurrent(1);
    // 每页大小
    page.setSize(3);
    // 分页查询，结果会放到 Page<User > 中，因此无需返回
    userMapper.selectPage(page, null);
    // 总条数
    long total = page.getTotal();
    System.out.println("total = " + total);
	// 总页数
    long pages = page.getPages();
    System.out.println("pages = " + pages);
    // 当前页结果
    List<User> list = page.getRecords();
    list.forEach(System.out::println);
}


# IService 的 CRUD
MybatisPlus 除了提供 BaseMapper，还提供了通用的 Service 接口： IService

# 新增
// 插入一条记录（选择字段，策略插入）
boolean save(T entity);
// 插入（批量）
boolean saveBatch(Collection<T> entityList);
// 插入（批量）
boolean saveBatch(Collection<T> entityList, int batchSize);
# 参数说明
类型参数名描述
Tentity实体对象
CollectionentityList实体对象集合
intbatchSize插入批次数量

# SaveOrUpdate
// TableId 注解存在更新记录，否插入一条记录
boolean saveOrUpdate(T entity);
// 根据 updateWrapper 尝试更新，否继续执行 saveOrUpdate (T) 方法
boolean saveOrUpdate(T entity, Wrapper<T> updateWrapper);
// 批量修改插入
boolean saveOrUpdateBatch(Collection<T> entityList);
// 批量修改插入
boolean saveOrUpdateBatch(Collection<T> entityList, int batchSize);
# 参数说明
类型参数名描述
Tentity实体对象
WrapperupdateWrapper实体对象封装操作类 UpdateWrapper
CollectionentityList实体对象集合
intbatchSize插入批次数量

# 删除
// 根据 entity 条件，删除记录
boolean remove(Wrapper<T> queryWrapper);
// 根据 ID 删除
boolean removeById(Serializable id);
// 根据 columnMap 条件，删除记录
boolean removeByMap(Map<String, Object> columnMap);
// 删除（根据 ID 批量删除）
boolean removeByIds(Collection<? extends Serializable> idList);
# 参数说明
类型参数名描述
WrapperqueryWrapper实体包装类 QueryWrapper
Serializableid主键 ID
Map<String, Object>columnMap表字段 map 对象
Collection<? extends Serializable>idList主键 ID 列表

# 修改
// 根据 UpdateWrapper 条件，更新记录 需要设置 sqlset
boolean update(Wrapper<T> updateWrapper);
// 根据 whereEntity 条件，更新记录
boolean update(T entity, Wrapper<T> updateWrapper);
// 根据 ID 选择修改
boolean updateById(T entity);
// 根据 ID 批量更新
boolean updateBatchById(Collection<T> entityList);
// 根据 ID 批量更新
boolean updateBatchById(Collection<T> entityList, int batchSize);
# 参数说明
类型参数名描述
WrapperupdateWrapper实体对象封装操作类 UpdateWrapper
Tentity实体对象
CollectionentityList实体对象集合
intbatchSize更新批次数量

# 查询单个
// 根据 ID 查询
T getById(Serializable id);
// 根据 Wrapper，查询一条记录。结果集，如果是多个会抛出异常，随机取一条加上限制条件 wrapper.last ("LIMIT 1")
T getOne(Wrapper<T> queryWrapper);
// 根据 Wrapper，查询一条记录
T getOne(Wrapper<T> queryWrapper, boolean throwEx);
// 根据 Wrapper，查询一条记录
Map<String, Object> getMap(Wrapper<T> queryWrapper);
// 根据 Wrapper，查询一条记录
<V> V getObj(Wrapper<T> queryWrapper, Function<? super Object, V> mapper);
# 参数说明
类型参数名描述
Serializableid主键 ID
WrapperqueryWrapper实体对象封装操作类 QueryWrapper
booleanthrowEx有多个 result 是否抛出异常
Tentity实体对象
Function<? super Object, V>mapper转换函数

# 查询多个
// 查询所有
List<T> list();
// 查询列表
List<T> list(Wrapper<T> queryWrapper);
// 查询（根据 ID 批量查询）
Collection<T> listByIds(Collection<? extends Serializable> idList);
// 查询（根据 columnMap 条件）
Collection<T> listByMap(Map<String, Object> columnMap);
// 查询所有列表
List<Map<String, Object>> listMaps();
// 查询列表
List<Map<String, Object>> listMaps(Wrapper<T> queryWrapper);
// 查询全部记录
List<Object> listObjs();
// 查询全部记录
<V> List<V> listObjs(Function<? super Object, V> mapper);
// 根据 Wrapper 条件，查询全部记录
List<Object> listObjs(Wrapper<T> queryWrapper);
// 根据 Wrapper 条件，查询全部记录
<V> List<V> listObjs(Wrapper<T> queryWrapper, Function<? super Object, V> mapper);
# 参数说明
类型参数名描述
WrapperqueryWrapper实体对象封装操作类 QueryWrapper
Collection<? extends Serializable>idList主键 ID 列表
Map<?String, Object>columnMap表字段 map 对象
Function<? super Object, V>mapper转换函数

# 分页查询
// 无条件翻页查询
IPage<T> page(IPage<T> page);
// 翻页查询
IPage<T> page(IPage<T> page, Wrapper<T> queryWrapper);
// 无条件翻页查询
IPage<Map<String, Object>> pageMaps(IPage<T> page);
// 翻页查询
IPage<Map<String, Object>> pageMaps(IPage<T> page, Wrapper<T> queryWrapper);
# 参数说明
类型参数名描述
IPagepage翻页对象
WrapperqueryWrapper实体对象封装操作类 QueryWrapper

# 查询数量
// 查询总记录数
int count();
// 根据 Wrapper 条件，查询总记录数
int count(Wrapper<T> queryWrapper);
# 参数说明
类型参数名描述
WrapperqueryWrapper实体对象封装操作类 QueryWrapper

# 链式查询
# query
// 链式查询 普通
QueryChainWrapper<T> query();
// 链式查询 lambda 式。注意：不支持 Kotlin
LambdaQueryChainWrapper<T> lambdaQuery(); 
// 示例：
query().eq("column", value).one();
lambdaQuery().eq(Entity::getId, value).list();


# 引入 mybatis-plus

# 依赖
<!--mybatis plus-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>

# 增加扫描路径
@MapperScan("com.lemon.goods")
@SpringBootApplication
public class GoodsApplication {
    public static void main(String[] args) {
        SpringApplication.run(GoodsApplication.class);
    }
}

# 全局配置
然后在 ly-item-service 的 application.yml 文件中添加配置：
mybatis-plus:
  type-aliases-package: com.leyou.item.entity # 别名扫描包
  mapper-locations: classpath*: mappers/*.xml # mapper 的 xml 文件地址
  global-config:
    db-config:
      id-type: auto # id 默认为自增长
      update-strategy: NOT_EMPTY # 更新时，只更新非空字段
      insert-strategy: NOT_EMPTY # 新增时，只新增非空字段

# 引入分页插件
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MybatisConfig {
    /**
     * 注册 mybatis plus 的分页插件
     */
    @Bean
    public MybatisPlusInterceptor paginationInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor();
        // 数据库类型
        paginationInnerInterceptor.setDbType(DbType.MYSQL);
        // 溢出总页数后是进行处理 (默认是否)
        paginationInnerInterceptor.setOverflow(true);
        // 设置最大单页限制数量，默认 500 条，-1 不受限制
        paginationInnerInterceptor.setMaxLimit(500L);
        interceptor.addInnerInterceptor(paginationInnerInterceptor);
        return interceptor;
    }
}

# 使用
# Service
public interface CategoryService extends IService<Category> {
}
# ServiceImpl
@Service
public class CategoryServiceImpl extends ServiceImpl<CategoryMapper, Category> implements CategoryService {
}
# Mapper
public interface CategoryMapper extends BaseMapper<Category> {
}
🚀🚀🚀

 
 更新于   阅读次数  次
请我喝[茶]~(￣▽￣)~*
田埂、 微信支付
微信支付
田埂、 支付宝
支付宝
田埂、 贝宝
贝宝