Java之SpringCloud Alibaba【二】【微服务调用组件Feign】

Java之SpringCloud Alibaba【一】【Nacos一篇文章精通系列】 跳转
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】 跳转
Java之SpringCloud Alibaba【三】【微服务Nacos-config配置中心】 跳转
Java之SpringCloud Alibaba【四】【微服务 Sentinel服务熔断】 跳转
Java之SpringCloud Alibaba【五】【微服务 Sentinel整合openfeign进行降级】 跳转
Java之SpringCloud Alibaba【六】【Alibaba微服务分布式事务组件—Seata】 跳转
Java之SpringCloud Alibaba【七】【Spring Cloud微服务网关Gateway组件】 跳转
Java之SpringCloud Alibaba【八】【Spring Cloud微服务Gateway整合sentinel限流】 跳转
Java之SpringCloud Alibaba【九】【Spring Cloud微服务Skywalking】 跳转

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】

    • 一、Java项目当中如何实现
    • 二、Feign
      • 1、什么是Feign
      • 2、SpringCloud Alibaba 快速整合`OpenFeign`
        • 1)工程搭建
        • 2)引入依赖
        • 3)编写调用接口`+@FeignClient`注解
        • 4)添加feign接口和方法
        • 5)完善调用服务的方法
      • 3、SpringCloud Feign的自定义配置和使用
        • 1)日志配置
        • 2)启动测试
        • 3)契约配置
        • 4)超时时间配置
      • 4、自定义拦截器实现认证逻辑

一、Java项目当中如何实现

1、HttpClient
HitpoClient 是Aoache Jlkracommon下的子项目,用来提供高效的、最新的、功能丰富的支持Htp 协议的客户端牌程工具包,并且它支持HTP协议最新版本和建议。Hitrolient相比(特统JDK自带URLConnection,提升了易用性和灵活性,使客户端发送HTTP请求变得容易,提高了开发的效率。

2、OKhttp
一个处理网络请求的开源项目,是安卓谎最火的轻星级框架,由Squre公司贡献,用于替代HTqAuiComection和AeachetHpaClen, Nitltp拥有简洁的APO、高效的性能,并支持多种协议(HTP2
和SPDY)。

3、HttpURLConnection
HitoURLConection是Java的标准类,它继承自URLComecdion,可用于向指定网站发送GET请求.POST请求。HibpURLComecdion使用比较复杂,不像HitpLClent 那样容易使用.
4、RestTemplate WebClient

RestTremplate是Spring提供的用于访问Rest服务的客户端,RestTemplate 提供了多种便捷访问远程HTTP服务的方法,能够大大提高客户端的编写效率。上面介绍的是最常见的几种调用接口的方法,我们下面要介绍的方法比上面的更简单、方便,它就是Feign.

二、Feign

1、什么是Feign

Feign是Neflix开发的声明式、模板化的HTTP客户端,其灵感来自Retrofit、JAXRS-2.0以及WebSocket。Feign可帮助我们更加便捷、优雅地调用HTTP API,Feign支持多种注解,例如Feign自带的注解或者JAX-RS注解等。

Sping cloud openfeign 对Feign进行了增强,使其支持Spring MVC注解,另外还整合了Ribbon和Nacos,从而使得Feign的使用更加方便。
优势

Fegn可以做到使用HTP请求远程服务时就像调用本地方法一样的体验,开发者完全感知不到这是远程方法,更感知不到这是个HTTP请求。它像Dubbo一样,consumer直接调用接口方法调用provider,而不需要通过常规的HttpClient构造请求再解析返回数据。

它解决了让开发者调用远程接口就跟调用本地方法一样,无需关注与远程的交互细节,更无需关注分布式环境开发。

2、SpringCloud Alibaba 快速整合OpenFeign

1)工程搭建

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第1张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第2张图片

  <artifactId>order-openfeignartifactId>

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第3张图片

 <module>order-openfeignmodule>

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第4张图片

2)引入依赖

<dependency>
	<groupId>org.springframework.cloudgroupId>
	<artifactId>spring-cloud-starter-openfeignartifactId>
dependency>

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第5张图片

3)编写调用接口+@FeignClient注解

复制之前的的order-nacos模块工程
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第6张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第7张图片

