Spring Cloud Feign 的远程服务调用

最新推荐文章于 2025-09-19 04:05:48 发布
原创 最新推荐文章于 2025-09-19 04:05:48 发布 · 2.4k 阅读 · 3 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#Spring Cloud Feign

本文介绍了如何在Spring Boot项目中利用Spring Cloud Feign进行远程服务调用。项目依赖包括Spring Cloud Consul、Spring Cloud Gateway、Hystrix和OpenFeign。文章详细阐述了创建项目的过程，包括配置信息、启动类、控制器类、接口类和服务熔断类的设置。通过Feign客户端，项目提供了一个接口，当远程调用服务正常时返回响应，异常时则通过服务熔断类返回默认信息。

Spring Cloud Feign 的远程服务调用

说明

简介

  • 首先，这是一个标准的 Spring Boot 项目
  • 其次，它实现基于 Spring Cloud Consul的服务注册功能
  • 最后，它支持 Spring Cloud Feign远程调用
    • 如果Feign 客户端远程调用异常，则返回 fallback 信息（通过 Spring Cloud Netflix Hystrix实现）
  • 当前实现的功能：
    • 提供一个接口，接收 uri 为 /api/user/{id}的 HTTP GET 请求
    • 这个接口通过 Feign 客户端远程调用 awesome-user-server服务中匹配 /api/user/{id}的接口

创建项目

  • 博主使用的开发工具是 Intellij IDEA，创建的项目结构如下所示：
    • 在这里插入图片描述
    • 主要包含六部分内容(其他部分请参考 Spring Cloud Gateway 网关)
      • 依赖信息：pom.xml
      • 配置信息：application.yml
      • 启动类: AwesomeUserApiApplication.java
      • 控制器类：UserController.java
      • 接口类：UserService.java
      • 接口对应的服务熔断类：UserServiceFallback.java

依赖

  • 主要引入依赖：
    • spring-cloud-starter-consul-all：注册服务到 Consul
    • spring-cloud-starter-gateway ：支持网关服务。（用于实现网关功能直接转发某些请求，和当前博客主要介绍的内容关系不大，但由于本博客属于 Spring Cloud 微服务化（精简完整版）的一部分，由于整体设计的原因，所以这里引入这个依赖）
    • spring-cloud-starter-netflix-hystrix ：支持熔断服务
    • spring-cloud-starter-openfeign：支持 Feign 客户端远程调用
  • 完整 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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>andy.wanna.sing</groupId>
  <artifactId>awesome-user-api</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>awesome-user-api</name>
  <url>http://www.example.com</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <java.version>1.8</java.version>
  </properties>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.3.RELEASE</version>
  </parent>

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-dependencies</artifactId>
        <version>Greenwich.SR1</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

  <dependencies>
     <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-consul-all</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
    </dependency>
    <dependency>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
    <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-actuator</artifactId>
      </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <finalName>awesome-gateway</finalName>
    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
      <plugins>
        <plugin>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
       <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-war-plugin</artifactId>
          <version>3.2.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>

配置信息

  • 主要配置内容：

    • 服务注册中心（Spring Cloud Consul 配置）
    • 启动 Feign Hystrix
    • 运行的端口号
    • 健康检查暴露的端点
  • application.yml
  • spring:
    application:
        name: awesome-gateway
    cloud:
        consul:
            host: localhost
            port: 8500
            discovery:
                enabled: true
                register: true
                healthCheckInterval: 10s
                instanceId: ${spring.application.name}:${vcap.application.instance_id:${spring.application.instance_id:${random.value}}}
feign:
  hystrix:
    enabled: true   
server:
    port: 9201
management:
    endpoints:
        web:
            exposure:
                include: metrics,env,beans,mappings,health

启动类

  • 标准的 Spring Boot 项目启动类
  • 注意：需要添加 @EnableFeignClients
  • package awesome.user.api;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * 启动类
 *
 *
 * @author: Andy
 * @time: 2019/4/15 15:39
 * @since
 */
@SpringBootApplication
@EnableFeignClients
public class AwesomeUserApiApplication {

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

}

控制器类

  • 提供一个用户接口，
    • 匹配 uri : /api/user/{id}
    • 接口调用 UserService的接口（UserService中实现了 Feign客户端远程调用和服务降级，下面会介绍）
    • package awesome.user.api.controller.user;

import awesome.user.api.bean.User;
import awesome.user.api.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

/**
 * 用户控制器
 *
 * @author: Andy
 * @time: 2019/4/16 21:36
 * @since
 */
@RestController
public class UserController {

    @Autowired
    private UserService userService;

    /**
     * 获取用户信息
     *
     *
     * @param id 用户ID
     * @return: {@link ResponseEntity<User> }
     * @author: Andy
     * @time: 2019/4/16 22:02
     */
    @GetMapping("/api/user/{id}")
    public ResponseEntity<?> getUser(@PathVariable("id") Integer id){
    try {
        return userService.getUser(id);
    }catch (Exception e){
        //todo: do something
        e.printStackTrace();
        return new ResponseEntity<>("请求失败！", HttpStatus.INTERNAL_SERVER_ERROR);
    }
}
}

