利用ThreadLocal在Java中实现精细化日志输出

public class UserRoleContext {

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

    /**
     * 设置当前线程的用户角色。
     * @param role 用户角色字符串，例如 "ADMIN", "DEVELOPER", "END_USER"
     */
    public static void setRole(String role) {
        CURRENT_USER_ROLE.set(role);
    }

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

    /**
     * 清理当前线程的用户角色信息。
     * 这一步至关重要，尤其是在使用线程池的Web应用中，防止角色信息泄露到后续请求。
     */
    public static void clearRole() {
        CURRENT_USER_ROLE.remove();
    }
}

// 假设这是一个Web应用中的认证过滤器或拦截器
public class AuthenticationFilter {

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        try {
            // 模拟认证过程，获取用户角色
            String userRole = authenticateAndGetRole(request); // 实际中会从Session、JWT或数据库中获取

            // 将用户角色设置到ThreadLocal中
            UserRoleContext.setRole(userRole);

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

        } finally {
            // 无论请求处理成功与否，最终都要清理ThreadLocal中的角色信息
            UserRoleContext.clearRole();
        }
    }

    private String authenticateAndGetRole(ServletRequest request) {
        // 实际认证逻辑，这里仅为示例
        // 例如：从HTTP Header或Session中解析用户ID，然后查询数据库获取角色
        String userId = request.getParameter("userId");
        if ("admin".equals(userId)) {
            return "ADMIN";
        } else if ("dev".equals(userId)) {
            return "DEVELOPER";
        } else {
            return "END_USER";
        }
    }
}

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

public class RoleBasedLogFilter extends Filter<ILoggingEvent> {

    @Override
    public FilterReply decide(ILoggingEvent event) {
        String currentUserRole = UserRoleContext.getRole();

        // 如果没有设置角色（例如，后台任务或未认证请求），默认允许所有日志，或根据需求拒绝
        if (currentUserRole == null) {
            return FilterReply.ACCEPT; // 或者 FilterReply.DENY
        }

        switch (currentUserRole) {
            case "ADMIN":
                // 管理员可以看到所有日志，包括DEBUG级别
                return FilterReply.ACCEPT;
            case "DEVELOPER":
                // 开发者可以看到INFO及以上，或特定DEBUG日志
                // 示例：拒绝包含敏感用户数据的DEBUG日志
                if (event.getLevel().isGreaterOrEqual(ch.qos.logback.classic.Level.INFO)) {
                    return FilterReply.ACCEPT;
                }
                // 进一步细化：如果DEBUG日志包含特定关键词，则拒绝
                if (event.getLevel() == ch.qos.logback.classic.Level.DEBUG && event.getMessage().contains("sensitive_user_data")) {
                    return FilterReply.DENY;
                }
                return FilterReply.ACCEPT; // 允许其他DEBUG日志
            case "END_USER":
                // 最终用户只能看到WARN及以上，且不包含内部实现细节的日志
                if (event.getLevel().isGreaterOrEqual(ch.qos.logback.classic.Level.WARN)) {
                    // 进一步过滤：如果消息包含内部系统信息，则拒绝
                    if (event.getMessage().contains("internal_system_details") || event.getMessage().contains("stack_trace")) {
                        return FilterReply.DENY;
                    }
                    return FilterReply.ACCEPT;
                }
                return FilterReply.DENY; // 拒绝低级别日志
            default:
                return FilterReply.NEUTRAL; // 默认行为，让下一个过滤器或Appender处理
        }
    }
}

<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.RoleBasedLogFilter"/>
    </appender>

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