springboot应用使用openfeign

openfeign的相关介绍：

https://cloud.spring.io/spring-cloud-openfeign/reference/html/

这个东西是springcloud的一个jar，一般来说用于微服务之间的服务调用。但是也可以用于一些系统间的接口调用，比直接用httpclient要方便一些。
事实上，如果用feign的话，就完全和springcloud无关了，一样可以实现接口调用。我阅读了feign相关的官方文档，觉得它的调用和配置方式没有openfeign优雅，因此最终选择了openfeign做系统间的接口调用。

pom文件

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-openfeign</artifactId>
  <version>3.1.4</version>
</dependency>

这里遇到了第一个坑，如果我们直接是springcloud的项目，因为指定了springcloud的版本，就不需要指定openfeign的版本了，因为在它的关联pom文件中都已经设置好了。我们直接在springboot中使用的话，就要指定版本。
这不是坑的地方，而是这个openfeign的版本要匹配适合的springboot版本比较坑，从官网可以查询到springcloud版本与springboot版本的适配情况，但是对于openfeign的版本与springboot的版本适配没有明确的说明。因为项目中springboot的版本已经确定了，用的2.7.5。openfeign的版本就只能从它与springcloud的版本大致的猜测可以用哪个版本。开始用错了版本，启动报错找了半天的原因。。。

配置文件

feign:
  serviceAppUrl: http://127.0.0.1:8888/servericeApp
  client:
    config:
      default:
        connectTimeout: 5000
        readTimeout: 5000

serviceAppUrl是你要调用的服务的地址，写在配置文件中，后期方便在CD的时候替换。对应k8s的values配置，方便在不同环境中使用。
connectTimeout,readTimeout的5000是接口超时时间，我这里写的5秒

代码

application.java

@EnableOpenApi
@SpringBootApplication
@EnableFeignClients(basePackages="com.xxx.xxx.service")
public class WebApplication{
   public static void main(String[] args){
       SpringApplication.run(WebApplication.class,args);
   }
}

配置@EnableFeignClients(basePackages="com.xxx.xxx.service")，basePackages指定要扫描的包，我们对应的service调用文件就写在这个包下面

@FeignClient(name="xxxService",url="${feign.serviceAppUrl}")
public interface IService{
   @GetMapping(/api/xxx/v1/xxx/xxx/{id})
   public Result detail(@PathVariable(name="id") Long id);
}

这里的feign.serviceAppUrl就是前面提到的配置文件中的调用对象的url
其他的写法和接口定义是一样的，可以写POST，GET，PATCH，DELETE等各种方法。写法可以参考官方文档。定义好的接口，就可以在项目其他的地方直接使用了，openfeign会通过代理的方式帮我们实现接口方法。

错误处理

对于常见的springcloud，大流量项目来说会要用到熔断，我们这里既然是单体的springboot项目，必然请求量不大，就不用考虑这些了，考虑错误处理就行。

@Configuration
public class FeignErrorDecoder implements ErrorDecoder{
  @Override
  public Exception decode(String methodKey, Response response){
     String json = null;
     try{
        json = Util.toString(response.body().asReader(Charset.forName("UTF-8")));
     }catch(IOException e){
       ...
     }
    ...
  }
}

实现ErrorDecoder就可以处理openfeign抛出的异常了。
这里的抛错指的是服务方返回的http状态码报错的情况（不是200,201这种请求正常的情况）
我们通过这个方法，就可以将调用方的异常报差处理为我们自己系统想要的格式。
这里获取返回的body时，注意设置编码格式为"UTF-8"（一般来说），不然获取的到中文就乱码了。

最后编辑于：2023.03.10 00:10:52