基于ThreadLocal实现Java中按用户角色分级日志记录

// UserRoleContextFilter.java (示例中的过滤器类)
public class UserRoleContextFilter {

    // 使用ThreadLocal存储当前线程的用户角色
    private static final ThreadLocal<String> USER_ROLE = new ThreadLocal<>();

    /**
     * 获取当前线程的用户角色。
     * @return 当前用户的角色字符串，如果未设置则返回null。
     */
    public static String getUserRole() {
        return USER_ROLE.get();
    }

    /**
     * 设置当前线程的用户角色。
     * 通常在用户认证成功后调用。
     * @param role 用户角色字符串（例如："ADMIN", "DEVELOPER", "END_USER"）。
     */
    public static void setUserRole(String role) {
        USER_ROLE.set(role);
    }

    /**
     * 清除当前线程的用户角色。
     * 必须在请求处理完成后调用，以防止线程池中线程复用导致数据混乱。
     */
    public static void clearUserRole() {
        USER_ROLE.remove();
    }

    // 假设这是一个模拟的过滤方法，实际应集成到Servlet Filter的doFilter方法中
    public void doTheFiltering() {
        String role = getUserRole();
        if (role == null) {
            // 用户未认证或角色未设置，可以采用默认日志策略
            System.out.println("未认证用户或角色：默认日志级别");
        } else if ("ADMIN".equals(role)) {
            // 管理员角色，可以显示所有详细日志
            System.out.println("管理员日志：显示所有详细信息");
        } else if ("DEVELOPER".equals(role)) {
            // 开发者角色，显示技术性日志
            System.out.println("开发者日志：显示技术性调试信息");
        } else if ("END_USER".equals(role)) {
            // 最终用户角色，只显示少量安全且必要的日志
            System.out.println("最终用户日志：仅显示少量关键信息");
        } else {
            // 其他角色或未知角色处理
            System.out.println("未知角色日志：默认处理");
        }
        // ... 在这里调用实际的日志框架进行日志记录
    }
}

// AuthenticationFilter.java (模拟认证过滤器的一部分)
public class AuthenticationFilter implements Filter {
    // ... 其他Filter方法

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        try {
            // 1. 执行认证逻辑，获取用户角色
            String userRole = authenticateAndGetRole(request); // 假设这是一个获取用户角色方法

            // 2. 将用户角色设置到ThreadLocal
            UserRoleContextFilter.setUserRole(userRole);

            // 3. 继续处理请求链
            chain.doFilter(request, response);

        } finally {
            // 4. 无论请求处理成功或失败，都必须清除ThreadLocal变量
            UserRoleContextFilter.clearUserRole();
        }
    }

    private String authenticateAndGetRole(ServletRequest request) {
        // 实际的认证逻辑，例如从会话、JWT token或数据库中获取用户角色
        // 示例：根据请求参数模拟角色
        String username = request.getParameter("username");
        if ("admin".equals(username)) {
            return "ADMIN";
        } else if ("dev".equals(username)) {
            return "DEVELOPER";
        } else if ("user".equals(username)) {
            return "END_USER";
        }
        return null; // 未认证或默认角色
    }
}

// LogbackRoleBasedFilter.java (Logback示例)
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.filter.Filter;
import ch.qos.logback.core.spi.FilterReply;

public class LogbackRoleBasedFilter extends Filter<ILoggingEvent> {

    @Override
    public FilterReply decide(ILoggingEvent event) {
        String role = UserRoleContextFilter.getUserRole();

        if ("ADMIN".equals(role) || "DEVELOPER".equals(role)) {
            // 管理员和开发者可以看到所有日志
            return FilterReply.ACCEPT;
        } else if ("END_USER".equals(role)) {
            // 最终用户只允许看到INFO级别及以上，且消息中不包含特定敏感词的日志
            if (event.getLevel().isGreaterOrEqual(ch.qos.logback.classic.Level.INFO) &&
                !event.getMessage().contains("sensitive_data") &&
                !event.getMessage().contains("stack_trace")) {
                return FilterReply.ACCEPT;
            } else {
                return FilterReply.DENY; // 拒绝不符合条件的日志
            }
        } else {
            // 默认情况下，未认证用户或未知角色只允许看到WARN及以上日志
            if (event.getLevel().isGreaterOrEqual(ch.qos.logback.classic.Level.WARN)) {
                return FilterReply.ACCEPT;
            } else {
                return FilterReply.DENY;
            }
        }
    }
}

<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <filter class="com.example.logging.LogbackRoleBasedFilter"/>
    </appender>

    <root level="INFO">
        <appender-ref ref="CONSOLE" />
    </root>
</configuration>

import org.slf4j.MDC; // SLF4J的MDC接口

// ... doFilter方法中
try {
    String userRole = authenticateAndGetRole(request);
    if (userRole != null) {
        MDC.put("userRole", userRole); // 将角色放入MDC
    }
    chain.doFilter(request, response);
} finally {
    MDC.remove("userRole"); // 清除MDC中的角色信息
}

<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!-- 模式中包含%X{userRole}来打印MDC中的userRole -->
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - [%X{userRole}] %msg%n</pattern>
        </encoder>
        <!-- 也可以使用SiftingAppender根据MDC值将日志路由到不同的文件 -->
        <!-- 或者使用ThresholdFilter配合MDC来实现更细粒度的过滤 -->
    </appender>

    <!-- 示例：使用TurboFilter根据MDC值进行过滤 -->
    <turboFilter class="ch.qos.logback.classic.turbo.MDCFilter">
        <MDCKey>userRole</MDCKey>
        <defaultValue>UNKNOWN</defaultValue>
        <onMatch>ACCEPT</onMatch>
        <onMismatch>NEUTRAL</onMismatch>
    </turboFilter>

    <root level="INFO">
        <appender-ref ref="CONSOLE" />
    </root>
</configuration>