14-mybatis-plus-conventions

MyBatis-Plus 使用规范

Mapper 定义

所有 Mapper 接口继承 BaseMapper<T>，添加 @Mapper 注解：

@Mapper
public interface XxxMapper extends BaseMapper<Xxx> { }

查询构造器

优先使用 LambdaQueryWrapper / LambdaUpdateWrapper（类型安全），禁止使用字符串列名。

// ✅ 正确：Lambda 方式，编译时检查
LambdaQueryWrapper<SysRole> wrapper = new LambdaQueryWrapper<SysRole>()
        .eq(SysRole::getRoleCode, roleCode)
        .eq(SysRole::getTenantId, tenantId)
        .orderByDesc(SysRole::getCreatedAt);

// ❌ 禁止：字符串列名，重构时易出错
QueryWrapper<SysRole> wrapper = new QueryWrapper<SysRole>()
        .eq("role_code", roleCode);

条件构造支持动态条件（第一个参数为 boolean）：

wrapper.eq(StringUtils.isNotBlank(name), SysRole::getRoleName, name);

自定义 SQL

简单的关联查询使用 @Select 注解直接写在 Mapper 接口上。复杂 SQL（动态条件多、超过 5 行）才使用 XML Mapper。

@Select("SELECT DISTINCT m.* FROM sys_menu m " +
        "INNER JOIN sys_role_menu rm ON rm.menu_id = m.id " +
        "WHERE rm.role_id = #{roleId} AND m.status = 1 " +
        "ORDER BY m.sort_order")
List<SysMenu> selectMenusByRoleId(@Param("roleId") Long roleId);

分页查询

统一使用 MyBatis-Plus 的 Page<T> + IPage<T>，不要手写 LIMIT/OFFSET。

// Controller
@GetMapping("/list")
public R<IPage<UserVO>> list(
        @RequestParam(defaultValue = "1") Integer page,
        @RequestParam(defaultValue = "10") Integer size) {
    Page<User> pageParam = new Page<>(page, size);
    IPage<UserVO> result = userService.findByPage(pageParam);
    return R.ok(result);
}

// Service / Mapper
IPage<User> selectPage(Page<User> page, @Param("ew") Wrapper<User> wrapper);

Entity 继承与审计字段

所有业务实体必须继承 BaseEntity，自动获得 createdAt、updatedAt、createBy、createByType、updateBy、updateByType 六个审计字段，由 AuditMetaObjectHandler 自动填充。

@Data
@EqualsAndHashCode(callSuper = true)
@TableName("xxx")
public class Xxx extends BaseEntity {
    @TableId(type = IdType.AUTO)
    private Long id;
    private Long tenantId;
    // ... 业务字段 ...
}

逻辑删除

需要逻辑删除的表在 Entity 字段上标记 @TableLogic：