SpringCloud-feign使用详解

更新时间：2025年01月10日 10:24:43 作者：一条行走的鱼

Feign是Spring Cloud中的轻量级RESTful HTTP服务客户端,它通过定义接口和注解简化了服务调用,Feign支持Ribbon进行负载均衡,并且可以通过OpenFeign与Spring MVC注解结合使用,文章详细介绍了Feign的使用方法、自定义配置以及与其他组件的集成

Feign

1、OpenFeign是什么

Github地址

Feign是一个声明式WebService客户端。使用Feign能让编写Web Service客户端更加简单。它的使用方法是定义一个服务接口然后在上面添加注解。Feign也支持可拔插式的编码器和解码器。Spring Cloud对Feign进行了封装，使其支持了Spring MVC标准注解和HttpMessageConverters。Feign可以与Eureka和Ribbon组合使用以支持负载均衡。

2、Feign能干什么

Feign旨在使编写Java Http客户端变得更容易。

使用Ribbon+RestTemplate时，利用RestTemplate对http请求的封装处理，形成了一套模版化的调用方法。但是在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用。所以，Feign在此基础上做了进一步封装，由他来帮助我们定义和实现依赖服务接口的定义。在Feign的实现下，我们只需创建一个接口并使用注解的方式来配置它(以前是Dao接口上面标注Mapper注解,现在是一个微服务接口上面标注一个Feign注解即可)，即可完成对服务提供方的接口绑定，简化了使用Spring cloud Ribbon时，自动封装服务调用客户端的开发量。

3、Feign集成Ribbon

利用Ribbon维护了生产者的服务列表信息，并且通过轮询实现了客户端的负载均衡。而与Ribbon不同的是，通过feign只需要定义服务绑定接口且以声明式的方法，优雅而简单的实现了服务调用。

4、Feign和OpenFeign的区别

Feign是Spring Cloud组件中的一个轻量级RESTful的HTTP服务客户端Feign内置了Ribbon，用来做客户端负载均衡，去调用服务注册中心的服务。Feign的使用方式是:使用Feign的注解定义接口，调用这个接口，就可以调用服务注册中心的服务。

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

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

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

5、Feign的简单使用

1)OpenFeign的使用

1.添加依赖

    <!-- openfeign 远程调用 -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>

2.编写接口

@FeignClient注解

value值的要调用的微服务名称

@FeignClient(value = "mall-order",path = "/order")
public interface OrderFeignService {

    @RequestMapping("/findOrderByUserId/{userId}")
    R findOrderByUserId(@PathVariable("userId") Integer userId);


}

3.主启动类添加注解

@EnableFeignClients

4.测试

2)Feign的使用

1.添加依赖

    <!-- feign调用依赖 -->
    <dependency>
        <groupId>com.netflix.feign</groupId>
        <artifactId>feign-core</artifactId>
        <version>8.18.0</version>
    </dependency>
    <dependency>
        <groupId>com.netflix.feign</groupId>
        <artifactId>feign-jackson</artifactId>
        <version>8.18.0</version>
    </dependency>

2.编写接口

public interface FeignDemo {


    @Headers({"Content-Type: application/json","Accept: application/json"})
    @RequestLine("GET /order/findOrderByUserId/{userId}")
    R findOrderByUserId(@Param("userId") Integer userId);
}

3.测试

public class FeignTest {

    public static void main(String[] args) {
        //基于json
        // encoder指定对象编码方式，decoder指定对象解码方式
        FeignDemo service = Feign.builder()
                .encoder(new JacksonEncoder())
                .decoder(new JacksonDecoder())
                .options(new Request.Options(1000, 3500))
                //.retryer(new Retryer.Default(5000, 5000, 3))
                .target(FeignDemo.class, "http://localhost:8020/");

        System.out.println(service.findOrderByUserId(1));
    }
}

4.结果

6、OpenFeign自定义配置

1)日志配置

有时候我们遇到 Bug，比如接口调用失败、参数没收到等问题，或者想看看调用性能，就需要配置 Feign 的

日志了，以此让 Feign 把请求信息输出来。

OpenFeign日志等级有四种分别为

NONE:不输出日志

BASIC:只输出请求方法的 URL 和响应的状态码以及接口执行的时间。

HEADERS：将 BASIC 信息和请求头信息输出。

FULL：输出完整的请求信息。

方式一:全局配置

1.编写配置类引入相关Bean

