一、主要功能
- 字典綁定
- 字段加密
- 數據脫敏
- 表結構動態維護
- 數據審計記錄
- 數據范圍(數據權限)
- 數據庫分庫分表、動態據源、讀寫分離、數據庫健康檢查自動切換。
二、使用
2.1 依賴導入
Spring Boot 引入自動依賴注解包
1
2
3
4
5
|
< dependency > < groupId >com.baomidou</ groupId > < artifactId >mybatis-mate-starter</ artifactId > < version >1.0.8</ version > </ dependency > |
注解(實體分包使用)
1
2
3
4
5
|
< dependency > < groupId >com.baomidou</ groupId > < artifactId >mybatis-mate-annotation</ artifactId > < version >1.0.8</ version > </ dependency > |
2.2 字典綁定
例如 user_sex 類型 sex 字典結果映射到 sexText 屬性
1
2
3
|
@FieldDict (type = "user_sex" , target = "sexText" ) private Integer sex; private String sexText; |
實現 IDataDict 接口提供字典數據源,注入到 Spring 容器即可。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
@Component public class DataDict implements IDataDict { /** * 從數據庫或緩存中獲取 */ private Map<String, String> SEX_MAP = new ConcurrentHashMap<String, String>() {{ put( "0" , "女" ); put( "1" , "男" ); }}; @Override public String getNameByCode(FieldDict fieldDict, String code) { System.err.println( "字段類型:" + fieldDict.type() + ",編碼:" + code); return SEX_MAP.get(code); } } |
2.3 字段加密
屬性 @FieldEncrypt 注解即可加密存儲,會自動解密查詢結果,支持全局配置加密密鑰算法,及注解密鑰算法,可以實現 IEncryptor 注入自定義算法。
1
2
|
@FieldEncrypt (algorithm = Algorithm.PBEWithMD5AndDES) private String password; |
2.4 數據脫敏
屬性 @FieldSensitive 注解即可自動按照預設策略對源數據進行脫敏處理,默認 SensitiveType 內置 9 種常用脫敏策略。例如:中文名、銀行卡賬號、手機號碼、固話號碼、郵寄地址、電子郵箱、身份證號碼、密碼、車牌號 脫敏策略,也可以自定義策略如下:
1
2
3
4
5
|
@FieldSensitive (type = "testStrategy" ) private String username; @FieldSensitive (type = SensitiveType.mobile) private String mobile; |
自定義脫敏策略 testStrategy 添加到默認策略中注入 Spring 容器即可。
1
2
3
4
5
6
7
8
9
10
11
12
|
@Configuration public class SensitiveStrategyConfig { /** * 注入脫敏策略 */ @Bean public ISensitiveStrategy sensitiveStrategy() { // 自定義 testStrategy 類型脫敏處理 return new SensitiveStrategy().addStrategy( "testStrategy" , t -> t + "***test***" ); } } |
2.5 DDL 數據結構自動維護
解決升級表結構初始化,版本發布更新 SQL 維護問題,目前支持 MySql、PostgreSQL。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
@Component public class PostgresDdl implements IDdl { /** * 執行 SQL 腳本方式 */ @Override public List<String> getSqlFiles() { return Arrays.asList( // 內置包方式 "db/tag-schema.sql" , // 文件絕對路徑方式 "D:\\db\\tag-data.sql" ); } } |
不僅僅可以固定執行,也可以動態執行!!
1
2
3
|
ddlScript.run( new StringReader( "DELETE FROM user;\n" + "INSERT INTO user (id, username, password, sex, email) VALUES\n" + |
這樣就完了嗎??當然沒有,它還支持多數據源執行!!!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
@Component public class MysqlDdl implements IDdl { @Override public void sharding(Consumer<IDdl> consumer) { // 多數據源指定,主庫初始化從庫自動同步 String group = "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 腳本方式 */ @Override public List<String> getSqlFiles() { return Arrays.asList( "db/user-mysql.sql" ); } } |
2.6 動態多數據源主從自由切換
@Sharding 注解支持一句話使數據源不限制隨意使用切換,你可以在 mapper 層添加注解,按需求指哪打哪!!
1
2
3
4
5
6
7
|
@Mapper @Sharding ( "mysql" ) public interface UserMapper extends BaseMapper<User> { @Sharding ( "postgres" ) Long selectByUsername(String username); } |
你也可以自定義策略統一調兵遣將
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
@Component public class MyShardingStrategy extends RandomShardingStrategy { /** * 決定切換數據源 key {@link ShardingDatasource} * * @param group 動態數據庫組 * @param invocation {@link Invocation} * @param sqlCommandType {@link SqlCommandType} */ @Override public void determineDatasourceKey(String group, Invocation invocation, SqlCommandType sqlCommandType) { // 數據源組 group 自定義選擇即可, keys 為數據源組內主從多節點,可隨機選擇或者自己控制 this .changeDatabaseKey(group, sqlCommandType, keys -> chooseKey(keys, invocation)); } } |
可以開啟主從策略,當然也是可以開啟健康檢查!!!
2.7 數據權限
mapper 層添加注解:
1
2
3
4
5
6
7
8
9
|
// 測試 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); |
模擬業務處理邏輯:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
@Bean public IDataScopeProvider dataScopeProvider() { return new AbstractDataScopeProvider() { @Override protected void setWhere(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 = new HashSet<>(); deptIds.add( "1" ); deptIds.add( "2" ); deptIds.add( "3" ); deptIds.add( "5" ); ItemsList itemsList = new ExpressionList(deptIds.stream().map(StringValue:: new ).collect(Collectors.toList())); InExpression inExpression = new InExpression( new Column(dataColumn.getAliasDotName()), itemsList); if ( null == plainSelect.getWhere()) { // 不存在 where 條件 plainSelect.setWhere( new Parenthesis(inExpression)); } else { // 存在 where 條件 and 處理 plainSelect.setWhere( new AndExpression(plainSelect.getWhere(), inExpression)); } } else if ( "mobile" .equals(dataColumn.getName())) { // 支持一個自定義條件 LikeExpression likeExpression = new LikeExpression(); likeExpression.setLeftExpression( new Column(dataColumn.getAliasDotName())); likeExpression.setRightExpression( new StringValue( "%1533%" )); plainSelect.setWhere( new AndExpression(plainSelect.getWhere(), likeExpression)); } } } } }; } |
最終執行 SQL 輸出:
1
2
3
|
SELECT u.* FROM user u WHERE (u.department_id IN ( '1' , '2' , '3' , '5' )) AND u.mobile LIKE '%1533%' LIMIT 1, 10 |
三、最后
大家好,我是 如夢技術春哥(mica 微服務組件開源作者)筆者使用 mybatis-plus 已有 4 年多(資深老粉),mybatis-plus 幫助我們大大提升了開發效率,統一了企業內代碼開發風格,降低維護成本。
如果大家在企業內有 mybatis-mate 使用場景,不妨支持一下。更多 mybatis-mate 使用示例詳見:https://gitee.com/baomidou/mybatis-mate-examples
到此這篇關于mybatis-plus團隊新作mybatis-mate實現數據權限的文章就介紹到這了,更多相關mybatis-mate 數據權限內容請搜索服務器之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持服務器之家!
原文鏈接:https://juejin.cn/post/7002876425187360781