6Sping Cloud Feign

Posted 2020-12-22 hosystem

1.Spring Cloud Feign简介

(1).Fegin简介

  官方文档：http://projects.spring.io/spring-cloud/spring-cloud.html#spring-cloud-feign

 

  Feign是一个声明式WebService客户端。使用Feign能让编写Web Service客户端更加简单, 它的使用方法是定义一个接口，然后在上面添加注解，同时也支持JAX-RS标准的注解。Feign也支持可拔插式的编码器和解码器。Spring Cloud对Feign进行了封装，使其支持了Spring MVC标准注解和HttpMessageConverters。Feign可以与Eureka和Ribbon组合使用以支持负载均衡。

  Feign是一个声明式的Web服务客户端，使得编写Web服务客户端变得非常容易，

只需要创建一个接口，然后在上面添加注解即可。

  官方文档：https://github.com/OpenFeign/feign

(2).Feign作用

  Feign旨在使编写Java Http客户端变得更容易。前面在使用Ribbon+RestTemplate时，利用RestTemplate对http请求的封装处理，形成了一套模版化的调用方法。但是在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用。所以，Feign在此基础上做了进一步封装，由他来帮助我们定义和实现依赖服务接口的定义。在Feign的实现下，我们只需创建一个接口并使用注解的方式来配置它(以前是Dao接口上面标注Mapper注解,现在是一个微服务接口上面标注一个Feign注解即可)，即可完成对服务提供方的接口绑定，简化了使用Spring cloud Ribbon时，自动封装服务调用客户端的开发量。

(3).Feign集成Ribbon

  利用Ribbon维护了MicroServiceCloud-Dept的服务列表信息，并且通过轮询实现了客户端的负载均衡。而与Ribbon不同的是，通过feign只需要定义服务绑定接口且以声明式的方法，优雅而简单的实现了服务调用。

2.Feign实现步骤

 

(1).创建工程

[1].新建工程feign

  新建microservicecloud-consumer-dept-feign

 

 

  将consumer里的com包和application.yml配置文件复制到新创建的feign里

 

  修改主启动类名

 

[2].pom文件

  配置microservicecloud-consumer-dept-feign的pom文件

<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0"          xmlns:xsi="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">     <parent>         <artifactId>microservicecloud</artifactId>         <groupId>com.hosystem</groupId>         <version>1.0-SNAPSHOT</version>     </parent>     <modelVersion>4.0.0</modelVersion>       <artifactId>microservicecloud-consumer-dept-feign</artifactId>       <dependencies>         <dependency><!-- 自己定义的api -->             <!--注意：groupId我们需要由com.hosystem.springcloud 变成com.hosystem就不会出现‘Dependency ‘com.hosystem.springcloud:microservicecloud-api:1.0-SNAPSHOT‘ not found‘错误-->             <groupId>com.hosystem</groupId>             <artifactId>microservicecloud-api</artifactId>             <version>${project.version}</version>         </dependency>         <dependency>             <groupId>org.springframework.boot</groupId>             <artifactId>spring-boot-starter-web</artifactId>         </dependency>         <!-- 修改后立即生效，热部署 -->         <dependency>             <groupId>org.springframework</groupId>             <artifactId>springloaded</artifactId>         </dependency>         <dependency>             <groupId>org.springframework.boot</groupId>             <artifactId>spring-boot-devtools</artifactId>         </dependency>           <!-- Ribbon相关 -->         <dependency>             <groupId>org.springframework.cloud</groupId>             <artifactId>spring-cloud-starter-eureka</artifactId>         </dependency>         <dependency>             <groupId>org.springframework.cloud</groupId>             <artifactId>spring-cloud-starter-ribbon</artifactId>         </dependency>         <dependency>             <groupId>org.springframework.cloud</groupId>             <artifactId>spring-cloud-starter-config</artifactId>         </dependency>           <!-- feign相关 -->         <dependency>             <groupId>org.springframework.cloud</groupId>             <artifactId>spring-cloud-starter-feign</artifactId>         </dependency>     </dependencies>   </project>

(2).修改microservicecloud-api工程

 

[1].修改pom文件

  新增部分：