@Configuration
public class FeignConfig {

    /**
     * 日志级别
     * 通过源码可以看到日志等级有 4 种，分别是：
     * NONE：不输出日志。
     * BASIC：只输出请求方法的 URL 和响应的状态码以及接口执行的时间。
     * HEADERS：将 BASIC 信息和请求头信息输出。
     * FULL：输出完整的请求信息。
     *
     * @return
     */
    @Bean
    public Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
}

2.修改配置文件

logging:
  level:
    com.tuling.mall.feigndemo.feign: debug #指定feign接口的路径

3.测试

方式二:局部配置

1.编写配置（不能主启动类扫描到),否则就成为了全局配置

@Configuration
public class FeignConfig {

    /**
     * 日志级别
     * 通过源码可以看到日志等级有 4 种，分别是：
     * NONE：不输出日志。
     * BASIC：只输出请求方法的 URL 和响应的状态码以及接口执行的时间。
     * HEADERS：将 BASIC 信息和请求头信息输出。
     * FULL：输出完整的请求信息。
     *
     * @return
     */
    @Bean
    public Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
}

2.配置文件

logging:
  level:
   com.qianyue.mall.openFeign: debug

3.修改注解信息

@FeignClient(value = "mall-order",configuration = FeignConfig.class) //指定配置
public interface OrderFeignService {

    @RequestMapping("/order/findOrderByUserId/{userId}")
    R findOrderByUserId(@PathVariable("userId") Integer userId);

}

说明：局部配置也可用通过配置文件方式配置

feign:
  client:
    config:
     mall-account:
      loggerLevel: FULL

2)契约配置

Spring Cloud 在 Feign 的基础上做了扩展，可以让 Feign 支持 Spring MVC 的注解来调用。原生的 Feign 是不支持 Spring MVC 注解的，如果你想在 Spring Cloud 中使用原生的注解方式来定义客户端也是可以的，通过配置契约来改变这个配置，Spring Cloud 中默认的是 SpringMvcContract。

修改锲约配置步骤如下:

1.修改契约配置，支持Feign原生的注解

    @Bean
    public Contract feignContract(){
        return new Contract.Default();
    }

2.修改接口

此时将不再支持MVC的注解

@FeignClient(value = "mall-order")
public interface OrderFeignService {

    @RequestLine("GET /order/findOrderByUserId/{userId}")
    public R findOrderByUserId(@Param("userId") Integer userId);


}

3.补充，也可用通过yml配置锲约

feign:
  client:
    config:
     mall-order:
      loggerLevel: FULL
      contract: feign.Contract.Default #指定Feign原生注解契约配置

3)拦截器配置

通常我们调用的接口都是有权限控制的，很多时候可能认证的值是通过参数去传递的，还有就是通过请求头去传递认证信息，比如 Basic 认证方式。

方式一 Basic认证

1.在配置类直接配置Basic认证

    @Bean
    public BasicAuthRequestInterceptor basicAuthRequestInterceptor() {
        return new BasicAuthRequestInterceptor("qianyue", "123456");
    }

2.效果

调用接口会携带编码后的认证去访问接口

方式二 RequestInterceptor认证

每次 feign 发起http调用之前，会去执行拦截器中的逻辑。

使用场景

统一添加 header 信息；
对 body 中的信息做修改或替换；

1.自定义拦截器实现认证逻辑

public class FeignAuthRequestInterceptor implements RequestInterceptor {
    @Override
    public void apply(RequestTemplate template) {
        // 业务逻辑  模拟认证逻辑
        String access_token = UUID.randomUUID().toString();
        template.header("Authorization",access_token);
    }
}

2.拦截器添加到容器中

    @Bean
    public FeignAuthRequestInterceptor feignAuthRequestInterceptor(){
        return new FeignAuthRequestInterceptor();
    }

3.结果

4.也可用在yaml配置拦截器

feign:
  client:
    config:
     mall-order:
      requestInterceptors[0]:  #配置拦截器
       com.qianyue.mall.interceptor.FeignAuthRequestInterceptor

4)超时时间配置

通过 Options 可以配置连接超时时间和读取超时时间，Options 的第一个参数是连接的超时时间（ms），默认值是 2s；第二个是请求处理的超时时间（ms），默认值是 5s。

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

或者是在yaml中配置

feign:
  client:
    config:
     mall-order:
      connectTimeout: 5000  # 连接超时时间，默认2s
      readTimeout: 3000 #请求处理超时时间，默认5s

