主页 / coding / 问题 / 79429326
Accepted
PatPanda
Asked: 2025-02-11 16:33:01 +0800 CST

如何创建 ArchUnit 规则来测试字段在包中是否是私有的

  • 772

我想创建一个 ArchUnit 规则，检查类是否通过公开公共字段来破坏封装。

唯一允许的公共字段应该是一个常量，类似于public static final int MAX_USERS = 100;

其他字段不应公开

我去尝试了下面的代码：

@Test
void fieldShouldAllBePrivateToProtectEncapsulation() {
    fields().should().bePrivate().check(importedClasses);
}

不幸的是，这并不起作用。

例如，它将此类标记为不好：

enum Device {
    IOS,
    LAPTOP

如何在 ArchUnit 中编写测试以确保除常量之外没有字段是公共的？

java

1 个回答

  1. Best Answer

    您需要一个额外的过滤步骤，将枚举常量从考虑范围中移除。实现此目的的一种方式如下：

    @Test
void fieldShouldAllBePrivateToProtectEncapsulation() {
    fields().that(areNotEnumConstants()).should().bePrivate().check(importedClasses);
}

private DescribedPredicate<? super JavaField> areNotEnumConstants() {
    return new DescribedPredicate<JavaField>("are not enum constants") {
        @Override
        public boolean test(JavaField javaField) {
            JavaClass owner = javaField.getOwner();
            return !owner.isEnum() || !javaField.getRawType().isAssignableTo(owner.reflect());
        }
    };
}

    它的作用是检查每个字段的所属类。如果字段的所有者（声明类）是枚举，则检查该字段是否可以分配给所讨论的枚举类型。

    这应该排除所有枚举常量，但有一个轻微的副作用，即它还允许以下内容：

    enum Device {
    IOS,
    LAPTOP;

    public Device whatAreYouEvenDoing; // This line will not trip the unit test
}

    如果您希望允许静态最终字段也具有不同的修饰符，则检查将变为：

    @Test
void fieldShouldAllBePrivateToProtectEncapsulation() {
    fields().that(areNotEnumConstants())
            .and().areNotStatic()
            .and().areNotFinal()
            .should().bePrivate()
            .check(importedClasses);
}
    • 1

相关问题