传参方式
feign传参要保证消费者与服务提供者的参数是一致的,同时方法的签名也要保持一致。
- 通过URL传递参数,GET请求,参数列表使用@PathVariable(");
- GET请求,每个基本参数必须加@RequestParam(“”);
- 如果是Post请求,而且是对象集合等参数,必须加RequestBodu或者RequestParam
通过URL传递参数(单个或者多个)
所谓的通过URL传递参数,即将参数放置于url中,在注解@GetMapping
中通过大括号标识,如/pathVariable/{name}/{age}
。在provider模块order-service中新增请求接口:
@GetMapping("/pathVariable/{name}/{age}")
public String pathVariable(@PathVariable("name") String name, @PathVariable("age") Integer age) {
return "通过url传递参数,name: " + name + ",age: " + age;
}
相应的,在consumer模块的feign接口中添加相应的方法签名,即便是在方法参数前,也不能忘记路径参数注解。
请求参数(一个或多个)
除了在url中携带参数外,还可以通过在请求后面拼接参数,通过?
和参数
和&
组成。在后端接收参数时每个参数都要使用@RequestParam
注解进行标注;通过这种传参方式,方法参数会通过变量名与参数名进行匹配。
首先在provider模块中新增一个请求接口。
@GetMapping("/requestParam")
public String requestParam(@RequestParam String name, @RequestParam Integer age) {
return "通过请参数传递参数,name: " + name + ",age: " + age;
}
第二步,在feignClient中添加上方方法的签名:
然后我们就可以在consumer模块中进行调用了,不再赘述。
传递对象
当我们需要传递对象时,通常需要涉及到POST请求,另一方面我们一般会在方法参数前使用注解@RequestBody
,会自动的将json格式字符串转换为规定的对象。因此我们使用Feign时,也不能忘记对象前的@RequestBody
注解。
第一步,由于我们要传递对象参数,先去创建一个Order
对象:
@NoArgsConstructor
@AllArgsConstructor
@Data
@Builder
public class Order {
private String name;
private Double price;
}
这里我们使用了一个@Builder
注解,是用来简化实例对象的,大家感兴趣可以了解下。
第二步,在provider 模块新增一个请求接口:
@PostMapping("/objectParam")
public String requestObject(@RequestBody Order order) {
return "通过对象传递了参数,内容:" + order.toString();
}
第三步,我们去consumer模块为feignClient增加相应的方法签名;
最后就可以进行调用了。
传参一个对象和一个参数
假如我们需要传递一个对象参数和另一个参数,应该如何传参?
我们可以使用@RequestBody
和@RequestParam
两个注解,当然请求方式是POST。
我们依旧在provider中新增一个请求接口,该接口需要一个对象参数,和一个基本类型的参数,如下:
@PostMapping("/requestObjectAndParam")
public String requestObjectAndParam(@RequestBody Order order, @RequestParam String remark) {
return "传递一个对象参数和一个基本类型对象参数";
}
第二步,在consumer模块的feignClient中新增对应的方法签名:
最后我们调用测试一下:
@GetMapping("/testObjectAndParam")
public String testObjectAndParam() {
return userOrderFeign.requestObjectAndParam(Order.builder().name("雨伞").price(55.0).build(), "备注");
}