Spring Cloud Feign 简介及入门示例

Bertha 。 2022-10-14 00:42 110阅读 0赞

### 文章目录 ###

*   *  简介
     *  集成
     *   *  pom
         *  启用
         *  调用示例

## 简介 ##

`OpenFeign`一个用于 Spring Boot 应用程序的声明式 REST 客户端。

`Feign`通过可插入的注解支持（包括Feign注解和 JAX-RS 注解）使编写 Web 服务客户端变得更容易。

使用 Feign 的一个好处是我们只需编写接口定义而不需要编写任何代码来调用服务。

Spring Cloud 对 Feign 进行了封装，使其支持 SpringMVC 标准注解和 HttpMessageConverters。Feign 可以与 Eureka 和 Ribbon 组合使用以支持负载均衡。

> Netflix Feign 和 OpenFeign 之间的差异
> 
> 从根本上说，Feign 的这两种实现是相同的。我们可以将此归因于 Netflix Feign 是 OpenFeign 的祖先。
> 
> 但是，Spring Cloud OpenFeign 包含 Spring Cloud Netflix Feign 中不可用的新选项和功能。

## 集成 ##

### pom ###

<dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
     <dependencyManagement>
         <dependencies>
             <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

### 启用 ###

将`@EnableFeignClients`添加到我们的主类中：

@SpringBootApplication
    @EnableFeignClients
    public class ExampleApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(ExampleApplication.class, args);
        }
    }
    或
    @Configuration
    @EnableFeignClients("com.laker.feign")
    public class FeignConfig { 
    
    }

使用`@FeignClient`注解声明一个 Feign 客户端：

@FeignClient(value = "jplaceholder", url = "https://jsonplaceholder.typicode.com/")
    public interface JSONPlaceHolderClient { 
    
        @RequestMapping(method = RequestMethod.GET, value = "/posts")
        List<Post> getPosts();
    
        @RequestMapping(method = RequestMethod.GET, value = "/posts/{postId}", produces = "application/json")
        Post getPostById(@PathVariable("postId") Long postId);
    }

### 调用示例 ###

@Autowired
    JSONPlaceHolderClient jsonPlaceHolderClient;
    
    @GetMapping("/info")
    public Response info() { 
        return Response.ok(jsonPlaceHolderClient.getPosts());
    }

**结果：**

{ 
    	code: 200,
    	msg: "",
    	data: [
    		{ 
    			userId: 1,
    			title: "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
    			body: "quia et suscipit suscipit recusandae consequuntur expedita et cum reprehenderit molestiae ut ut quas totam nostrum rerum est autem sunt rem eveniet architecto",
    			id: 1
    		},
    		{ 
    			userId: 1,
    			title: "qui est esse",
    			body: "est rerum tempore vitae sequi sint nihil reprehenderit dolor beatae ea dolores neque fugiat blanditiis voluptate porro vel nihil molestiae ut reiciendis qui aperiam non debitis possimus qui neque nisi nulla",
    			id: 2
    		},