一个注解优雅的实现接口数据脱敏

开发 前端
数据脱敏有很多种实现方式,关键是哪种更加适合,哪种更加优雅.....

大家好,我是不才陈某~

通常接口返回值中的一些敏感数据也是要脱敏的,比如身份证号、手机号码、地址.....通常的手段就是用*隐藏一部分数据,当然也可以根据自己需求定制。

言归正传,如何优雅的实现呢?有两种实现方案,如下:

  • 整合Mybatis插件,在查询的时候针对特定的字段进行脱敏
  • 整合Jackson,在序列化阶段对特定字段进行脱敏
  • 基于Sharding Sphere实现数据脱敏

第一种方案网上很多实现方式,下面演示第二种,整合Jackson。

1. 自定义一个Jackson注解

需要自定义一个脱敏注解,一旦有属性被标注,则进行对应得脱敏,如下:

/**
* 自定义jackson注解,标注在属性上
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside
@JsonSerialize(using = SensitiveJsonSerializer.class)
public @interface Sensitive {
//脱敏策略
SensitiveStrategy strategy();
}

2. 定制脱敏策略

针对项目需求,定制不同字段的脱敏规则,比如手机号中间几位用*替代,如下:

/**
* 脱敏策略,枚举类,针对不同的数据定制特定的策略
*/
public enum SensitiveStrategy {
/**
* 用户名
*/
USERNAME(s -> s.replaceAll("(\\S)\\S(\\S*)", "$1*$2")),
/**
* 身份证
*/
ID_CARD(s -> s.replaceAll("(\\d{4})\\d{10}(\\w{4})", "$1****$2")),
/**
* 手机号
*/
PHONE(s -> s.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2")),
/**
* 地址
*/
ADDRESS(s -> s.replaceAll("(\\S{3})\\S{2}(\\S*)\\S{2}", "$1****$2****"));


private final Function<String, String> desensitizer;

SensitiveStrategy(Function<String, String> desensitizer) {
this.desensitizer = desensitizer;
}

public Function<String, String> desensitizer() {
return desensitizer;
}
}

以上只是提供了部分,具体根据自己项目要求进行配置。

3. 定制JSON序列化实现

下面将是重要实现,对标注注解@Sensitive的字段进行脱敏,实现如下:

/**
* 序列化注解自定义实现
* JsonSerializer<String>:指定String 类型,serialize()方法用于将修改后的数据载入
*/
public class SensitiveJsonSerializer extends JsonSerializer<String> implements ContextualSerializer {
private SensitiveStrategy strategy;

@Override
public void serialize(String value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
gen.writeString(strategy.desensitizer().apply(value));
}

/**
* 获取属性上的注解属性
*/
@Override
public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) throws JsonMappingException {

Sensitive annotation = property.getAnnotation(Sensitive.class);
if (Objects.nonNull(annotation)&&Objects.equals(String.class, property.getType().getRawClass())) {
this.strategy = annotation.strategy();
return this;
}
return prov.findValueSerializer(property.getType(), property);

}
}

4. 定义Person类,对其数据脱敏

使用注解@Sensitive注解进行数据脱敏,代码如下:

@Data
public class Person {
/**
* 真实姓名
*/
@Sensitive(strategy = SensitiveStrategy.USERNAME)
private String realName;
/**
* 地址
*/
@Sensitive(strategy = SensitiveStrategy.ADDRESS)
private String address;
/**
* 电话号码
*/
@Sensitive(strategy = SensitiveStrategy.PHONE)
private String phoneNumber;
/**
* 身份证号码
*/
@Sensitive(strategy = SensitiveStrategy.ID_CARD)
private String idCard;
}

5. 模拟接口测试

以上4个步骤完成了数据脱敏的Jackson注解,下面写个controller进行测试,代码如下:

@RestController
public class TestController {
@GetMapping("/test")
public Person test(){
Person user = new Person();
user.setRealName("不才陈某");
user.setPhoneNumber("19796328206");
user.setAddress("浙江省杭州市....");
user.setIdCard("4333333333334334333");
return user;
}
}

调用接口查看数据有没有正常脱敏,结果如下:

{
"realName": "不*陈某",
"address": "浙江省****市..****",
"phoneNumber": "197****8206",
"idCard": "4333****34333"
}

6. 总结

数据脱敏有很多种实现方式,关键是哪种更加适合,哪种更加优雅.....

责任编辑:武晓燕 来源: 码猿技术专栏
相关推荐

2024-11-08 15:56:36

2024-11-07 10:55:26

2023-08-01 08:54:02

接口幂等网络

2022-06-10 13:03:44

接口重试while

2022-05-16 10:45:22

Redis接口限流缓存

2023-06-06 08:51:06

2022-12-12 08:14:47

2022-05-26 10:42:30

数据权限注解

2023-10-09 07:37:01

2023-08-21 08:01:03

2022-05-31 08:36:41

微服务网关鉴权

2021-01-04 09:12:31

集合变量

2022-06-20 08:37:28

接口tokenAO

2023-12-30 20:04:51

MyBatis框架数据

2020-12-08 08:08:51

Java接口数据

2020-11-03 16:00:33

API接口微服务框架编程语言

2023-04-17 08:56:29

微服务鉴权业务

2024-11-11 11:30:34

2023-06-05 08:22:20

2021-08-03 15:25:09

数据库Sharding SpSQL
点赞
收藏

51CTO技术栈公众号