Mybatis Plus框架項目落地實踐分析總結(jié)

更新時間：2023年03月01日 14:54:29 作者：CoderV的進階筆記

這篇文章主要為大家介紹了Mybatis Plus框架項目落地實踐分析總結(jié)，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

大綱

設(shè)計
- BaseEntity
- 邏輯刪除
- 自動填充字段
代碼生成類
查詢操作
- Query基類(復(fù)用+PageQuery)
- 普通Query
- Lambda Query
- 復(fù)雜多表查詢
- 報表型查詢
保存操作
- 模型利用JPA保存
- 批量保存數(shù)據(jù)
- 按條件更新數(shù)據(jù)
擴展
- 阻止全表操作
- 動態(tài)數(shù)據(jù)源
- 多租戶

詳細代碼實現(xiàn)在開源項目Agileboot中：github.com/valarchie/A…關(guān)于Mybatis Plus的實踐，如有不足或者建議歡迎大家評論指正。

廢話不多說進入正題。

基礎(chǔ)設(shè)計

BaseEntity

對于數(shù)據(jù)庫中表中的公共字段我們可以抽取出來做成基類繼承。避免表映射的數(shù)據(jù)庫實體類字段太過繁雜。
例如常用的創(chuàng)建時間、創(chuàng)建者、更新時間、更新者、邏輯刪除字段。

/**
 * Entity基類
 *
 * @author valarchie
 */
@EqualsAndHashCode(callSuper = true)
@Data
public class BaseEntity<T extends Model<?>> extends Model<T> {
    @ApiModelProperty("創(chuàng)建者ID")
    @TableField(value = "creator_id", fill = FieldFill.INSERT)
    private Long creatorId;
    @ApiModelProperty("創(chuàng)建時間")
    @TableField(value = "create_time", fill = FieldFill.INSERT)
    private Date createTime;
    @ApiModelProperty("更新者ID")
    @TableField(value = "updater_id", fill = FieldFill.UPDATE, updateStrategy = FieldStrategy.NOT_NULL)
    private Long updaterId;
    @ApiModelProperty("更新時間")
    @TableField(value = "update_time", fill = FieldFill.UPDATE)
    private Date updateTime;
    /**
     * deleted字段請在數(shù)據(jù)庫中 設(shè)置為tinyInt   并且非null   默認(rèn)值為0
     */
    @ApiModelProperty("刪除標(biāo)志（0代表存在 1代表刪除）")
    @TableField("deleted")
    @TableLogic
    private Boolean deleted;
}

通過繼承了基類，實體類看起來就簡潔了許多。

/**
 * <p>
 * 通知公告表
 * </p>
 *
 * @author valarchie
 * @since 2022-10-02
 */
@Getter
@Setter
@TableName("sys_notice")
@ApiModel(value = "SysNoticeEntity對象", description = "通知公告表")
public class SysNoticeEntity extends BaseEntity<SysNoticeEntity> {
    private static final long serialVersionUID = 1L;
    @ApiModelProperty("公告ID")
    @TableId(value = "notice_id", type = IdType.AUTO)
    private Integer noticeId;
    @ApiModelProperty("公告標(biāo)題")
    @TableField("notice_title")
    private String noticeTitle;
    @ApiModelProperty("公告類型（1通知 2公告）")
    @TableField("notice_type")
    private Integer noticeType;
    @ApiModelProperty("公告內(nèi)容")
    @TableField("notice_content")
    private String noticeContent;
    @ApiModelProperty("公告狀態(tài)（1正常 0關(guān)閉）")
    @TableField("`status`")
    private Integer status;
    @ApiModelProperty("備注")
    @TableField("remark")
    private String remark;
    @Override
    public Serializable pkVal() {
        return this.noticeId;
    }
}

既然抽取出了公共字段，我們可以更進一步將這些公共字段進行自動填值處理。
Mybatis Plus提供了字段自動填充的插件。

自動填充字段

/**
 * Mybatis Plus允許在插入或者更新的時候
 * 自定義設(shè)定值
 * @author valarchie
 */
