Java应用中根据用户角色定制日志行为的实践指南

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

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

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

    /**
     * 清除当前线程的用户角色信息。
     * 这一步至关重要，尤其是在使用线程池的环境中。
     */
    public static void clearRole() {
        CURRENT_ROLE.remove();
    }
}

// 示例：在Web请求处理过滤器中设置和清理角色
public class AuthenticationFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        try {
            // 假设这里是认证逻辑，并获取到用户角色
            String userRole = authenticateAndGetRole(request); // 实际的认证逻辑

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

            // 继续处理请求
            chain.doFilter(request, response);
        } finally {
            // 无论请求处理成功或失败，都必须清除ThreadLocal中的角色信息
            UserRoleContext.clearRole();
        }
    }

    // 模拟认证和获取角色的方法
    private String authenticateAndGetRole(ServletRequest request) {
        // ... 实际的认证逻辑，例如从会话或JWT中获取角色
        // 简单示例：根据请求参数模拟不同角色
        String userId = request.getParameter("userId");
        if ("admin".equals(userId)) {
            return "ADMIN";
        } else if ("dev".equals(userId)) {
            return "DEVELOPER";
        } else {
            return "END_USER";
        }
    }

    // ... 其他Filter方法
}

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 role = UserRoleContext.getRole();

        // 如果没有角色信息（例如未认证的请求），则默认允许所有日志，或根据需求拒绝
        if (role == null) {
            return FilterReply.NEUTRAL; // 让其他过滤器或默认行为决定
            // 或者 return FilterReply.DENY; 如果未认证请求不允许任何日志
        }

        switch (role) {
            case "ADMIN":
                // 管理员可以看到所有日志
                return FilterReply.NEUTRAL; 
            case "DEVELOPER":
                // 开发人员可以看到所有日志，但可以额外处理，例如添加更多上下文信息
                return FilterReply.NEUTRAL;
            case "END_USER":
                // 普通用户只允许查看WARN和ERROR级别的日志
                if (event.getLevel().isGreaterOrEqual(ch.qos.logback.classic.Level.WARN)) {
                    return FilterReply.NEUTRAL; // 允许WARN及以上级别
                } else {
                    return FilterReply.DENY; // 拒绝DEBUG, INFO级别
                }
            default:
                // 未知角色，默认拒绝或允许
                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.RoleBasedLogFilter" />
    </appender>

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