Spring Cloud OpenFeign

作为Spring Cloud的子项目之一,Spring Cloud OpenFeign以将OpenFeign集成到Spring Boot应用中的方式,为微服务架构下服务之间的调用提供了解决方案。首先,利用了OpenFeign的声明式方式定义Web服务客户端;其次还更进一步,通过集成Ribbon或Eureka实现负载均衡的HTTP客户端。

Spring Cloud OpenFeign的最新版本是2018.8发布的2.0.1.RELEASE。

在Spring Cloud OpenFeign中,除了OpenFeign自身提供的标注(annotation)之外,还可以使用JAX-RS标注,或者Spring MVC标注。下面还是以OpenFeign标注为例介绍用法。

1. OpenFeign的标注@FeignClient和@EnableFeignClients

OpenFeign提供了两个重要标注@FeignClient和@EnableFeignClients。

@FeignClient标注用于声明Feign客户端可访问的Web服务。

@EnableFeignClients标注用于修饰Spring Boot应用的入口类,以通知Spring Boot启动应用时,扫描应用中声明的Feign客户端可访问的Web服务。

1) @FeignClient标注的参数

    name, value (默认""),两者等价

    qualifier (默认"")

    url (默认"")

    decode404 (默认false)

    configuration (默认FeignClientsConfiguration.class)

    fallback (默认void.class)

    fallbackFactory (默认void.class)

    path (默认"")

    primary (默认true)

2) @FeignClient标注的configuration参数

@FeignClient标注的configuration参数,默认是通过FeignClientsConfiguration类定义的,可以配置Client,Contract,Encoder/Decoder等。

FeignClientsConfiguration类中的配置方法及默认值如下:

    feignContract: SpringMvcContract

    feignDecoder: ResponseEntityDecoder

    feignEncoder: SpringEncoder

    feignLogger: Slf4jLogger

    feignBuilder: Feign.Builder

    feignClient: LoadBalancerFeignClient(开启Ribbon时)或默认的HttpURLConnection

3) 定制@FeignClient标注的configuration类

@FeignClient标注的默认配置类为FeignClientsConfiguration,我们可以定义自己的配置类如下:

    @Configuration

    public class MyConfiguration {

    @Bean

    public Contract feignContract(...) {...}


    @Bean

    public Encoder feignEncoder() {...}


    @Bean

    public Decoder feignDecoder() {...}


    ...

    }

然后在使用@FeignClient标注时,给出参数如下:

    @FeignClient(name = "myServiceName", configuration = MyConfiguration.class, ...)

    public interface MyService {

        @RequestMapping("/")

        public String getName();


        ...

    }

当然,定制@FeignClient标注的configuration类还可以有另一个方法,直接配置application.yaml文件即可,示例如下:

    feign:

      client:

    config:

      feignName: myServiceName

    connectTimeout: 5000

    readTimeout: 5000

    loggerLevel: full

    encoder: com.example.MyEncoder

    decoder: com.example.MyDecoder

    contract: com.example.MyContract

4) @EnableFeignClients标注的参数

    value, basePackages (默认{})

    basePackageClasses (默认{})

    defaultConfiguration (默认{})

    clients (默认{})

2. 使用OkHttpClient作为client的Feign客户端

在FeignAutoConfiguration的预配置基础上,要使用OkHttpClient作为client的Feign客户端非常简单,步骤如下:

1) pom.xml中,加入对OkHttp的依赖

    <dependency>

      <groupId>com.squareup.okhttp3</groupId>

      <artifactId>okhttp</artifactId>

      <version>3.10.0</version>

    </dependency>

2) application.yaml中

    feign:

        okhttp:

            enabled: true

或者application.properties中,

feign.okhttp.enabled = true

3) 必要时,还可以在Spring配置类中定义一个Spring Bean方法,返回OkHttpClient对象,以定制OkHttpClient。

3. 使用Apache HttpComponents HttpClient作为client的Feign客户端

在FeignAutoConfiguration的预配置基础上,要使用Apache HttpComponents HttpClient作为client的Feign客户端非常简单,步骤如下:

1) pom.xml中,加入对Apache HttpClient的依赖 (略)

2) application.yaml中,

    feign:

        httpclient:

            enabled: true

或者application.properties中,

feign.httpclient.enabled = true

3) 必要时,定义Spring Bean定制返回一个ClosableHttpClient对象

4. 应用示例

1) 创建Spring Boot应用

在应用中,通过Feign客户端访问另一个服务(localhost:8888)

2) pom.xml

    <dependencies>

        <dependency>

          <groupId>org.springframework.cloud</groupId>

          <artifactId>spring-cloud-openfeign</artifactId>

          <version>2.0.1.RELEASE</version>

          <type>pom</type>

          <scope>import</scope>

        </dependency>

        <dependency>

            <groupId>org.springframework.cloud</groupId>

            <artifactId>spring-cloud-starter-openfeign</artifactId>

        </dependency>

    </dependencies>

3) 定义服务接口

    @FeignClient(name="myServiceName", url="localhost:8888")

    public interface MyService {

    @RequestMapping("/")

    public String getName();

    }

4) 定义访问Web服务的REST控制器类

    @RestController

    public class MyController {

    @Autowired

    MyService myService;


    @RequestMapping("/hello")

    public String helloName() {

    return myService.getName();

    }

    }

5) 编写Spring Boot应用的入口类

    @SpringBootApplication

    @EnableFeignClients

    public class MyApplication {

        public static void main(String[] args) {

            SpringApplication.run(MyApplication.class, args);

        }

    }

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容