@FeignClient path属性路径前缀带路径变量时报错的解决

下面是详细的解释和示例。

问题描述

当使用@FeignClient注解时，如果在path属性中设置了路径前缀，且该前缀包含路径变量，则会出现如下错误：

org.springframework.cloud.netflix.ribbon.RibbonLoadBalancerClient : LB returned null for service: xxx

这个错误可能是由于feign链接到未知的服务，或者是由于path属性中的路径前缀不被正确处理而导致的。

原因分析

错误的原因是，当在path属性中包含路径变量时，Feign 无法确定路径前缀的实际值。这会导致 Feign 使用了错误的路径来发起请求，从而使得请求失败。

解决方案

为了解决这个问题，我们需要使用@PathVariable注解来给路径前缀添加路径变量，并且使用 ${var} 的形式在路径前缀中使用路径变量。这样可以让 Feign 获取到路径前缀的实际值。

下面是使用@PathVariable和${var}的示例:

示例1

对于一个服务名为user-service 的服务，它的 path 属性中包含路径变量 {userId}，可以像下面这样设置：

@FeignClient(name = "user-service", path = "${feign.path.user-service}/users/{userId}")
public interface UserFeignClient {

    @GetMapping("/{id}")
    User getUserById(@PathVariable("id") Integer id);

}

这里，通过在path属性中使用${feign.path.user-service}，将路径前缀中的服务名用路径变量表示出来。然后在方法参数中使用@PathVariable注解添加路径变量{id}。当调用getUserById方法时，Feign 将自动将{id}解析为id对应的值，并使用实际的请求路径发起请求。

示例2

对于一个服务名为book-service的服务，它的path属性中包含路径变量{bookId}，并且这个路径变量还包含在/books/{bookId}/chapter中，那么可以像下面这样设置：

@FeignClient(name = "book-service", path = "${feign.path.book-service}/books/{bookId}/chapter")
public interface BookFeignClient {

    @GetMapping("/{chapterId}")
    Chapter getChapterById(@PathVariable("bookId") Integer bookId,
                            @PathVariable("chapterId") Integer chapterId);
}

这里，通过在path属性中使用${feign.path.book-service}，将路径前缀中的服务名用路径变量表示出来。然后在方法参数中使用@PathVariable注解添加路径变量{bookId}和{chapterId}。当调用getChapterById方法时，Feign 将自动将{bookId}和{chapterId}解析为对应的值，并使用实际的请求路径发起请求。

总结

使用 ${var}和 @PathVariable 的方式，可以有效的避免 Feign 在处理包含路径变量的路径前缀时出现错误。要注意，在实际使用中，要根据具体情况为${var}设置正确的值。通过上面的例子，相信你已经掌握了如何在@FeignClient的path属性中正确的设置路径前缀，并避免了相关错误的发生。