Spring Cloud Feign 的远程服务调用

Spring Cloud Feign 的远程服务调用

• • 
    
• ​​说明​​
• ​​简介​​
• ​​创建项目​​
• 
  
• ​​依赖​​
• ​​配置信息​​
• ​​主要配置内容：​​
• ​​启动类​​
• ​​控制器类​​
• ​​接口类​​
• ​​接口对应的服务熔断类​​
• 
  
• ​​测试​​
• 
  
• ​​服务正常可用​​
• ​​服务异常不可用​​
• 
  
  • 
    

说明

• • 
    
• 项目运行的前提条件：服务注册中心已经启动。
• 本项目的服务注册与发现是基于 Spring Cloud Consul 实现。具体内容博主写在另一篇博客：
• • ​​Spring Cloud Consul 服务注册中心​​
• 本博客是 ​​Spring Cloud 微服务化（精简完整版）​​的一部分。
  • 
    

简介

• • 
    
• 首先，这是一个标准的 Spring Boot 项目
• 其次，它实现基于 ​​Spring Cloud Consul​​的服务注册功能
• 最后，它支持 ​​Spring Cloud Feign​​远程调用
• • 如果Feign 客户端远程调用异常，则返回 fallback 信息（通过 ​​Spring Cloud Netflix Hystrix​​实现）
• 当前实现的功能：
• • • 
      
  • 提供一个接口，接收 uri 为 ​​/api/user/{id}​​的 HTTP GET 请求
  • 这个接口通过 Feign 客户端远程调用 ​​awesome-user-server​​​服务中匹配 ​​/api/user/{id}​​的接口
    • 
      
  • 
    

创建项目

• 博主使用的开发工具是 Intellij IDEA，创建的项目结构如下所示：
• • • 
      
  • 
  • 主要包含六部分内容(其他部分请参考 ​​Spring Cloud Gateway 网关​​)
  • • • 
        
    • 依赖信息：pom.xml
    • 配置信息：application.yml
    • 启动类: AwesomeUserApiApplication.java
    • 控制器类：UserController.java
    • 接口类：UserService.java
    • 接口对应的服务熔断类：UserServiceFallback.java
      • 
        
    • 
      

依赖

• • 
    
• 主要引入依赖：
• • • 
      
  • spring-cloud-starter-consul-all：注册服务到 Consul
  • spring-cloud-starter-gateway ：支持网关服务。（用于实现网关功能直接转发某些请求，和当前博客主要介绍的内容关系不大，但由于本博客属于 ​​Spring Cloud 微服务化（精简完整版）​​的一部分，由于整体设计的原因，所以这里引入这个依赖）
  • spring-cloud-starter-netflix-hystrix ：支持熔断服务
  • spring-cloud-starter-openfeign：支持 Feign 客户端远程调用
    • 
      
• 完整 pom.xml
• ​​<?xml version="1.0" encoding="UTF-8"?><project xmlns="​http://maven.apache.org/POM/4.0.0">​http://maven.apache.org/POM/4.0.0​​" xmlns:xsi="​www.w3.org/2001/XMLSchema-instance">​http://www.w3.org/2001/XMLSchema-instance​​"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>andy.wanna.sing</groupId> <artifactId>awesome-user-api</artifactId> <version>1.0-SNAPSHOT</version> <packaging>jar</packaging> <name>awesome-user-api</name> <url>​​http://www.example.com​​</url> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> <java.version>1.8</java.version> </properties> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.3.RELEASE</version> </parent> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Greenwich.SR1</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-consul-all</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-hystrix</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> <build> <finalName>awesome-gateway</finalName> <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) --> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> <plugin> <artifactId>maven-clean-plugin</artifactId> <version>3.1.0</version> </plugin> <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging --> <plugin> <artifactId>maven-resources-plugin</artifactId> <version>3.0.2</version> </plugin> <plugin> <artifactId>maven-compiler-plugin</artifactId> <version>3.8.0</version> </plugin> <plugin> <artifactId>maven-surefire-plugin</artifactId> <version>2.22.1</version> </plugin> <plugin> <artifactId>maven-war-plugin</artifactId> <version>3.2.2</version> </plugin> <plugin> <artifactId>maven-install-plugin</artifactId> <version>2.5.2</version> </plugin> <plugin> <artifactId>maven-deploy-plugin</artifactId> <version>2.8.2</version> </plugin> </plugins> </pluginManagement> </build></project>​​
  • 
    

配置信息

• • 
    
• 主要配置内容：
• • • 
      
  • 服务注册中心（Spring Cloud Consul 配置）
  • 启动 Feign Hystrix
  • 运行的端口号
  • 健康检查暴露的端点
    • 
      
• application.yml
• ​​spring: application: name: awesome-gateway cloud: consul: host: localhost port: 8500 discovery: enabled: true register: true healthCheckInterval: 10s instanceId: ${spring.application.name}:${vcap.application.instance_id:${spring.application.instance_id:${random.value}}} feign: hystrix: enabled: true server: port: 9201 management: endpoints: web: exposure: include: metrics,env,beans,mappings,health ​​
  • 
    

启动类

• • 
    
