接口数据如何脱敏

1. 背景
   通常接口返回值中的一些敏感数据也是要脱敏的，比如身份证号、手机号码…通常的手段就是用*隐藏一部分数据，当然也可以根据自己需求定制
2. 方案 参考原文
   下面例子，利用Jackson在序列化阶段对特定字段进行脱敏
3. 代码

import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import demo.func.SensitiveJsonSerializer;
import demo.func.SensitiveStrategy;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 自定义jackson注解，标注在属性上
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside
@JsonSerialize(using = SensitiveJsonSerializer.class)
public @interface Sensitive {

    //脱敏策略
    SensitiveStrategy strategy();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

import java.util.function.Function;

public enum SensitiveStrategy {

    /**
     * 手机号
     */
    PHONE(s -> s.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2"));

    private final Function<String, String> desensitizer;

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

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

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.BeanProperty;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.ContextualSerializer;
import demo.annotation.Sensitive;

import java.io.IOException;
import java.util.Objects;

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

    private SensitiveStrategy strategy;


    @Override
    public JsonSerializer<?> createContextual(SerializerProvider provider, 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 provider.findValueSerializer(property.getType(), property);
    }

    @Override
    public void serialize(String value, JsonGenerator gen, SerializerProvider serializerProvider) throws IOException {
        gen.writeString(strategy.desensitizer().apply(value));
    }
}
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

@Data
@AllArgsConstructor
public class SecretStr {

    @Sensitive(strategy = SensitiveStrategy.PHONE)
    private String phone;

    private String name;
}
1
2
3
4
5
6
7
8
9

@RestController
public class TestController {

    @GetMapping("/getSecret")
    public R<SecretStr> getSecret(){
        SecretStr secretStr = new SecretStr("15068433245","zs");
        return R.success(secretStr);
    }
}
1
2
3
4
5
6
7
8
9

4. 结果

{
    "code": 200,
    "msg": "操作成功",
    "data": {
        "phone": "150****3245",
        "name": "zs"
    }
}
1
2
3
4
5
6
7
8