当前位置:   article > 正文

太强了,一个注解搞定接口返回数据脱敏

修改response body返回值脱敏注解方式
 
 

往期热门文章:

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  1. 1、isEmpty和isBlank的区别,至少一半人答不上来...
  2. 2、Lombok同时使⽤@Data和@Builder 的坑
  3. 3、IntelliJ IDEA快捷键大全 + 动图演示,建议收藏!
  4. 4、如何防止你的 jar 被反编译?
  5. 5、大公司为什么禁止SpringBoot项目使用Tomcat?
  6. juejin.cn/post/7110110794188062727

下午惬意时光,突然产品小姐姐走到我面前,打断我短暂的摸鱼time,企图与我进行深入交流,还好我早有防备没有闪,打开瑞star的点单页面,暗示没有一杯coffee解决不了的需求,需求是某些接口返回的信息,涉及到敏感数据的必须进行脱敏操作,我思考一反,表示某问题,马上安排。

eb0a0a80392c7d7d2800d35fce123a43.jpeg

思路

1.要做成可配置多策略的脱敏操作,要不然一个个接口进行脱敏操作,重复的工作量太多,很显然违背了“多写一行算我输”的程序员规范,思来想去,定义数据脱敏注解和数据脱敏逻辑的接口, 在返回类上,对需要进行脱敏的属性加上,并指定对应的脱敏策略操作。

2.接下来我只需要拦截控制器返回的数据,找到带有脱敏注解的属性操作即可,一开始打算用@ControllerAdvice去实现,但发现需要自己去反射类获取注解,当返回对象比较复杂,需要递归去反射,性能一下子就会降低,于是换种思路,我想到平时使用的@JsonFormat,跟我现在的场景很类似,通过自定义注解跟字段解析器,对字段进行自定义解析,tql

代码

1. 自定义数据注解,并可以配置数据脱敏策略
  1. @Target({ElementType.FIELD, ElementType.TYPE})
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. public @interface DataMasking {
  5.     DataMaskingFunc maskFunc() default DataMaskingFunc.NO_MASK;
  6. }
2. 自定义Serializer,参考jackson的StringSerializer,下面的示例只针对String类型进行脱敏
  1. public interface DataMaskingOperation {
  2.     String MASK_CHAR = "*";
  3.     
  4.     String mask(String content, String maskChar);
  5. }
  6. public enum DataMaskingFunc {
  7.      /**
  8.      *  脱敏转换器
  9.      */
  10.      NO_MASK((str, maskChar) -> {
  11.         return str;
  12.      }),
  13.      ALL_MASK((str, maskChar) -> {
  14.         if (StringUtils.hasLength(str)) {
  15.             StringBuilder sb = new StringBuilder();
  16.             for (int i = 0; i < str.length(); i++) {
  17.                 sb.append(StringUtils.hasLength(maskChar) ? maskChar : DataMaskingOperation.MASK_CHAR);
  18.             }
  19.             return sb.toString();
  20.         } else {
  21.             return str;
  22.         }
  23.     });
  24.     private final DataMaskingOperation operation;
  25.     private DataMaskingFunc(DataMaskingOperation operation) {
  26.         this.operation = operation;
  27.     }
  28.     public DataMaskingOperation operation() {
  29.         return this.operation;
  30.     }
  31. }
  32. public final class DataMaskingSerializer extends StdScalarSerializer<Object> {
  33.     private final DataMaskingOperation operation;
  34.     public DataMaskingSerializer() {
  35.         super(String.class, false);
  36.         this.operation = null;
  37.     }
  38.     public DataMaskingSerializer(DataMaskingOperation operation) {
  39.         super(String.class, false);
  40.         this.operation = operation;
  41.     }
  42.     public boolean isEmpty(SerializerProvider prov, Object value) {
  43.         String str = (String)value;
  44.         return str.isEmpty();
  45.     }
  46.     public void serialize(Object value, JsonGenerator gen, SerializerProvider provider) throws IOException {
  47.         if (Objects.isNull(operation)) {
  48.             String content = DataMaskingFunc.ALL_MASK.operation().mask((String) value, null);
  49.             gen.writeString(content);
  50.         } else {
  51.             String content = operation.mask((String) value, null);
  52.             gen.writeString(content);
  53.         }
  54.     }
  55.     public final void serializeWithType(Object value, JsonGenerator gen, SerializerProvider provider, TypeSerializer typeSer) throws IOException {
  56.         this.serialize(value, gen, provider);
  57.     }
  58.     public JsonNode getSchema(SerializerProvider provider, Type typeHint) {
  59.         return this.createSchemaNode("string"true);
  60.     }
  61.     public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException {
  62.         this.visitStringFormat(visitor, typeHint);
  63.     }
  64. }
3. 自定义AnnotationIntrospector,适配我们自定义注解返回相应的Serializer
  1. @Slf4j
  2. public class DataMaskingAnnotationIntrospector extends NopAnnotationIntrospector {
  3.     @Override
  4.     public Object findSerializer(Annotated am) {
  5.         DataMasking annotation = am.getAnnotation(DataMasking.class);
  6.         if (annotation != null) {
  7.             return new DataMaskingSerializer(annotation.maskFunc().operation());
  8.         }
  9.         return null;
  10.     }
  11. }
4. 覆盖ObjectMapper
  1. @Configuration(
  2.         proxyBeanMethods = false
  3. )
  4. public class DataMaskConfiguration {
  5.     @Configuration(
  6.             proxyBeanMethods = false
  7.     )
  8.     @ConditionalOnClass({Jackson2ObjectMapperBuilder.class})
  9.     static class JacksonObjectMapperConfiguration {
  10.         JacksonObjectMapperConfiguration() {
  11.         }
  12.         @Bean
  13.         @Primary
  14.         ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
  15.             ObjectMapper objectMapper = builder.createXmlMapper(false).build();
  16.             AnnotationIntrospector ai = objectMapper.getSerializationConfig().getAnnotationIntrospector();
  17.             AnnotationIntrospector newAi = AnnotationIntrospectorPair.pair(ai, new DataMaskingAnnotationIntrospector());
  18.             objectMapper.setAnnotationIntrospector(newAi);
  19.             return objectMapper;
  20.         }
  21.     }
  22. }
5. 返回对象加上注解
  1. public class User implements Serializable {
  2.     /**
  3.      * 主键ID
  4.      */
  5.     private Long id;
  6.     /**
  7.      * 姓名
  8.      */
  9.     @DataMasking(maskFunc = DataMaskingFunc.ALL_MASK)
  10.     private String name;
  11.     /**
  12.      * 年龄
  13.      */
  14.     private Integer age;
  15.     /**
  16.      * 邮箱
  17.      */
  18.     @DataMasking(maskFunc = DataMaskingFunc.ALL_MASK)
  19.     private String email;
  20. }
  1. 往期热门文章:
  2. 1、计算机专业会不会成为下一个土木?
  3. 2、xxl-job惊艳的设计,怎能叫人不爱
  4. 3、ArrayList#subList这四个坑,一不小心就中招
  5. 4、面试官:大量请求 Redis 不存在的数据,从而影响数据库,该如何解决?
  6. 5、MySQL 暴跌!
  7. 6、超越 Xshell!号称下一代 Terminal 终端神器,用完爱不释手!
  8. 7、IDEA 官宣全新默认 UI,太震撼了!!
  9. 8、让你直呼「卧槽」的 GitHub 项目!
  10. 9、Kafka又笨又重,为啥不选Redis?
  11. 1050多个高频免费 API 接口分享
声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/煮酒与君饮/article/detail/920858
推荐阅读
相关标签
  

闽ICP备14008679号