接口类

  • 这个类是本博客的核心类
    • 它实现了 FeignClient远程调用和 Hystrix服务降级
      • 类上有注解 @FeignClient(name = "awesome-user-server", fallback = UserServiceFallback.class)，它的作用是把请求转发到 awesome-user-server服务，并且当请求出现异常时，返回 UserService的实现类 UserServiceFallback对应的方法的返回值。
      • 方法上有注解 @GetMapping("/api/user/{id}")，表示这个方法的调用匹配的远程服务的 uri，在本例中，即匹配 awesome-user-server服务中 uri 为 /api/user/{id}的接口。
    • package awesome.user.api.service;

import awesome.user.api.bean.User;
import awesome.user.api.fallback.UserServiceFallback;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@FeignClient(name = "awesome-user-server", fallback = UserServiceFallback.class)
public interface UserService {

    /**
     * 获取用户信息
     *
     *
     * @param id 用户ID
     * @return: {@link <User> }
     * @author: Andy
     * @time: 2019/4/16 22:02
     */
    @GetMapping("/api/user/{id}")
    ResponseEntity<?> getUser(@PathVariable("id") Integer id);
}

接口对应的服务熔断类

  • 即实现服务降级的类
    • 这个类必须需要有 @FeignClient注解的接口，并为每个方法定义默认返回值。
    • 这个类需要被注册成 Bean，以便注入。所以，博主给它添加注解@Component
    • package awesome.user.api.fallback;

import awesome.user.api.bean.User;
import awesome.user.api.service.UserService;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;

/**
 * user 服务降级类
 *
 * @author: Andy
 * @time: 2019/4/16 21:47
 * @since
 */
