如何通过ArchUnit在Java代码中强制仅使用SLF4J日志框架？

现有测试逻辑的落地障碍 #

你当前编写的两个校验规则，实际在项目中推广时很容易遇到卡点，核心问题有三个：

• 对java.lang.System的拦截粒度过粗：规则判定只要代码依赖该类就触发违规，会把System.currentTimeMillis()统计接口耗时、System.getenv()读取环境变量这类完全合理的用法全部误判，跑一次规则可能产出几百条无效违规，根本没法落地
• 禁止的日志框架覆盖不全：目前仅拦截了JDK内置的java.util.logging，没有覆盖Commons Logging、Log4j 1.x、Log4j 2.x等其他主流日志框架，规则存在很大的漏检漏洞
• 违规判定边界模糊：没有单独定义“通过System.out/err打日志”这个具体的违规行为，把所有用到System类的场景都归为违规，完全没有区分正常用法和异常用法

优化后的规则设计思路 #

整套校验逻辑拆分为三个独立的维度，既不干扰正常业务代码，又能全覆盖违规场景：

• 全量拦截所有非SLF4J的日志框架API调用，不管是JDK内置还是第三方的日志实现，只要业务代码直接依赖这些包就触发违规
• 精准定位对System.out、System.err两个静态字段的访问行为，其他对System类的合法调用完全放行
• 不设置过度强硬的正向约束，避免对DTO、值对象、纯工具类这类没有日志需求的类造成不必要的限制

可直接复用的测试代码 #

class EnforceSlf4JLoggingTest {

    private final JavaClasses importedClasses = new ClassFileImporter()
            .withImportOption(new ImportOption.DoNotIncludeTests())
            // 替换为你项目实际的业务根包
            .importPackages("com.your.company.project");

    /**
     * 禁止使用任何非SLF4J的日志框架
     * 覆盖所有主流内置/第三方日志框架
     */
    @Test
    public void shouldNotUseLoggingFrameworksOtherThanSlf4j() {
        noClasses()
                .should()
                .dependOnClassesThat()
                .resideInAnyPackage(
                        // JDK内置日志框架
                        "java.util.logging..",
                        // Apache Commons Logging
                        "org.apache.commons.logging..",
                        // Log4j 1.x
                        "org.apache.log4j..",
                        // Log4j 2.x 核心API
                        "org.apache.logging.log4j..",
                        // 防止业务代码直接调用Logback实现类
                        "ch.qos.logback..",
                        // 禁止直接使用SLF4J的内部实现类
                        "org.slf4j.impl..",
                        "org.slf4j.helpers.NOP..")
                .because("业务代码必须统一使用SLF4J API记录日志")
                .check(importedClasses);
    }

    /**
     * 禁止直接访问System.out/System.err打日志
     * 不会误伤System类的其他正常用法
     */
    @Test
    public void shouldNotUseSystemOutputForLogging() {
        noClasses()
                .should()
                .accessFieldWhere(new DescribedPredicate<JavaField>("直接访问System.out/err标准流") {
                    @Override
                    public boolean test(JavaField input) {
                        return input.getOwner().getName().equals("java.lang.System")
                                && (input.getName().equals("out") || input.getName().equals("err"));
                    }
                })
                .because("禁止通过标准输出/错误输出打日志，必须使用SLF4J记录业务日志")
                .check(importedClasses);
    }
}

落地注意事项 #

• 禁止列表中不要加入SLF4J核心包（org.slf4j..），这是唯一允许业务代码直接调用的日志API
• 因为规则仅导入项目自身的业务包，天然不会扫描到日志框架的内部实现类（比如Logback的初始化逻辑、SLF4J的桥接适配类），不会把框架运行逻辑判定为违规
• 如果个别类因为历史原因需要临时兼容旧的日志写法，直接给对应类加@ArchIgnore注解跳过校验即可，不要为了少数特例放宽全局规则
• 不要强行编写“所有业务类必须持有SLF4J Logger字段”的规则：我们的目标是“只要代码需要打日志，就必须用SLF4J”，而不是“不管是否需要打日志，都必须强制持有Logger字段”，后者会给无日志需求的值对象、枚举类造成大量无意义的约束

内容的提问来源于stack exchange，提问作者Andriy Kryvtsun