微服务5声明式 HTTP 客户端 —— Feign

Posted JavaLearnerZGQ

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了微服务5声明式 HTTP 客户端 —— Feign相关的知识，希望对你有一定的参考价值。

目录

一、RestTemplate 不好的地方

Long userId = orderById.getUserId();
String url = "http://userservice/users/getUserById/" + userId;
User userById = http.getForObject(url, User.class);

✏️ 代码可读性差、编程体验不统一
✏️ 当发送网络请求时的请求参数特别复杂的时候，URL 难以维护


二、Feign 是什么

✏️ Github 地址：https://github.com/OpenFeign/feign
✏️ Feign 是一个声明式的 HTTP 客户端
✏️ 可帮助开发者优雅地发送 HTTP 请求


三、使用

✏️ 依赖

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

✏️ 启动开关 @EnableFeignClients

@EnableFeignClients // 开启声明式 HTTP 客户端 Feign 的使用
@MapperScan("com.gq.order.mapper")
@SpringBootApplication
public class OrderApplication 
    public static void main(String[] args) 
        SpringApplication.run(OrderApplication.class, args);

✏️ 编写 Feign 客户端（声明远程调用的信息）

基于 SpringMVC 注解声明远程调用的信息：
① 服务名称：userservice
② 请求方式：GET
③ 请求路径：/user/id
④ 请求参数：Long id
⑤ 返回值类型：User

@FeignClient("userservice") // 服务名称
public interface UserFeignClient 
    
    @GetMapping("/users/getUserById/id")
    User getById(@PathVariable String id);


@Service
@Transactional
public class OrderServiceImpl implements OrderService 
    @Resource
    private OrderMapper orderMapper;

    @Resource
    private UserFeignClient userFeignClient;

    /**
     * 根据订单 id 查询订单
     */
    @Transactional(readOnly = true)
    @Override
    public Order getOrderById(Long orderId) 
        Order orderById = orderMapper.getOrderById(orderId);

        if (orderById != null) 
            Long userId = orderById.getUserId();

            // 使用 Feign 发起远程调用
            User userById = userFeignClient.getById(userId + "");

            orderById.setUser(userById);
        

        return orderById;

四、自定义 Feign 的配置

(1) Feign 的几个常见配置

☘️ 一般修改的都是日志级别

(2) 配置 Feign 的日志级别

① 通过配置文件

全局配置: 

feign:
  client:
    config:
      default: # default 是全局配置（若写服务名称, 则是针对该微服务的配置）
        loggerLevel: FULL # 日志级别

局部配置：

feign:
  client:
    config:
      userservice: # 写服务名称表示只针对该微服务的配置
        loggerLevel: FULL # 日志级别

② Java 代码配置日志级别

必须配置下面的配置结合 Feign 的日志配置才能有效果

logging:
  level:
    com.gq: debug

📖 创建 FeignClientConfiguration

/**
 * 对 Feign 的配置（该配置类在 Feign 相关的注解中使用）
 */
public class FeignClientConfiguration 
    @Bean
    public Logger.Level feignLogLevel() 
        return Logger.Level.FULL;

📖 若是全局配置，将 FeignClientConfiguration 配置类放在 @EnableFeignClients 注解中

// 全局配置 Feign 的日志级别
@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)
@MapperScan("com.gq.order.mapper")
@SpringBootApplication
public class OrderApplication 
    public static void main(String[] args) 
        SpringApplication.run(OrderApplication.class, args);

📖 若是局部配置，将 FeignClientConfiguration 配置类放在 @FeignClient 注解中

// 局部配置 Feign 的日志级别
@FeignClient(value = "userservice", configuration = FeignClientConfiguration.class)
public interface UserFeignClient 
    @GetMapping("/users/getUserById/id")
    User getById(@PathVariable String id);

五、Feign 性能优化

(1) 性能优化介绍

📔 Feign 底层的客户端实现方案：
① URLConnection: 默认实现（不支持连接池）
② Apache HttpClient：支持连接池
③ OKHttp：支持连接池

