我用注解优雅的实现了数据的脱敏

￡神魔★判官ぃ 2023-01-17 02:27 120阅读 0赞

## 1使用场景 ##

你平时肯定做过这样的需求。要求展示用户的手机号，但是不能完全展示，需要在中间给手机号打码，如下图：

![图片][5f8d93abadbdacbe55982a5a2b6198b9.png]

我们将关键数据做了适当隐藏，这样就叫数据脱敏。

## 2数据脱敏 ##

**数据脱敏**又称**数据去隐私化**或**数据变形**，是在给定的规则、策略下对敏感数据进行变换、修改的技术机制，能够在很大程度上解决敏感数据在非可信环境中使用的问题。根据数据保护规范和脱敏策略．对业务数据中的敏感信息实施自动变形．实现对敏感信息的隐藏。

我们来看看具体需求，现在要求对以下数据的电话号码和身份证号码适当隐藏处理：

![20210426160613181.gif][]

要求脱敏处理后的效果为：

![图片][f2b1cd7d394311dafeb5213f9c30c174.png]

如上图，我们将手机号与身份证号做了适当的隐藏。

![图片][2cd608ab9e1cd98f5a0da6d65aedf756.png]

我们常规的做法是先获取到`userInfo`，然后获取`mobile`和`idCard`，再将`mobile`和`idCard`做相应的脱敏处理，最后再`set`进`userInfo`中。

但这里有个问题这里我们调用了`getUserInfo()`后，采用了大量的代码去专门处理脱敏数据，而实际上我们只是要获取`userInfo`的信息而已，为此我决定采用注解的形式，将数据进行数据脱敏即可。

## 3代码实现 ##

我们先列出数据脱敏的类型

![图片][bc37d72ad0b7ed11107a0bef409fc62f.png]

上面为我们需要脱敏的数据枚举。

然后我们根据不同的枚举类型调用各自的脱敏方法

![20210426160613181.gif][]

我们还要编写一个处理序列化的类

![图片][38d1bbea7a197a28033aff551b08a849.png]

我们在`SensitiveDataSerialize`类中重写了`serialize()`，里面调用了我们之前的`jsonHandler(s, jsonGenerator)`数据脱敏的方法，这个方法根据不同的枚举类型实现对应的数据脱敏。

然后我们还要重写`createContextual()`方法，这里面实现的功能就是扫描脱敏注解然后实现各自的数据脱敏。

接下来我们定义脱敏注解。

![图片][b825358fbd3c449b6b4cf65af2aae1ee.png]

这个`value()`是我们传入的类型枚举。

我们来看看具体的脱敏方法，脱敏方法我主要写在这个`SensitiveInfoUtils`工具类中。这里我们来看一个手机号脱敏方法。

![20210426160613181.gif][]

简单来说，就是字符串的截取和替换。

我们在实体类中标上数据脱敏的注解

![图片][0861da26c1a06d4e9b75541134ea1f14.png]

根据业务需求，我们对手机号和身份证进行数据脱敏。

最后我们在Controller层写一个接口：

![图片][442605648f2ad71372df6748416f2ef7.png]

启动工程运行接口，获取如开头的结果：

![图片][f2b1cd7d394311dafeb5213f9c30c174.png]

## 4关于代码封装性思考 ##

前面我们写的`jsonHandler()`方法是根据类型枚举调用对应的脱敏方法

switch (this.type) {
        case CHINESE_NAME: {
            jsonGenerator.writeString(SensitiveInfoUtils.chineseName(s));
            break;
        }
        case ID_CARD: {
            jsonGenerator.writeString(SensitiveInfoUtils.idCardNum(s));
            break;
        }
        case FIXED_PHONE: {
            jsonGenerator.writeString(SensitiveInfoUtils.fixedPhone(s));
            break;
        }
        case MOBILE_PHONE: {
            jsonGenerator.writeString(SensitiveInfoUtils.mobilePhone(s));
            break;
        }
        case ADDRESS: {
            jsonGenerator.writeString(SensitiveInfoUtils.address(s, 4));
            break;
        }
        case EMAIL: {
            jsonGenerator.writeString(SensitiveInfoUtils.email(s));
            break;
        }
        case BANK_CARD: {
            jsonGenerator.writeString(SensitiveInfoUtils.bankCard(s));
            break;
        }
    }

但是我们如果要增加脱敏类型，比如增加学校SCHOOL，那么这个方法就要增加