@Component
@Slf4j
public class CustomMetaObjectHandler implements MetaObjectHandler {
    public static final String CREATE_TIME_FIELD = "createTime";
    public static final String CREATOR_ID_FIELD = "creatorId";
    public static final String UPDATE_TIME_FIELD = "updateTime";
    public static final String UPDATER_ID_FIELD = "updaterId";
    @Override
    public void insertFill(MetaObject metaObject) {
        if (metaObject.hasSetter(CREATE_TIME_FIELD)) {
            this.setFieldValByName(CREATE_TIME_FIELD, new Date(), metaObject);
        }
        if (metaObject.hasSetter(CREATOR_ID_FIELD)) {
            this.strictInsertFill(metaObject, CREATOR_ID_FIELD, Long.class, getUserIdSafely());
        }
    }
    @Override
    public void updateFill(MetaObject metaObject) {
        if (metaObject.hasSetter(UPDATE_TIME_FIELD)) {
            this.setFieldValByName(UPDATE_TIME_FIELD, new Date(), metaObject);
        }
        if (metaObject.hasSetter(UPDATER_ID_FIELD)) {
            this.strictUpdateFill(metaObject, UPDATER_ID_FIELD, Long.class, getUserIdSafely());
        }
    }
    public Long getUserIdSafely() {
        Long userId = null;
        try {
            LoginUser loginUser = AuthenticationUtils.getLoginUser();
            userId = loginUser.getUserId();
        } catch (Exception e) {
            log.info("can not find user in current thread.");
        }
        return userId;
    }
}

使用自定義填充值時，需要在生成實體的時候加上配置。FieldFill.INSERT 和 FieldFill.INSERT_UPDATE

private void entityConfig(StrategyConfig.Builder builder) {
    Entity.Builder entityBuilder = builder.entityBuilder();
    entityBuilder
        .enableLombok()
        .addTableFills(new Column("create_time", FieldFill.INSERT))
        .addTableFills(new Column("creator_id", FieldFill.INSERT))
        .addTableFills(new Property("updateTime", FieldFill.INSERT_UPDATE))
        .addTableFills(new Property("updaterId", FieldFill.INSERT_UPDATE))
        // ID strategy AUTO, NONE, INPUT, ASSIGN_ID, ASSIGN_UUID;
        .idType(IdType.AUTO)
        .formatFileName("%sEntity");
    if (isExtendsFromBaseEntity) {
        entityBuilder
            .superClass(BaseEntity.class)
            .addSuperEntityColumns("creator_id", "create_time", "creator_name", "updater_id", "update_time",
                "updater_name", "deleted");
    }
    entityBuilder.build();
}

邏輯刪除

數(shù)據(jù)庫一般不進行真實刪除操作。但是如果讓我們手工處理這些邏輯刪除的話，也是非常麻煩。Mybatis Plus有提供這樣的插件。僅需要在EntityConfig中設(shè)置邏輯刪除的字段是哪個即可。

entityBuilder
    // deleted的字段設(shè)置成tinyint  長度為1
    .logicDeleteColumnName("deleted")
    .formatFileName("%sEntity");

代碼生成類

Mybatis plus支持生成entity,mapper,service,controller這四層類。但是筆者認(rèn)為生成類的時候還是不要直接覆蓋原本的類比較好。
我將生成的類，固定放在一個目錄讓使用者自己copy類到指定的目錄。
以下是我自己封裝的CodeGenerator的代碼片段。
需要填入的字段主要是：

作者名
包名
表名
是否需要繼承基類（因為不是所有表都需要繼承基類）