<!--feign相关-->         <dependency>             <groupId>org.springframework.cloud</groupId>             <artifactId>spring-cloud-starter-feign</artifactId>         </dependency>     </dependencies>

  完整部分：

<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0"          xmlns:xsi="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">     <!-- 子类里面显示声明才能有明确的继承表现，无意外就是父类的默认版本否则自己定义 -->     <parent>         <artifactId>microservicecloud</artifactId>         <groupId>com.hosystem</groupId>         <version>1.0-SNAPSHOT</version>     </parent>     <modelVersion>4.0.0</modelVersion>       <!--当前Module叫什么名字 -->     <artifactId>microservicecloud-api</artifactId>       <!-- 当前Module需要用到的jar包，按自己需求添加，如果父类已经包含了，可以不用写版本号 -->     <dependencies>         <dependency>             <groupId>org.projectlombok</groupId>             <artifactId>lombok</artifactId>         </dependency>           <!--feign相关-->         <dependency>             <groupId>org.springframework.cloud</groupId>             <artifactId>spring-cloud-starter-feign</artifactId>         </dependency>     </dependencies>   </project>

[2].创建接口

  新建DeptClientService接口并新增注解@FeignClient。

package com.hosystem.springcloud.service;   import com.hosystem.springcloud.entities.Dept; import org.springframework.cloud.netflix.feign.FeignClient; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod;   import java.util.List;   @FeignClient(value = "MICROSERVICECLOUD-DEPT") public interface DeptClientService {     @RequestMapping(value = "/dept/get/{id}",method = RequestMethod.GET)     public Dept get(@PathVariable("id") long id);       @RequestMapping(value = "/dept/list",method = RequestMethod.GET)     public List<Dept> list();       @RequestMapping(value = "/dept/add",method = RequestMethod.POST)     public boolean add(Dept dept); }

[3].mvn clean和mvn install

 

(3).修改microservicecloud-consumer-dept-feign

  microservicecloud-consumer-dept-feign工程修改Controller，添加上一步新建的DeptClientService接口

package com.hosystem.springcloud.controller;   import com.hosystem.springcloud.entities.Dept; import com.hosystem.springcloud.service.DeptClientService; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController;   import javax.annotation.Resource; import java.util.List;     @RestController //注:这里一定不能忘记注解@RestController 否则出现404; public class DeptController_Consumer {       //注：如果出现could not autowired no beans of ‘DeptClientService‘ type found. 我们只需要将@autowired改成@Resource即可     @Resource     private DeptClientService service;       @RequestMapping(value = "/consumer/dept/get/{id}")     public Dept get(@PathVariable("id") Long id)     {         return this.service.get(id);     }       @RequestMapping(value = "/consumer/dept/list")     public List<Dept> list()     {         return this.service.list();     }       @RequestMapping(value = "/consumer/dept/add")     public Object add(Dept dept)     {         return this.service.add(dept);     } }

(4).修改主启动类

  修改microservicecloud-consumer-dept-feign主启动类

package com.hosystem.springcloud;   import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.netflix.eureka.EnableEurekaClient; import org.springframework.cloud.netflix.feign.EnableFeignClients; import org.springframework.context.annotation.ComponentScan;     @SpringBootApplication @EnableEurekaClient @EnableFeignClients(basePackages= {"com.hosystem.springcloud"}) @ComponentScan("com.hosystem.springcloud") public class DeptConsumer80_Feign_App {     public static void main(String[] args)     {         SpringApplication.run(DeptConsumer80_Feign_App.class, args);     } }

(5).测试

[1].启动eureka集群

 

[2].启动provider8001、provider8002、provider8003

 

[3].启动Feign

 

[4].访问页面

  Feign自带负载均衡配置项

http://localhost/consumer/dept/list

 

(6).总结

  Feign通过接口的方法调用Rest服务(之前是Ribbon+RestTemplate),该请求发送给Eureka服务器(http://MICROSERVICECLOUD-DEPT/dept/list),通过Feign直接找到服务接口，由于在进行服务调用的时候融合了Ribbon技术，所以也支持负载均衡作用。

 

参考文档：

http://projects.spring.io/spring-cloud/spring-cloud.html#spring-cloud-feign

https://github.com/OpenFeign/feign