4)添加feign接口和方法
/*
*
* 2、添加feign接口和方法
* name 指定调用rest接口所对应的服务名
* path 指定调用的rest接口所在的StockController指定的@RequestMapping
* */
@FeignClient(name = "stock-service",path = "/stock")
public interface StockFeignService {
    // 声明需要调用的rest接口对应的方法
    @RequestMapping("/reduct")
    String reduct();
}
/*
上面的内容是和下面是一一对应的

@RestController
@RequestMapping("/stock")
public class StockController {
    @Value("${server.port}")
    String port;
    @RequestMapping("/reduct")
    public String reduct(){
        System.out.println("扣减库存");
        return "扣减库存:"+port;
    }
}
*/
5)完善调用服务的方法
@SpringBootApplication
@EnableFeignClients
public class OrderApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class);
    }
}

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第8张图片

@RestController
@RequestMapping("/order")
public class OrderController {

    @Autowired
    private StockFeignService stockFeignService;

    @RequestMapping("/add")
    public String add(){
        System.out.println("下单成功");
        String msg = stockFeignService.reduct();
        return "Hello Feign"+msg;
    }

}

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第9张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第10张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第11张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第12张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第13张图片
http://localhost:8040/order/add
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第14张图片
刷新页面
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第15张图片

3、SpringCloud Feign的自定义配置和使用

Feign提供了很多的扩展机制,让用户可以更加灵活的使用。

1)日志配置

有时候我们遇到Bug,比如接口调用失败、参数没收到等问题,或者想看看调用性能,就需要配置Feign的日志了,以此让Feign 把请求信息输出来。
1、日志配置

//注意:此处配置@configuration注解就会全局生效,如果想指定对应微服务生效,就不能配置
public class Feignconfig {
	**
	* 日志级别
	*	@return
	* /
	@Bean
	public Logger.Level feignLoggerLevel() {
		return Logger.Level.FULL;
	}
}

通过源码可以看到日志等级有4种,分别是:

  • NONE【性能最佳,适用于生产】:不记录任何日志(默认值)。
  • BASIC【适用于生产环境追踪问题】∶仅记录请求方法、URL、响应状态代码以及执行时间。
  • HEADERS:记录BASIC级别的基础上,记录请求和响应的header
  • FULL【比较适用于开发及测试环境定位问题】︰记录请求和响应的headerbody和元数据。

2、局部配置,让调用的微服务生效,在@FeignClient注解中指定使用的配置类

@Feignclient(value = "mall-order" ,path = "/order" ,configuration = FeignConfig.class)
public interface OrderFeignservice{
	RequestMapping("/findorderByUserId/{userId}")
	public R findOrderByUserId(@Pathvariable("userId" ) Integer userId);
}

创建新的nacos
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第16张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第17张图片

    <artifactId>product-nacosartifactId>

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第18张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第19张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第20张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第21张图片

完善ProductController
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第22张图片


@RestController
@RequestMapping("/product")
public class ProductController {

    @Value("${server.port}")
    String port;

    @RequestMapping("/{id}")
    public String add(@PathVariable Integer id){
        System.out.println("查询商品:"+id);
        return "查询商品"+id+":"+port;
    }
}

ProductApplication
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第23张图片


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

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第24张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第25张图片

/*
* 全部配置 当使用@Configuration将会作用所有的服务提供方
* 局部配置 如果只想针对某一个服务进行配置,就不加@Configuration
* */
@Configuration
public class FeignConfig {

    @Bean
    public Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }

}

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第26张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第27张图片

@FeignClient(name = "product-service",path = "/product")
public interface ProductFeignService {

    @RequestMapping("/{id}")
    public String get(@PathVariable("id") Integer id);

}

完善OrderController
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第28张图片

@RestController
@RequestMapping("/order")
public class OrderController {

    @Autowired
    private StockFeignService stockFeignService;

    @Autowired
    ProductFeignService productFeignService;

    @RequestMapping("/add")
    public String add(){
        System.out.println("下单成功");
        String s = stockFeignService.reduct();
        String p = productFeignService.get(1);
        return "Hello Feign"+s+p;
    }

}

** 设置日志数据级别**
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第29张图片

# springboot 默认的日志级别是info,feign的dubug的日志级别就不会输出
logging:
  level:
    com.itbluebox.product.feign: debug
2)启动测试

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第30张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第31张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第32张图片

全部启动成功
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第33张图片
访问测试:http://localhost:8040/order/add
在这里插入图片描述
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第34张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第35张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第36张图片

@FeignClient(name = "stock-service",path = "/stock",configuration = FeignConfig.class)
public interface StockFeignService {
    // 声明需要调用的rest接口对应的方法
    @RequestMapping("/reduct")
    String reduct();
}

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第37张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第38张图片

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第39张图片

