SpringCloud（13）：Feign使用接口方式调用服务

深碍√TFBOYSˉ_ 2023-01-12 01:50 94阅读 0赞

### 一、简介 ###

Feign是声明式web service客户端，它让微服务之间的调用变得更简单了，类似controller调用service。SpringCloud可在使用Feign时提供负载均衡的http客户端。

feign，主要是社区，大家都习惯面向接口编程。这个是很多开发人员的规范。调用微服务访问的两种方法：

1.  微服务名字（LoadBalancer）
2.  接口和注解（feign）

### 二、Feign的作用 ###

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

### 三、Feign搭建 ###

（1）创建Feign模块，这个也是客户端模块端口号80。之所以没在之前的客户端模块上修改主要是用于比较。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjk4MzUx_size_16_color_FFFFFF_t_70][]

（2）创建完成后把80端口的模块内容复制到Feign中。去掉自定义的负载均衡配置。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjk4MzUx_size_16_color_FFFFFF_t_70 1][]

### 四、提供服务 ###

（1）在SpringCloud-api模块中添加Feigin依赖

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

（2）在api模块中添加service包，提供服务。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjk4MzUx_size_16_color_FFFFFF_t_70 2][]

（3）编写Feign接口，注意该接口内容和服务提供者Controller类似。

package com.buba.springcloud.service;
    
    import com.buba.springcloud.pojo.Dept;
    import org.springframework.cloud.openfeign.FeignClient;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.PostMapping;
    
    import java.util.List;
    
    @FeignClient(value = "SPRINGCLOUD-PROVIDER-DEPT")
    public interface DeptClientService {
    
        @GetMapping("/dept/get/{deptId}")
        Dept selDeptById(@PathVariable("deptId") long deptId);
    
        @PostMapping("/dept/addDept")
        boolean addDept(Dept dept);
    
        @GetMapping("/dept/list")
        List<Dept> selDept();
    }

（4）修改springcloud-dept-feign模块DeptConsumerController，把写好的Feign接口注入进来。

package com.buba.springcloud.controller;
    
    import com.buba.springcloud.pojo.Dept;
    import com.buba.springcloud.service.DeptClientService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.cloud.loadbalancer.support.LoadBalancerClientFactory;
    import org.springframework.core.env.Environment;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    import org.springframework.web.client.RestTemplate;
    
    import java.util.List;
    
    @RestController
    public class DeptConsumerController {
    
    
        private DeptClientService deptClientService;
    
        @RequestMapping("/consumer/dept/get/{deptId}")
        public Dept get(@PathVariable("deptId") long deptId) {
            return this.deptClientService.selDeptById(deptId);
        }
    
        @RequestMapping("/consumer/dept/add")
        public boolean add(Dept dept) {
            return this.deptClientService.addDept(dept);
        }
    
        @RequestMapping("/consumer/dept/list")
        public List<Dept> list() {
            return this.deptClientService.selDept();
        }
    
    
        @Autowired
        public void setDeptClientService(DeptClientService deptClientService) {
            this.deptClientService = deptClientService;
        }
    }

可以看到微服务调用方式又编程了面向接口的方式。

（5）在springcloud-dept-feign模块启动类添加注解。

package com.buba.springcloud;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
    import org.springframework.cloud.openfeign.EnableFeignClients;
    
    @SpringBootApplication
    @EnableEurekaClient // Eureka客户端启动类
    @EnableFeignClients(basePackages = {"com.buba.springcloud"})
    public class DeptConsumerFeign_80 {
        public static void main(String[] args) {
            SpringApplication.run(DeptConsumerFeign_80.class, args);
        }
    }

（6）启动Feign客户端、Eureka服务和三个服务提供者进行访问。[http://localhost/consumer/dept/list][http_localhost_consumer_dept_list]

![20210127174152676.png][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjk4MzUx_size_16_color_FFFFFF_t_70]: /images/20221119/9373794be6ee40fc80958c8affc3961a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjk4MzUx_size_16_color_FFFFFF_t_70 1]: /images/20221119/0aefca70654543eb94373466ef5e0676.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjk4MzUx_size_16_color_FFFFFF_t_70 2]: /images/20221119/eac17c49e30d47dfa241c0af4c04edf4.png
[http_localhost_consumer_dept_list]: http://localhost/consumer/dept/list
[20210127174152676.png]: /images/20221119/910b086a6dfe4013b63b70bfbd5d3414.png