一、OpenFeign介绍

OpenFeign是种声明式，模版化的HTTP客户端。使 OpenFeign进远程调时，开发者完全感知不到这是在进远程调，是像在调本地法样。使式是注解+接形式，把需要调的远程接封装到接当中，映射地址为远程接的地址。在启动SpringCloud应时，Feign会扫描标有@FeignClient注解的接，成代理并且注册到Spring容器当中。成代理时Feign会为每个接法创建个RequestTemplate对象，该对象封装HTTP请求需要的全部信息，请求参数名、请求法等信息都是在这个过程中确定的，模版化就体现在这。

二、OpenFeign的使用

搭建前置环境，在pom.xml文件中引入依赖，可以选择使用注册中心或者配置中心

org.springframework.cloud spring-cloud-dependencies 2020.0.3 pom import org.springframework.cloud spring-cloud-starter-consul-config org.springframework.cloud spring-cloud-starter-consul-discovery org.springframework.boot spring-boot-starter-actuator org.springframework.cloud spring-cloud-starter-openfeign

1.使用注册中心

使注册中，将服务注册到consul（nacos），调者拿到被调服务的地址端进调

spring.cloud.consul.host=192.168.0.124#consul地址spring.cloud.consul.port=8080#端号spring.cloud.consul.discovery.service-name=service-test-01#服务名称spring.cloud.consul.discovery.health-check-interval=1m#健康检查间隔时间server.port=10000#服务端号

在配置类上开启服务发现以及允许远程调

@EnableDiscoveryClient //开启服务发现@EnableFeignClients //开启服务调，只需要在调开启即可

服务运之后可以在consul的UI界看到运的服务，consul会定时检查服务的健康状态
创建远程调用接口

@FeignClient(“serviceName”)public interface Service2Remote { /** 这有定义解码器对远程调的结果进解析，拿到真正的返回类型，所以接返回值类型和远程接返回类型保持致 **/ @PostMapping(“/page”) List pageQuestion(PageQuestionReq req);}

简单使用

