BJ_ZTEITS-Developers / parking-cloud-yudao

Commit e5ab9b71b65c11c7ad300c2b225d98a19348b349

Authored by gaibu
1 parent c60f8d6d

feat: 完善注释

Inline Side-by-side
Showing 8 changed files with 17 additions and 41 deletions
yudao-framework/yudao-spring-boot-starter-biz-desensitize/src/main/java/cn/iocoder/yudao/framework/desensitize/core/regex/annotation/EmailDesensitize.java
  View file @e5ab9b7
... ... @@ -17,18 +17,15 @@ import java.lang.annotation.Target;
17 17 @Target({ElementType.FIELD})
18 18 @Retention(RetentionPolicy.RUNTIME)
19 19 @JacksonAnnotationsInside
20   -@Desensitize(desensitizationBy = EmailDesensitizationHandler.class) // 邮箱;比如：example@gmail.com脱敏之后为e****@gmail.com
  20 +@Desensitize(desensitizationBy = EmailDesensitizationHandler.class)
21 21 public @interface EmailDesensitize {
22 22 /**
23   - * 匹配的正则表达式（默认匹配所有）
  23 + * 匹配的正则表达式
24 24 */
25 25 String regex() default "(^.)[^@]*(@.*$)";
26 26  
27 27 /**
28   - * 替换规则，会将匹配到的字符串全部替换成 replacer
29   - * 例如：regex=123; replacer=******
30   - * 原始字符串 123456789
31   - * 脱敏后字符串 ******456789
  28 + * 替换规则，邮箱;比如：example@gmail.com脱敏之后为e****@gmail.com
32 29 */
33 30 String replacer() default "$1****$2";
34 31 }
... ...
yudao-framework/yudao-spring-boot-starter-biz-desensitize/src/main/java/cn/iocoder/yudao/framework/desensitize/core/slider/annotation/BankCard.java
  View file @e5ab9b7
... ... @@ -17,7 +17,7 @@ import java.lang.annotation.Target;
17 17 @Target({ElementType.FIELD})
18 18 @Retention(RetentionPolicy.RUNTIME)
19 19 @JacksonAnnotationsInside
20   -@Desensitize(desensitizationBy = BankCardDesensitization.class)// 银行卡号;比如：9988002866797031脱敏之后为998800********31
  20 +@Desensitize(desensitizationBy = BankCardDesensitization.class)