• 标准的 Spring Boot 项目启动类
• 注意：需要添加 ​​@EnableFeignClients​​
• ​​package awesome.user.api;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;/** * 启动类 * * * @author: Andy * @time: 2019/4/15 15:39 * @since */ @SpringBootApplication@EnableFeignClientspublic class AwesomeUserApiApplication { public static void main(String[] args) { SpringApplication.run(AwesomeUserApiApplication.class, args); }}​​
  • 
    

控制器类

• 提供一个用户接口，
• • • 
      
  • 匹配 uri : ​​/api/user/{id}​​
  • 接口调用 ​​UserService​​​的接口（​​UserService​​​中实现了 ​​Feign​​客户端远程调用和服务降级，下面会介绍）
  • ​​package awesome.user.api.controller.user;import awesome.user.api.bean.User;import awesome.user.api.service.UserService;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.http.HttpStatus;import org.springframework.http.ResponseEntity;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.PathVariable;import org.springframework.web.bind.annotation.RestController;/** * 用户控制器 * * @author: Andy * @time: 2019/4/16 21:36 * @since */ @RestControllerpublic class UserController { @Autowired private UserService userService; /** * 获取用户信息 * * * @param id 用户ID * @return: {@link ResponseEntity<User> } * @author: Andy * @time: 2019/4/16 22:02 */ @GetMapping("/api/user/{id}") public ResponseEntity<?> getUser(@PathVariable("id") Integer id){ try { return userService.getUser(id); }catch (Exception e){ //todo: do something e.printStackTrace(); return new ResponseEntity<>("请求失败！", HttpStatus.INTERNAL_SERVER_ERROR); }}}​​
    • 
      

接口类

• 这个类是本博客的核心类
• • • 
      
  • 它实现了 ​​FeignClient​​​远程调用和 ​​Hystrix​​服务降级
  • • • 
        
    • 类上有注解 ​​@FeignClient(name = "awesome-user-server", fallback = UserServiceFallback.class)​​​，它的作用是把请求转发到 ​​awesome-user-server​​​服务，并且当请求出现异常时，返回 ​​UserService​​​的实现类 ​​UserServiceFallback​​对应的方法的返回值。
    • 方法上有注解 ​​@GetMapping("/api/user/{id}")​​​，表示这个方法的调用匹配的远程服务的 uri，在本例中，即匹配 ​​awesome-user-server​​​服务中 uri 为 ​​/api/user/{id}​​的接口。
      • 
        
  • ​​package awesome.user.api.service;import awesome.user.api.bean.User;import awesome.user.api.fallback.UserServiceFallback;import org.springframework.cloud.openfeign.FeignClient;import org.springframework.http.ResponseEntity;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.PathVariable;@FeignClient(name = "awesome-user-server", fallback = UserServiceFallback.class)public interface UserService { /** * 获取用户信息 * * * @param id 用户ID * @return: {@link <User> } * @author: Andy * @time: 2019/4/16 22:02 */ @GetMapping("/api/user/{id}") ResponseEntity<?> getUser(@PathVariable("id") Integer id);}​​
    • 
      

接口对应的服务熔断类

• 即实现服务降级的类
• • • 
      
  • 这个类必须需要有 ​​@FeignClient​​注解的接口，并为每个方法定义默认返回值。
  • 这个类需要被注册成 Bean，以便注入。所以，博主给它添加注解​​@Component​​
  • ​​package awesome.user.api.fallback;import awesome.user.api.bean.User;import awesome.user.api.service.UserService;import org.springframework.http.HttpStatus;import org.springframework.http.ResponseEntity;import org.springframework.stereotype.Component;/** * user 服务降级类 * * @author: Andy * @time: 2019/4/16 21:47 * @since */ @Componentpublic class UserServiceFallback implements UserService { @Override public ResponseEntity<?> getUser(Integer id) { return new ResponseEntity<>("Server 请求失败！" ,HttpStatus.INTERNAL_SERVER_ERROR); }}​​
    • 
      

测试

• 上面我们构建了一下 API 项目。它的作用是：
• • • 
      
  • 提供一个接口，接受匹配 ​​/api/user/{id}​​​的请求，并通过 ​​FeignClient​​​远程调用 ​​awesome-user-server​​服务的接口获取相关信息，最后返回响应。
  • • 当​​FeignClient​​远程调用服务不可用时，返回接口对应的服务熔断类对应方法的返回值。
  • 为了完成这个测试，我们需要要 ​​awesome-user-server​​服务。
  • • ​​awesome-user-server​​必须是 Web 项目，并且注册到服务注册中心。实现基于 Spring Cloud Consul 的服务注册与发现，博主写在下面的博客：
    • • ​​Spring Cloud Consul 构建服务​​
    • 
      

服务正常可用

• 使 awesome-user-server 服务的 /api/user/1 接口正常可用。
• • • 
      
  • 
  • 访问：​​http://localhost:9201/api/user/1​​
  • 返回结果：
    • 
      

服务异常不可用

• 使 awesome-user-server 服务的 /api/user/1 接口不可用。
• • • 
      
  • 
  • 访问：​​http://localhost:9201/api/user/1​​
  • 返回结果：
    •