在Java中使用ArchUnit强制执行BigDecimal实例化时的架构规则

Question

我正在一个Java项目中工作，其中有一个特定的需求：所有的BigDecimal实例应仅通过一个工具类创建，我们暂且称其为MathUtils。目标是确保MathContext和其他配置的一致应用。

为了在整个代码库中强制执行这个规则，我正在考虑使用ArchUnit。然而，我在制定确保BigDecimal只在MathUtils中被实例化而不是在应用程序的其他部分直接实例化的规则时遇到了挑战。

这是我目前尝试的方法：

@ArchTest
public static final ArchRule bigDecimalShouldOnlyBeInstantiatedInMathUtils = noClasses()
    .that().doNotHaveFullyQualifiedName("a.b.c.MathUtils")
    .should().callConstructor(BigDecimal.class)
    .because("BigDecimal应该只在MathUtils中被实例化");

我正在寻求如何正确设置ArchUnit规则以实现此目的的指导，或者是否有其他方法或工具可以用于在Java中实施此类架构约束。

关键要点：

如何编写一个ArchUnit规则来确保BigDecimal实例仅在一个特定类（MathUtils）中创建？
是否有其他策略或工具可以用于强制执行此类架构规则？

任何见解或建议都将不胜感激！

Benjamin Lindley · Answer

在我看来，使用ArchUnit来检查Java类之间的期望/不期望的依赖关系是一个很好的主意。另一个可选方案是jQAssistant。

对于您的特定需求，还需要考虑两点：

callConstructor(BigDecimal.class)仅检查无参构造函数的调用，因为该方法实际上是定义为callConstructor(Class owner, Class... parameterTypes)
BigDecimal实例也可以通过valueOf方法创建，我假设这些调用也是不被允许的。

考虑到这两个方面，您可以编写如下规则：

import static com.tngtech.archunit.core.domain.JavaAccess.Predicates.target;
import static com.tngtech.archunit.core.domain.JavaAccess.Predicates.targetOwner;
import static com.tngtech.archunit.core.domain.JavaClass.Predicates.equivalentTo;
import static com.tngtech.archunit.core.domain.properties.HasName.Predicates.name;
import static com.tngtech.archunit.lang.conditions.ArchPredicates.has;
import static com.tngtech.archunit.lang.conditions.ArchPredicates.is;
import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.noClasses;

@ArchTest
public static final ArchRule bigDecimalShouldOnlyBeInstantiatedInMathUtils = noClasses()
    .that().doNotHaveFullyQualifiedName("a.b.c.MathUtils")
    .should().callConstructorWhere(targetOwner(is(equivalentTo(BigDecimal.class))))
    .orShould().callMethodWhere(targetOwner(is(equivalentTo(BigDecimal.class))).and(target(has(name("valueOf")))))
    .as("BigDecimal should only be instantiated in MathUtils");

请注意，我已经将.because(..)更改为.as(..)来为错误消息创建一个较短的规则描述，因为原始描述可能过于冗长。

MT0 · Answer

您已经很接近了！但是请注意，callConstructor(BigDecimal.class)仅会匹配无参数的BigDecimal构造函数，这可能并不是您想要的（而且在我的JDK中甚至并不存在）。

如果您想禁止任何对BigDecimal构造函数的调用，则可以使用以下规则：

@ArchTest
ArchRule bigDecimalShouldOnlyBeInstantiatedInMathUtils = noClasses()
    .that().doNotHaveFullyQualifiedName(MathUtils.class.getName())
    .should().callConstructorWhere(describe("目标为BigDecimal", constructorCall ->
            constructorCall.getTargetOwner().isEquivalentTo(BigDecimal.class)
    ))
    .because("BigDecimal应该只在MathUtils中被实例化");