十、整合 Spring Cloud OpenFeign

上一篇：九、整合鉴权体系 Spring Security OAuth2

OpenFeign

Feign是一个受到Retrofit，JAXRS-2.0和WebSocket启发的Java到HTTP客户端绑定器。Feign的第一个目标是降低将Denominator统一绑定到HTTP API 的复杂性。[引自https://github.com/OpenFeign/feign官网]

        相当于，OpenFeign将HTTP服务之间的请求由传统的HTTP API调用IP完整路径替换成模块化访问，降低复杂度

Spring Cloud OpenFeign

        Spring Cloud OpenFeign以将OpenFeign集成到Spring Boot应用中的方式，为微服务架构下服务之间的调用提供了解决方案。

        我们知道，前端访问后端微服务接口时，都是通过：“ip+端口+接口api”的形式进行调用的，而有时候我们访问一个服务的接口，该接口业务可能还会内部调用另一个微服务的接口进行信息处理，而这时候采用硬编码方式即使用IP+端口方式调用则会显得十分僵硬和不方便。

        结合SpringCloud后，由于存在注册中心，每个服务都会在注册中心进行注册，所以Spring Cloud OpenFeign实现了通过注册服务模块进行特定服务访问的方式，方便了服务间调用的简化

Spring Cloud OpenFeign的原理

实践整合Spring Cloud Feign

一、引依赖。新建一个测试项目：spring-cloud-openfeign，并引入依赖

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>spring-cloud-parent</artifactId>
        <groupId>com.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>spring-cloud-openfeign</artifactId>


    <dependencies>
        <!--引入基本数据操作模块-->
        <dependency>
            <groupId>com.springcloud</groupId>
            <artifactId>common-data</artifactId>
        </dependency>

        <!--eureka 客户端-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>

        <!--实时健康监控-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <!--系统内主要基础模块，如工具类等-->
        <dependency>
            <groupId>com.springcloud</groupId>
            <artifactId>common-core</artifactId>
        </dependency>

        <!--Api接口文档在线生成工具-->
        <dependency>
            <groupId>com.springcloud</groupId>
            <artifactId>common-swagger</artifactId>
        </dependency>

        <!--配置客户端-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-client</artifactId>
        </dependency>

        <!--作为web项目存在-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--oauth2模块-->
        <dependency>
            <groupId>com.springcloud</groupId>
            <artifactId>common-auth2</artifactId>
        </dependency>

        <!--热部署-->
        <!--<dependency>-->
        <!--<groupId>org.springframework.boot</groupId>-->
        <!--<artifactId>spring-boot-devtools</artifactId>-->
        <!--<optional>true</optional>-->
        <!--</dependency>-->

    </dependencies>
</project>

二、加注解，启动类使用@EnableFeignClient 注解开启Feign服务

package com.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.security.oauth2.config.annotation.web.configuration.EnableResourceServer;

/**
 * @类名 SpringCloudOpenFeignAppliction
 * @描述 TODO
 * @版本 1.0
 * @创建人 XuKang
 * @创建时间 2021/6/30 13:54
 **/
@EnableFeignClients
@EnableEurekaClient
@SpringBootApplication
@EnableResourceServer
public class SpringCloudOpenFeignAppliction {

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

三、加配置，将该模块服务注册在eureka中

server:
  port: 8999 #服务端口
spring:
  profiles:
    active: dev #当前生效环境
  application:
    name: spring-cloud-openfeign #指定应用的唯一标识/服务名
  # 配置中心
  cloud:
    config:
      fail-fast: true
      name: datasource-mybatis-plus,redis #指定工程于config server中的应用名
      profile: ${spring.profiles.active} #指定工程于config server中的生效环境
      uri: http://localhost:8080 #指定配置中心的注册路径


# 注册中心配置
eureka:
  instance:
    prefer-ip-address: true #优先使用IP地址注册
  client:
    service-url:
      defaultZone: http://127.0.0.1:8761/eureka/

四、写代码，编写一个FeignClient，使用注解@FeignClient指向前述项目的springcloud-client项目

package com.springcloud.feign;

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

/**
 * @类名 ConfigClientFeign
 * @描述 TODO
 * @版本 1.0
 * @创建人 XuKang
 * @创建时间 2021/6/30 14:02
 * @修改人 XuKang
 * @修改时间 2021/6/30 14:02
 **/
@FeignClient(value = "springcloud-client",name = "springcloud-client")
public interface ConfigClientFeign {

    @GetMapping("client/getName")
    String getUserName();
}

编写接口调用该方法实现内部访问：

package com.springcloud.controller;

import com.baomidou.mybatisplus.extension.api.R;
import com.springcloud.feign.ConfigClientFeign;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @类名 FeignController
 * @描述 测试controller
 * @版本 1.0
 * @创建人 XuKang
 * @创建时间 2021/6/30 14:13
 **/
@RestController
@RequestMapping("feign")
public class FeignController {

    @Autowired
    private ConfigClientFeign configClientFeign;

    /**
     * 获取name
     * @return
     */
    @GetMapping("getName")
    public String getName(){
        return configClientFeign.getUserName();
    }

}

五、配置spring-cloud-gateway访问权限

        - id: spring-cloud-openfeign
          uri: lb://spring-cloud-openfeign #网关路由到springcloud-client模块，lb指向内部注册模块
          predicates: #转发谓词，用于设置匹配路由的规则
            - Path=/spring-cloud-openfeign/** #通过请求路径匹配
          filters:
            - RequestTime=true
            - StripPrefix=1

六、启动服务测试接口：

启动这几个访问，测试接口

获取access_token

通过网关，token请求测试接口

总结

1、OpenFeign将HTTP服务之间的请求由传统的HTTP API调用IP完整路径替换成模块化访问，降低复杂度

2、Spring Cloud OpenFeign以将OpenFeign集成到Spring Boot应用中的方式，为微服务架构下服务之间的调用提供了解决方案，简化了服务间的调用

资源地址

参考资源地址

下一篇：十一、整合Spring Boot Admin