Spring Cloud Open Feign集成

Posted 2022-08-25 java_wxid

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Spring Cloud Open Feign集成相关的知识，希望对你有一定的参考价值。

文章目录

上一章节讲了Spring Cloud Alibaba Nacos集成，博文地址：https://liaozhiwei.blog.csdn.net/article/details/126463469
本章会结合上一章节的spring-cloud-alibaba-nacos-demo项目一起讲解Spring Cloud Open Feign

代码地址：https://gitee.com/java_wxid/java_wxid/tree/master/demo/spring-cloud-open-feign-demo
老样子先创建项目看效果

创建spring-cloud-open-feign-demo项目

如下（示例）：

修改pom.xml文件

代码如下（示例）：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--    引入父工程-->
<!--    <parent>-->
<!--        <groupId>com.example</groupId>-->
<!--        <artifactId>demo</artifactId>-->
<!--        <version>0.0.1-SNAPSHOT</version>-->
<!--    </parent>-->

    <groupId>com.example</groupId>
    <artifactId>spring-cloud-open-feign-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-cloud-open-feign-demo</name>
    <description>Demo project for Spring Boot</description>

    <!--    属性配置-->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <!--引入 Spring Boot、Spring Cloud、Spring Cloud Alibaba 三者 BOM 文件，进行依赖版本的管理，防止不兼容。
        在 https://dwz.cn/mcLIfNKt 文章中，Spring Cloud Alibaba 开发团队推荐了三者的依赖关系-->
        <spring.boot.version>2.3.12.RELEASE</spring.boot.version>
        <spring.cloud.version>Hoxton.SR12</spring.cloud.version>
        <spring.cloud.alibaba.version>2.2.7.RELEASE</spring.cloud.alibaba.version>
    </properties>


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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!--        在SpringBoot 2.4.x的版本之后，对于bootstrap.properties/bootstrap.yaml配置文件(我们合起来成为Bootstrap配置文件)的支持，其实这个jar包里什么都没有，就只有一个标识类Marker，用来标识要开启Bootstrap配置文件的支持，由于父类用了2.5.6版本需要导入如下的依赖-->
<!--        <dependency>-->
<!--            <groupId>org.springframework.cloud</groupId>-->
<!--            <artifactId>spring-cloud-starter-bootstrap</artifactId>-->
<!--        </dependency>-->
        <!--        代表web模块，在这个模块中含了许多JAR包，有spring相关的jar，内置tomcat服务器，jackson等，这些web项目中常用的的功能都会自动引入-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 引入 Spring Cloud Alibaba Nacos Discovery 相关依赖，将 Nacos 作为注册中心，并实现对其的自动配置 -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <!--openfeign客户端依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-openfeign-core</artifactId>
            <version>2.2.6.RELEASE</version>
        </dependency>
        <!--引入HttpClient依赖-->
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-httpclient</artifactId>
        </dependency>
        <!-- 引入Feign Slf4j -->
        <dependency>
            <groupId>com.netflix.feign</groupId>
            <artifactId>feign-slf4j</artifactId>
            <version>8.14.4</version>
        </dependency>
    </dependencies>

    <!--
        引入 Spring Boot、Spring Cloud、Spring Cloud Alibaba 三者 BOM 文件，进行依赖版本的管理，防止不兼容。
        在 https://dwz.cn/mcLIfNKt 文章中，Spring Cloud Alibaba 开发团队推荐了三者的依赖关系
     -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-parent</artifactId>
                <version>$spring.boot.version</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>$spring.cloud.version</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>$spring.cloud.alibaba.version</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

</project>

创建bootstrap.yml文件

代码如下（示例）：

#bootstrap.yml优先级比application.yml优先级高
spring:
  #prefix−spring.profile.active.$file-extension
  #nacos会根据当前环境去拼接配置名称查找相应配置文件，
  #示例：spring.application.name-spring.profiles.active-spring.cloud.nacos.config.file-extension
  #获取到值：nacos-autoconfig-service-dev.yml
  profiles:
    #开发环境dev，测试环境test，生产环境prod
    active: dev
  application:
    #配置应用的名称，用于获取配置
    name: open-feign
  cloud:
    nacos:
      discovery:
        # 服务注册地址
        server-addr: ip:8848
      config:
        #nacos配置中心地址
        server-addr: ip:8848
        #配置中心的命名空间id
        namespace: 9e50b6d9-6c3d-4e7a-b701-10f085e4b98d
        #配置分组，默认没有也可以
        group: DEFAULT_GROUP
        #配置文件后缀，用于拼接配置配置文件名称，目前只支持yaml和properties
        file-extension: yaml
        #配置自动刷新
        refresh-enabled: true
        #配置文件的前缀，默认是application.name的值，如果配了prefix，就取prefix的值
        #prefix: nacos-autoconfig-service-$spring.profile.active
        # 配置编码
        encode: UTF-8
        username: nacos
        password: nacos

创建application.yml文件

代码如下（示例）：

server:
  port: 8803