补充说明： Feign的底层用的是Ribbon，但超时时间以Feign配置为准

5)客户端组件配置

Feign 中默认使用 JDK 原生的 URLConnection 发送 HTTP 请求，我们可以集成别的组件来替换掉

URLConnection，比如 Apache HttpClient，OkHttp。

使用HttpClient

1.引入依赖

        <!-- feign调用依赖 -->
        <dependency>
            <groupId>com.netflix.feign</groupId>
            <artifactId>feign-core</artifactId>
            <version>8.18.0</version>
        </dependency>
        <dependency>
            <groupId>com.netflix.feign</groupId>
            <artifactId>feign-jackson</artifactId>
            <version>8.18.0</version>
        </dependency>

2.添加配置

feign:
  httpclient:
    enabled: true #其实默认就是true

3.测试会调用ApacheHttpClient的execute方法

使用okClient

1.引入依赖

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

2.修改yaml

feign:
  httpclient:
    enabled: false
  okhttp:
    enabled: true

3.测试

会调用OkHttpClient的execute方法

关于这一块的配置可用参考Feign的自动配置类FeignAutoConfiguration

6)压缩配置

开启压缩可以有效节约网络资源，提升接口性能，我们可以配置 GZIP 来压缩数据：

开启配置

feign:
  httpclient:
    enabled: true
#  okhttp:
#    enabled: true
  compression:
    request:
      enabled: true
      # 配置压缩的类型
      mime-types: text/xml,application/xml,application/json
      # 最小压缩值
      min-request-size: 2048
    response:
      enabled: true

结果

注意：只有当 Feign 的 Http Client 不是 okhttp3 的时候，压缩才会生效，配置源码在 FeignAcceptGzipEncodingAutoConfiguration

7)编码器解码器

Feign 中提供了自定义的编码解码器设置，同时也提供了多种编码器的实现，比如 Gson、Jaxb、Jackson。我们可以用不同的编码解码器来处理数据的传输。如果你想传输 XML 格式的数据，可以自定义 XML 编码解码器来实现获取使用官方提供的 Jaxb

public interface Encoder { 
    void encode(Object object, Type bodyType, RequestTemplate template) throws EncodeExcepti on; 
     } 
public interface Decoder { 
    Object decode(Response response, Type type) throws IOException, DecodeException, FeignEx ception; 
}

JavaConfig配置

    @Bean
    public Decoder decoder(){
            return new JacksonDecoder();
    }

    @Bean
    public Encoder encoder(){
        return new JacksonEncoder();
    }

YAML配置

feign:
  client:
    config:
     mall-order:
       encoder: feign.jackson.JacksonEncoder
       decoder: feign.jackson.JacksonDecoder

7、SpringCloud整合Dubbo

1)生产者服务抽离

新建一个api工程,存放我们的Dubbo接口如下

public interface UserService {

	List<User> list();
	User getById(Integer id);

}

2)生产者代码

1.依赖

    <dependencies>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-dubbo</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>


        <dependency>
            <groupId>com.qianyue.mall</groupId>
            <artifactId>mall-common</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>com.qianyue.spring-cloud-alibaba</groupId>
            <artifactId>mall-dubbo-api</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>

    </dependencies>

2.yaml配置

dubbo:
  scan:
    base-packages: com.qianyue.mall.service #服务实现类的扫描基准包	
  protocol:
    name: dubbo
    port: -1
spring:
  application:
    name: mall-order-dubbo
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    druid:
      driver-class-name: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://localhost:3306/ms_order?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
      username: root
      password: 199787
      initial-size: 10
      max-active: 100
      min-idle: 10
      max-wait: 60000
      pool-prepared-statements: true
      max-pool-prepared-statement-per-connection-size: 20
      time-between-eviction-runs-millis: 60000
      min-evictable-idle-time-millis: 300000
      test-while-idle: true
      test-on-borrow: false
      test-on-return: false
      stat-view-servlet:
        enabled: true
        url-pattern: /druid/*
      filter:
        stat:
          log-slow-sql: true
          slow-sql-millis: 1000
          merge-sql: false
        wall:
          config:
            multi-statement-allow: true
  main:
    allow-bean-definition-overriding: true
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.26.129


#mybatis-plus
mybatis-plus:
  mapper-locations: classpath*:/mapper/**/*.xml
  #实体扫描，多个package用逗号或者分号分隔
  typeAliasesPackage: com.qianyue.mall.entity
  global-config:
    #数据库相关配置
    db-config:
      #主键类型  AUTO:"数据库ID自增"
      id-type: AUTO
      logic-delete-value: -1
      logic-not-delete-value: 0
      banner: false
    #原生配置
    configuration:
      map-underscore-to-camel-case: true
      cache-enabled: false
      call-setters-on-nulls: true
      jdbc-type-for-null: 'null'
