OpenFeign接口是否必须为@PathVariable和@RequestParam指定名称？

在OpenFeign 3.1.3版本中，PathVariableParameterProcessor和RequestParamParameterProcessor新增了校验逻辑：带有@PathVariable或@RequestParam注解的参数必须显式指定name（或value，二者是别名）属性，否则会抛出IllegalStateException: PathVariable annotation was empty on param X的异常。而此前版本无此校验，因此未指定参数名的代码可以正常运行。

解决方案 #

1. 手动显式指定参数名（最稳妥的方案）

直接在注解中补充参数名称，这也是符合后续版本设计预期的写法，示例修改如下：

@GetMapping("/{entityType}/{entityId}")
List<Document> getDocs(
        @PathVariable("entityType") String entityType,
        @PathVariable("entityId") String entityId,
        @RequestParam(value = "ownerId", required = false) String ownerId,
        @RequestParam(value = "q", required = false) String q);

2. 配置编译参数自动保留参数名（自动化方案）

Java编译时默认会丢弃方法参数的原始名称，需通过添加-parameters编译参数让JVM保留参数名。OpenFeign的SpringMvcContract可以利用这些保留的参数名自动填充注解的name属性，无需手动指定。

Maven配置：在pom.xml中修改maven-compiler-plugin：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <source>1.8</source> <!-- 需Java 8及以上版本 -->
                <target>1.8</target>
                <compilerArgs>
                    <arg>-parameters</arg>
                </compilerArgs>
            </configuration>
        </plugin>
    </plugins>
</build>

Gradle配置：在build.gradle中添加：

compileJava {
    options.compilerArgs.add("-parameters")
}

3. 自定义Contract绕过校验（不推荐）

通过自定义SpringMvcContract替换默认实现，移除参数名校验逻辑，但这种方式可能与后续版本的兼容性冲突，不建议长期使用。示例代码如下（仅作参考）：

@Configuration
public class FeignConfig {
    @Bean
    public Contract feignContract() {
        return new SpringMvcContract() {
            @Override
            protected void processAnnotationsOnParameter(List<Annotation> annotations, ParameterMetadata data) {
                // 跳过参数名校验逻辑，直接调用父类方法（需根据源码调整，避免破坏原有逻辑）
                super.processAnnotationsOnParameter(annotations, data);
            }
        };
    }
}

说明 #

虽然OpenFeign官方文档未明确提及该校验规则，但3.1.3版本的代码逻辑已强制要求显式指定参数名（或通过编译参数保留参数名）。优先推荐前两种方案，尤其是手动指定参数名的方式，代码可读性更强且兼容性更好。

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