Início / coding / Perguntas / 79429326
Accepted
PatPanda
Asked: 2025-02-11 16:33:01 +0800 CST

Como criar uma regra ArchUnit para testar se os campos são privados em pacotes

  • 772

Gostaria de criar uma regra ArchUnit que verifica se uma classe não está quebrando o encapsulamento ao expor um campo público.

O único campo público permitido deve ser uma constante, algo comopublic static final int MAX_USERS = 100;

Outros campos não devem ser públicos

Fui tentar o seguinte código:

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

Infelizmente isso não funciona.

Por exemplo, ele está sinalizando esta classe como ruim:

enum Device {
    IOS,
    LAPTOP

Como posso escrever um teste no ArchUnit para garantir que nenhum campo seja público, exceto constante?

java

1 respostas

  1. Best Answer

    O que você precisa é de uma etapa de filtro extra que remova constantes enum de consideração. Uma maneira de fazer isso é a seguinte:

    @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());
        }
    };
}

    O que isso faz é verificar a classe proprietária de cada campo em consideração. Se o proprietário do campo (a classe declarante) for um enum, então ele verifica se o campo é atribuível ao tipo enum em questão.

    Isso deve excluir todas as constantes de enumeração, mas tem um pequeno efeito colateral: também permite o seguinte:

    enum Device {
    IOS,
    LAPTOP;

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

    Se você quiser permitir que campos finais estáticos também tenham modificadores diferentes, a verificação se torna:

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

relate perguntas