Spring Boot 日志记录脱敏

本文由简悦 SimpRead 转码，原文地址 blog.csdn.net

在 Spring Boot 中，我们可以通过配置 Logback 和 Log4j2 等常用的日志框架来记录日志。为了保护敏感信息不被泄露，需要对一些敏感信息进行脱敏处理，比如手机号码、身份证号码、银行卡号等。

下面以 Logback 为例，介绍几种常见的脱敏方法。

1. 使用自定义过滤器

在 Logback 中，我们可以使用 Filter 过滤器来对日志进行处理。我们可以自定义一个过滤器，对日志中的敏感信息进行脱敏处理。

比如，我们可以自定义一个手机号码过滤器：

import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.filter.AbstractMatcherFilter;
import ch.qos.logback.core.spi.FilterReply;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class PhoneMaskingFilter extends AbstractMatcherFilter<ILoggingEvent> {

    private static final String PHONE_PATTERN = "(?<![\\d])[1][3-9]\\d{9}(?![\\d])";

    @Override
    public FilterReply decide(ILoggingEvent event) {
        if (!isStarted()) {
            return FilterReply.NEUTRAL;
        }
        if (event.getLevel() != Level.INFO) {
            return FilterReply.NEUTRAL;
        }
        Object[] args = event.getArgumentArray();
        if (args == null) {
            return FilterReply.NEUTRAL;
        }
        for (int i = 0; i < args.length; i++) {
            if (args[i] instanceof String) {
                String msg = (String) args[i];
                Pattern pattern = Pattern.compile(PHONE_PATTERN);
                Matcher matcher = pattern.matcher(msg);
                StringBuffer sb = new StringBuffer();
                while (matcher.find()) {
                    String phone = matcher.group();
                    matcher.appendReplacement(sb, phone.substring(0, 3) + "****" + phone.substring(7));
                }
                matcher.appendTail(sb);
                args[i] = sb.toString();
            }
        }
        return FilterReply.NEUTRAL;
    }
}

上面的过滤器会匹配手机号码并将其替换为 ****，保护用户手机号码不被泄露。

对于其他敏感信息也可以类似方式处理。

在 logback.xml 中配置过滤器：

<appender >
    <filter class="com.example.log.PhoneMaskingFilter"/>
    <encoder>
        <pattern>%date{ISO8601} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

2. 使用 Logstash 的 Mutate 插件

Logstash 是一款开源的数据处理引擎，可以用于收集、处理、转换和输出日志等数据。Logstash 中的 Mutate 插件提供了多个常用的数据处理功能，包括脱敏。

比如，使用 Logstash 的 mutate 插件，可以对手机号码进行脱敏处理：

filter {
  mutate {
    gsub => [
      "message", "(?<![\\d])[1][3-9]\\d{9}(?![\\d])", "****"
    ]
  }
}

上述配置会将日志中所有的手机号码替换为 ****。

3. 使用 AOP 实现日志脱敏

在 Spring Boot 中，我们还可以使用 AOP（面向切面编程）的方式，在日志输出前对敏感信息进行脱敏处理。

比如，我们可以定义一个 LogAspect 切面类，在 @Before 注解的方法中，对方法参数中的敏感信息进行脱敏处理，然后再调用目标方法。

@Aspect
@Component
public class LogAspect {

    private static final String PHONE_PATTERN = "(?<![\\d])[1][3-9]\\d{9}(?![\\d])";

    @Before("execution(* com.example.controller..*(..))")
    public void beforeController(JoinPoint joinPoint) {
        Object[] args = joinPoint.getArgs();
        if (args == null) {
            return;
        }
        for (int i = 0; i < args.length; i++) {
            if (args[i] instanceof String) {
                String msg = (String) args[i];
                Pattern pattern = Pattern.compile(PHONE_PATTERN);
                Matcher matcher = pattern.matcher(msg);
                StringBuffer sb = new StringBuffer();
                while (matcher.find()) {
                    String phone = matcher.group();
                    matcher.appendReplacement(sb, phone.substring(0, 3) + "****" + phone.substring(7));
                }
                matcher.appendTail(sb);
                args[i] = sb.toString();
            }
        }
        try {
            joinPoint.proceed(args);
        } catch (Throwable e) {
            e.printStackTrace();
        }
    }
}

上面的切面类会在所有 com.example.controller 包下的方法调用前执行，对方法参数中的手机号码进行脱敏处理，然后再调用目标方法。

综上所述，以上是 Spring Boot 中实现日志脱敏的几种方法，根据实际情况选择适合自己的方式即可。

1. 使用自定义过滤器

2. 使用 Logstash 的 Mutate 插件

3. 使用 AOP 实现日志脱敏

目录