02 Feign发送get请求

大家接触Feign都是通过Spring Cloud，平时使用的均是Spring MVC的注解。但是Feign是完全不依赖SpringMvc的注解的，是可以直接使用的哟。

1 准备工作

1.1 准备工作：Feign日志打印

Feign内置了日志打印的

• feign.Logger.JavaLogger：使用的java.util.logging.Logger输出，但是日志级别的FINE级别，默认不会输出到控制台
• feign.Logger.ErrorLogger：错误输出。使用的System.err.printf()输出
• feign.Logger.NoOpLogger：什么都不输出，它是Feign的默认使用的Logger实现，也就是不会给控制台输出

1.2 准备工作：定义一个Feign客户端构建器

package study.wyy.feign.java.spi;
import feign.Feign;
import feign.Logger;
import feign.Retryer;


public class FeignClientBuilder<T> {
	// 服务提供者的地址
    public static String HOST = "http://localhost:8001";
    public static <T> T build(Class<T> clazz){
       return Feign.builder()
                // 输出日志到控制台
                .logger(new Logger.ErrorLogger()).logLevel(Logger.Level.FULL)
                // 关闭重试
                .retryer(Retryer.NEVER_RETRY)
                // 404进行编码，404的时候就不会抛出异常了
                .decode404()
                .target(clazz,HOST);
    }
}

1 Get请求入门

1.1 案例

1. 入门代码中的服务提供者模块添加一个get请求

/**
 * 测试一个参数
 *
 * @return
 */
@GetMapping("/get")
public String test01(@RequestParam String name) {
    return name;
}

2. Feign客户端定义

package study.wyy.feign.java.consumer;

import feign.Param;
import feign.RequestLine;

/**
 * @author by wyaoyao
 * @Description
 * @Date 2021/3/20 10:02 上午
 */
public interface GetControllerClient {
    /**
     * 测试一个参数
     *
     * @return
     */
    @RequestLine("GET /feign/provider/get?name={name}")
    String invokeTest01(@Param(value = "name") String name);
}

3. 测试

package study.wyy.feign.java.test;

import org.junit.Before;
import org.junit.Test;
import study.wyy.feign.java.consumer.GetControllerClient;
import study.wyy.feign.java.spi.FeignClientBuilder;

public class GetControllerClientTest {

    private GetControllerClient client;
    @Before
    public void before(){
        client  = FeignClientBuilder.build(GetControllerClient.class);
    }

    @Test
    public void test01(){
        String response = client.invokeTest01("张三");
        System.out.println(response);
    }
}

输出：