feign:
  compression:
    request:
      # 压缩支持的MIME类型
      mime-types: text/xml,application/xml,application/json
      # 开启请求数据的压缩功能（开启了在创建http请求中对请求数据的压缩功能）
      enabled: true
      # 设置启用数据压缩的最小下限 数据压缩下限  1024标识传输数据大于1024 才会进行数据压缩（最小压缩值标准）
      min-request-size: 1024
    # 开启响应数据的压缩功能
    response:
      enabled: true
#  #启用okhttp作为专用通信组件
#  okhttp:
#    enabled: true
  client:
    config:
      default: # default全局的配置
        loggerLevel: BASIC  # 日志级别，最好用basic或none
  #使用连接池代替默认的URLConnection，使用HttpClient或OKHttp
  httpclient:
    enabled: true  # 支持HttpClient的开关
    max-connections: 200  # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数

修改启动类SpringCloudOpenFeignDemoApplication

代码如下（示例）：

package com.example.springcloudopenfeigndemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class SpringCloudOpenFeignDemoApplication 

    public static void main(String[] args) 
        SpringApplication.run(SpringCloudOpenFeignDemoApplication.class, args);

创建FeignController

代码如下（示例）：

package com.example.springcloudopenfeigndemo.controller;

import com.example.springcloudopenfeigndemo.serivce.NacosConfigService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Author: liaozhiwei
 * @Description: TODO
 * @Date: Created in 21:18 2022/8/22
 */

@RestController
@RequestMapping("/feign")
/*@EnableAutoConfiguration：这就是spring boot的核心功能，自动配置。就是根据当前引入的JAR包进行自动配置.
 比如：引入了jackson的jar包，那么就会自动配置json转换，所以这里可以使用@ResponseBody.
 比如：引入了spring boot的web模块，就会自动配置web.xml等与web项目相关的内容，所以这些配置都不需要我们自己配了*/
@EnableAutoConfiguration
public class FeignController 

    @Autowired
    NacosConfigService nacosConfigService;

    @RequestMapping(value = "/getNacosConfigure",method = RequestMethod.GET)
    public String getNacosConfigure()
        return nacosConfigService.getNacosConfigure();

创建NacosConfigService

代码如下（示例）：

package com.example.springcloudopenfeigndemo.serivce;

/**
 * @Author: liaozhiwei
 * @Description: TODO
 * @Date: Created in 21:42 2022/8/22
 */
public interface NacosConfigService 


    String getNacosConfigure();

创建NacosConfigServiceImpl

代码如下（示例）：

package com.example.springcloudopenfeigndemo.serivce.impl;

import com.example.springcloudopenfeigndemo.serivce.NacosConfigService;
import com.example.springcloudopenfeigndemo.serivce.feign.NacosConfigFeign;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

/**
 * @Author: liaozhiwei
 * @Description: TODO
 * @Date: Created in 21:40 2022/8/22
 */
@Service
public class NacosConfigServiceImpl implements NacosConfigService 


    @Autowired
    NacosConfigFeign nacosConfigFeign;

    @Override
    public String getNacosConfigure()
        return nacosConfigFeign.getNacosConfigure();

创建NacosConfigFeign

代码如下（示例）：

package com.example.springcloudopenfeigndemo.serivce.feign;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.GetMapping;

/**
 * @Author: liaozhiwei
 * @Description: TODO
 * @Date: Created in 21:19 2022/8/22
 */
@Component
@FeignClient(value = "nacos-config")
public interface NacosConfigFeign 

    @GetMapping( "/getNacosConfigure")
    String getNacosConfigure();

改造上一章的spring-cloud-alibaba-nacos-demo项目

创建NacosConfigController

package com.example.springcloudalibabanacosdemo.controller;

import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * @Author: liaozhiwei
 * @Description: TODO
 * @Date: Created in 21:22 2022/8/22
 */
@Controller
/*@EnableAutoConfiguration：这就是spring boot的核心功能，自动配置。就是根据当前引入的JAR包进行自动配置.
 比如：引入了jackson的jar包，那么就会自动配置json转换，所以这里可以使用@ResponseBody.
 比如：引入了spring boot的web模块，就会自动配置web.xml等与web项目相关的内容，所以这些配置都不需要我们自己配了*/
@EnableAutoConfiguration
public class NacosConfigController 

    @RequestMapping(value = "/getNacosConfigure",method = RequestMethod.GET)
    @ResponseBody
    public String getNacosConfigure()
        return "获取配置成功！！！";

启动spring-cloud-alibaba-nacos-demo项目测试接口

接口正常

校验openfeign是否正常工作

发现openfeign可以正常工作

以上是关于Spring Cloud Open Feign集成的主要内容，如果未能解决你的问题，请参考以下文章

如何使用 spring-cloud-netflix 和 feign 编写集成测试

使用 Spring Cloud Open Feign 获取 JSON 中的对象列表

如何将opentracing/jaeger与spring cloud、hystrix、feign集成？

Spring Cloud ZooKeeper集成Feign的坑3，程序Run模式运行没事，Debug模式下报错

spring cloud学习--Feign

spring-cloud feign hystrix配置熔断为啥不生效的原因