public static void main(String[] args) {
    // 默認(rèn)讀取application-dev yml中的master數(shù)據(jù)庫配置
    JSON ymlJson = JSONUtil.parse(new Yaml().load(ResourceUtil.getStream("application-dev.yml")));
    CodeGenerator generator = CodeGenerator.builder()
        .databaseUrl(JSONUtil.getByPath(ymlJson, URL_PATH).toString())
        .username(JSONUtil.getByPath(ymlJson, USERNAME_PATH).toString())
        .password(JSONUtil.getByPath(ymlJson, PASSWORD_PATH).toString())
        .author("valarchie")
        //生成的類 放在orm子模塊下的/target/generated-code目錄底下
        .module("/agileboot-orm/target/generated-code")
        .parentPackage("com.agileboot")
        .tableName("sys_config")
        // 決定是否繼承基類
        .isExtendsFromBaseEntity(true)
        .build();
    generator.generateCode();
}

查詢操作

Query基類

系統(tǒng)內(nèi)的查詢大部分有共用的邏輯。比如時間范圍的查詢、排序。我們可以抽取這部分邏輯放在基類。然后把具體查詢條件的構(gòu)造，放到子類去實現(xiàn)。

AbstractQuery

/**
 * @author valarchie
 */
@Data
public abstract class AbstractQuery<T> {
    protected String orderByColumn;
    protected String isAsc;
    @JsonFormat(shape = Shape.STRING, pattern = "yyyy-MM-dd")
    private Date beginTime;
    @JsonFormat(shape = Shape.STRING, pattern = "yyyy-MM-dd")
    private Date endTime;
    private static final String ASC = "ascending";
    private static final String DESC = "descending";
    /**
     * 生成query conditions
     * @return
     */
    public abstract QueryWrapper<T> toQueryWrapper();
    public void addSortCondition(QueryWrapper<T> queryWrapper) {
        if(queryWrapper != null) {
            boolean sortDirection = convertSortDirection();
            queryWrapper.orderBy(StrUtil.isNotBlank(orderByColumn), sortDirection,
                StrUtil.toUnderlineCase(orderByColumn));
        }
    }
    public void addTimeCondition(QueryWrapper<T> queryWrapper, String fieldName) {
        if (queryWrapper != null) {
            queryWrapper
                .ge(beginTime != null, fieldName, DatePickUtil.getBeginOfTheDay(beginTime))
                .le(endTime != null, fieldName, DatePickUtil.getEndOfTheDay(endTime));
        }
    }
    public boolean convertSortDirection() {
        boolean orderDirection = true;
        if (StrUtil.isNotEmpty(isAsc)) {
            if (ASC.equals(isAsc)) {
                orderDirection = true;
            } else if (DESC.equals(isAsc)) {
                orderDirection = false;
            }
        }
        return orderDirection;
    }
}

PageQuery

分頁是非常常見的查詢條件，我們可以基于AbstractQuery再做一層封裝。

/**
 * @author valarchie
 */
@Data
public abstract class AbstractPageQuery<T> extends AbstractQuery<T> {
    public static final int MAX_PAGE_NUM = 200;
    public static final int MAX_PAGE_SIZE = 500;
    @Max(MAX_PAGE_NUM)
    protected Integer pageNum = 1;
    @Max(MAX_PAGE_SIZE)
    protected Integer pageSize = 10;
    public Page<T> toPage() {
        return new Page<>(pageNum, pageSize);
    }
}

普通Query

比如我們有個菜單查詢列表，我們可以新建一個MenuQuery繼承AbstractQuery。然后實現(xiàn) toQueryWrapper方法去構(gòu)造查詢條件。

/**
 * @author valarchie
 */
@Data
public class MenuQuery extends AbstractQuery<SysMenuEntity> {
    private String menuName;
    private Boolean isVisible;
    private Integer status;
    @Override
    public QueryWrapper<SysMenuEntity> toQueryWrapper() {
        QueryWrapper<SysMenuEntity> queryWrapper = new QueryWrapper<SysMenuEntity>()
            .like(StrUtil.isNotEmpty(menuName), "menu_name", menuName)
            .eq(isVisible != null, "is_visible", isVisible)
            .eq(status != null, "status", status);
        queryWrapper.orderBy(true, true, Arrays.asList("parent_id", "order_num"));
        return queryWrapper;
    }
}

如果有另外一個不同的菜單查詢列表，查詢的參數(shù)一樣，但是查詢條件的構(gòu)造不一樣。我們可以新建一個DifferentMenuQuery類繼承MenuQuery類，再覆寫toQueryWrapper方法即可。

Lambda Query

如果在項目中的查詢明確是單表操作的話，我們可以使用LambdaQuery來構(gòu)造查詢。

LambdaQueryWrapper<SysMenuEntity> menuQuery = Wrappers.lambdaQuery();
menuQuery.select(SysMenuEntity::getMenuId);
List<SysMenuEntity> menuList = menuService.list(menuQuery);

復(fù)雜多表查詢

Mybatis Plus支持@Select注解，遇到簡單的多表join查詢的話，我們可以直接在代碼中寫SQL語句。

以下是Mapper中的實現(xiàn)。${ew.customSqlSegment} 會渲染出QueryWrapper類生成的查詢條件。

/**
 * 根據(jù)條件分頁查詢用戶列表
 * @param page 頁碼對象
 * @param queryWrapper 查詢對象
 * @return 用戶信息集合信息
 */
@Select("SELECT u.*, d.dept_name, d.leader_name "
    + "FROM sys_user u "
    + " LEFT JOIN sys_dept d ON u.dept_id = d.dept_id "
    + "${ew.customSqlSegment}")
Page<SearchUserDO> getUserList(Page<SearchUserDO> page,
    @Param(Constants.WRAPPER) Wrapper<SearchUserDO> queryWrapper);

Service層中的實現(xiàn)。

@Override
public Page<SearchUserDO> getUserList(AbstractPageQuery<SearchUserDO> query) {
    return baseMapper.getUserList(query.toPage(), query.toQueryWrapper());
}

報表型查詢

如果遇到復(fù)雜的報表型查詢，利用@Select注解的話，可能SQL看起來還是非常的復(fù)雜。此時推薦使用XML的形式。

保存操作

模型利用JPA保存

Mybatis Plus支持activeRecord特性，我們可以直接在Entity上執(zhí)行save\update\delete等操作?？蚣軙詣訋臀覀兟鋷?。 activeRecord需要在EntityConfig配置。

        entityBuilder
            // operate entity like JPA.
            .enableActiveRecord()
            // deleted的字段設(shè)置成tinyint  長度為1
            // ID strategy AUTO, NONE, INPUT, ASSIGN_ID, ASSIGN_UUID;
            .idType(IdType.AUTO)
            .formatFileName("%sEntity");

因為Entity都是生成的，我們不方便將業(yè)務(wù)邏輯直接放在Entity中。這樣會和數(shù)據(jù)庫實體過于耦合。
推薦新建一個模型類繼承XxxxEntity,然后將邏輯填充在模型類中。

public class DeptModel extends SysDeptEntity {
    private ISysDeptService deptService;
    public DeptModel(ISysDeptService deptService) {
        this.deptService = deptService;
    }
    public DeptModel(SysDeptEntity entity, ISysDeptService deptService) {
        if (entity != null) {
            // 如果大數(shù)據(jù)量的話  可以用MapStruct優(yōu)化
            BeanUtil.copyProperties(entity, this);
        }
        this.deptService = deptService;
    }
    public void loadAddCommand(AddDeptCommand addCommand) {
        this.setParentId(addCommand.getParentId());
        this.setAncestors(addCommand.getAncestors());
        this.setDeptName(addCommand.getDeptName());
        this.setOrderNum(addCommand.getOrderNum());
        this.setLeaderName(addCommand.getLeaderName());
        this.setPhone(addCommand.getPhone());
        this.setEmail(addCommand.getEmail());
    }
    public void checkDeptNameUnique() {
        if (deptService.isDeptNameDuplicated(getDeptName(), getDeptId(), getParentId())) {
            throw new ApiException(ErrorCode.Business.DEPT_NAME_IS_NOT_UNIQUE, getDeptName());
        }
    }
    public void generateAncestors() {
        if (getParentId() == 0) {
            setAncestors(getParentId().toString());
            return;
        }
        SysDeptEntity parentDept = deptService.getById(getParentId());
        if (parentDept == null || StatusEnum.DISABLE.equals(
            BasicEnumUtil.fromValue(StatusEnum.class, parentDept.getStatus()))) {
            throw new ApiException(ErrorCode.Business.DEPT_PARENT_DEPT_NO_EXIST_OR_DISABLED);
        }
        setAncestors(parentDept.getAncestors() + "," + getParentId());
    }
}