📔 以上 OKHttp、URLConnection 和 Apache HttpClient 是几种发送 HTTP 请求的客户端工具
📔 不使用连接池性能会很差

🍒 Feign 性能优化主要包括两个方面：
① 使用支持连接池的 HTTP 请求客户端 （如 Apache HttpClient、OKHttp） 代替 URLConnection

② 日志级别最好使用 BASIC或 NONE【debug 的时候才用 FULL】

(2) 修改 Feign 底层的 HTTP 请求客户端

🎁 添加 HttpClient 依赖

	<dependency>
	    <groupId>io.github.openfeign</groupId>
	    <artifactId>feign-httpclient</artifactId>
	</dependency>

🎁 在 yaml 文件配置连接池

feign:
  client:
    config:
      default:
        loggerLevel: BASIC # 打印基本的请求和响应信息
  httpclient:
    enabled: true # 开启 Feign 对 HttpClient 的支持
    max-connections: 168
    max-connections-per-route: 39 # 每个路径的最大连接数

六、Feign 的最佳实践

(1) 方式一：继承（不好，不推荐）

🎄 给消费者的 FeignClient 和提供者的 Controller 定义统一的父接口作为标准

(2) 方式二：抽取

🎄 将 Feign 抽取为独立的模块

当定义的 FeignClient 不在 SpringBootApplication 的扫描包范围时，FeignClient 将无法使用（解决方法如下）

🚀 指定 FeignClient 所在包

@EnableFeignClients(basePackages = "com.guoqing.feign")

🚀 指定 FeignClient 字节码

@EnableFeignClients(clients = UserFeignClient.class)

spring cloud——feign声明式服务调用

什么是Feign

Feign是Spring Cloud Netflix组件中的一个轻量级RESTFUL和HTTP服务客户端，实现了负载均衡和Rest调用的开源框架，封装了Ribbon和RestTemplate，实现了web Service的面向接口编程，进一步降低了项目的耦合度。
是一种声明式，模板化的HTTP客户端（仅在Consumer中使用），使用Feign的注解定义接口，调用这个接口，就可以调用服务注册中心的服务

Feign解决了什么问题

像调用本地方法一样调用远程方法，无感知远程HTTP请求，使用Feign实现负载均衡是首选方案，只需要创建一个接口，然后在上面添加注解即可。

Feign VS OpenFeign

OpenFeign 是spring cloud在Feign的基础上支持了Spring MVC注解，如@RequestMapping，@Pathvariable。OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口，并通过动态代理的方式生产实现类，实现类中做负载均衡并调用服务

Feign入门案例

使用的是前面的springcloud的Eureka中的两个provider，以及注册中心，这里consumer的使用，需要注意，需要单独写一个service，表示请求服务的接口名称
需要调用的服务为service-provider，调用的接口就是selectAll接口，在接口上面要注解调用服务的请求地址

import org.springframework.cloud.openfeign.FeignClient
import org.springframework.web.bind.annotation.GetMapping

@FeignClient("service-provider")
interface ProductService 


    @GetMapping("/product/test")
    fun selectAll():String

build.gradle.kts

import org.jetbrains.kotlin.gradle.tasks.KotlinCompile

plugins 
    id("org.springframework.boot") version "2.3.7.RELEASE"
    id("io.spring.dependency-management") version "1.0.10.RELEASE"
    kotlin("jvm") version "1.3.72"
    kotlin("plugin.spring") version "1.3.72"


group = "com"
version = "0.0.1-SNAPSHOT"
java.sourceCompatibility = JavaVersion.VERSION_1_8

repositories 
    mavenCentral()


dependencies 
    implementation("org.springframework.boot:spring-boot-starter-web")
    implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
    implementation("org.jetbrains.kotlin:kotlin-reflect")
    implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
    testImplementation("org.springframework.boot:spring-boot-starter-test") 
        exclude(group = "org.junit.vintage", module = "junit-vintage-engine")
    
    // https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-dependencies
    implementation("org.springframework.cloud:spring-cloud-dependencies:Hoxton.SR12")
    // https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-netflix-eureka-client
    implementation("org.springframework.cloud:spring-cloud-starter-netflix-eureka-client:2.2.10.RELEASE")
    // https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-openfeign
    implementation("org.springframework.cloud:spring-cloud-starter-openfeign:2.2.10.RELEASE")



