SpringBoot 自定义注解实现涉密字段脱敏

下面是详细的攻略：

简介

在实际项目中，很多时候需要对涉密字段进行脱敏，以保护用户隐私，比如手机号、身份证号、银行卡号等。本文将介绍如何使用 SpringBoot 自定义注解来实现涉密字段的脱敏功能。

步骤

定义注解

首先需要定义一个注解，用于标识需要脱敏的字段。可以自定义一个 @SensitiveInfo 注解，该注解可以用在类、字段、方法等地方。注解可以定义在 java.lang.annotation 包下。

package java.lang.annotation;

@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SensitiveInfo {

}

实现脱敏逻辑

定义注解之后，我们需要实现脱敏逻辑。可以使用正则表达式或其他方法对需要脱敏的内容进行替换。下面是一个简单的脱敏示例，用于对手机号进行脱敏：

public class SensitiveInfoUtils {

    /**
     * 对手机号进行脱敏
     * @param phone 手机号
     * @return 脱敏后的手机号
     */
    public static String maskPhone(String phone) {
        if(StringUtils.isBlank(phone)) {
            return "";
        }
        if(phone.length()!=11) {
            return phone;
        }
        return phone.replaceAll("(\\d{3})\\d{4}(\\d{4})","$1****$2");
    }
}

可以根据实际需求修改脱敏逻辑。

实现拦截器

接下来需要实现一个拦截器，用于在 Controller 层拦截请求，获取需要脱敏的数据，并进行脱敏操作。可以使用 SpringBoot 的拦截器机制来实现。

public class SensitiveInfoInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if(handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            Method method = handlerMethod.getMethod();
            SensitiveInfo sensitiveInfo = method.getAnnotation(SensitiveInfo.class);
            if(sensitiveInfo != null) {
                Object[] args = handlerMethod.getMethodParameters();
                for (int i = 0; i < args.length; i++) {
                    if(args[i] instanceof String) {
                        args[i] = SensitiveInfoUtils.maskPhone((String) args[i]);
                    } else if(args[i] instanceof User) {
                        User user = (User) args[i];
                        user.setPhone(SensitiveInfoUtils.maskPhone(user.getPhone()));
                    }
                }

            }
        }
        return true;
    }
}

上述代码中，我们首先判断方法是否含有 @SensitiveInfo 注解，如果有，就获取方法参数中的需要脱敏的数据，并调用 SensitiveInfoUtils 中的方法进行脱敏操作。

使用注解

最后，在需要脱敏的字段上加上 @SensitiveInfo 注解即可。

@RestController
public class UserController {

    @PostMapping("/register")
    public void register(@SensitiveInfo String phone, @RequestBody User user) {
        // do something
    }

}

在上述代码中，phone 参数会被拦截器拦截并进行脱敏操作。user 对象中的 phone 属性也会被脱敏。

测试示例

下面给出两个测试示例，用于检验我们的脱敏功能是否正常。

示例一

请求：

POST /register HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "张三",
    "phone": "13800000000",
    "idCard": "510122199001011234",
    "bankCard": "1234567890123456"
}

响应：

HTTP/1.1 200 OK
Content-Type: application/json

{
    "code": 0,
    "msg": "注册成功"
}

在上述示例中，我们定义了一个 /register 接口，接口中包含一个需要脱敏的手机号字段。我们可以看到，请求中的手机号被脱敏后传递给了 Controller，注册成功后返回了一个正确的响应。

示例二

请求：

POST /register HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "name": "李四",
    "phone": "110119199001011234",
    "idCard": "510122199001011234",
    "bankCard": "1234567890123456"
}

响应：

HTTP/1.1 200 OK
Content-Type: application/json

{
    "code": 0,
    "msg": "注册成功"
}

在上述示例中，请求中的手机号不是合法的手机号，因此脱敏逻辑会直接返回原始字符串。但是 Controller 仍然可以正常接收到参数并进行后续操作。

总结

通过本文的示例，我们可以看到，使用 SpringBoot 自定义注解可以实现涉密字段的脱敏操作，从而保护用户隐私。需要注意的是，脱敏逻辑需要根据实际需求进行修改和完善。在实际开发中，还可以结合其他技术，比如 AOP、代码生成等来实现更加复杂的脱敏操作。