如何在构建阶段验证接口与实现类的方法参数名一致？

下面的代码原本能正确返回字符串"ab"：

public interface ITest
{
    String JoinString(String first, String second);
}

public class Test implements ITest
{

    @Override
    public String JoinString(String first, String second)
    {
        return first + second;
    }
}

public class Main
{
    public static int Main(Object[] args)
    {
        var inst = (ITest) new Test();
        inst.JoinString("a", "b");
    }
}

但如果修改接口，交换参数顺序：

public interface ITest
{
    String JoinString(String second, String first);
}

此时调用方法仍会返回"ab"，而非预期的"ba"——这是因为开发者对first和second的语义预期出现偏差，但Java本身不会因为参数名不匹配抛出错误。

如何验证接口与实现类的方法参数名一致？最好能在构建阶段直接抛出错误终止构建。

解决方案 #

1. 自定义编译期注解处理器 #

自己写一个注解和对应的处理器，在编译阶段自动检查参数名匹配情况：

• 先定义一个标记用的注解：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
public @interface MatchParamNames {}

• 给需要检查的接口加上这个注解：

@MatchParamNames
public interface ITest {
    String JoinString(String first, String second);
}

• 编写注解处理器继承AbstractProcessor，在process方法里：
  1. 扫描所有带@MatchParamNames注解的接口
  2. 找到这些接口的所有实现类
  3. 逐个对比接口方法和实现方法的参数名，只要有位置上的参数名不匹配，就调用processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "参数名不匹配：接口方法参数为[" + 接口参数名 + "]，实现类为[" + 实现类参数名 + "]")，直接触发编译错误。

2. 用静态代码分析工具（如Checkstyle） #

配置Checkstyle的自定义规则，添加检查项：检查接口实现类的方法参数名必须和接口定义的完全一致。把Checkstyle集成到Maven或Gradle构建流程中，构建时自动执行检查，发现不匹配就终止构建并报错。

注意事项 #

Java默认编译后的class文件不会保留参数名，需要在编译时添加-parameters参数：

• Maven中可以在maven-compiler-plugin里配置：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.8.1</version>
    <configuration>
        <parameters>true</parameters>
    </configuration>
</plugin>

只有开启这个参数，注解处理器或静态分析工具才能拿到真实的参数名，否则只能得到arg0、arg1这类默认名称，无法进行有效检查。

内容的提问来源于stack exchange，提问作者horato