在應(yīng)用層我們就可以直接調(diào)用模型類來完成邏輯操作。整個代碼的語義性非常強。

public void addDept(AddDeptCommand addCommand) {
    DeptModel deptModel = deptModelFactory.create();
    deptModel.loadAddCommand(addCommand);
    deptModel.checkDeptNameUnique();
    deptModel.generateAncestors();
    deptModel.insert();
}

批量保存數(shù)據(jù)

以上是單條數(shù)據(jù)的落庫操作，那么多條數(shù)據(jù)循環(huán)去insert的話，顯然不是一個明智之舉。
Mybatis Plus提供了批量落庫操作。

private boolean saveMenus() {
    List<SysRoleMenuEntity> list = new ArrayList<>();
    if (getMenuIds() != null) {
        for (Long menuId : getMenuIds()) {
            SysRoleMenuEntity rm = new SysRoleMenuEntity();
            rm.setRoleId(getRoleId());
            rm.setMenuId(menuId);
            list.add(rm);
        }
        return roleMenuService.saveBatch(list);
    }
    return false;
}

按條件更新數(shù)據(jù)

JPA的方式有一個弊端就是需要先拿到數(shù)據(jù)實體類，才能調(diào)用save等操作。

還有一種情況，我們需要按照某些條件去更新數(shù)據(jù)，而不想先一條條獲取數(shù)據(jù)再Save。

此時可以使用LambdaUpdate類。

LambdaUpdateWrapper<SysUserEntity> updateWrapper = new LambdaUpdateWrapper<>();
updateWrapper.set(SysUserEntity::getRoleId, null).eq(SysUserEntity::getUserId, userId);
userService.update(updateWrapper);

擴展

阻止全表操作

Mybatis Plus提供了安全方面的插件，比如阻止全標(biāo)更新刪除的插件。

僅需要聲明MybatisPlusInterceptor Bean，依次添加攔截插件即可。

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new BlockAttackInnerInterceptor());
    return interceptor;
}

動態(tài)數(shù)據(jù)源

Mybatis Plus提供@DS注解去動態(tài)選擇從庫還是主庫來執(zhí)行SQL.

@DS("slave")
@PreAuthorize("@permission.has('system:notice:list')")
@GetMapping("/listFromSlave")
public ResponseDTO<PageDTO<NoticeDTO>> listFromSlave(NoticeQuery query) {
    PageDTO<NoticeDTO> pageDTO = noticeApplicationService.getNoticeList(query);
    return ResponseDTO.ok(pageDTO);
}

比如打上了@DS("slave")的接口，就會去找slave這個從庫進行操作。

多租戶

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new TenantLineInnerInterceptor(new TenantLineHandler() {
            @Override
            public Expression getTenantId() {
                // 獲取租戶ID 實際應(yīng)該從用戶信息中獲取
                return new LongValue(1);
            }
            // 這是 default 方法,默認(rèn)返回 false 表示所有表都需要拼多租戶條件
            @Override
            public boolean ignoreTable(String tableName) {
                return !"sys_user".equalsIgnoreCase(tableName);
            }
        }));
        // 如果用了分頁插件注意先 add TenantLineInnerInterceptor 再 add PaginationInnerInterceptor
        // 用了分頁插件必須設(shè)置 MybatisConfiguration#useDeprecatedExecutor = false
//        interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
        return interceptor;
    }

以上就是Mybatis Plus框架項目落地實踐分析總結(jié)的詳細內(nèi)容，更多關(guān)于Mybatis Plus框架項目實踐的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: