您好,登錄后才能下訂單哦!
這篇文章主要介紹了Mybatis Plus框架源碼分析的相關(guān)知識(shí),內(nèi)容詳細(xì)易懂,操作簡(jiǎn)單快捷,具有一定借鑒價(jià)值,相信大家閱讀完這篇Mybatis Plus框架源碼分析文章都會(huì)有所收獲,下面我們一起來(lái)看看吧。
對(duì)于數(shù)據(jù)庫(kù)中表中的公共字段我們可以抽取出來(lái)做成基類繼承。避免表映射的數(shù)據(jù)庫(kù)實(shí)體類字段太過(guò)繁雜。
例如常用的創(chuàng)建時(shí)間、創(chuàng)建者、更新時(shí)間、更新者、邏輯刪除字段。
/** * 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)建時(shí)間") @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("更新時(shí)間") @TableField(value = "update_time", fill = FieldFill.UPDATE) private Date updateTime; /** * deleted字段請(qǐng)?jiān)跀?shù)據(jù)庫(kù)中 設(shè)置為tinyInt 并且非null 默認(rèn)值為0 */ @ApiModelProperty("刪除標(biāo)志(0代表存在 1代表刪除)") @TableField("deleted") @TableLogic private Boolean deleted; }
通過(guò)繼承了基類,實(shí)體類看起來(lái)就簡(jiǎn)潔了許多。
/** * <p> * 通知公告表 * </p> * * @author valarchie * @since 2022-10-02 */ @Getter @Setter @TableName("sys_notice") @ApiModel(value = "SysNoticeEntity對(duì)象", 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; } }
既然抽取出了公共字段,我們可以更進(jìn)一步將這些公共字段進(jìn)行自動(dòng)填值處理。
Mybatis Plus提供了字段自動(dòng)填充的插件。
/** * Mybatis Plus允許在插入或者更新的時(shí)候 * 自定義設(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; } }
使用自定義填充值時(shí),需要在生成實(shí)體的時(shí)候加上配置。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ù)庫(kù)一般不進(jìn)行真實(shí)刪除操作。但是如果讓我們手工處理這些邏輯刪除的話,也是非常麻煩。Mybatis Plus有提供這樣的插件。僅需要在EntityConfig中設(shè)置邏輯刪除的字段是哪個(gè)即可。
entityBuilder // deleted的字段設(shè)置成tinyint 長(zhǎng)度為1 .logicDeleteColumnName("deleted") .formatFileName("%sEntity");
Mybatis plus支持生成entity,mapper,service,controller這四層類。 但是筆者認(rèn)為生成類的時(shí)候還是不要直接覆蓋原本的類比較好。
我將生成的類,固定放在一個(gè)目錄讓使用者自己copy類到指定的目錄。
以下是我自己封裝的CodeGenerator的代碼片段。
需要填入的字段主要是:
作者名
包名
表名
是否需要繼承基類(因?yàn)椴皇撬斜矶夹枰^承基類)
public static void main(String[] args) { // 默認(rèn)讀取application-dev yml中的master數(shù)據(jù)庫(kù)配置 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(); }
系統(tǒng)內(nèi)的查詢大部分有共用的邏輯。比如時(shí)間范圍的查詢、排序。我們可以抽取這部分邏輯放在基類。 然后把具體查詢條件的構(gòu)造,放到子類去實(shí)現(xiàn)。
/** * @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; } }
分頁(yè)是非常常見(jiàn)的查詢條件,我們可以基于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); } }
比如我們有個(gè)菜單查詢列表,我們可以新建一個(gè)MenuQuery繼承AbstractQuery。然后實(shí)現(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; } }
如果有另外一個(gè)不同的菜單查詢列表,查詢的參數(shù)一樣,但是查詢條件的構(gòu)造不一樣。我們可以新建一個(gè)DifferentMenuQuery類繼承MenuQuery類,再覆寫toQueryWrapper方法即可。
如果在項(xiàng)目中的查詢明確是單表操作的話,我們可以使用LambdaQuery來(lái)構(gòu)造查詢。
LambdaQueryWrapper<SysMenuEntity> menuQuery = Wrappers.lambdaQuery(); menuQuery.select(SysMenuEntity::getMenuId); List<SysMenuEntity> menuList = menuService.list(menuQuery);
Mybatis Plus支持@Select注解,遇到簡(jiǎn)單的多表join查詢的話,我們可以直接在代碼中寫SQL語(yǔ)句。
以下是Mapper中的實(shí)現(xiàn)。${ew.customSqlSegment} 會(huì)渲染出QueryWrapper類生成的查詢條件。
/** * 根據(jù)條件分頁(yè)查詢用戶列表 * @param page 頁(yè)碼對(duì)象 * @param queryWrapper 查詢對(duì)象 * @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層中的實(shí)現(xiàn)。
@Override public Page<SearchUserDO> getUserList(AbstractPageQuery<SearchUserDO> query) { return baseMapper.getUserList(query.toPage(), query.toQueryWrapper()); }
如果遇到復(fù)雜的報(bào)表型查詢,利用@Select注解的話,可能SQL看起來(lái)還是非常的復(fù)雜。此時(shí)推薦使用XML的形式。
Mybatis Plus支持activeRecord特性,我們可以直接在Entity上執(zhí)行save\update\delete等操作??蚣軙?huì)自動(dòng)幫我們落庫(kù)。 activeRecord需要在EntityConfig配置。
entityBuilder // operate entity like JPA. .enableActiveRecord() // deleted的字段設(shè)置成tinyint 長(zhǎng)度為1 // ID strategy AUTO, NONE, INPUT, ASSIGN_ID, ASSIGN_UUID; .idType(IdType.AUTO) .formatFileName("%sEntity");
因?yàn)镋ntity都是生成的,我們不方便將業(yè)務(wù)邏輯直接放在Entity中。這樣會(huì)和數(shù)據(jù)庫(kù)實(shí)體過(guò)于耦合。
推薦新建一個(gè)模型類繼承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)用模型類來(lái)完成邏輯操作。整個(gè)代碼的語(yǔ)義性非常強(qiáng)。
public void addDept(AddDeptCommand addCommand) { DeptModel deptModel = deptModelFactory.create(); deptModel.loadAddCommand(addCommand); deptModel.checkDeptNameUnique(); deptModel.generateAncestors(); deptModel.insert(); }
以上是單條數(shù)據(jù)的落庫(kù)操作,那么多條數(shù)據(jù)循環(huán)去insert的話,顯然不是一個(gè)明智之舉。
Mybatis Plus提供了批量落庫(kù)操作。
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; }
JPA的方式有一個(gè)弊端就是需要先拿到數(shù)據(jù)實(shí)體類,才能調(diào)用save等操作。
還有一種情況,我們需要按照某些條件去更新數(shù)據(jù),而不想先一條條獲取數(shù)據(jù)再Save。
此時(shí)可以使用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; }
Mybatis Plus提供@DS注解去動(dòng)態(tài)選擇從庫(kù)還是主庫(kù)來(lá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")的接口,就會(huì)去找slave這個(gè)從庫(kù)進(jìn)行操作。
@Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); interceptor.addInnerInterceptor(new TenantLineInnerInterceptor(new TenantLineHandler() { @Override public Expression getTenantId() { // 獲取租戶ID 實(shí)際應(yīng)該從用戶信息中獲取 return new LongValue(1); } // 這是 default 方法,默認(rèn)返回 false 表示所有表都需要拼多租戶條件 @Override public boolean ignoreTable(String tableName) { return !"sys_user".equalsIgnoreCase(tableName); } })); // 如果用了分頁(yè)插件注意先 add TenantLineInnerInterceptor 再 add PaginationInnerInterceptor // 用了分頁(yè)插件必須設(shè)置 MybatisConfiguration#useDeprecatedExecutor = false // interceptor.addInnerInterceptor(new PaginationInnerInterceptor()); return interceptor; }
關(guān)于“Mybatis Plus框架源碼分析”這篇文章的內(nèi)容就介紹到這里,感謝各位的閱讀!相信大家對(duì)“Mybatis Plus框架源碼分析”知識(shí)都有一定的了解,大家如果還想學(xué)習(xí)更多知識(shí),歡迎關(guān)注億速云行業(yè)資訊頻道。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。