1. Mybaits-plus实战(三)
1.1. 特殊使用规则
1.1.1. Model逻辑删除
- 数据库对应实体类,继承Model类可以实现AR模式的sql语句操作,但这里需要注意的是,对逻辑删除,官方说明需要实现如下重写方法才能生效,也就是使用
实例化对象.deleteById()
@Override
protected Serializable pkVal() {
/**
* AR 模式这个必须有,否则 xxById 的方法都将失效!
* 另外 UserMapper 也必须 AR 依赖该层注入,有可无 XML
*/
return id;
}
- 事实上,在主键字段添加
@TableId(value = "id", type = IdType.AUTO)
该注解,效果等同上面
- 还要注意的,对逻辑删除字段不要加
transient
修饰词,否则逻辑删除也会不生效
1.1.2. MetaObjectHandler统一数据库操作数据处理
- 你可以在操作数据库前打印日志,也可以对即将输入的数据做修改
- 重要的是,如果你只是实现了这个接口实现类,并注入了Spring,对你修改的字段,返回前端的数据是会有修改的内容,但是插入或更新数据库是不存在的;这里你需要做的是在要进行插入或修改的字段上面加上注解
@TableField(fill = FieldFill.INSERT)
,这里FieldFill
有四种选择,如下,它默认是不做处理的,所以一定要填个
public enum FieldFill {
/**
* 默认不处理
*/
DEFAULT,
/**
* 插入填充字段
*/
INSERT,
/**
* 更新填充字段
*/
UPDATE,
/**
* 插入和更新填充字段
*/
INSERT_UPDATE
}
- 效果如下
1.1.3. 级联操作
- 对自定义语句条件用wrapper包装,实现多表联合查询也可以用链式的条件查询
- 例子基本都在下面了
//可直接在这里定义方法列表,默认只有在类上加注解才会支持方法
@QuerySupport("selectPageByCustomWithXml")
public interface UserMapper extends BaseMapper<User> {
String JOIN_SQL = "SELECT user.*, role.name as role_name, role.create_time as role_create_time FROM user as user LEFT JOIN role as role ON user.role_id = role.id";
@QuerySupport
@Select("SELECT user.*, role.name as role_name, role.create_time as role_create_time FROM user as user LEFT JOIN role as role ON user.role_id = role.id")
List<UserRoleVO> findUserWithRoleByVoWithQueryList(@Param(Constants.WRAPPER) QueryWrapper<UserRoleVO> wrapper);
@QuerySupport
@Select(JOIN_SQL)
List<User> selectListByCustom(@Param(Constants.WRAPPER) Wrapper<User> wrapper);
/**
* 使用mybatis-plus自定义分页查询,使用resultMap将结果解析到关联对象中
*
* @param page 必须为第一个参数
* @param wrapper
* @return
*/
//类型优先级 (若未存在注解,当类型与mapper泛型不一致时使用其本身) @ResultType > @ResultMap > @Table(在类型一致时应用存在的resultMap)
@ResultMap("userCascadeResult")
@QuerySupport
@Select({"<script>", JOIN_SQL, "</script>"})
Page<User> selectPageByCustom(Page<User> page, @Param(Constants.WRAPPER) Wrapper<User> wrapper);
@QuerySupport
Page<User> selectPageByCustomWithXml(Page<User> page, @Param(Constants.WRAPPER) Wrapper<User> wrapper);
@QuerySupport
@Select({JOIN_SQL, "WHERE user.id = #{id}"})
User selectCascadeById(Serializable id);
@ResultMap("userCascadeResult")
@Select({JOIN_SQL, "WHERE user.id = #{id}"})
User selectCascadeById2(Serializable id);
@QuerySupport
@Select({"${text}"})
List<User> selectByText(@Param("text") String text, @Param(Constants.WRAPPER) Wrapper<User> wrapper);
/**
* Wrapper支持select指定列的方式
* @param wrapper
* @return
*/
@QuerySupport
@Select("SELECT %s FROM user as user LEFT JOIN role as role ON user.role_id = role.id")
List<UserRoleVO> findUserWithRoleByVoWithQueryListAndColumns(@Param(Constants.WRAPPER) Wrapper<UserRoleVO> wrapper);
@ResultMap("userNotCascadeResult")
@QuerySupport
@Select("SELECT %s FROM user")
Page<User> selectPageByCustomWithAssociationAndColumns(Page<User> page, @Param(Constants.WRAPPER) Wrapper<User> wrapper);
}
<select id="selectPageByCustomWithXml" resultMap="userCascadeResult">
SELECT user.*,
role.name as role_name,
role.create_time as role_create_time
FROM user as user
LEFT JOIN role as role
ON user.role_id = role.id
</select>
1.1.4. 增删改查技巧
@Resource
private UserMapper mapper;
- 增
mapper.insert(
new User().setId(10086L)
.setName("miemie")
.setEmail("miemie@baomidou.com")
.setAge(3));
- 删
mapper.delete(new QueryWrapper<User>()
.lambda().eq(User::getName, "Sandy"))
- 改
mapper.update(
new User().setEmail("miemie@baomidou.com"),
new QueryWrapper<User>()
.lambda().eq(User::getId, 2)
);
- 查
User user = mapper.selectOne(new QueryWrapper<User>().lambda().eq(User::getId, 10086));
List<User> users = mapper.selectList(Wrappers.<User>query().orderByAsc("age"));
1.1.5. 查询去字段技巧
- 之前说过一个,通过加
transient
,利用jackson或fastjson,在返回前端的时候对它做处理去掉对应的字段,但同时我们又遇到个问题,比如del_flag
,该字段往往前端不需要,但又不能加transient
,原因上面也说了会导致逻辑删除功能失效,这时,还有个办法解决
- 在实体字段上加上注解
@TableField(select = false)
,表示在进行sql查询时,去掉该字段的查询,这是在sql层面去掉该字段的查询,当然,如果你明确sql要查询这个字段还是可以查的
/**
* 添加transient会导致逻辑删除模式失效
*/
@ApiModelProperty(value = "是否删除:0-正常 1-软删除")
@TableLogic
@TableField(select = false)
private Integer delFlag;
1.1.6. 子查询和嵌套查询
System.out.println("----- 带子查询(sql注入) ------");
List<User> plainUsers2 = userMapper.selectList(new QueryWrapper<User>()
.inSql("role_id", "select id from role where id = 2"));
List<User> lambdaUsers2 = userMapper.selectList(new QueryWrapper<User>().lambda()
.inSql(User::getRoleId, "select id from role where id = 2"));
Assert.assertEquals(plainUsers2.size(), lambdaUsers2.size());
print(plainUsers2);
System.out.println("----- 带嵌套查询 ------");
List<User> plainUsers3 = userMapper.selectList(new QueryWrapper<User>()
.nested(i -> i.eq("role_id", 2L).or().eq("role_id", 3L))
.and(i -> i.ge("age", 20)));
List<User> lambdaUsers3 = userMapper.selectList(new QueryWrapper<User>().lambda()
.nested(i -> i.eq(User::getRoleId, 2L).or().eq(User::getRoleId, 3L))
.and(i -> i.ge(User::getAge, 20)));
Assert.assertEquals(plainUsers3.size(), lambdaUsers3.size());
print(plainUsers3);
----- 带子查询(sql注入) ------
SELECT id,name,age,email,role_id FROM user WHERE role_id IN (select id from role where id = 2)
----- 带嵌套查询 ------
SELECT id,name,age,email,role_id FROM user WHERE ( role_id = ? OR role_id = ? ) AND ( age >= ? )
1.2. 其它功能点(基本都是插件)
- 性能分析(sql执行时间)
- 乐观锁
- 分页
- 主键生成器
- 自定义sql
- 多租户
1.3. 总结
- 其它功能点不是前面已经写过例子的,就是很少使用
- 到现在我已经把mybatis-plus的所有官方文档和sample代码例子都看了一遍,也做了一些总结和特别标注,毕竟很多功能可能暂时用不到不代表以后用不到,在总结此篇的时候也让我对此前的博客有些技术上的修正,比如
MetaObjectHandler
的使用,并不是只能把值放返回对象,它是可以直接插入数据库的
- mybatis-plus的总结工作到现在结束了,知识点应该已经概括了官方文档的所有,有啥意见建议请下面提_