[GetControllerClient#invokeTest01] ---> GET http://localhost:8001/feign/provider/get?name=%E5%BC%A0%E4%B8%89 HTTP/1.1
[GetControllerClient#invokeTest01] ---> END HTTP (0-byte body)
[GetControllerClient#invokeTest01] <--- HTTP/1.1 200 (41ms)
[GetControllerClient#invokeTest01] connection: keep-alive
[GetControllerClient#invokeTest01] content-length: 6
[GetControllerClient#invokeTest01] content-type: text/plain;charset=UTF-8
[GetControllerClient#invokeTest01] date: Sat, 20 Mar 2021 04:46:28 GMT
[GetControllerClient#invokeTest01] keep-alive: timeout=60
[GetControllerClient#invokeTest01] 
[GetControllerClient#invokeTest01] 张三
[GetControllerClient#invokeTest01] <--- END HTTP (6-byte body)
张三

1.2 API讲解（一）

上面主要涉及了两个注解

• feign.RequestLine
• feign.Param

1.2.1 RequestLine注解

用于指定请求方法和请求Url模板。
比如：@RequestLine("GET /feign/provider/get?name={name}")，就指定了：

• 请求方式为Get请求
• 请求的url模板为/feign/provider/get?name={name}

// 只能用在方法上
@java.lang.annotation.Target(METHOD) 
@Retention(RUNTIME)
public @interface RequestLine {
  //定义请求方式，请求路径，还有请求参数
  String value();
  // 是否编码/符号，默认是会编码的,也就是转义的意思
  boolean decodeSlash() default true;
	// 默认支持URL传多值，是通过key来传输的。形如：key=value1&key=value2&key=value3
  // CollectionFormat不同的取值对应不同的分隔符，一般不建议改
  CollectionFormat collectionFormat() default CollectionFormat.EXPLODED;
}

使用注意点：

1. 请求方法必须大写：GET，POST，因为底层是通过下面的枚举feign.Request.HttpMethod映射

public enum HttpMethod {
  GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH
}

2. RequestLine注解的首个单词必须是HTTP方法，且必须顶格写（前面不允许有空格），但后面是需要有空格（可以多个）

// 前面不允许有空格（错误实例）
@RequestLine(" GET /feign/provider/get?name={name}")  
String invokeTest01(@Param(value = "name") String name);

// 后面是需要有空格（错误实例）
@RequestLine("GET/feign/provider/get?name={name}")  
String invokeTest01(@Param(value = "name") String name);

// 后面是需要有空格
@RequestLine("GET /feign/provider/get?name={name}")  
String invokeTest01(@Param(value = "name") String name);

// 后面是需要有空格（可以多个）
@RequestLine("GET   /feign/provider/get?name={name}")  
String invokeTest01(@Param(value = "name") String name);

1.2.2 Param注解

通过名称定义模板变量，其值将用于填入上面的模版

package feign;

import java.lang.annotation.Retention;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

@Retention(RUNTIME)
@java.lang.annotation.Target(PARAMETER)  // 只能用在参数上
public @interface Param {

  /**
   * 指定请求模板中的参数名
   *  @RequestLine("GET /feign/provider/get?name={name}")
   * {name}就是模板的中的参数名，对应的形参最后将填充对应的请求模板对应的位置
   */
  String value();

  /**
   * How to expand the value of this parameter, if {@link ToStringExpander} isn't adequate.
   * 如何把参数填充到模板中，默认是调用取toString方法
   */
  Class<? extends Expander> expander() default ToStringExpander.class;

  /**
   * Specifies whether argument is already encoded The value is ignored for headers (headers are
   * never encoded)
   * 是否编码，默认不编码，但是请求头从不编码
   * @see QueryMap#encoded
   */
  boolean encoded() default false;

  interface Expander {

    /**
     * Expands the value into a string. Does not accept or return null.
     */
    String expand(Object value);
  }

  final class ToStringExpander implements Expander {
    @Override
    public String expand(Object value) {
      return value.toString();
    }
  }
}

比如上面的：

@RequestLine("GET /feign/provider/get?name={name}")  
String invokeTest01(@Param(value = "name") String name);
@Test
  public void test01(){
      String response = getControllerClient.invokeTest01("张三");
      System.out.println(response);
  }

调用的时候就是把实参张三，填充到请求url上：feign/provider/get?name=wade

注意1 ：
@Param是不能省略的，即使形参的参数名字和模板中的一致也不可以省略

下面就测试一下：

1. 服务提供者

@GetMapping("/param1")
public String param1(@RequestParam String name){
    return "@Param " + name;
}

3. 客户端
4. 测试

public interface ParamClient {

    /**
     * 测试1: 使用Param注解
     * @param
     * @return
     */
    @RequestLine("GET /feign/provider/param1?name={name}")
    String consumerParam1(@Param("name") String str);
    
    /**
     * 测试1: 不使用Param注解，形参和模板中的参数key对应
     * @param
     * @return
     */
    @RequestLine("GET /feign/provider/param1?name={name}")
    String consumerParam2(String name);
    
    /**
     * 测试1: 不使用Param注解，但是形参和模板中的参数key不对应
     * @param
     * @return
     */
    @RequestLine("GET /feign/provider/param1?name={name}")
    String consumerParam3(String str);
    
}

测试

public class ParamTest {
    private ParamClient client;
    @Before
    public void before(){
        client  = FeignClientBuilder.build(ParamClient.class);
    }
    @Test
    public void testConsumerParam1() {
        String result = client.consumerParam1("Feign");
        System.out.println(result);
    }

    @Test
    public void testConsumerParam2() {
        String s = client.consumerParam2("Feign");
        System.out.println(s);
    }

    @Test
    public void testConsumerParam3() {
        String s = client.consumerParam3("Feign");
        System.out.println(s);
    }

}

只有第一个可以测试通过，第二个第三个都是同一个错误：

[ParamClient#consumerParam3] ---> GET http://localhost:8001/feign/provider/param1 HTTP/1.1  # 参数根本没有拼接
[ParamClient#consumerParam3] Content-Length: 5
[ParamClient#consumerParam3] 
[ParamClient#consumerParam3] Feign
[ParamClient#consumerParam3] ---> END HTTP (5-byte body)
[ParamClient#consumerParam3] <--- HTTP/1.1 405 (18ms)
[ParamClient#consumerParam3] allow: GET
[ParamClient#consumerParam3] connection: keep-alive
[ParamClient#consumerParam3] content-type: application/json
[ParamClient#consumerParam3] date: Thu, 17 Dec 2020 07:54:20 GMT
[ParamClient#consumerParam3] keep-alive: timeout=60
[ParamClient#consumerParam3] transfer-encoding: chunked
[ParamClient#consumerParam3] 
[ParamClient#consumerParam3] {"timestamp":"2020-12-17T07:54:20.980+0000","status":405,"error":"Method Not Allowed","message":"Request method 'POST' not supported","path":"/feign/provider/param1"}
[ParamClient#consumerParam3] <--- END HTTP (166-byte body)

feign.FeignException$MethodNotAllowed: status 405 reading ParamClient#consumerParam3(String)

2 Get请求：请求参数为Map

2.1 案例

1. 服务提供

/**
 * 测试一个Map，一次性传递多个参数
 *
 * @return
 */
@GetMapping("/get/map")
public String test02(@RequestParam Map<String, Object> map) {
    try {
        return new ObjectMapper().writeValueAsString(map);
    } catch (JsonProcessingException e) {
        e.printStackTrace();
        return "error";
    }
}

2. feign客户端

/**
* 测试一个Map，一次性传递多个参数
*/
@RequestLine("GET /feign/provider/get/map?map={map}")
String invokeTest02(@Param("map") Map<String, Object> map);

3. 测试

@Test
public void test02(){
    Map<String, Object> map = new HashMap<>();
    map.put("name","wade");
    map.put("age",28);
    String response = client.invokeTest02(map);
    System.out.println(response);
}

输出：

[GetControllerClient#invokeTest02] ---> GET http://localhost:8001/feign/provider/get/map?map=%7Bname=wade,%20age=28%7D HTTP/1.1
[GetControllerClient#invokeTest02] ---> END HTTP (0-byte body)
[GetControllerClient#invokeTest02] <--- HTTP/1.1 200 (147ms)
[GetControllerClient#invokeTest02] connection: keep-alive
[GetControllerClient#invokeTest02] content-length: 29
[GetControllerClient#invokeTest02] content-type: text/plain;charset=UTF-8
[GetControllerClient#invokeTest02] date: Sat, 20 Mar 2021 09:24:29 GMT
[GetControllerClient#invokeTest02] keep-alive: timeout=60
[GetControllerClient#invokeTest02] 
[GetControllerClient#invokeTest02] {"map":"{name=wade, age=28}"}
[GetControllerClient#invokeTest02] <--- END HTTP (29-byte body)
{"map":"{name=wade, age=28}"}

发现使用@Param注解不对，请求路径上的参数是:

/feign/provider/get/map?map=%7Bname=wade,%20age=28%7D

我们期望的请求格式：

/feign/provider/get/map?name=wade&age=28

在服务提供者打个断点，看一下数据：
这里使用另一个注解feign.QueryMap，并且请求url模板也不对，应该这样

/**
 * 测试一个Map，一次性传递多个参数
 
 */
@RequestLine("GET /feign/provider/get/map")
String invokeTest02(@QueryMap Map<String, Object> map);

再看输出，url就是期望的样子：name=wade&age=28

[GetControllerClient#invokeTest02] ---> GET http://localhost:8001/feign/provider/get/map?name=wade&age=28 HTTP/1.1
[GetControllerClient#invokeTest02] ---> END HTTP (0-byte body)
[GetControllerClient#invokeTest02] <--- HTTP/1.1 200 (3273ms)
[GetControllerClient#invokeTest02] connection: keep-alive
[GetControllerClient#invokeTest02] content-length: 26
[GetControllerClient#invokeTest02] content-type: text/plain;charset=UTF-8
[GetControllerClient#invokeTest02] date: Sat, 20 Mar 2021 09:44:25 GMT
[GetControllerClient#invokeTest02] keep-alive: timeout=60
[GetControllerClient#invokeTest02] 
[GetControllerClient#invokeTest02] {"name":"wade","age":"28"}
[GetControllerClient#invokeTest02] <--- END HTTP (26-byte body)
{"name":"wade","age":"28"}

2.2 API讲解（二）

2.2.1 QueryMap注解

package feign;

import java.lang.annotation.Retention;
import java.util.List;
import java.util.Map;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

@Retention(RUNTIME)
@java.lang.annotation.Target(PARAMETER)
public @interface QueryMap {
  /**
   * Specifies whether parameter names and values are already encoded.
   *
   * @see Param#encoded
   */
  boolean encoded() default false;
}

• 只能用到参数上
• 用于传递多个查询值，拼接在url上
• 只能用于标注map类型

3 Get请求发送：数组或者集合

1. 服务提供者

@GetMapping("/param2")
public String param2(@RequestParam String[] names){
    return "@Param " + names;
}

@GetMapping("/param3")
public String param3(@RequestParam List<String> names){
    return "@Param " + names;
}

2. feign客户端

@RequestLine("GET /feign/provider/param2?names={names}")
public String testArr(@Param("names") String[] names);

@RequestLine("GET /feign/provider/param3?names={names}")
public String testCollection(@Param("names") List<String> names);

3. 测试

@Test
public void testArr(){
    System.out.println(client.testArr(new String[]{"java","python"}));
}

@Test
public void testCollection(){
    List<String> list = new ArrayList<>();
    list.add("java");
    list.add("python");
    System.out.println(client.testCollection(null));
}

数组

[ParamClient#testArr] ---> GET http://localhost:8001/feign/provider/param2?names=%5BLjava.lang.String&names=@4cdbe50f HTTP/1.1
[ParamClient#testArr] ---> END HTTP (0-byte body)
[ParamClient#testArr] <--- HTTP/1.1 200 (324ms)
[ParamClient#testArr] connection: keep-alive
[ParamClient#testArr] content-length: 35
[ParamClient#testArr] content-type: text/plain;charset=UTF-8
[ParamClient#testArr] date: Sun, 21 Mar 2021 04:39:30 GMT
[ParamClient#testArr] keep-alive: timeout=60
[ParamClient#testArr] 
[ParamClient#testArr] @Param [Ljava.lang.String;@282531b4
[ParamClient#testArr] <--- END HTTP (35-byte body)
@Param [Ljava.lang.String;@282531b4

参数names=等于的是的这个数组的地址值，也就说默认还调用数组的toString方法

GET http://localhost:8001/feign/provider/param2?names=%5BLjava.lang.String&names=@4cdbe50f HTTP/1.1

collection：

[ParamClient#testCollection] ---> GET http://localhost:8001/feign/provider/param3?names=java&names=python HTTP/1.1
[ParamClient#testCollection] ---> END HTTP (0-byte body)
[ParamClient#testCollection] <--- HTTP/1.1 200 (4346ms)
[ParamClient#testCollection] connection: keep-alive
[ParamClient#testCollection] content-length: 21
[ParamClient#testCollection] content-type: text/plain;charset=UTF-8
[ParamClient#testCollection] date: Sun, 21 Mar 2021 04:44:30 GMT
[ParamClient#testCollection] keep-alive: timeout=60
[ParamClient#testCollection] 
[ParamClient#testCollection] @Param [java, python]
[ParamClient#testCollection] <--- END HTTP (21-byte body)
@Param [java, python]

可见collection是没有问题

测试feign使用集合，而mvc使用数组

/**
使用使用List测试/feign/provider/param2接口
**/ 
@RequestLine("GET /feign/provider/param2?names={names}")
public String testArr(@Param("names") List<String> names);

@Test
 public void testCollection2(){
     List<String> list = new ArrayList<>();
     list.add("java");
     list.add("python");
     System.out.println(client.testArr(list));
 }

[ParamClient#testArr] ---> GET http://localhost:8001/feign/provider/param2?names=java&names=python HTTP/1.1
[ParamClient#testArr] ---> END HTTP (0-byte body)
[ParamClient#testArr] <--- HTTP/1.1 200 (28215ms)
[ParamClient#testArr] connection: keep-alive
[ParamClient#testArr] content-length: 21
[ParamClient#testArr] content-type: text/plain;charset=UTF-8
[ParamClient#testArr] date: Sun, 21 Mar 2021 04:51:57 GMT
[ParamClient#testArr] keep-alive: timeout=60
[ParamClient#testArr] 
[ParamClient#testArr] @Param [java, python]
[ParamClient#testArr] <--- END HTTP (21-byte body)
@Param [java, python]

可见collection依旧可以是没有问题，所以在传递数组或者集合数据的时候，推荐使用Feign

4 Get请求发送：发送pojo

1. pojo

package study.wyy.feign.model;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONPObject;
import lombok.Data;
import lombok.ToString;

import java.io.Serializable;
import java.util.List;

/**
 * @author: wyaoyao
 * @date: 2020-12-17 13:17
 * @description:
 */
@Data
public class User implements Serializable {

    private String name;
    /**8
     * 年龄
     */
    private Integer age;

    private List<String> hobby;

2. 服务提供者

@GetMapping("/get/pojo/")
public String test05(User user) {
    return user.toString();
}

3. feign客户端

   /**
     * pojo
     *
     * @return
     */
    @RequestLine("GET /feign/provider/get/pojo/")
    String invokeTest05(@QueryMap User user);

4. 测试

@Test
public void test05() {
    User user = new User();
    user.setAge(13);
    user.setName("Wade");
    user.setHobby(Arrays.asList("basketball","football"));
    String response = client.invokeTest05(user);
    System.out.println(response);
}

[GetControllerClient#invokeTest05] ---> GET http://localhost:8001/feign/provider/get/pojo/?name=Wade&age=13&hobby=basketball&hobby=football HTTP/1.1
[GetControllerClient#invokeTest05] ---> END HTTP (0-byte body)
[GetControllerClient#invokeTest05] <--- HTTP/1.1 200 (67ms)
[GetControllerClient#invokeTest05] connection: keep-alive
[GetControllerClient#invokeTest05] content-length: 53
[GetControllerClient#invokeTest05] content-type: text/plain;charset=UTF-8
[GetControllerClient#invokeTest05] date: Sun, 21 Mar 2021 05:03:36 GMT
[GetControllerClient#invokeTest05] keep-alive: timeout=60
[GetControllerClient#invokeTest05] 
[GetControllerClient#invokeTest05] User(name=Wade, age=13, hobby=[basketball, football])
[GetControllerClient#invokeTest05] <--- END HTTP (53-byte body)
User(name=Wade, age=13, hobby=[basketball, football])