SpringCloud组件：创建第一个Feign客户端

1. Feign简介

Feign是一个声明式的Web服务客户端，它使得写Web服务变得更简单。使用Feign,只需要创建一个接口并注解。它具有可插拔的注解特性，包括Feign注解和JAX-RS注解。Feign同时支持可插拔的编码器和解码器。Spring Cloud对SpringMVC添加了支持，同时在Spring Web中次用相同的HttpMessageConverter。当我们使用Feign的时候，Spring Cloud整和了Ribbon和Eureka去提供负载均衡。

Feign基于Netflix Feign实现，整合了Spring Cloud Ribbon与Spring Cloud Hystrix，除了提供这两者的强大功能之外，它还提供了一种声明式的Web服务客户端定义方式。

Spring Cloud Netflix的微服务都是以HTTP接口的形式暴露的，所以调用方式有：

  • JDK原生的URLConnection
  • Apache的Http Client
  • Netty的异步HTTP Client
  • Spring的RestTemplate
  • Feign

而Feign是一个使用起来更加方便的HTTP客戶端，使用起来就像是调用自身工程的方法，而感觉不到是调用远程方法。Feign还支持可插拔的编码器和解码器，Spring在用的时候增加了对@RequestMapping的处理，Feign的目的是尽量的减少资源和代码来实现和HTTP API的连接。通过自定义的编码解码器以及错误处理，可以编写任何基于文本的HTTP API。

github地址：https://github.com/OpenFeign/feign

在源码中可以看到子模块包括Ribbon和Hystrix，所以Feign是基于Ribbon和Hystrix的声明式服务调用组件。Feign是一种声明式、模板化的HTTP客户端。

2. 来源

Feign使得Java HTTP客户端编写更方便。Feign灵感来源于Retrofit、JAXRS-2.0和WebSocket。Feign最初是为了降低统一绑定Denominator到HTTP API的复杂度，不区分是否支持Restful。

3. 前期准备

  1. 一个服务注册中心tairan-spring-cloud-eureka，端口8761。参考SpringCloud组件：搭建Eureka服务注册中心
  2. 创建tairan-spring-cloud-feign-api核心工程，对外提供api接口。
  3. 创建服务提供者tairan-spring-cloud-feign-privder工程，提供/hello接口，启动三个实例，端口分别为10001，10002，10003，并注册到服务中心。参考SpringCloud组件：将微服务提供者注册到Eureka服务中心
  4. 创建服务消费者tairan-spring-cloud-feign-consumer工程，提供/feign-hello接口，端口号为8080，并注册到服务中心。

4. 构建项目

4.1 创建tairan-spring-cloud-feign-api工程

同样的是采用idea开发工具创建一个SpringBoot项目，然后引入Spring Cloud Feign依赖以及相关依赖，项目的pom.xml内容如下所示：

...//省略部分配置
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.1.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
</dependencies>
...//省略部分配置

注意：网上有的文章说引入的依赖是spring-cloud-starter-feign，其实官方不再推荐使用，推荐使用spring-cloud-starter-openfeign。

4.1.1 创建HelloService接口

在tairan-spring-cloud-feign-api工程中只提供api接口，具体实现由tairan-spring-cloud-feign-privder工程实现。代码如下：

package com.tairan.chapter.feign.api;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.RequestMapping;

@FeignClient(value = "tairan-spring-cloud-feign-provider")
public interface HelloService {

    @RequestMapping("/hello")
    String getMessage() throws Exception;

}

4.2 创建tairan-spring-cloud-feign-privder工程

同样的是采用idea开发工具创建一个SpringBoot项目，然后引入Spring Cloud Feign依赖以及tairan-spring-cloud-feign-api依赖，项目的pom.xml内容如下所示：

...//省略部分配置
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.1.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
    <skipTests>true</skipTests>

    <spring-cloud.version>Greenwich.RC1</spring-cloud.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    
    <dependency>
        <groupId>com.tairan.chapter</groupId>
        <artifactId>tairan-spring-cloud-feign-api</artifactId>
    </dependency>
</dependencies>

<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>
...//省略部分配置

4.2.1 创建HelloController

创建HelloController类，并实现HelloService接口，代码如下：

package com.tairan.chapter.feigin.provider.controller;

import com.tairan.chapter.feign.api.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController implements HelloService {

    @Autowired
    private Environment environment;

    @Override
    public String getMessage() {
        return environment.getProperty("spring.application.name") + ":" + environment.getProperty("server.port", "8080");
    }
}

Environment获取项目配置信息，本接口中返回项目服务名与端口号。

4.3 创建tairan-spring-cloud-feign-consumer工程

同样的是采用idea开发工具创建一个SpringBoot项目，然后引入Spring Cloud Feign依赖以及tairan-spring-cloud-feign-api依赖，项目的pom.xml内容如4.2 创建tairan-spring-cloud-feign-privder工程。

4.3.1 入口类

在应用主类中通过@EnableFeignClients注解开启Feign功能，因为需要注册到服务中心，所以还需要@EnableDiscoveryClient注解，代码如下所示：

package com.tairan.chapter.feign.consumer;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableDiscoveryClient
// 通过@EnableFeignClients注解开启Spring Cloud Feign的支待功能。
@EnableFeignClients("com.tairan.chapter.feign.api")
public class TairanSpringCloudFeignConsumerApplication {

    public static void main(String[] args) {
        SpringApplication.run(TairanSpringCloudFeignConsumerApplication.class, args);
    }

}

4.3.2 创建FeignHelloController类

创建FeignHelloController实现对Feign客户端的调用，代码如下：

package com.tairan.chapter.feign.consumer.controller;

import com.tairan.chapter.feign.api.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class FeignHelloController {

    @Autowired
    private HelloService helloService;

    @RequestMapping("/feign-hello")
    public String getNodeInfo() throws Exception {
        return helloService.getMessage();
    }

}

5. 运行测试

我们已经完成所需工程的创建以及配置工作，接下来我们按照下面的步骤进行执行测试：

  1. 启动服务注册中心tairan-spring-cloud-eureka
  2. 通过如下命令启动tairan-spring-cloud-feign-privder三个实例
java -jar tairan-spring-cloud-feign-provider-1.0-SNAPSHOT.jar --server.port=10001
java -jar tairan-spring-cloud-feign-provider-1.0-SNAPSHOT.jar --server.port=10002
java -jar tairan-spring-cloud-feign-provider-1.0-SNAPSHOT.jar --server.port=10003
  1. 启动tairan-spring-cloud-feign-consumer服务
  2. 访问tairan-spring-cloud-feign-consumer工程的/feign-hello接口，链接：http://localhost:8080/feign-hello

所以服务启动完成后，打开tairan-spring-cloud-eureka管理界面地址：http://localhost:8761，如下图所示：

Eureka Server管理界面

5.1 访问/feign-hello接口

访问链接：http://localhost:8080/feign-hello
连续访问如上接口链接，展示效果如下图所示：

6. 结论

Feign实现了与Ribbon同样的负载均衡的效果。

7. 源码位置

本章源码已经上传到淡若悠然，请结合源码进行学习，感谢阅读。

码云地址（本章源码）：https://gitee.com/litairan/tairan-spring-cloud

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,547评论 6赞 477
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,399评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,428评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,599评论 1赞 274
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,612评论 5赞 365
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,577评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,941评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,603评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,852评论 1赞 297
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,375评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,955评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2赞 342