Mybatis Plus 框架專案落地實踐總結
2023-02-22 06:01:57
在使用了Mybatis Plus框架進行專案重構之後，關於如何更好的利用Mybatis plus。在此做一些總結供大家參考。
主要總結了以下這幾個方面的實踐。
- 基礎設計
- BaseEntity
- 邏輯刪除
- 自動填充欄位
- 程式碼生成類
- 查詢操作
- Query基礎類別(複用+PageQuery)
- 普通Query
- Lambda Query
- 複雜多表查詢
- 報表型查詢
- 儲存操作
- 模型利用JPA儲存
- 批次儲存資料
- 擴充套件
- 阻止全表操作
- 動態資料來源
- 多租戶
詳細程式碼實現在開源專案Agileboot中：https://github.com/valarchie/AgileBoot-Back-End
關於Mybatis Plus的實踐，如有不足或者建議歡迎大家評論指正。
廢話不多說進入正題。
基礎設計
BaseEntity
對於資料庫中表中的公共欄位我們可以抽取出來做成基礎類別繼承。避免表對映的資料庫實體類欄位太過繁雜。
例如常用的建立時間、建立者、更新時間、更新者、邏輯刪除欄位。
/**
* Entity基礎類別
*
* @author valarchie
*/
@EqualsAndHashCode(callSuper = true)
@Data
public class BaseEntity<T extends Model<?>> extends Model<T> {
@ApiModelProperty("建立者ID")
@TableField(value = "creator_id", fill = FieldFill.INSERT)
private Long creatorId;
@ApiModelProperty("建立時間")
@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欄位請在資料庫中 設定為tinyInt 並且非null 預設值為0
*/
@ApiModelProperty("刪除標誌（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("公告標題")
@TableField("notice_title")
private String noticeTitle;
@ApiModelProperty("公告型別（1通知 2公告）")
@TableField("notice_type")
private Integer noticeType;
@ApiModelProperty("公告內容")
@TableField("notice_content")
private String noticeContent;
@ApiModelProperty("公告狀態（1正常 0關閉）")
@TableField("`status`")
private Integer status;
@ApiModelProperty("備註")
@TableField("remark")
private String remark;
@Override
public Serializable pkVal() {
return this.noticeId;
}
}
既然抽取出了公共欄位，我們可以更進一步將這些公共欄位進行自動填值處理。
Mybatis Plus提供了欄位自動填充的外掛。
自動填充欄位
/**
* Mybatis Plus允許在插入或者更新的時候
* 自定義設定值
* @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();
}
邏輯刪除
資料庫一般不進行真實刪除操作。但是如果讓我們手工處理這些邏輯刪除的話，也是非常麻煩。Mybatis Plus有提供這樣的外掛。僅需要在EntityConfig中設定邏輯刪除的欄位是哪個即可。
entityBuilder
// deleted的欄位設定成tinyint 長度為1
.logicDeleteColumnName("deleted")
.formatFileName("%sEntity");
程式碼生成類
Mybatis plus支援生成entity,mapper,service,controller這四層類。
但是筆者認為生成類的時候還是不要直接覆蓋原本的類比較好。
我將生成的類，固定放在一個目錄讓使用者自己copy類到指定的目錄。
以下是我自己封裝的CodeGenerator的程式碼片段。
需要填入的欄位主要是：
- 作者名
- 包名
- 表名
- 是否需要繼承基礎類別（因為不是所有表都需要繼承基礎類別）
public static void main(String[] args) {
// 預設讀取application-dev yml中的master資料庫設定
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基礎類別
系統內的查詢大部分有共用的邏輯。比如時間範圍的查詢、排序。我們可以抽取這部分邏輯放在基礎類別。
然後把具體查詢條件的構造，放到子類去實現。
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。然後實現
toQueryWrapper方法去構造查詢條件。
/**
* @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;
}
}
如果有另外一個不同的選單查詢列表，查詢的引數一樣，但是查詢條件的構造不一樣。我們可以新建一個DifferentMenuQuery類繼承MenuQuery類，再覆寫toQueryWrapper方法即可。
Lambda Query
如果在專案中的查詢明確是單表操作的話，我們可以使用LambdaQuery來構造查詢。
LambdaQueryWrapper<SysMenuEntity> menuQuery = Wrappers.lambdaQuery();
menuQuery.select(SysMenuEntity::getMenuId);
List<SysMenuEntity> menuList = menuService.list(menuQuery);
複雜多表查詢
Mybatis Plus支援@Select註解，遇到簡單的多表join查詢的話，我們可以直接在程式碼中寫SQL語句。
以下是Mapper中的實現。${ew.customSqlSegment} 會渲染出QueryWrapper類生成的查詢條件。
/**
* 根據條件分頁查詢使用者列表
* @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層中的實現。
@Override
public Page<SearchUserDO> getUserList(AbstractPageQuery<SearchUserDO> query) {
return baseMapper.getUserList(query.toPage(), query.toQueryWrapper());
}
報表型查詢
如果遇到複雜的報表型查詢，利用@Select註解的話，可能SQL看起來還是非常的複雜。此時推薦使用XML的形式。
儲存操作
模型利用JPA儲存
Mybatis Plus支援activeRecord特性，我們可以直接在Entity上執行save\update\delete等操作。框架會自動幫我們落庫。
activeRecord需要在EntityConfig設定。
entityBuilder
// operate entity like JPA.
.enableActiveRecord()
// deleted的欄位設定成tinyint 長度為1
// ID strategy AUTO, NONE, INPUT, ASSIGN_ID, ASSIGN_UUID;
.idType(IdType.AUTO)
.formatFileName("%sEntity");
因為Entity都是生成的，我們不方便將業務邏輯直接放在Entity中。這樣會和資料庫實體過於耦合。
推薦新建一個模型類繼承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) {
// 如果巨量資料量的話 可以用MapStruct優化
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());
}
}
在應用層我們就可以直接呼叫模型類來完成邏輯操作。整個程式碼的語意性非常強。
public void addDept(AddDeptCommand addCommand) {
DeptModel deptModel = deptModelFactory.create();
deptModel.loadAddCommand(addCommand);
deptModel.checkDeptNameUnique();
deptModel.generateAncestors();
deptModel.insert();
}
批次儲存資料
以上是單條資料的落庫操作，那麼多條資料迴圈去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;
}
按條件更新資料
JPA的方式有一個弊端就是需要先拿到資料實體類，才能呼叫save等操作。
還有一種情況，我們需要按照某些條件去更新資料，而不想先一條條獲取資料再Save。
此時可以使用LambdaUpdate類。
LambdaUpdateWrapper<SysUserEntity> updateWrapper = new LambdaUpdateWrapper<>();
updateWrapper.set(SysUserEntity::getRoleId, null).eq(SysUserEntity::getUserId, userId);
userService.update(updateWrapper);
擴充套件
阻止全表操作
Mybatis Plus提供了安全方面的外掛，比如阻止全標更新刪除的外掛。僅需要宣告MybatisPlusInterceptor Bean，依次新增攔截外掛即可。
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new BlockAttackInnerInterceptor());
return interceptor;
}
動態資料來源
Mybatis Plus提供@DS註解去動態選擇從庫還是主庫來執行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 實際應該從使用者資訊中獲取
return new LongValue(1);
}
// 這是 default 方法,預設返回 false 表示所有表都需要拼多租戶條件
@Override
public boolean ignoreTable(String tableName) {
return !"sys_user".equalsIgnoreCase(tableName);
}
}));
// 如果用了分頁外掛注意先 add TenantLineInnerInterceptor 再 add PaginationInnerInterceptor
// 用了分頁外掛必須設定 MybatisConfiguration#useDeprecatedExecutor = false
// interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
return interceptor;
}