OpenFeign是一个声明式的web服务客户端,让编写web服务客户端变得非常容易,只需创建一个接口并在接口上添加注解即可主要是用在客户端(消费者端)
生产者项目和以前上传的一样,只是需要新建一个消费者即可
生产者地址https://blog.csdn.net/qq_39990869/article/details/108795140
OpenFeign主要就是用在消费者项目中的,内部整合了Ribbon可以实现负载均衡,
Ribbon的介绍请看原来我的博客https://blog.csdn.net/qq_39990869/article/details/108844639
新建消费者
pom,xml
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>com.at.springcloud</groupId>
<artifactId>cloud-api-commons</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
yml文件
server:
port: 80
eureka:
client:
#表示是否将自己注册进EurekaServer默认为true
register-with-eureka: true
#是否从EurekaServer抓取已有的注册消息,默认为true,单节点无所谓,集群必须设置为true才能配合ribbon使用负载均衡
fetch-registry: true
service-url:
#集群版
defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/
#单机版
#defaultZone: http://localhost:7001/eureka/
instance:
instance-id: consumer80
prefer-ip-address: true #访问路径可以显示ip
#Eureka客户端向服务端发送心跳的实际间隔,单位为秒(默认为30秒)
lease-renewal-interval-in-seconds: 1
#Eureka服务端收到最后一次心跳后等待时间上线,单位为秒(默认为90秒) 超时将剔除服务
lease-expiration-duration-in-seconds: 2
启动类@EnableFeignClients此注解就是相当于开启了OpenFeign必须加
@SpringBootApplication
@EnableFeignClients
public class OrderFeignMain {
public static void main(String[] args) {
SpringApplication.run(OrderFeignMain.class,args);
}
}
OpenFeign最主要的一个类,就是需要创建一个接口并使用@FeignClient来完成OpenFeign对生产者的调用
@FeignClient这里放的是eureka上面生产者的名称,如果是其他的注册中心那么就用该生产者在该注册中心上的名称
@GetMapping(value ="/payment/get/{id}")//这里是具体的生产者的接口地址
@Component
//这里放的是eureka上面生产者的名称,如果是其他的注册中心那么就用该生产者在该注册中心上的名称
@FeignClient("CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService {
//这里是具体的生产者的接口地址
@GetMapping(value ="/payment/get/{id}")
//这个方法就是controller中的方法或者是service中的接口方法,用controller中的更方便直接带着接口地址
public CommonResult getPaymentById(@PathVariable("id") Long id);
}
controller类
@RestController
@Slf4j
public class OrderFeignController {
@Autowired
private PaymentFeignService paymentFeignService;
@RequestMapping("/consumer/payment/feign/get/{id}")
public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id){
//直接就可以先调用service一样进行调用
return paymentFeignService.getPaymentById(id);
}
}
OpenFeign超时控制
这里我们需要写一个小小的例子来演示超时场景
案例场景如下:如果一个接口不能1秒内返回数据,OpenFeign会报错,这里解释以下OpenFeign默认的超时时间是1秒钟,如果在进行接口调用时1秒钟没有结果返回那么OpenFeign就会超时。
生产者加一个2秒钟才能返回结果的方法然后让消费者去调用,因为超过了OpenFeign默认的1秒那么肯定会报错。
生产者controller添加一个方法
这只是一个方法,我就是为了让它出错才这么写的
//为了测试OpenFeign超时
@GetMapping(value = "/payment/feign/timeout")
public String paymentFeignTimeout(){
try { TimeUnit.SECONDS.sleep(2);
}catch (Exception e) {
e.printStackTrace();
}
return serverPort;
}
消费者先在OpenFeign定义的service接口中添加生产者controller的地址和方法接口
//这里是具体的生产者的接口地址
@GetMapping(value = "/payment/feign/timeout")
public String paymentFeignTimeout();
然后在消费者controller中进行接口调用
@GetMapping(value = "/consumer/payment/feign/timeout")
public String paymentFeignTimeout(){
return paymentFeignService.paymentFeignTimeout();
}
启动所有的生产者和eureka集群以及消费者项目,在浏览器端访问消费者的地址就会出现如下错误,显示OpenFeign超时
解决超时的方案如下:
因为OpenFeign本身内部集成Ribbon,所以可以在yml文件中使用Ribbon来解决OpenFeign超时问题。
yml文件修改如下:
server:
port: 80
eureka:
client:
#表示是否将自己注册进EurekaServer默认为true
register-with-eureka: true
#是否从EurekaServer抓取已有的注册消息,默认为true,单节点无所谓,集群必须设置为true才能配合ribbon使用负载均衡
fetch-registry: true
service-url:
#集群版
defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/
#单机版
#defaultZone: http://localhost:7001/eureka/
instance:
instance-id: consumer80
prefer-ip-address: true #访问路径可以显示ip
#Eureka客户端向服务端发送心跳的实际间隔,单位为秒(默认为30秒)
lease-renewal-interval-in-seconds: 1
#Eureka服务端收到最后一次心跳后等待时间上线,单位为秒(默认为90秒) 超时将剔除服务
lease-expiration-duration-in-seconds: 2
#下面是添加的超时配置五秒钟
ribbon:
ReadTimeout: 5000
ConnectTimeout: 5000
再次运行项目就可以看到消费者运行成功。
OpenFeign日志打印
要实现日志打印需要写一个配置类
@Configuration
public class FeignConfig {
@Bean
Logger.Level feignLoggerLevel(){
return Logger.Level.FULL;
}
}
当配置类写完后我们就需要在yml文件中配置一下日志打印的级别
配置如下:
server:
port: 80
eureka:
client:
#表示是否将自己注册进EurekaServer默认为true
register-with-eureka: true
#是否从EurekaServer抓取已有的注册消息,默认为true,单节点无所谓,集群必须设置为true才能配合ribbon使用负载均衡
fetch-registry: true
service-url:
#集群版
defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/
#单机版
#defaultZone: http://localhost:7001/eureka/
instance:
instance-id: consumer80
prefer-ip-address: true #访问路径可以显示ip
#Eureka客户端向服务端发送心跳的实际间隔,单位为秒(默认为30秒)
lease-renewal-interval-in-seconds: 1
#Eureka服务端收到最后一次心跳后等待时间上线,单位为秒(默认为90秒) 超时将剔除服务
lease-expiration-duration-in-seconds: 2
ribbon:
ReadTimeout: 5000
ConnectTimeout: 5000
#此处就是新配置的日志打印
logging:
level:
#日志级别
com.atguigu.springcloud.service.PaymentFeignService: debug
然后运行项目,访问消费者的接口就能够在后台的控制台看到打印的具体的日志。