# springboot 默认的日志级别是info,feign的dubug的日志级别就不会输出
logging:
  level:
    com.itbluebox.product.feign: debug
# feign日志的局部配置
feign:
  client:
    config:
      product-service:
        loggerLevel: BASIC

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第40张图片
http://localhost:8040/order/add
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第41张图片

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第42张图片

3)契约配置

Spring Cloud在Feign的基础上做了扩展,使用Sping MVC的主解来完成Feign的功能。原生的Feign是不支持Ssping MVC注解的,如果你想在Spoing Coud中使用原生的主解方式来定义客户端也是可以的,通过配置契约来改变这个配置,Spring Cloud中默认的是 SpringMvcContract。
Spring Cloud 1早期版本就是用的原生Fegin.随着netflix的停更替换成了Open feign

/*
    * 修改契约配置,支持Feign原生的注解
    * */
    @Bean
    public Contract feignContract(){
        return new Contract.Default();
    }

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第43张图片

我们不在这里配置,在配置文件当中配置
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第44张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第45张图片

 @RequestLine("GET /{id}")   //@RequestLine
    public String get(@Param("id") Integer id);

4)超时时间配置

通过Optons 可以配置连接超时时间和读取超时时间,Options的第一个参数是连接的超时时间(ms),默认值是2s;第二个是请求处理的超时时间(ns),默认值是5s

全局配置

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第46张图片

    @Bean
    public Request.Options options(){
        return new Request.Options(5000,10000);
    }

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第47张图片

        # 链接超时时间。默认是2s
        connecTimeout: 5000
        # 请求处理超时时间 默认5s
        readTimeout: 3000

在ProductController当中设置睡眠4秒,模拟链接超时
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第48张图片

    @Value("${server.port}")
    String port;

    @RequestMapping("/{id}")
    public String add(@PathVariable Integer id) throws InterruptedException {
        Thread.sleep(4000);
        System.out.println("查询商品:"+id);
        return "查询商品"+id+":"+port;
    }

重新启动项目
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第49张图片

http://localhost:8040/order/add
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第50张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第51张图片

4、自定义拦截器实现认证逻辑

创建拦截器
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第52张图片

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第53张图片

package com.itbluebox.product.interceptor.feign;

import feign.RequestInterceptor;
import feign.RequestTemplate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class CustomFeignInterceptor implements RequestInterceptor {

    Logger logger = LoggerFactory.getLogger(this.getClass());

    @Override
    public void apply(RequestTemplate requestTemplate) {
        // Todo
        requestTemplate.header("xxxx","xxx");
        requestTemplate.query("id","111");
        requestTemplate.uri("/9");
        logger.info("feign 拦截器!");
    }
}

    /*
    *  自定义拦截器
    */
    @Bean
    public FeignAuthRequestInterceptor feignAuthRequestInterceptor(){
        return new FeignAuthRequestInterceptor();
    }

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第54张图片

# feign日志的局部配置
feign:
  client:
    config:
      product-service:
        loggerLevel: BASIC
        contract: feign.Contract.Default #设置为默认的契约 (还原成为原生注解)
        # 链接超时时间。默认是2s
        connecTimeout: 5000
        # 请求处理超时时间 默认5s
        readTimeout: 10000
        requestInterceptors[0]:
          com.itbluebox.product.interceptor.feign.CustomFeignInterceptor

Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第55张图片

访问:http://localhost:8040/order/add
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第56张图片
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】_第57张图片

Java之SpringCloud Alibaba【一】【Nacos一篇文章精通系列】 跳转
Java之SpringCloud Alibaba【二】【微服务调用组件Feign】 跳转
Java之SpringCloud Alibaba【三】【微服务Nacos-config配置中心】 跳转
Java之SpringCloud Alibaba【四】【微服务 Sentinel服务熔断】 跳转
Java之SpringCloud Alibaba【五】【微服务 Sentinel整合openfeign进行降级】 跳转
Java之SpringCloud Alibaba【六】【Alibaba微服务分布式事务组件—Seata】 跳转
Java之SpringCloud Alibaba【七】【Spring Cloud微服务网关Gateway组件】 跳转
Java之SpringCloud Alibaba【八】【Spring Cloud微服务Gateway整合sentinel限流】 跳转
Java之SpringCloud Alibaba【九】【Spring Cloud微服务Skywalking】 跳转

你可能感兴趣的:(Java,java,spring,cloud,微服务)