Question

我的界面如下所示

interface Evaluator {
    boolean requiresP2();
    EvalResult evaluate(Param1 p1, Param2 p2, Param3 p3);
    // some more methods
}

此接口由多个类实现。 CAL方法的参数p2由某些人使用，而其他人则不使用。方法requiresP2基本上返回一个布尔值，告诉evaluate方法是否使用p2。

现在，这些问题在上下文中可能看起来有些奇怪，但请相信我，这在我们的用例中是有意义的。另外，需要花费大量时间来重构所有代码以消除对requiresP2方法的需求，所以如果我们讨论除了自上而下的代码库重构之外的解决方案，我将不胜感激。

问题是方法requiresP2的返回值基于evaluate方法的实现方式。因此，每个人都必须确保在更改requiresP2方法时更新evaluate方法。

我正在寻找方法，以便可以通过编译器/ unit-tests / linters强制执行，而不是将其留给开发人员的内存。

编辑：我仍在探索模拟框架对此问题的适用性。

我认为我可以在单元测试中反映在单元测试中检查evaluate的正文以检查它是否引用p2然后确保它与requiresP2方法返回的值，但似乎无法使用反射检查方法体。

我正在寻找有关如何做到这一点的建议。任何意见都表示赞赏。

Answer 1

您还没有提到另一个选项：静态代码分析工具。

您可以使用SonarQube + SonarLint组合来获得所需的执行力：

使用SonarQube服务器创建新的静态代码分析规则，该规则将基于您使用的界面和您的独特用例。

然后在IDE / IDE上安装SonarLint（支持Eclipse和IntelliJ），并将其连接到SonarQube服务器。

这样，静态代码分析扫描将检测您的界面的不正确使用情况，并在IDE中使用可视标记在相关代码行（实际上是对您的代码进行说明）上进行指示。

Answer 2

您可以使用ASM检查是否使用了该参数。

使用例如将其添加到项目中Apache Ivy，您可以将其添加到ivy.xml：

<dependency org="org.ow2.asm" name="asm" rev="6.1.1" />

或者为Maven，Gradle等执行等效操作。然后，您可以通过以下方式检查参数：

import java.io.IOException;
import java.io.InputStream;
import java.io.UncheckedIOException;
import java.util.concurrent.atomic.AtomicBoolean;

import org.objectweb.asm.ClassReader;
import org.objectweb.asm.ClassVisitor;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;

// . . .

public static boolean usesP2(Evaluator evaluator) {
    AtomicBoolean usesP2 = new AtomicBoolean(false);
    String internalName = evaluator.getClass().getName().replace('.', '/');
    String classFileResource = "/" + internalName + ".class";

    ClassVisitor visitor = new ClassVisitor(Opcodes.ASM6) {
        @Override
        public MethodVisitor visitMethod(int access, String name,
                String desc, String signature, String[] exceptions) {
            if ("evaluate".equals(name)) {
                return new MethodVisitor(Opcodes.ASM6) {
                    @Override
                    public void visitVarInsn(final int insn, final int slot) {
                        if (slot == 2) usesP2.set(true);
                    }
                };
            }
            return super.visitMethod(access, name, desc, signature, exceptions);
        }
    };
    try (InputStream is = Evaluator.class.getResourceAsStream(classFileResource)) {
        ClassReader reader = new ClassReader(is);
        reader.accept(visitor, 0);
    } catch (IOException e) {
        throw new UncheckedIOException(e);
    }
    return usesP2.get();
}

public static void assertCorrectlyDocumentsP2(Evaluator evaluator) {
    boolean usesP2 = usesP2(evaluator);
    if (usesP2 && !evaluator.requiresP2()) {
        throw new AssertionError(evaluator.getClass().getName() +
                " uses P2 without documenting it");
    }
    if (!usesP2 && evaluator.requiresP2()) {
        throw new AssertionError(evaluator.getClass().getName() +
                " says it uses P2 but does not");
    }
}

单元测试：

@Test
public void testFalsePositive() {
    assertCorrectlyDocumentsP2(new FalsePositive());
}

@Test
public static void testFalseNegative() {
    assertCorrectlyDocumentsP2(new FalseNegative());
}

（这假设有两个错误Evaluator s，FalsePositive和FalseNegative，其中一个文档表示它使用P2但没有，另一个没有文档即使它分别使用P2，也是如此。）

注意：在usesP2中，我们检查堆栈帧的插槽2中的变量指令（访问本地变量的指令）。插槽编号为0，第一个插槽为this。 P2仅在插槽2中，因为Evaluator::evaluate是实例方法。如果是静态方法，我们必须检查是否使用插槽1 以检测是否使用了参数P2。 警告演员。

验证方法体中是否使用了方法参数

2 个答案: