SpringCloud组件——OpenFeign

一.使用

1.为什么要使用

OpenFeign是⼀个声明式的WebService客户端。它让微服务之间的调用变得更简单，类似controller调用service，只需要创建⼀个接口，然后添加注解即可使用OpenFeign。

2.引入依赖

加下面的依赖引入到服务消费者中：

<dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

3.启动类添加注解

在服务消费者的启动类上添加注解@EnableFeignClients：

@EnableFeignClients
@SpringBootApplication
public class OrderServiceApplication {public static void main(String[] args) {SpringApplication.run(OrderServiceApplication.class, args);}
}

4.编写OpenFeign客户端

这个接口写在服务消费者哪里：

@FeignClient(value = "product-service")
public interface OpenFeignClient {@RequestMapping("/product/{productId}")ProductInfo get(@PathVariable("productId")Integer productId);
}@FeignClient(value = "product-service",path = "/product")
public interface OpenFeignClient {@RequestMapping("/{productId}")ProductInfo get(@PathVariable("productId")Integer productId);
}

这两种写法都可以。

FeignClient参数说明：
name/value：指定的微服务名称，在Nacos也可以看

path：定义当前FeignClient的统一前缀。

5.修改远程调用的代码

远程调用代码在服务消费者处：

@Resource
OpenFeignClient openFeignClient;@RequestMapping("/{orderId}")
public OrderInfo getOrderById(@PathVariable("orderId") Integer orderId){OrderInfo orderInfo = orderMapper.selectByOrderId(orderId);ProductInfo productInfo=openFeignClient.get(orderInfo.getProductId());orderInfo.setProductInfo(productInfo);return orderInfo;
}

二.参数传递

上面演示的是直接从URL中获取参数，下面介绍其他的参数传递方式。

1.传递单个参数

比如说我们只想传递一个id，我们要使用@RequestParam注解。

服务提供者的代码：

@RequestMapping("/p1")
public String p1(Integer id){return "product-service 接收到参数, id:"+id;
}

服务消费者Feign客户端的代码：

@RequestMapping("/p1")
String p1(@RequestParam("id") Integer id);

2.传递多个参数

比如我们要传递一个id和一个name，也使用@RequestParam注解，给每个参数都写。

服务提供者的代码：

@RequestMapping("/p2")
public String p2(Integer id, String name){return "product-service 接收到参数, id:"+id+",name:"+name;
}

服务消费者Feign客户端的代码：

@RequestMapping("/p2")
String p2(@RequestParam("id") Integer id, @RequestParam("name") String name);

3.传递对象

要使用@SpringQueryMap注解

服务提供者的代码：

@RequestMapping("/p3")
public String p3(ProductInfo productInfo){return "product-service 接收到参数: productInfo"+productInfo.toString();
}

服务消费者Feign客户端的代码：

@RequestMapping("/p3")
String p3(@SpringQueryMap ProductInfo productInfo);

4.传递JSON对象

使用@RequestBody注解

服务提供者的代码：

@RequestMapping("/p4")
public String p4(@RequestBody ProductInfo productInfo){return "product-service 接收到参数: productInfo"+productInfo.toString();
}

服务消费者Feign客户端的代码：

@RequestMapping("/p4")
String p4(@RequestBody ProductInfo productInfo);

三.最佳实践

1.Fegin继承

1）创建一个Module

2）引入相关依赖

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId></dependency>
</dependencies>

3）编写接口

也就是将刚刚上面在服务消费者中写的接口复制到这里。

4）打jar包

5）在服务提供方和服务消费方中引入刚刚的jar包，同时在服务提供方和消费方实现刚刚写的接口

2.抽取

1）创建一个Module

2）引入相关依赖

3）编写API接口

4）打jar包

这四步跟上面是一样的。

5）引入jar包，删除原来服务消费者中的API接口，通过启动类添加扫描路径，让Spring扫描我们刚刚写的接口，在服务消费者中直接调用我们写的接口。

@EnableFeignClients(clients = {ProductInterface.class})
@SpringBootApplication
public class OrderServiceApplication {public static void main(String[] args) {SpringApplication.run(OrderServiceApplication.class, args);}
}