tasks.withType<Test> 
    useJUnitPlatform()


tasks.withType<KotlinCompile> 
    kotlinOptions 
        freeCompilerArgs = listOf("-Xjsr305=strict")
        jvmTarget = "1.8"

application.yml

server:
  port: 9091

spring:
  application:
    name: service-consumer

eureka:
  client:
    register-with-eureka: false
    registry-fetch-interval-seconds: 10
    service-url:
      service-url:
        defaultZone: http://localhost:8761/eureka/

#局部的负载均衡策略
#service-provider 为调用的服务的名称
service-provider:
  ribbon:
    NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RandomRule

启动文件

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication
import org.springframework.cloud.openfeign.EnableFeignClients

@SpringBootApplication
@EnableFeignClients
class ServiceConsumerApplication

fun main(args: Array<String>) 
    runApplication<ServiceConsumerApplication>(*args)

consumer接口的实现层

import com.service_consumer.service.ProductService
import com.service_consumer.service.TestService
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.stereotype.Repository

@Repository
class TestServiceImpl :TestService

    @Autowired
    lateinit var productService: ProductService

    override fun hello(id: String): String 
        return productService.selectAll()+" "+id

项目结构

Feign负载均衡

可以使用配置文件注解的方式进行全局配置，也可以在application.yml中，根据服务名进行单独配置

import com.netflix.loadbalancer.RandomRule
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration

@Configuration
class RibbonConfig 

    @Bean
    fun randomRule(): RandomRule 
        return RandomRule()

Feign请求传参

get方式的传递

    @GetMapping("/product/id")
    fun selectById(@PathVariable("id") id:String) : String

然后调用正常调用consumer接口就可以了
post方法传参，在服务中就是@RequstBody注解

    @PostMapping("/product/save")
    fun saveOne(user:Product):R<*>

Feign性能优化

gzip压缩，大约可以减少70%以上的文件大小
局部配置
只要配置Consumer通过Feign到Provider的请求与相应的Gzip压缩

feign:
  compression:
    request:
      mime-types: text/xml,application/xml,application/json #配置压缩支持的类型
      min-request-size: 512          #配置压缩数据大小的最小阈值，默认2048
      enabled: true      #请求是否开启
    response:
      enabled: true      #响应是否开启

全局配置

server:
  port: 9091
  compression:
    enabled: true
    mime-types: application/json,application/xml,text/html,text/xml,text/plain

HTTP连接池
使用HttpClient，它封装了HTTP的请求头，参数，内容体，响应等等，不仅使客户端发送HTTP请求变得容易，而且也方便了开发人员测试接口（基于HTTP协议的）
需要进入如下依赖（一般需要导入第一个，第一个以及集成在了新版的SpringCloud中）

// https://mvnrepository.com/artifact/org.apache.httpcomponents/httpclient
implementation("org.apache.httpcomponents:httpclient:4.5.13")
// https://mvnrepository.com/artifact/io.github.openfeign/feign-httpclient
implementation("io.github.openfeign:feign-httpclient:11.8")

需要在consumer的配置文件中，声明使用HTTPClient

feign:
  httpclient:
    enabled: true

状态查看
需要在resources中添加日志文件logback.xml

请求超时

全局的

ribbon:
  ConnectTimeout: 5000 #默认时间是1秒
  ReadTimeout: 5000 #请求处理的超时时间

局部的，可以根据不同的微服务的名称进行配置

以上是关于微服务5声明式 HTTP 客户端 —— Feign的主要内容，如果未能解决你的问题，请参考以下文章

声明式HTTP客户端 - Spring Cloud OpenFeign

SpringCloud-声明式Rest调用Feign

微服务中远程调用Dubbo与Feign对比

微服务架构实战学习：利用Feign实现声明式服务调用（也阔以通过公众号查看）

微服务之Feign分布式RPC

微服务之Feign分布式RPC