21 21 public @interface BankCard {
22 22  
23 23 /**
... ... @@ -31,10 +31,7 @@ public @interface BankCard {
31 31 int suffixKeep() default 2;
32 32  
33 33 /**
34   - * 替换规则，会将前缀后缀保留后，全部替换成 replacer
35   - * 例如：prefixKeep = 1; suffixKeep = 2; replacer = "*";
36   - * 原始字符串 123456
37   - * 脱敏后 1***56
  34 + * 替换规则，银行卡号;比如：9988002866797031脱敏之后为998800********31
38 35 */
39 36 String replacer() default "*";
40 37  
... ...
yudao-framework/yudao-spring-boot-starter-biz-desensitize/src/main/java/cn/iocoder/yudao/framework/desensitize/core/slider/annotation/CarLicense.java
  View file @e5ab9b7
... ... @@ -17,7 +17,7 @@ import java.lang.annotation.Target;
17 17 @Target({ElementType.FIELD})
18 18 @Retention(RetentionPolicy.RUNTIME)
19 19 @JacksonAnnotationsInside
20   -@Desensitize(desensitizationBy = CarLicenseDesensitization.class) // 车牌号;比如：粤A66666脱敏之后为粤A6***6
  20 +@Desensitize(desensitizationBy = CarLicenseDesensitization.class)
21 21 public @interface CarLicense {
22 22  
23 23 /**
... ... @@ -31,10 +31,7 @@ public @interface CarLicense {
31 31 int suffixKeep() default 1;
32 32  
33 33 /**
34   - * 替换规则，会将前缀后缀保留后，全部替换成 replacer
35   - * 例如：prefixKeep = 1; suffixKeep = 2; replacer = "*";
36   - * 原始字符串 123456
37   - * 脱敏后 1***56
  34 + * 替换规则，车牌号;比如：粤A66666脱敏之后为粤A6***6
38 35 */
39 36 String replacer() default "*";
40 37  
... ...
yudao-framework/yudao-spring-boot-starter-biz-desensitize/src/main/java/cn/iocoder/yudao/framework/desensitize/core/slider/annotation/ChineseName.java
  View file @e5ab9b7
... ... @@ -17,7 +17,7 @@ import java.lang.annotation.Target;
17 17 @Target({ElementType.FIELD})
18 18 @Retention(RetentionPolicy.RUNTIME)
19 19 @JacksonAnnotationsInside
20   -@Desensitize(desensitizationBy = ChineseNameDesensitization.class) // 中文名;比如：刘子豪脱敏之后为刘**
  20 +@Desensitize(desensitizationBy = ChineseNameDesensitization.class)
21 21 public @interface ChineseName {
22 22  
23 23 /**
... ... @@ -31,10 +31,7 @@ public @interface ChineseName {
31 31 int suffixKeep() default 0;
32 32  
33 33 /**
34   - * 替换规则，会将前缀后缀保留后，全部替换成 replacer
35   - * 例如：prefixKeep = 1; suffixKeep = 2; replacer = "*";
36   - * 原始字符串 123456
37   - * 脱敏后 1***56
  34 + * 替换规则，中文名;比如：刘子豪脱敏之后为刘**
38 35 */
39 36 String replacer() default "*";
40 37  
... ...
yudao-framework/yudao-spring-boot-starter-biz-desensitize/src/main/java/cn/iocoder/yudao/framework/desensitize/core/slider/annotation/FixedPhone.java
  View file @e5ab9b7
... ... @@ -17,7 +17,7 @@ import java.lang.annotation.Target;
17 17 @Target({ElementType.FIELD})
18 18 @Retention(RetentionPolicy.RUNTIME)
19 19 @JacksonAnnotationsInside
20   -@Desensitize(desensitizationBy = FixedPhoneDesensitization.class) // 固定电话;比如：01086551122脱敏之后为0108*****22
  20 +@Desensitize(desensitizationBy = FixedPhoneDesensitization.class)
21 21 public @interface FixedPhone {
22 22  
23 23 /**
... ... @@ -31,10 +31,7 @@ public @interface FixedPhone {
31 31 int suffixKeep() default 2;
32 32  
33 33 /**
34   - * 替换规则，会将前缀后缀保留后，全部替换成 replacer
35   - * 例如：prefixKeep = 1; suffixKeep = 2; replacer = "*";
36   - * 原始字符串 123456
37   - * 脱敏后 1***56
  34 + * 替换规则，固定电话;比如：01086551122脱敏之后为0108*****22
38 35 */
39 36 String replacer() default "*";
40 37  
... ...
yudao-framework/yudao-spring-boot-starter-biz-desensitize/src/main/java/cn/iocoder/yudao/framework/desensitize/core/slider/annotation/IdCard.java
  View file @e5ab9b7
... ... @@ -17,7 +17,7 @@ import java.lang.annotation.Target;
17 17 @Target({ElementType.FIELD})
18 18 @Retention(RetentionPolicy.RUNTIME)
19 19 @JacksonAnnotationsInside
20   -@Desensitize(desensitizationBy = IdCardDesensitization.class) // 身份证号码;比如：530321199204074611脱敏之后为530321**********11
  20 +@Desensitize(desensitizationBy = IdCardDesensitization.class)
21 21 public @interface IdCard {
22 22  
23 23 /**
... ... @@ -31,10 +31,7 @@ public @interface IdCard {
31 31 int suffixKeep() default 2;
32 32  
33 33 /**
34   - * 替换规则，会将前缀后缀保留后，全部替换成 replacer
35   - * 例如：prefixKeep = 1; suffixKeep = 2; replacer = "*";
36   - * 原始字符串 123456
37   - * 脱敏后 1***56
  34 + * 替换规则，身份证号码;比如：530321199204074611脱敏之后为530321**********11
38 35 */
39 36 String replacer() default "*";
40 37  
... ...
yudao-framework/yudao-spring-boot-starter-biz-desensitize/src/main/java/cn/iocoder/yudao/framework/desensitize/core/slider/annotation/Password.java
  View file @e5ab9b7
... ... @@ -17,7 +17,7 @@ import java.lang.annotation.Target;
17 17 @Target({ElementType.FIELD})
18 18 @Retention(RetentionPolicy.RUNTIME)
19 19 @JacksonAnnotationsInside
20   -@Desensitize(desensitizationBy = PasswordDesensitization.class) // 密码;比如：123456脱敏之后为******
  20 +@Desensitize(desensitizationBy = PasswordDesensitization.class)
21 21 public @interface Password {
22 22  
23 23 /**
... ... @@ -31,10 +31,7 @@ public @interface Password {
31 31 int suffixKeep() default 0;
32 32  
33 33 /**
34   - * 替换规则，会将前缀后缀保留后，全部替换成 replacer
35   - * 例如：prefixKeep = 1; suffixKeep = 2; replacer = "*";
36   - * 原始字符串 123456
37   - * 脱敏后 1***56
  34 + * 替换规则，密码;比如：123456脱敏之后为******
38 35 */
39 36 String replacer() default "*";
40 37  
... ...
yudao-framework/yudao-spring-boot-starter-biz-desensitize/src/main/java/cn/iocoder/yudao/framework/desensitize/core/slider/annotation/PhoneNumber.java
  View file @e5ab9b7
... ... @@ -17,7 +17,7 @@ import java.lang.annotation.Target;
17 17 @Target({ElementType.FIELD})
18 18 @Retention(RetentionPolicy.RUNTIME)
19 19 @JacksonAnnotationsInside
20   -@Desensitize(desensitizationBy = PhoneNumberDesensitization.class) // 手机号;比如：13248765917脱敏之后为132****5917
  20 +@Desensitize(desensitizationBy = PhoneNumberDesensitization.class)
21 21 public @interface PhoneNumber {
22 22  
23 23 /**
... ... @@ -31,10 +31,7 @@ public @interface PhoneNumber {
31 31 int suffixKeep() default 4;
32 32  
33 33 /**
34   - * 替换规则，会将前缀后缀保留后，全部替换成 replacer
35   - * 例如：prefixKeep = 1; suffixKeep = 2; replacer = "*";
36   - * 原始字符串 123456
37   - * 脱敏后 1***56
  34 + * 替换规则，手机号;比如：13248765917脱敏之后为132****5917
38 35 */
39 36 String replacer() default "*";
40 37  
... ...