Mybatis Plus基础和使用技巧

1、条件查询(QueryWrapper)

如果说,我们需要查询的 SQL 语句如下:

SELECT * FROM user_info WHERE age = 20

那么对应的代码可以为:

QueryWrapper<UserInfo> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("age", 20);
List<UserInfo> list = userInfoMapper.selectList(queryWrapper );


以上就是查询用户表,用户年龄等于20的用户信息

2、条件查询(QueryWrapper lambda)

QueryWrapper<UserInfo> queryWrapper = new QueryWrapper<>();
queryWrapper.lambda().eq(UserInfo::getAge, 20);
List<UserInfo> list = userInfoMapper.selectList(queryWrapper );

以上就是 QueryWrapper 的 lambda 表达式写法,这样能够避免写字段名写错,或者未转换驼峰写法导致 SQL 错误


3、条件查询(LambdaQueryWrapper)

LambdaQueryWrapper<UserInfo> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(UserInfo::getAge, 20);
List<UserInfo> list = userInfoMapper.selectList(queryWrapper );

LambdaQueryWrapper 与 QueryWrapper 的 lambda 写法基本一致


4、分页查询

// 条件查询
LambdaQueryWrapper<UserInfo> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(UserInfo::getAge, 20);
// 分页对象
Page<UserInfo> queryPage = new Page<>(page, limit);
// 分页查询
IPage<UserInfo> iPage = userInfoMapper.selectPage(queryPage , queryWrapper);
// 数据总数
Long total = iPage.getTotal();
// 集合数据
List<UserInfo> list = iPage.getRecords();

以上就是分页查询,如果无需条件查询,queryWrapper 可为 null


5、分页查询(联表)

当我们需要关联表格分页查询时,第3步已经满足不了我们的需求了,那么我们需要进行联表分页查询

假设我们需要的 SQL 语句如下:

SELECT
a.*,
b.`name` AS sex_text 
FROM
user_info a
LEFT JOIN user_sex b ON ( a.sex = b.id ) 
WHERE
1 = 1 
AND a.age > 20


那么我们需要进行如下操作:


1、新建 UserInfoVO.java

import com.zyxx.entity.UserInfo;
import lombok.Data;
@Data
public class UserInfoVO extends UserInfo {
    // 性别
    private String sexText;
}


2、UserInfoMapper.java 中

IPage<UserInfoVO> list(Page<UserInfoVO> page, @Param(Constants.WRAPPER) Wrapper<UserInfoVO> queryWrapper);

3、UserInfoMapper.xml 中

<select id="list" resultType="com.zyxx.vo.UserInfoVO">
    SELECT
a.*,
b.`name` AS sex_text 
FROM
user_info a
LEFT JOIN user_sex b ON ( a.sex = b.id ) 
    ${ew.customSqlSegment}
</select>


4、UserInfoServiceImpl.java 中

// 条件查询
LambdaQueryWrapper<UserInfoVO> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(UserInfo::getAge, 20);
// 分页对象
Page<UserInfoVO> queryPage = new Page<>(page, limit);
// 分页查询
IPage<UserInfoVO> iPage = userInfoMapper.list(queryPage , queryWrapper);
// 数据总数
Long total = iPage.getTotal();
// 用户数据
List<UserInfoVO> list = iPage.getRecords();


以上就是分页查询(联表)时的操作,这个应该是用的比较多的


6、AND 和 OR

queryWrapper 默认是按照 and 来连接的,但是在我们业务需求中,肯定会用到 or 来写 SQL


1、初级

假设我们需要的 SQL 语句如下:

SELECT
a.* 
FROM
user_info a 
WHERE
1 = 1 
AND a.id <> 1 
AND ( a.`name` = 'jack' OR a.phone = '13888888888' )

那么我们可以这样写:


LambdaQueryWrapper<UserInfo> queryWrapper = new LambdaQueryWrapper<>();
// AND a.id <> 1 
queryWrapper.ne(UserInfo::getId, "1");
// AND ( a.`name` = 'jack' OR a.phone = '13888888888' )
queryWrapper.and(i -> i.eq(UserInfo::getName, "jack").or().eq(UserInfo::getPhone, "13888888888"));
// 查询结果
List<UserInfo> list = userInfoMapper.selectList(queryWrapper);

以上就完成了初级的 and 和 or 联用的情况


2、复杂

假设我们需要的 SQL 语句如下:

SELECT
a.* 
FROM
user_info a 
WHERE
1 = 1 
AND a.id <> 1 
AND ( (a.`name` = 'jack' AND a.category = 1) OR (a.phone = '13888888888' OR a.category = 2) )

那么我们可以这样写:


LambdaQueryWrapper<UserInfo> queryWrapper = new LambdaQueryWrapper<>();
// AND a.id <> 1 
queryWrapper.ne(UserInfo::getId, "1");
// AND ( (a.`name` = 'jack' AND a.category = 1) OR (a.phone = '13888888888' OR a.category = 2) )
queryWrapper.and(i -> (i.and(j -> j.eq(UserInfo::getName, "jack").eq(UserInfo::getCategory, 1))).or(j -> j.eq(UserInfo::getPhone, "13888888888").eq(UserInfo::getCategory, 2)));
// 查询结果
List<UserInfo> list = userInfoMapper.selectList(queryWrapper);

以上就完成了复杂的 and 和 or 联用的情况

那么以后遇见更复杂的,可以按此规则继续进行拼接 SQL


7、@TableLogic

这个注解是 Mybatis-Plus 的逻辑删除标志,一般注解在实体的属性上,假如我的用户信息表,用一个字段(del_flag)用来表示数据的删除状态,如下:

@ApiModelProperty(value = "删除状态(0--未删除1--已删除)")
@TableField("del_flag")
@TableLogic
private Integer delFlag;

Mybatis-Plus 默认使用 0 表示有效,1表示无效,当然也可以自定义,有两种方式:


1、注解上

@ApiModelProperty(value = "删除状态(0--未删除1--已删除)")

@TableField("del_flag")

@TableLogic(value = "1", delval = "0")

private Integer delFlag;

value = “” 默认的原值,delval = “” 删除后的值


2、配置文件

# mybatis配置
mybatis-plus:
  # 全局配置
  global-config:
    db-config:
      # 逻辑删除全局字段 (默认无 设置会自动扫描实体字段)
      logic-delete-field: delFlag
      # 逻辑删除全局值(默认 1、表示已删除)
      logic-delete-value: 1
      # 逻辑未删除全局值(默认 0、表示未删除)
      logic-not-delete-value: 0


那么,我们在查询数据的时候,会自动为我们加上查询条件


AND del_flag = 0

这时候逻辑删除生效,当我们执行 userInfoMapper.removeById(id) 时,也不会物理删除,实际执行的 SQL 如下:


UPDATE user_info set del_flag = 1 where id = #{id}

注意:自己在 xml 文件中写的 SQL 不会自动加上逻辑删除条件


8、指定查询字段(select)

当我们只需要查询表格中的某几个字段,如果表格数据很大的话,我们不应该查询表格的所有字段,假如,我们需要的 SQL 如下:


SELECT
id,
`name`,
phone 
FROM
user_info 
WHERE
1 = 1 
AND age = 20

我们只需要查询年龄等于20的用户的 id、name、phone,所以,可以这样写

LambdaQueryWrapper<UserInfo> queryWrapper = new LambdaQueryWrapper<>();
// 只查询 id,name,phone
queryWrapper.select(UserInfo::getId, UserInfo::getName, UserInfo::getPhone);
// 查询条件为:age = 20
queryWrapper.eq(UserInfo::getAge, 20);
List<UserInfo> list = userInfoMapper.selectList(queryWrapper );

这样,我们就需要查询表中所有字段的数据,大大缩短了查询时间


8、查询一条数据(getOne)

getOne 是 service 中的方法,当我们使用 getOne 查询一条数据返回的时候,我们往往不是用主键 ID 去查询,如果用主键 ID 查询一条数据,我们应该使用:

UserInfo userInfo = userInfoService.getById(id);

假如我们用户表中有 openId 字段,例如:微信用户,这个肯定是唯一的,我们需要使用 openId 查询一条用户信息,我们通常使用:

LambdaQueryWrapper<UserInfo> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(UserInfo::getOpenId, openId);
UserInfo userInfo = userInfoService.getOne(queryWrapper);


但是这样存在一定的风险,也就是说如果表中存在同一个 openId 的两条及两条以上的数据时,会抛出异常,所以我们需要这样:

LambdaQueryWrapper<UserInfo> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(UserInfo::getOpenId, openId);
UserInfo userInfo = userInfoService.getOne(queryWrapper, false);

可以看出,传入了一个 false 参数,该参数的含义为:


据 Wrapper,查询一条记录

有多个 result 是否抛出异常

通过查看源码:

@Override
public T getOne(Wrapper<T> queryWrapper, boolean throwEx) {
    if (throwEx) {
        return baseMapper.selectOne(queryWrapper);
    }
    return SqlHelper.getObject(log, baseMapper.selectList(queryWrapper));
}

如果传入的是 true(默认值),则不作处理进行查询,否则进行分页查询,再看 getObject() 方法中:

/**
* 从list中取第一条数据返回对应List中泛型的单个结果
*
* @param list ignore
* @param <E>  ignore
* @return ignore
*/
public static <E> E getObject(Log log, List<E> list) {
   if (CollectionUtils.isNotEmpty(list)) {
       int size = list.size();
       if (size > 1) {
           log.warn(String.format("Warn: execute Method There are  %s results.", size));
       }
       return list.get(0);
   }
   return null;
}

默认取第一条数据返回,所以当我们查询为多条数据时,默认返回第一条


原文链接:https://lizhou.blog.csdn.net/article/details/108093246

qrcode