...
        case SCHOOL: {
            jsonGenerator.writeString(SensitiveInfoUtils.school(s));
            break;
        }

如果再增加其他类型，那么这里就要增加其他类型的代码，这个方法就需要修改，这样就破坏了代码的封装性。因此我决定将其改造成策略模式。

![图片][4a6e0cd084d23b7d14d773f95a0eebf0.png]

我们来看看目录，这里每个类型对应一个策略类，首先我们来看策略接口：

public interface SensitiveStrategy {
    
        SensitiveType getSensitiveType();
    
        String maskingData(String str);
    }

我们定义了两个方法，`getSensitiveType()`是获取对应枚举类型的方法，`maskingData(String str)`是实现数据脱敏的方法。因为每个实现的策略类大同小异，这里我们看一个策略类，以`MobilePhoneStrategy`为例。我们来看看代码：

@Component
    public class MobilePhoneStrategy implements SensitiveStrategy {
    
        @Override
        public SensitiveType getSensitiveType() {
            return SensitiveType.MOBILE_PHONE;
        }
    
        @Override
        public String maskingData(String str) {
            return SensitiveInfoUtils.mobilePhone(str);
        }
    }

代码中我们返回了对应的手机类型枚举，和调用了对应的手机号脱敏方法。

然后我们写一个service类：

@Service
    public class SensitiveStrategyService {
        Map<SensitiveType, SensitiveStrategy> map = Maps.newHashMap();
    
        public SensitiveStrategyService(List<SensitiveStrategy> sensitiveStrategyList) {
            sensitiveStrategyList.forEach(sensitiveStrategy -> map.put(sensitiveStrategy.getSensitiveType(), sensitiveStrategy));
        }
    
        public String generatorSensitive(SensitiveType typeEnum, String str) {
            SensitiveStrategy sensitiveStrategy = map.get(typeEnum);
            if (sensitiveStrategy != null) {
                return sensitiveStrategy.maskingData(str);
            }
            return StringUtils.EMPTY;
        }
    
    }

这里我们用map存入枚举类型和对应的策略类，map数据如下：

![图片][74ce63d1ed9d4fdbef79bde22ab25b5a.png]

之后我们在`serialize()`方法中调用：

![图片][38b935e12298ca524db705c0cf7c21f7.png]

这我们通过`SpringContextHolder.getBean()`获取容器中的`sensitiveStrategyService`实例，然后就是调用方法。

我们同样获取了想要的结果。

使用策略模式，我们需要增加类型时，只需要新增一个策略类，在里面重写好对应的方法，其他地方都不需要修改。

以上就是今天的全部内容了，对完整代码有可以私聊我【微信搜：Lvshen\_9】获取。

[5f8d93abadbdacbe55982a5a2b6198b9.png]: /images/20221022/2a179c8463fb41c980a44b8720f081a4.png
[20210426160613181.gif]: /images/20221022/4b4c4bb50ccd4017a65b4e557be06510.png
[f2b1cd7d394311dafeb5213f9c30c174.png]: /images/20221022/5967445c6894444d96006216842dcd14.png
[2cd608ab9e1cd98f5a0da6d65aedf756.png]: /images/20221022/3ebf83a751324020a53ae9b332ab2f42.png
[bc37d72ad0b7ed11107a0bef409fc62f.png]: /images/20221022/643533f4908e43e3812cd1172e0b70dc.png
[38d1bbea7a197a28033aff551b08a849.png]: /images/20221022/7214b77ec7754078b7cba09997de0ede.png
[b825358fbd3c449b6b4cf65af2aae1ee.png]: /images/20221022/6eaa4576a5e84ca5ade41b2e5ba50424.png
[0861da26c1a06d4e9b75541134ea1f14.png]: /images/20221022/79b0cbc1b4834d478b5fd4e9e1ffcf17.png
[442605648f2ad71372df6748416f2ef7.png]: /images/20221022/1fd3e2c1a3ad46b1bf390667e5c04035.png
[4a6e0cd084d23b7d14d773f95a0eebf0.png]: /images/20221022/3757e68f1b574d9f84cafe94aaa26357.png
[74ce63d1ed9d4fdbef79bde22ab25b5a.png]: /images/20221022/6ec21d0cca014785b27775b84c194b66.png
[38b935e12298ca524db705c0cf7c21f7.png]: /images/20221022/e890975166494c41a2b77d160df22613.png