logo头像
Snippet 博客主题

RESTful风格的微服务-Feign调用服务

微服务 restful 2018/03/11

现在的微服务已经有种趋势是，微服务之间的调用越来越多采用HTTP协议。如何优雅地高效地调用HTTP服务是我们需要考虑的一个问题。前两天已经简单对比了一下常用的几个HTTP client工具，参见：RESTful风格的微服务-HTTP client，最后说到个人推荐使用 Feign + Http Client。

00 前言

可能你会说，一般的微服务框架都有完整的服务提供者和服务消费者以及服务注册中心解决方案，比如Dubbo和Spring Cloud等，按照各自标准的方式就能轻松实现服务调用。而最近兴起的Service Mesh的微服务解决方案，是将微服务治理相关的功能作为基础设施服务，独立于业务功能服务开发之外，而且不限制实现服务发布和服务消费所实现的框架，因此我们有必要单独探索一下HTTP client的用法。

从前两天我的试用感受上来看，比较喜欢使用 Feign + Http Client (apache.httpcomponents) 这套HTTP服务调用工具。我的所有的测试代码都是基于 Spring Boot 2.0 框架写的，Spring Boot 也是个人目前比较喜欢的服务开发框架，能让我快速的构建测试基础项目。

01 HTTP请求响应

首先介绍一下HTTP协议中本文所关系的知识点，主要是如何通过HTTP协议发送数据和接收数据。

Internet的基本协议是TCP/IP协议，目前广泛使用的FTP、HTTP协议都是基于TCP/IP的，HTTP是Web应用最主要使用的协议。HTTP的版本也从刚开始的1.0到现在普遍使用的1.1，还有逐渐全面支持的2.0，HTTP协议的快速发展也使其用途更加广泛。

  • 请求报文分为：请求行、请求头、请求体。
  • 响应报文分为：响应行、响应头、响应体。

本文主要介绍的是HTTP client的使用方式，因此我们详细介绍一下请求报文：

  • 请求行：请求方法、请求URL、HTTP协议及版本；
  • 请求头：Accept、Content-Type、Host、Cookie、Referer、Cache-Control等；
  • 请求体：就是请求数据；

在我们的实际使用过程中，不止是请求体能携带数据发送至服务器端，携带数据的方式分为以下四种：

  • Query Parameter，就是常见的请求url问号（?）后面的部分（例如，?name=rabbitGYK&age=125）；
  • Path Parameter，这种数据是作为url的一部分出现的（例如，/person/rabbitGYK）；
  • Request Body，这是实实在在放在了HTTP协议的数据部分，常见的POST方法提交form表单；
  • Request Header，经常在Cookie中放置一些数据，后者通过给某个header设置特定的value；

请求方法：

方法（操作） 意义
GET 请求读取由URL所标记的信息
POST 向服务器提交信息
PUT 在指明的URL下存储一个文档
DELETE 删除指明的URL所标记的资源
HEAD 请求读取由URL所标记的信息的首部
TRACE 用来进行环回测试的请求报文
OPTIOON 请求一些选项的信息
CONNECT 用于代理服务器

其中，前面四个方法是我们在微服务设计中经常用到的，在使用的时候我们经常关注它们是否是幂等性操作，GET、PUT、DELETE都是幂等操作，POST不是，以下进行分析：

  • 首先GET请求很好理解，对资源做查询多次，此实现的结果都是一样的。
  • PUT请求的幂等性可以这样理解，将A修改为B，它第一次请求值变为了B，再进行多次此操作，最终的结果还是B，与一次执行的结果是一样的，所以PUT是幂等操作。
  • 同理可以理解DELETE操作，第一次将资源删除后，后面多次进行此删除请求，最终结果是一样的，将资源删除掉了。
  • POST不是幂等操作，因为一次请求添加一份新资源，二次请求则添加了两份新资源，多次请求会产生不同的结果，因此POST不是幂等操作。

02 Feign的示例

我做的这个测试实践是基于spring boot 2.0的项目，需要首先在SPRING INITIALIZR生成基础的spring boot项目。然后具体的操作步骤如下：

  1. 引入依赖jar包
<!-- feign核心包 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-core</artifactId>
    <version>9.5.1</version>
</dependency>
<!-- feign使用jackson数据编码 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-jackson</artifactId>
    <version>9.5.1</version>
</dependency>
<!-- jackson的jar在spring boot的项目中本身就已经引入了，不需要单独引入 -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.9.4</version>
</dependency>
<!-- feign的http client底层实现使用apache httpcomponents httpclient -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
    <version>9.5.1</version>
</dependency>
<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.5</version>
</dependency>
  1. 编写调用服务的HTTP client代码
package com.rabbit.boot.consumer.service;

import com.rabbit.boot.consumer.common.ResultEntity;
import com.rabbit.boot.consumer.model.Person;
import feign.Headers;
import feign.Param;
import feign.RequestLine;