@Component
public class UserServiceFallback implements UserService {
    @Override
    public ResponseEntity<?> getUser(Integer id) {
        return new ResponseEntity<>("Server 请求失败！" ,HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

测试

  • 上面我们构建了一下 API 项目。它的作用是：
    • 提供一个接口，接受匹配 /api/user/{id}的请求，并通过 FeignClient远程调用 awesome-user-server服务的接口获取相关信息，最后返回响应。
      • 当FeignClient远程调用服务不可用时，返回接口对应的服务熔断类对应方法的返回值。
    • 为了完成这个测试，我们需要要 awesome-user-server服务。
      • awesome-user-server必须是 Web 项目，并且注册到服务注册中心。实现基于 Spring Cloud Consul 的服务注册与发现，博主写在下面的博客：

服务正常可用

服务异常不可用

SpringCloud系列之feign服务间远程调用
zhangxing
08-11 4966
1.场景还原 在微服务架构中，服务间调用是家常便饭；如何进行服务间远程调用呢？今天笔者就springcloud中feign远程调用给大伙讲解一番，希望能够有所帮助 2.实现方案 ①加入pom依赖 &lt;dependency&gt; &lt;groupId&gt;org.springframework.cloud&lt;/groupId&gt; &lt;artif...
深入理解Spring Cloud Feign与Ribbon：优雅的微服务调用解决方案
热门推荐
张彦峰的博客
02-14 167万+
在现代的分布式系统中，微服务架构已经成为了构建大型应用的主流方式。而在微服务架构中，服务间的通信尤为重要，直接影响到系统的稳定性和性能。Spring Cloud作为领先的微服务解决方案，提供了Feign和Ribbon这两个强大的工具，用于简化和优化服务间的调用和负载均衡。本文将探讨Spring Cloud Feign和Ribbon的工作原理及其在实际应用中的最佳实践，帮助开发者更好地理解和利用这些工具来构建可靠的微服务系统。
springCloud_Feign远程调用
TimeFriends
05-17 3568
Feign远程调用 Feign替代RestTemplate 先来看我们以前利用RestTemplate发起远程调用的代码 String url ="http://userservice/user/"+order.getUserId(); User user = restTemplate.getForObject(url,User.class); 存在下面问题: ① 代码可读性差,编程提验不统一 ② 参数复杂URL难以维护 Feign是一个声明式的http客户端. ① 引入依赖 <depende
SpringCloud远程调用Feign请求
wohaipagui的博客
05-07 191
1.简介 Feign可以把Rest的请求进行隐藏，伪装成类似SpringMVC的Controller一样。你不用再自己拼接url，拼接参数等等操作，一切都交给Feign去做。 2 快速入门 2.1 导入依赖 <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId>
Feign：远程调用组件
xike1024的博客
09-19 1053
Feign远程调用组件：概念、价值、应用场景、原理、使用、核心配置
Feign-自定义配置
Leon_Jinhai_Sun的博客
11-07 706
自定义配置 Feign可以支持很多的自定义配置，如下表所示： 类型 作用 说明 feign.Logger.Level 修改日志级别 包含四种不同的级别：NONE、BASIC、HEADERS、FULL feign.codec.Decoder 响应结果的解析器 http远程调用的结果做解析，例如解析json字符串为java对象 feign.codec.Encoder 请求参数编码 将请求参数编码，便于通过http请求发送 feign. Cont
spring cloud feign实现远程调用服务传输文件的方法
08-27
主要介绍了spring cloud feign实现远程调用服务传输文件的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
使用Spring Cloud Feign远程调用的方法示例
08-27
在上述例子中，我们看到如何使用Spring Cloud Feign进行远程调用。`UserClient`接口定义了远程调用的API，`@FeignClient`注解指定了服务名，即要调用的目标微服务，同时提供了回退类`UserClientFallback`，用于处理...
SpringCloud_ Feign远程调用
qq_57689612的博客
07-01 1365
介绍Feign及其使用、配置等
实现Spring Cloud Feign远程调用方法示例
最新发布
10-04
在实际应用中，Spring Cloud Feign通过提供声明式API简化了远程调用过程：例如，`UserClient`接口定义了远程调用的HTTP方式，而带有@FeignClient注解的目标微服务则明确了需要调用的具体服务，并支持回退机制（如`...
[菜鸟SpringCloud入门]第四章：远程调用服务实战
weixin_33878457的博客
03-12 256
前言 欢迎来到菜鸟SpringCloud入门实战系列(SpringCloudForNoob)，该系列通过层层递进的实战视角，来一步步学习和理解SpringCloud。 本系列适合有一定Java以及SpringBoot基础的同学阅读。 每篇文章末尾都附有本文对应的Github源代码，方便同学调试。 Github仓库地址： https://github.com/qqxx6661/springclou...
SpringCloud远程服务调用
CloverYou的博客
11-17 2709
笔记 在微服务中，若想要使用远程调用，需要引入spring-cloud-starter-openfeign（在使用注册中心的环境下） <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> <version>xxx</version> <
SpringCloud，Feign实现服务间相互调用
咸鱼想睡觉
11-18 2782
SpringCloud，Feign实现服务间相互调用
springcloud - feign 服务调用 远程服务调用
weixin_44012040的博客
10-09 491
一. Feign的概念 Spring Cloud Netflix的微服务都是以HTTP接口的形式暴露的，所以可以用Apache的HttpClient或Spring的RestTemplate去调用 而Feign是一个使用起来更加方便的HTTP客户端，它用起來就好像调用本地方法一样，完全感觉不到是调用的远程方法 Feign是一个声明式的Web Service客户端，它的目的就是让Web Service...
SpringCloud中的远端服务调用（2种方式）
cfdsscv的博客
11-06 2703
一.基于RestTemplate对象实现远端服务调用 步骤1：在服务消费方的启动类中添加如下方法，用于创建RestTemplate对象 @Bean public RestTemplate restTemplate(){//基于此对象实现远端服务调用 return new RestTemplate(); } 步骤2：定义服务消费方Controller层,在此对象方法内部实现远端服务调用 package com.jt.consumer.controller; import org.s..
03.SpringCloud服务间远程调用
m0_53951384的博客
01-08 1664
使用Feign的步骤：① 引入依赖② 添加@EnableFeignClients注解③ 编写FeignClient接口④ 使用FeignClient中定义的方法代替RestTemplate类型作用说明修改日志级别包含四种不同的级别：NONE、BASIC、HEADERS、FULL响应结果的解析器http远程调用的结果做解析，例如解析json字符串为java对象请求参数编码将请求参数编码，便于通过http请求发送支持的注解格式默认是SpringMVC的注解失败重试机制。
SpringCloudAlibaba微服务远程调用之Nacos篇—Nacos的安装、服务注册、服务集群配置、配置负载均衡策略、配置命名空间与非临时实例、nacos集群配置、nacos与feign的结合
weixin_64339548的博客
09-20 3455
本文主要是通过结合实例进行针对nacos的安装，项目、环境、服务集群。nacos集群的配置，以及如何使用nacos并通过RestTemplate或者使用openfeign实现服务的远程调用，废话不多说，直接开始一、基础项目导入。
Spring Cloud Gateway如何优雅地进行feign调用
sslulu520的博客
04-13 1万+
Spring Cloud Gateway通过WebFlux响应式框架实现了全异步处理，看过Spring Cloud Gateway源码的同学应该都深有体会，响应式编程的代码有多么难理解。正因为Spring Cloud Gateway的响应式编程，导致它直接调用feign会有问题，因为feign的调用是同步调用。遇到feign同步调用的问题，直接通过线程池强制将feign调用转成异步调用，简单粗暴，在我看来也并不是一个好的方案。
springcloud组件之远程调用Feign
zzh18856960604的博客
03-09 348
OpenFeign的使用 思考: 使用RestTemplate+ribbon已经可以完成服务间的调用，为什么还要使用feign？ String restTemplateForObject = restTemplate.getForObject("http://服务名/url?参数" + name, String.class); 存在问题 每次调用服务都需要写这些代码，存在大量冗余 服务地址如果修改，维护成本高 使用不够灵活 OpenFeign组件 0.说明 Feign是一个声明式的伪Http客户端，
Spring Cloud Feign服务调用实例演示
在Spring Cloud中，通过`@EnableCircuitBreaker`或`@EnableHystrix`注解激活Hystrix，结合Feign可以为服务调用提供熔断功能，当依赖的服务不可用时，能够快速失败并提供备选方案。 ### 压缩包子文件名称列表 在本...
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值