大家好，我是鋒哥，今天介紹一個 MyBatis - Plus 官方發布的神器：mybatis-mate ！
來自：java思維導圖
MyBatis - Plus 官方發布的神器：mybatis-mate 為 mp 企業級模塊，支持分庫分表，數據審計、數據敏感詞過濾（AC算法），字段加密，字典回寫（數據綁定），數據權限，表結構自動生成 SQL 維護等，旨在更敏捷優雅處理數據。1.主要功能
字典綁定
字段加密
數據脫敏
表結構動態維護
數據審計記錄
數據範圍（數據權限）
數據庫分庫分表、動態據源、讀寫分離、數- - 據庫健康檢查自動切換。
2.1 依賴導入
Spring Boot 引入自動依賴註解包
<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-mate-starter</artifactId><version>1.0.8</version></dependency>註解（實體分包使用）
<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-mate-annotation</artifactId><version>1.0.8</version></dependency>2.2 字段數據綁定（字典回寫）
例如 user_sex 類型 sex 字典結果映射到 sexText 屬性
@FieldDict(type="user_sex", target ="sexText")privateInteger sex;privateStringsexText;實現 IDataDict 接口提供字典數據源，注入到 Spring 容器即可。
@ComponentpublicclassDataDictimplementsIDataDict {/*** 從數據庫或緩存中獲取*/privateMap<String,String> SEX_MAP =newConcurrentHashMap<String,String>() {{put("0","女");put("1","男");}};@OverridepublicStringgetNameByCode(FieldDict fieldDict,Stringcode) {System.err.println("字段類型："+ fieldDict.type() +"，編碼："+ code);returnSEX_MAP.get(code);}}2.3 字段加密
屬性 @FieldEncrypt 註解即可加密存儲，會自動解密查詢結果，支持全局配置加密密鑰算法，及註解密鑰算法，可以實現 IEncryptor 注入自定義算法。
@FieldEncrypt(algorithm = Algorithm.PBEWithMD5AndDES)privateStringpassword;2.4 字段脫敏
屬性 @FieldSensitive 註解即可自動按照預設策略對源數據進行脫敏處理，默認 SensitiveType 內置 9 種常用脫敏策略。
例如：中文名、銀行卡賬號、手機號碼等 脫敏策略。也可以自定義策略如下：
@FieldSensitive(type="testStrategy")privateStringusername;@FieldSensitive(type= SensitiveType.mobile)privateStringmobile;自定義脫敏策略 testStrategy 添加到默認策略中注入 Spring 容器即可。
@ConfigurationpublicclassSensitiveStrategyConfig{/*** 注入脫敏策略*/@BeanpublicISensitiveStrategysensitiveStrategy(){// 自定義 testStrategy 類型脫敏處理returnnewSensitiveStrategy().addStrategy("testStrategy", t -> t +"***test***");}}例如：文章敏感詞過濾
/*** 演示文章敏感詞過濾*/@RestControllerpublicclassArticleController{@AutowiredprivateSensitiveWordsMapper sensitiveWordsMapper;// 測試訪問下面地址觀察請求地址、界面返回數據及控制台（ 普通參數 ）// 無敏感詞 http://localhost:8080/info?content=tom&see=1&age=18// 英文敏感詞 http://localhost:8080/info?content=my%20content%20is%20tomcat&see=1&age=18// 漢字敏感詞 http://localhost:8080/info?content=%E7%8E%8B%E5%AE%89%E7%9F%B3%E5%94%90%E5%AE%8B%E5%85%AB%E5%A4%A7%E5%AE%B6&see=1// 多個敏感詞 http://localhost:8080/info?content=%E7%8E%8B%E5%AE%89%E7%9F%B3%E6%9C%89%E4%B8%80%E5%8F%AA%E7%8C%ABtomcat%E6%B1%A4%E5%A7%86%E5%87%AF%E7%89%B9&see=1&size=6// 插入一個字變成非敏感詞 http://localhost:8080/info?content=%E7%8E%8B%E7%8C%AB%E5%AE%89%E7%9F%B3%E6%9C%89%E4%B8%80%E5%8F%AA%E7%8C%ABtomcat%E6%B1%A4%E5%A7%86%E5%87%AF%E7%89%B9&see=1&size=6@GetMapping("/info")publicStringinfo(Article article)throwsException{returnParamsConfig.toJson(article);}// 添加一個敏感詞然後再去觀察是否生效 http://localhost:8080/add// 觀察【貓】這個詞被過濾了 http://localhost:8080/info?content=%E7%8E%8B%E5%AE%89%E7%9F%B3%E6%9C%89%E4%B8%80%E5%8F%AA%E7%8C%ABtomcat%E6%B1%A4%E5%A7%86%E5%87%AF%E7%89%B9&see=1&size=6// 嵌套敏感詞處理 http://localhost:8080/info?content=%E7%8E%8B%E7%8C%AB%E5%AE%89%E7%9F%B3%E6%9C%89%E4%B8%80%E5%8F%AA%E7%8C%ABtomcat%E6%B1%A4%E5%A7%86%E5%87%AF%E7%89%B9&see=1&size=6// 多層嵌套敏感詞 http://localhost:8080/info?content=%E7%8E%8B%E7%8E%8B%E7%8C%AB%E5%AE%89%E7%9F%B3%E5%AE%89%E7%9F%B3%E6%9C%89%E4%B8%80%E5%8F%AA%E7%8C%ABtomcat%E6%B1%A4%E5%A7%86%E5%87%AF%E7%89%B9&see=1&size=6@GetMapping("/add")publicStringadd()throwsException{Long id =3L;if(null== sensitiveWordsMapper.selectById(id)) {System.err.println("插入一個敏感詞："+ sensitiveWordsMapper.insert(newSensitiveWords(id,"貓")));// 插入一個敏感詞，刷新算法引擎敏感詞SensitiveWordsProcessor.reloadSensitiveWords();}return"ok";}// 測試訪問下面地址觀察控制台（ 請求json參數 ）// idea 執行 resources 目錄 TestJson.http 文件測試@PostMapping("/json")publicStringjson(@RequestBody Article article)throwsException{returnParamsConfig.toJson(article);}}2.5 DDL 數據結構自動維護
解決升級表結構初始化，版本發布更新 SQL 維護問題，目前支持 MySql、PostgreSQL。
@ComponentpublicclassPostgresDdlimplementsIDdl{/*** 執行 SQL 腳本方式*/@OverridepublicList<String>getSqlFiles(){returnArrays.asList(// 內置包方式"db/tag-schema.sql",// 文件絕對路徑方式"D:\\db\\tag-data.sql");}}不僅僅可以固定執行，也可以動態執行！！
ddlScript.run(new StringReader("DELETEFROMuser;\n" +"INSERTINTOuser(id, username,password, sex, email)VALUES\n" +"(20,'Duo','123456',0,'Duo@baomidou.com');"));它還支持多數據源執行！！！
@ComponentpublicclassMysqlDdlimplementsIDdl{@Overridepublicvoidsharding(Consumer<IDdl> consumer){// 多數據源指定，主庫初始化從庫自動同步Stringgroup="mysql";ShardingGroupProperty sgp = ShardingKey.getDbGroupProperty(group);if(null!= sgp) {// 主庫sgp.getMasterKeys().forEach(key -> {ShardingKey.change(group+ key);consumer.accept(this);});// 從庫sgp.getSlaveKeys().forEach(key -> {ShardingKey.change(group+ key);consumer.accept(this);});}}/*** 執行 SQL 腳本方式*/@OverridepublicList<String>getSqlFiles(){returnArrays.asList("db/user-mysql.sql");}}2.6 動態多數據源主從自由切換
@Sharding 註解使數據源不限制隨意使用切換，你可以在 mapper 層添加註解，按需求指哪打哪！！
@Mapper@Sharding("mysql")public interface UserMapper extends BaseMapper<User> {@Sharding("postgres")Long selectByUsername(String username);}你也可以自定義策略統一調兵遣將
@ComponentpublicclassMyShardingStrategyextendsRandomShardingStrategy{/*** 決定切換數據源 key {@linkShardingDatasource}**@paramgroup 動態數據庫組*@paraminvocation {@linkInvocation}*@paramsqlCommandType {@linkSqlCommandType}*/@OverridepublicvoiddetermineDatasourceKey(String group, Invocation invocation, SqlCommandType sqlCommandType){// 數據源組 group 自定義選擇即可， keys 為數據源組內主從多節點，可隨機選擇或者自己控制this.changeDatabaseKey(group, sqlCommandType, keys -> chooseKey(keys, invocation));}}可以開啟主從策略，當然也是可以開啟健康檢查！具體配置：
mybatis-mate:sharding:health: true # 健康檢測primary: mysql # 默認選擇數據源datasource:mysql: # 數據庫組-key: node1...-key: node2cluster: slave # 從庫讀寫分離時候負責 sql 查詢操作，主庫 master 默認可以不寫...postgres:-key: node1 # 數據節點...2.7 分布式事務日誌打印
部分配置如下：
/*** <p>* 性能分析攔截器，用於輸出每條 SQL 語句及其執行時間* </p>*/@Slf4j@Component@Intercepts({@Signature(type= StatementHandler.class, method ="query", args = {Statement.class, ResultHandler.class}),@Signature(type= StatementHandler.class, method ="update", args = {Statement.class}),@Signature(type= StatementHandler.class, method ="batch", args = {Statement.class})})publicclassPerformanceInterceptorimplementsInterceptor {/*** SQL 執行最大時長，超過自動停止運行，有助於發現問題。*/privatelong maxTime =0;/*** SQL 是否格式化*/privatebooleanformat =false;/*** 是否寫入日誌文件<br>* true 寫入日誌文件，不阻斷程序執行！<br>* 超過設定的最大執行時長異常提示！*/privatebooleanwriteInLog =false;@OverridepublicObjectintercept(Invocation invocation) throws Throwable {Statement statement;ObjectfirstArg = invocation.getArgs()[0];if(Proxy.isProxyClass(firstArg.getClass())) {statement = (Statement) SystemMetaObject.forObject(firstArg).getValue("h.statement");}else{statement = (Statement) firstArg;}MetaObject stmtMetaObj = SystemMetaObject.forObject(statement);try{statement = (Statement) stmtMetaObj.getValue("stmt.statement");}catch(Exception e) {// do nothing}if(stmtMetaObj.hasGetter("delegate")) {//Hikaritry{statement = (Statement) stmtMetaObj.getValue("delegate");}catch(Exception e) {}}StringoriginalSql =null;if(originalSql ==null) {originalSql = statement.toString();}originalSql = originalSql.replaceAll("[\\s]+"," ");int index = indexOfSqlStart(originalSql);if(index >0) {originalSql = originalSql.substring(index);}// 計算執行 SQL 耗時long start = SystemClock.now();Objectresult = invocation.proceed();long timing = SystemClock.now() - start;// 格式化 SQL 打印執行結果Objecttarget = PluginUtils.realTarget(invocation.getTarget());MetaObject metaObject = SystemMetaObject.forObject(target);MappedStatement ms = (MappedStatement) metaObject.getValue("delegate.mappedStatement");StringBuilder formatSql =newStringBuilder();formatSql.append(" Time：").append(timing);formatSql.append(" ms - ID：").append(ms.getId());formatSql.append("\n Execute SQL：").append(sqlFormat(originalSql, format)).append("\n");if(this.isWriteInLog()) {if(this.getMaxTime() >=1&& timing >this.getMaxTime()) {log.error(formatSql.toString());}else{log.debug(formatSql.toString());}}else{System.err.println(formatSql);if(this.getMaxTime() >=1&& timing >this.getMaxTime()) {thrownewRuntimeException(" The SQL execution time is too large, please optimize ! ");}}returnresult;}@OverridepublicObjectplugin(Objecttarget) {if(targetinstanceofStatementHandler) {returnPlugin.wrap(target,this);}returntarget;}@OverridepublicvoidsetProperties(Properties prop) {StringmaxTime = prop.getProperty("maxTime");Stringformat = prop.getProperty("format");if(StringUtils.isNotEmpty(maxTime)) {this.maxTime = Long.parseLong(maxTime);}if(StringUtils.isNotEmpty(format)) {this.format =Boolean.valueOf(format);}}publiclong getMaxTime() {returnmaxTime;}publicPerformanceInterceptor setMaxTime(long maxTime) {this.maxTime = maxTime;returnthis;}publicbooleanisFormat() {returnformat;}publicPerformanceInterceptor setFormat(booleanformat) {this.format = format;returnthis;}publicbooleanisWriteInLog() {returnwriteInLog;}publicPerformanceInterceptor setWriteInLog(booleanwriteInLog) {this.writeInLog = writeInLog;returnthis;}publicMethod getMethodRegular(Class<?> clazz,StringmethodName) {if(Object.class.equals(clazz)) {returnnull;}for(Method method : clazz.getDeclaredMethods()) {if(method.getName().equals(methodName)) {returnmethod;}}returngetMethodRegular(clazz.getSuperclass(), methodName);}/*** 獲取sql語句開頭部分** @param sql* @return*/privateint indexOfSqlStart(Stringsql) {StringupperCaseSql = sql.toUpperCase();Set<Integer>set=newHashSet<>();set.add(upperCaseSql.indexOf("SELECT "));set.add(upperCaseSql.indexOf("UPDATE "));set.add(upperCaseSql.indexOf("INSERT "));set.add(upperCaseSql.indexOf("DELETE "));set.remove(-1);if(CollectionUtils.isEmpty(set)) {return-1;}List<Integer> list =newArrayList<>(set);Collections.sort(list, Integer::compareTo);returnlist.get(0);}privatefinalstaticSqlFormatter sqlFormatter =newSqlFormatter();/*** 格式sql** @param boundSql* @param format* @return*/publicstaticStringsqlFormat(StringboundSql,booleanformat) {if(format) {try{returnsqlFormatter.format(boundSql);}catch(Exception ignored) {}}returnboundSql;}}使用：
@RestController@AllArgsConstructorpublic class TestController {privateBuyServicebuyService;// 數據庫 test 表 t_order 在事務一致情況無法插入數據，能夠插入說明多數據源事務無效// 測試訪問 http://localhost:8080/test// 製造事務回滾 http://localhost:8080/test?error=true 也可通過修改表結構製造錯誤// 注釋 ShardingConfig 注入 dataSourceProvider 可測試事務無效情況@GetMapping("/test")publicStringtest(Boolean error) {returnbuyService.buy(null != error && error);}}2.8 數據權限
mapper 層添加註解:
// 測試 test 類型數據權限範圍，混合分頁模式@DataScope(type ="test", value = {// 關聯表 user 別名 u 指定部門字段權限@DataColumn(alias ="u", name ="department_id"),// 關聯表 user 別名 u 指定手機號字段（自己判斷處理）@DataColumn(alias ="u", name ="mobile")})@Select("select u.* from user u")List<User> selectTestList(IPage<User> page, Long id,@Param("name") String username);模擬業務處理邏輯：
@BeanpublicIDataScopeProvider dataScopeProvider() {returnnewAbstractDataScopeProvider() {@OverrideprotectedvoidsetWhere(PlainSelect plainSelect,Object[] args, DataScopeProperty dataScopeProperty) {// args 中包含 mapper 方法的請求參數，需要使用可以自行獲取/*// 測試數據權限，最終執行 SQL 語句SELECT u.* FROM user u WHERE (u.department_id IN ('1', '2', '3', '5'))AND u.mobile LIKE '%1533%'*/if("test".equals(dataScopeProperty.getType())) {// 業務 test 類型List<DataColumnProperty> dataColumns = dataScopeProperty.getColumns();for(DataColumnProperty dataColumn : dataColumns) {if("department_id".equals(dataColumn.getName())) {// 追加部門字段 IN 條件，也可以是 SQL 語句Set<String> deptIds =newHashSet<>();deptIds.add("1");deptIds.add("2");deptIds.add("3");deptIds.add("5");ItemsList itemsList =newExpressionList(deptIds.stream().map(StringValue::new).collect(Collectors.toList()));InExpression inExpression =newInExpression(newColumn(dataColumn.getAliasDotName()), itemsList);if(null== plainSelect.getWhere()) {// 不存在 where 條件plainSelect.setWhere(newParenthesis(inExpression));}else{// 存在 where 條件 and 處理plainSelect.setWhere(newAndExpression(plainSelect.getWhere(), inExpression));}}elseif("mobile".equals(dataColumn.getName())) {// 支持一個自定義條件LikeExpression likeExpression =newLikeExpression();likeExpression.setLeftExpression(newColumn(dataColumn.getAliasDotName()));likeExpression.setRightExpression(newStringValue("%1533%"));plainSelect.setWhere(newAndExpression(plainSelect.getWhere(), likeExpression));}}}}};}最終執行 SQL 輸出：
SELECTu.*FROMuseruWHERE(u.department_idIN('1','2','3','5'))ANDu.mobileLIKE'%1533%'LIMIT1,10目前僅有付費版本，了解更多 mybatis-mate 使用示例詳見：
https://gitee.com/baomidou/mybatis-mate-examples
http://download.java1234.com/每月送666套Java海量資源網站VIP會員，供大夥一起學Java
👆長按上方二維碼2秒,備註vip
鋒哥，10年Java老司機，小鋒網絡科技 光槓司令員，司令部：www.java1234.vip 每天堅持鍛煉身體，堅持早睡早起，崇尚自由，平時喜歡帶帶Java學員 (已經成功指導1000+學員高薪就業)，喜歡搞搞Java技術自媒體，搞搞小產品，後期還打算搞搞B站和D音短視頻+直播，技術方面，打算再搞搞大數據云計算，時代變化快，緊跟時代的腳步，不怕平庸的人生，就怕沒有夢想和野心的一生。
留言列表