spring cloud feign的基本使用

在上一节，我们学会了如何使用ribbon进行来进行服务之间的调用，但是那种需要通过RestTemplate来进行调用而且当参数比较多时，使用起来就比较麻烦。那么有没有一种调用远程方法（别的服务）就像调用本地方法呢？feign就是这样的一种声明式的http客户端，使调用远程方法就像调用本地方法一样。

前置条件-工程的创建

eureka-server
    |- 服务注册中心
feign
    product-provider-8083
    product-provider-8084
        |- 服务提供者
    product-consumer-8082
        |- 服务消费者，使用feign进行调用(演示Feign调用各种方法的参数) 

需求：

1、使用feign完成基本的curd操作
    2、使用feign调用各种传参的方法，比如传递对象，传递map，同时传递多个参数等

实现步骤：

1、新建服务提供者：
        product-provider-8083和product-provider-8084，就是一个普通的spring boot工程，对外暴露基本的crud api.
    2、新建服务提供者
        product-consumer-8082
        |- 启动类上增加 @EnableFeignClients 注解
        |- client接口上需要增加 @FeignClient(name="上面product-provider-%d工程中的spring.application.name的值") 注解
   
    3、@FeignClient注解下的方法注意事项：
        1、@PathVariable注解的使用
            使用这个注解的使用，必须要写里面的name或value的值，即@PathVariable("field"),不写启动报错
        2、返回值可以返回实体类或Map类型等等
        3、@RequestParam注解传递参数的问题
            |- 不存在@RequestParam注解
                >> 请求类型将会变成post请求，即使你在方法上指定为get也不行。这个时候可以存在一个没有带注解的参数
                   ** 示例：
                      1、  @GetMapping("product/selectByProductIdAndName")
                           Map<String, Object> selectByProductIdAndNameMap(Map<String, Object> params);
                           结果：此时是post请求，即使上方加上了@GetMapping注解也会是发送post请求
                      2、  @GetMapping("product/selectByProductIdAndName")
                           Map<String, Object> selectByProductIdAndName(String productId, String productName)
                           结果：程序启动报错，因为存在多个参数没有@RequestParam注解
            |- 存在@RequestParam注解
                >> 不指定value的情况下，必须加载Map类型的参数上，里面的值会附加在url后面
                    ** 示例：
                        1、  @GetMapping("product/selectByProductIdAndName")
                             Map<String, Object> selectByProductIdAndNameMap(@RequestParam Map<String, Object> params);
                             结果：没有指定value,注解加载map类型的参数上
                        2、  @GetMapping("product/selectByProductIdAndName")
                             Map<String, Object> selectByProductIdAndName(@RequestParam String productId, String productName);
                             结果：启动报错,没有指定value的值，且参数不是map类型
                        3、  @GetMapping("product/selectByProductIdAndName")
                             Map<String, Object> selectByProductIdAndName(@RequestParam("productId") String productId, String productName);
                             结果：由于后面有一个参数没有加上@RequestParam注解，此时这个请求就变成了post请求发送，即使申明的是get请求
                        4、  @GetMapping("product/selectByProductIdAndName")
                             Map<String, Object> selectByProductIdAndName(@RequestParam("productId") String productId, @RequestParam("productName") String productName);
                             结果：正常的get请求

            |- 传递对象
                >> 服务提供方在控制层使用的是@RequestBody接收参数
                    ** 调用方 feignClient 的写法： 直接传递一个对象（默认就是@RequestBody）
                        参考：com.huan.study.feign.ProductServiceFeign.addProduct(@RequestBody ProductVO productVO); 此时前面的@RequestBody可以不写
                >> 服务提供方没有使用@RequestBody进行接收
                    ** 调用方 feignClient 的写法： 需要传递一个Map
                        参考：com.huan.study.feign.ProductServiceFeign.updateProduct(@RequestParam Map<String,Object> params);
                            1、需要以Map的参数传递
                            2、@RequestParam注解不可少

代码结构：

代码：

1、服务提供者和注册中心（略）
2、声明式客户端feign的编写

@FeignClient(name = "product-provider")
public interface ProductServiceFeign {

	/**
	 * PathVariable 注解使用时，必须里面要有值,即@PathVariable("")或@PathVariable(name="")
	 *
	 * @param productId
	 * @return
	 */
	@GetMapping("product/selectOne/{productId}")
	ProductVO selectByProductId(@PathVariable("productId") String productId);

	/**
	 * 去掉 @RequestParam 注解将变成post请求,加上为get请求
	 *
	 * @param params
	 * @return
	 */
	@GetMapping("product/selectByProductIdAndName")
	Map<String, Object> selectByProductIdAndNameMap(@RequestParam Map<String, Object> params);

//	程序启动报错，存在多个参数没有@requestParam注解
//	@GetMapping("product/selectByProductIdAndName")
//	Map<String, Object> selectByProductIdAndName(String productId, String productName);

//  程序启动报错，没有指定value的值，且参数不是map
//	@GetMapping("product/selectByProductIdAndName")
//	Map<String, Object> selectByProductIdAndName(@RequestParam String productId, String productName);

//  由于后面有一个参数没有加上@RequestParam注解，此时这个请求就变成了post请求发送，即使申明的是get请求
//	@GetMapping("product/selectByProductIdAndName")
//	Map<String, Object> selectByProductIdAndName(@RequestParam("productId") String productId, String productName);

	@GetMapping("product/selectByProductIdAndName")
	Map<String, Object> selectByProductIdAndName(@RequestParam("productId") String productId, @RequestParam("productName") String productName);

	@PostMapping("product/addProduct")
	Map<String, Object> addProduct(@RequestBody ProductVO productVO);

	@PostMapping("product/updateProduct")
	Map<String, Object> updateProduct(@RequestParam Map<String, Object> params);

	@PostMapping("product/delete")
	Map<String, Object> delteProduct(@RequestParam("productId") String productId);

}

 

参数传递对应图：