import java.util.List;

/**
 * @Author: guoyankui
 * @DATE: 06/03/2018 10:24 AM
 */
@Headers({"Accept: application/json", "Host: web"})
public interface PersonService {

    /**
     * GET Request Body 只有底层使用ApacheHttpClient，可以这么用
     * HttpURLConnection（JDK）：这种用法会将get方法自动转为post
     * OkHttpClient：这种用法会报错，method GET must not have a request body.
     * @param person
     * @return
     */
    @RequestLine("GET /person/name")
    @Headers("Content-Type: application/json")
    ResultEntity<String> getPersonInfo(Person person);

    /**
     * GET Uri Template
     * @param name 使用@Param注解是将参数放在Uri Template中的占位符
     * @return
     */
    @RequestLine("GET /person/info?name={name}")
    @Headers("Content-Type: application/json")
    ResultEntity<Person> getPersonInfo(@Param("name") String name);

    /**
     * GET Uri Template
     * @param age
     * @param male
     * @return 返回复杂参数
     */
    @RequestLine("GET /persons?age={age}&male={male}")
    @Headers("Content-Type: application/json")
    ResultEntity<List<Person>> getPersons(@Param("age") Integer age, @Param("male") Boolean male);

    /**
     * POST Request Body
     * @param person feign中这种传递object（标准POJO）的方式，是将参数放在了Request Body中
     * @return
     */
    @RequestLine("POST /person")
    @Headers("Content-Type: application/json")
    ResultEntity<Person> addPerson(Person person);

    /**
     * POST Uri Template 也可以
     * @param name
     * @return
     */
    @RequestLine("POST /name?name={name}")
    @Headers("Content-Type: application/json")
    ResultEntity<String> getName(@Param("name") String name);

    /**
     * PUT Uri Template
     * @param name
     * @param age
     * @return
     */
    @RequestLine("PUT /person/{name}?age={age}")
    @Headers("Content-Type: application/json")
    ResultEntity<Person> updatePerson(@Param("name") String name, @Param("age") Integer age);

    /**
     * PUT Request Body
     * @param person
     * @return
     */
    @RequestLine("PUT /person/info")
    @Headers("Content-Type: application/json")
    ResultEntity<Person> updatePersonOne(Person person);

    /**
     * DELETE Uri Template
     * @param name
     * @return
     */
    @RequestLine("DELETE /person/{name}")
    @Headers("Content-Type: application/json")
    ResultEntity<Person> deletePerson(@Param("name") String name);

    /**
     * DELETE Request Body
     * @param person
     * @return
     */
    @RequestLine("DELETE /person/info")
    @Headers("Content-Type: application/json")
    ResultEntity<Person> deletePersonOne(Person person);
}
  1. 利用Feign构建客户端实例
private String baseUrl = "http://127.0.0.1:9999/boot-linkerd-test";

private PersonService personService = Feign.builder().client(new ApacheHttpClient())
            .encoder(new JacksonEncoder())
            .decoder(new JacksonDecoder()).target(PersonService.class, baseUrl);

其中，client(new ApacheHttpClient())是指定使用Apache Http client作为发起HTTP请求的底层支撑，encoder(new JacksonEncoder()) 是指定请求数据使用Jackson API编码，decoder(new JacksonDecoder())是指定对响应数据使用Jackson API解码，target(PersonService.class, baseUrl)中指定了构建出来的服务调用客户端类型，以及基础URL，baseUrl 加上 @RequestLine 中的URL部分组成完整的服务端URL。

  1. 调用服务
ResultEntity<String> resultEntity = personService.getPersonInfo(person);
ResultEntity<Person> resultEntity = personService.getPersonInfo(name);
ResultEntity<List<Person>> persons = personService.getPersons(age, male);
ResultEntity<Person> resultEntity = personService.addPerson(person);
ResultEntity<String> resultEntity = personService.getName(name);
ResultEntity<Person> person = personService.updatePerson(name, age);
ResultEntity<Person> person1 = personService.updatePersonOne(person);
ResultEntity<Person> person = personService.deletePerson(name);
ResultEntity<Person> person1 = personService.deletePersonOne(person);

从上面的代码示例可以看出，就像调用普通的方法一样调用服务，优雅吧！

03 总结

本文从HTTP协议的相关知识开始，介绍了Feign的简单用法，选取的示例相对来说比较全面，包含了GET、POST、PUT、DELETE四种常用的请求方法，以及分别使用URI Template和Request Body传递参数的方式，还有请求头的设置方法。

个人非常喜欢Feign这个HTTP服务的调用工具，让人感觉到，原来http协议的接口调用也能像调用本地方法一样使用，再也不怕写不出整洁的代码了。

转载声明：商业转载请联系作者获得授权,非商业转载请注明出处 © rabbitGYK
上一篇
Copyright © 2018 | Powered by Hexo | rabbitGYK