@RestController@RequestMapping(“/service/remote”)public class RemoteController { @Autowired private Service2Remote service2Remote; @PostMapping(“/getQuestionList”) public List getQuestionList(@RequestBody PageQuestionReq req){ List result = service2Remote.pageQuestion(req); //对拿到的数据进处理… return result; }}

2.使用配置中心

将请求的URL写在配置中进读取修改配置件

spring.cloud.consul.config.format=KEY_VALUE#consul 持yaml格式和Key-value形式spring.cloud.consul.config.enabled=true#开启配置spring.cloud.consul.config.prefixes=glab/plat/wt/application/test#consul配置存放的外层件夹录spring.cloud.consul.config.default-context=config# 级件夹spring.cloud.consul.config.watch.delay=1000#轮询时间spring.cloud.consul.discovery.enabled=false#关闭注册remote.url=www.baidu.com#请求地址

创建远程调用接口

@FeignClient(name = “service2RemoteByUrl”,url = “${remote.url}”) //name需要配置，URL从配置中读取public interface Service2RemoteByUrl { @PostMapping(“/page”) List pageQuestion(PageQuestionReq req);}

3.自定义解码器（编码器）

// 定义解码器实现Decoder接，重写decode 法即可，根据具体需求进编写//如果是定义编码器，需要实现Encoder接，重写encode 法public class FeignDecoder implements Decoder { @Override public Object decode(Response response, Type type) throws IOException,DecodeException, FeignException { if (response.body() == null){ throw new DecodeException(ErrorEnum.EXECUTE_ERR.getErrno(),”没有获取到有效结果值”,response.request()); } // 拿到值 String result = Util.toString(response.body().asReader(Util.UTF_8)); Map resMap = null; try { resMap = JSON.parseObject(result, Map.class); } catch (Exception e) { //返回结果是字符串 return result; }}

4.远程调用携带Cookie

由于feign调是新创建个Request，因此在请求时不会携带些原本就有的信息，例如Cookie，因此需要定义RequestInterceptor对Request进额外设置，般情况下，写 Cookie是较常的做法，如下设置

@Configurationpublic class BeanConfig { @Bean public RequestInterceptor requestInterceptor(){ return template -> { ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest request = attributes.getRequest(); //此处可以根据业务具体定制携带规则 String data = request.getParameter(“data”); String code = null; try { //这需要转码，否则会报错 code = URLEncoder.encode(data, “UTF-8”); } catch (UnsupportedEncodingException e) { e.printStackTrace(); } template.query(“data”,code); //请求头中携带Cookie String cookie = request.getHeader(“Cookie”); template.header(“Cookie”,cookie); }; } @Bean public Decoder decoder(){ return new FeignDecoder(); }}

三、调用流程解析

//在使 EnableFeignClients开启feign功能时，点击进会看到该注解是通过ImportFeignClientsRegistrar类效的，其中有个法//registerBeanDefinitions执两条语句registerDefaultConfiguration(metadata, registry); //加载默认配置信息registerFeignClients(metadata, registry); //注册扫描标有FeignClient的接 //关注registerFeignClients 法for (String basePackage : basePackages) { candidateComponents.addAll(scanner.findCandidateComponents(basePackage)); //在basePackage路径下扫描并添加标有FeignClient的接 }for (BeanDefinition candidateComponent : candidateComponents) { //遍历 if (candidateComponent instanceof AnnotatedBeanDefinition) { registerClientConfiguration(registry, name, attributes.get(“configuration”)); // registerFeignClient(registry, annotationMetadata, attributes); //注册到Spring容器当中，法详细在FeignClientsRegistrar类当中 }}//在对feign调时进断点调试//在成Feign远程接的代理类时，调处理器是Feign提供的FeignInvocationHandlerpublic Object invoke(Object proxy, Method method, Object[] args) throws Throwable { if (“equals”.equals(method.getName())) { //equals，hashCode，toString三个法直接本地执 } else if (“hashCode”.equals(method.getName())) { return hashCode(); } else if (“toString”.equals(method.getName())) { return toString(); } //执法对应的法处理器MethodHandler，这个接是Feign提供的，与InvocationHandler 任何关系，只有个invoke 法 return dispatch.get(method).invoke(args);}//点进上的invoke 法public Object invoke(Object[] argv) throws Throwable { //创建个request模版 RequestTemplate template = buildTemplateFromArgs.create(argv); while (true) { try { return executeAndDecode(template, options); //创建request执并且解码 } }}Object executeAndDecode(RequestTemplate template, Options options) throws Throwable { Request request = targetRequest(template); //创建Request并增强 Response response = client.execute(request, options); //执调用请求，不再继续分析了 response = response.toBuilder().request(request).requestTemplate(template).build(); //如果有重写解码器，使定义的解码器，feign默认使 SpringEncoder if (decoder != null) return decoder.decode(response, metadata.returnType()); } Request targetRequest(RequestTemplate template) { //如果定义了RequestInterceptor，在这可以对Request进增强 for (RequestInterceptor interceptor : requestInterceptors) { //执定义的apply 法 interceptor.apply(template); } //创建Request return target.apply(template);}

四、补充

关于Client接的实现类，使注册中和使配置中其流程稍有区别

//使配置中拿url 式进调，使的是Client的默认内部实现类 Default ，其中Default使的是HttpURLConnection进 Http请求的HttpURLConnection connection = convertAndSend(request, options);//如果使的是服务发现，使的使 Client的实现类FeignBlockingLoadBalancerClient，它会去根据配置的服务名去注册中查找服务的IP地址和端号，执使的仍然是默认实现类Default，通过HttpURLConnection请求//FeignBlockingLoadBalancerClient，根据服务名称查找服务IP地址、端 88 ServiceInstance instance = loadBalancerClient.choose(serviceId, lbRequest);//具体实现法，BlockingLoadBalancerClient类中 145 Response loadBalancerResponse = Mono.from(loadBalancer.choose(request)).block();//还有其他实现Client接的客户端，例如ApacheHttpClient，ApacheHttpClient带有连接池功能，具有优秀的HTTP连接复能，需要通过引依赖来使

郑重声明：本文内容及图片均整理自互联网，不代表本站立场，版权归原作者所有，如有侵权请联系管理员(admin#wlmqw.com)删除。