如何使用 archunit 验证方法注释是否使用具有特定值的属性

Question

我有一个 @Audit 注释，它有很多可选属性，我需要对某些包强制使用一个布尔属性 useAccount = true。

我正在尝试使用 archunit 来完成此验证，这样每当开发人员提交违反规则的代码时，CI 就会破坏并通知团队。

这会破坏构建：

@Audit
public myMethod(...) {
...
}

这是正确的方法：

@Audit(useAccount = true)
public myMethod(...) {
...
}

问题是 Archunit 当前不支持断言方法。我期待做这样的事情：

methods().that().resideInAnyPackage("..controllers..", "..service..").and().areAnnotatedWith(Audit.class).should(attributeCheckCondition)

然后我的自定义条件 attributeCheckCondition 将负责查看属性值。

有没有一种方法可以像我们检索类一样检索方法？无需编写更复杂的谓词和条件？

Answer 1

更新

从 ArchUnit 0.10.0 开始，可以为成员创建规则。

methods().that().areDeclaredInClassesThat().resideInAnyPackage("..controllers..", "..service..").and().areAnnotatedWith(Audit.class).should(attributeCheckCondition)

另请参阅用户指南中的 Composing Member Rules。

原答案

由于目前没有可用于方法的基本规则定义，因此需要一个中间步骤。 ArchUnit 有一个 ClassesTransformer 可以将 JavaClasses 转换为其他类型的集合。

ClassesTransformer<JavaMethod> methods = new AbstractClassesTransformer<JavaMethod>("methods") {
    @Override
    public Iterable<JavaMethod> doTransform(JavaClasses javaClasses) {
        Set<JavaMethod> allMethods = new HashSet<>();
        for (JavaClass javaClass : javaClasses) {
            allMethods.addAll(javaClass.getMethods());
        }
        return allMethods;
    }
};

此 ClassesTransformer 可用作自定义规则定义的基础。

ArchRule rule = ArchRuleDefinition.all(methods).that(owner(resideInAnyPackage("..controllers..", "..service.."))).and(annotatedWith(Audit.class)).should(haveAttributeValue());
rule.check(javaClasses);

另见 Rules with Custom Concepts in the User Guide and this issue。

Answer 2

我在类上找到了一种使用自定义谓词和条件来完成此操作的方法，当我这样做时，我不知道 Roland 的响应似乎更好，因为它提供了一种表达规则的方法从方法的角度断言这就是我要求的原因。

但是我想post这里的解决方案，以便它对其他人有用。

DescribedPredicate<JavaClass> HAVE_A_METHOD_ANNOTATED_WITH_AUDIT =
    new DescribedPredicate<JavaClass>("have a method annotated with @Audit")
    {
        @Override
        public boolean apply(JavaClass input)
        {
            return input.getMethods().stream().anyMatch(method -> method.isAnnotatedWith(Audit.class));
        }
    };

ArchCondition<JavaClass> ONLY_SET_ATTRIBUTE_USE_ACCOUNT_SET_TO_TRUE =
    new ArchCondition<JavaClass>("only set useAccount attribute to true")
    {
        @Override
        public void check(JavaClass item, ConditionEvents events)
        {
            item.getMethods().stream().filter(method ->
           method.isAnnotatedWith(Audit.class) && !method.getAnnotationOfType(Audit.class)
                                                            .useAccount()
            )
                .forEach(method -> {
                    String message = String.format(
                        "Method %s is annotated with @Audit but useAccount is not set to true",
                        method.getFullName());
                    events.add(SimpleConditionEvent.violated(method, message));
                });
        }
    };

则规则表示为：

ArchRule ANNOTATION_RULE = classes()
    .that()
    .resideInAnyPackage("..controller..", "..service..")
    .and(HAVE_A_METHOD_ANNOTATED_WITH_AUDIT)
    .should(ONLY_SET_ATTRIBUTE_USE_ACCOUNT_SET_TO_TRUE);

Answer 3

这是除了@raspacorp（启发了我！）之外的另一个自定义示例。

为了检查 @Secured(ROLE) 方法注释，我实施了以下规则：

public static class SecuredByRoleArchCondition extends ArchCondition<JavaMethod> {
    private final String[] expectedRoles;

    public SecuredByRoleArchCondition(String[] expectedRoles) {
        super(String.format("accessed by @Secured methods with roles %s", Arrays.toString(expectedRoles)));
        this.expectedRoles = expectedRoles;
    }

    public static SecuredByRoleArchCondition haveSecuredAnnotationWithRoles(String... expectedRoles) {
        return new SecuredByRoleArchCondition(expectedRoles);
    }

    @Override
    public void check(JavaMethod javaMethod, ConditionEvents events) {
        if (!javaMethod.isAnnotatedWith(Secured.class)) {
            String message = String.format("Method %s annotation @Secured(%s) is missing",
                    javaMethod.getFullName(), Arrays.toString(expectedRoles));
            events.add(SimpleConditionEvent.violated(javaMethod, message));
            return;
        }
        String[] annotationRoleValues = javaMethod.getAnnotationOfType(Secured.class).value();
        if (!Arrays.equals(annotationRoleValues, expectedRoles)) {
            String message = String.format("Method %s @Secured with %s has wrong roles, expected %s instead",
                    javaMethod.getFullName(), Arrays.toString(annotationRoleValues), Arrays.toString(expectedRoles));
            events.add(SimpleConditionEvent.violated(javaMethod, message));
        }
    }
}

下面是这个 archCondition 的示例用法：

@ArchTest
static ArchRule admin_actions_with_post_mapping_should_be_secured_by_ADMIN_WRITE_role =
        methods()
                .that().areDeclaredInClassesThat().resideInAnyPackage(ADMIN_PACKAGES)
                .and().areAnnotatedWith(PostMapping.class)
                .should(haveSecuredAnnotationWithRoles("ADMIN_WRITE"));

如何使用 archunit 验证方法注释是否使用具有特定值的属性

How to validate that a method annotation is using an attribute with an specific value using archunit

java

junit

archunit

更新

原答案