server:
  port: 8510

3.服务实现类

@DubboService
@Slf4j
public class UserServiceImpl implements UserService {


	@Override
	public List<User> list() {
		log.info("查询user列表");
		List<User> list = new ArrayList<>();
		return list;
	}

	@Override
	public User getById(Integer id) {
		return null;
	}


}

3)消费者代码

1.引入依赖

dependencies>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-dubbo</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        <dependency>
            <groupId>com.qianyue.mall</groupId>
            <artifactId>mall-common</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>com.qianyue.spring-cloud-alibaba</groupId>
            <artifactId>mall-dubbo-api</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>

2.yaml配置

dubbo:
  cloud:
    subscribed-services: mall-order-dubbo #指定订阅的服务
  protocol:
    name: dubbo
    port: -1

spring:
  application:
    name: mall-user-dubbo
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    druid:
      driver-class-name: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://localhost:3306/ms_order?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
      username: root
      password: 199787
      initial-size: 10
      max-active: 100
      min-idle: 10
      max-wait: 60000
      pool-prepared-statements: true
      max-pool-prepared-statement-per-connection-size: 20
      time-between-eviction-runs-millis: 60000
      min-evictable-idle-time-millis: 300000
      test-while-idle: true
      test-on-borrow: false
      test-on-return: false
      stat-view-servlet:
        enabled: true
        url-pattern: /druid/*
      filter:
        stat:
          log-slow-sql: true
          slow-sql-millis: 1000
          merge-sql: false
        wall:
          config:
            multi-statement-allow: true
  main:
    allow-bean-definition-overriding: true
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.26.129
server:
  port: 8610

3.服务调用

@RestController
@RequestMapping("/user")
@Slf4j
public class UserController {

    @DubboReference
    UserService userService;

    @RequestMapping("/findOrderByUserId/{userId}")
    public User findOrderByUserId(@PathVariable("userId") Integer userId){
        User user = userService.getById(userId);
        return user;
    }

}

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

maven多模块项目依赖管理与依赖继承详解
这篇文章主要介绍了maven多模块项目依赖管理与依赖继承详解，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-12-12
Java Set简介_动力节点Java学院整理
Set最大的特性就是不允许在其中存放的元素是重复的。接下来通过本文给大家分享java set常用方法和原理分析，需要的的朋友参考下吧
2017-05-05
浅谈JVM之类的加载链接和初始化
有了java class文件之后，为了让class文件转换成为JVM可以真正运行的结构，需要经历加载，链接和初始化的过程。这三个过程是怎么工作的呢？在本文中你将会找到答案。
2021-06-06
SPFA 算法实例讲解
下面小编就为大家带来一篇SPFA 算法实例讲解。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-07-07
如何构建可重复读取inputStream的request
这篇文章主要介绍了如何构建可重复读取inputStream的request，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-03-03
java文件的简单读写操作方法实例分析
这篇文章主要介绍了java文件的简单读写操作方法,结合实例形式分析了java文件流进行读写操作的方法与相关操作注意事项,需要的朋友可以参考下
2020-05-05
SpringBoot中的@EnableAutoConfiguration注解解析
这篇文章主要介绍了SpringBoot中的@EnableAutoConfiguration注解解析,@EnableAutoConfiguration也是借助@Import的帮助,将所有符合自动配置条件的bean定义注册到IoC容器,需要的朋友可以参考下
2023-09-09
java interface的两个经典用法
这篇文章主要为大家详细介绍了java interface的两个经典用法,具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2016-09-09
java中map与实体类的相互转换操作
这篇文章主要介绍了java中map与实体类的相互转换操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-07-07
详解Java语言中的抽象类与继承
这篇文章主要为大家详细介绍了Java语言中的抽象类与继承的相关资料，文中的示例代码讲解详细，对我们学习Java有一定的帮助，感兴趣的小伙伴快跟随小编一起了解一下
2022-10-10