Spring Cloud OpenFeign 声明式服务调用

最新推荐文章于 2024-09-02 22:04:58 发布
最新推荐文章于 2024-09-02 22:04:58 发布
阅读量393 收藏 2
点赞数 1
分类专栏： Spring Cloud 教程合集 文章标签： Spring Cloud OpenFeign
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/cxy35/article/details/105754110
版权

文章目录


学习在 Spring Cloud 中使用 OpenFeign 实现声明式服务调用，包括简单调用、参数传递、继承特性、日志配置、数据压缩、服务降级/容错等功能。

1 概述

前面无论是基本调用，还是 Hystrix ，我们实际上都是通过手动调用 RestTemplate 来实现远程调用的。使用 RestTemplate 比较繁琐，每一个请求的参数、请求地址、返回数据类型不同，其他都是一样的，所以我们希望能够对请求进行简化，简化方案就是 OpenFeign 。

一开始这个组件叫 Feign/Netflix Feign ，但是 Netflix 中的组件，现在已经停止开源工作， OpenFeign 是 Spring Cloud 团队在 Netflix Feign 的基础上开发出来的声明式服务调用组件。关于 OpenFeign 组件的 Issue 见 https://github.com/OpenFeign/feign/issues/373 。

2 准备工作

2.1 服务注册

创建 Spring Boot 项目 openfeign-client-provider ，作为我们的服务提供者，添加 Web/Eureka Client 依赖，如下：

最终的依赖如下：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <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-test</artifactId>
        <scope>test</scope>
        <exclusions>
            <exclusion>
                <groupId>org.junit.vintage</groupId>
                <artifactId>junit-vintage-engine</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
</dependencies>

项目创建成功后，修改 application.properties 配置文件，将 openfeign-client-provider 注册到 Eureka Server 上（服务注册中心使用 Eureka Server ），如下：

# 当前服务的名称
spring.application.name=openfeign-client-provider
# 当前服务的端口
server.port=4000

# 服务注册中心地址
eureka.client.service-url.defaultZone=http://127.0.0.1:1111/eureka

接下来，启动 Eureka Server ，待服务注册中心启动成功后，再启动 openfeign-client-provider ，两者都启动成功后，访问 http://127.0.0.1:1111 可以看到 openfeign-client-provider 的注册信息。

当然 openfeign-client-provider 也可以集群化部署，下面对 openfeign-client-provider 进行打包，之后我们在命令行启动两个 provider 实例：

java -jar openfeign-client-provider-0.0.1-SNAPSHOT.jar --server.port=4000
java -jar openfeign-client-provider-0.0.1-SNAPSHOT.jar --server.port=4001

最后在 openfeign-client-provider 提供一个 hello 接口，用于后续服务消费者 openfeign-client-consumer 来消费，如下：

@RestController
public class ProviderController {
    @Value("${server.port}")
    Integer port; // 支持启动多个实例，做负载均衡，用端口区分

    @GetMapping("/hello")
    public String hello() {
        return "hello cxy35: " + port;
    }
}

2.2 服务消费

创建 Spring Boot 项目 openfeign-client-consumer ，作为我们的服务消费者，添加 Web/Eureka Client/OpenFeign 依赖，如下：

最终的依赖如下：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</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-test</artifactId>
        <scope>test</scope>
        <exclusions>
            <exclusion>
                <groupId>org.junit.vintage</groupId>
                <artifactId>junit-vintage-engine</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
</dependencies>

项目创建成功后，修改 application.properties 配置文件，将 openfeign-client-consumer 注册到 Eureka Server 上（服务注册中心使用 Eureka Server ），如下：

# 当前服务的名称
spring.application.name=openfeign-client-consumer
# 当前服务的端口
server.port=4002

# 服务注册中心地址
eureka.client.service-url.defaultZone=http://127.0.0.1:1111/eureka

接着，在项目启动类上添加 @EnableFeignClients 注解，开启 OpenFeign 功能，如下：

@SpringBootApplication
@EnableFeignClients // 开启 OpenFeign 功能
public class OpenfeignClientConsumerApplication {

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

}

接下来，启动 openfeign-client-consumer ，访问 http://127.0.0.1:1111 可以看到 openfeign-client-consumer 的注册信息。

最后在 openfeign-client-consumer 中新增测试业务类和接口，去实现服务调用，从而消费 openfeign-client-provider 中提供的接口，如下：

约定：本文中的服务调用失败（测试服务降级/容错），可以采用关闭某个 openfeign-client-provider 来模拟，短时间内会报错（因为 provider 地址会缓存 consumer 上一段时间），从而达到我们的目的。

3 简单调用

新建测试业务类 ConsumerService ，如下：

@FeignClient("openfeign-client-provider")
public interface ConsumerService {

    @GetMapping("/hello")
    String hello(); // 这里的方法名无所谓，随意取
}

新建测试接口 ConsumerController ，如下：

@RestController
public class ConsumerController {
    @Autowired
    ConsumerService consumerService;

    @GetMapping("/hello")
    public String hello() {
        return consumerService.hello();
    }
}

访问 http://127.0.0.1:4002/hello 完成测试。

4 参数传递

OpenFeign 中的请求参数传递与普通请求参数传递的区别如下：

  1. 参数一定要绑定参数名。
  2. 如果通过 header 来传递参数，一定记得中文要转码。

修改 ProviderController ，增加测试接口，如下：

@RestController
public class ProviderController {
    @Value("${server.port}")
    Integer port; // 支持启动多个实例，做负载均衡，用端口区分

    @GetMapping("/hello")
    public String hello() {
        return "hello cxy35: " + port;
    }

    @GetMapping("/hello2")
    public String hello2(String name) {
        System.out.println(new Date());
        return "hello " + name + ": " + port;
    }

    @PostMapping("/user")
    public User addUser(@RequestBody User user) {
        return user;
    }

    @DeleteMapping("/user/{id}")
    public void deleteUser(@PathVariable Integer id) {
        System.out.println(id);
    }

    @GetMapping("/user")
    public void getUserByName(@RequestHeader String name) throws UnsupportedEncodingException {
        System.out.println(URLDecoder.decode(name, "UTF-8"));
    }
}

修改 ConsumerService ，增加各种类型的测试接口，如下：

@FeignClient("openfeign-client-provider")
public interface ConsumerService {

    @GetMapping("/hello")
    String hello(); // 这里的方法名无所谓，随意取

    @GetMapping("/hello2")
    String hello2(@RequestParam("name") String name);

    @PostMapping("/user")
    User addUser(@RequestBody User user);

    @DeleteMapping("/user/{id}")
    void deleteUser(@PathVariable("id") Integer id);

    @GetMapping("/user")
    void getUserByName(@RequestHeader("name") String name);
}

注意，凡是 key/value 形式的参数，一定要标记参数的名称。

修改 ConsumerController ，增加测试接口，如下：

@RestController
public class ConsumerController {
    @Autowired
    ConsumerService consumerService;

    @GetMapping("/hello")
    public String hello() {
        return consumerService.hello();
    }

    @GetMapping("/testOpenFeign")
    public String testOpenFeign() throws UnsupportedEncodingException {
        String s = consumerService.hello();

        String s2 = consumerService.hello2("程序员35");
        System.out.println(s2);

        User user = new User();
        user.setId(1);
        user.setUsername("cxy35");
        user.setPassword("123");

        User u = consumerService.addUser(user);
        System.out.println(u);

        consumerService.deleteUser(1);

        consumerService.getUserByName(URLEncoder.encode("程序员35", "UTF-8"));

        return s;
    }
}

访问 http://127.0.0.1:4002/testOpenFeign 完成测试。

注意：放在 header 中的中文参数，一定要编码之后传递。

5 继承特性

修改 spring-cloud-common 模块，增加一个公共的接口，给 openfeign-client-provider 和 openfeign-client-consumer 使用。但是由于这个模块要用到 Spring MVC 的东西，因此添加 Web 依赖，最终的依赖如下：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <version>2.2.6.RELEASE</version>
    </dependency>
</dependencies>

在 spring-cloud-common 中新增 OpenFeignService 接口，里面的内容就是上文中 ConsumerService 接口的内容，如下：

public interface OpenFeignService {
    @GetMapping("/hello")
    String hello(); // 这里的方法名无所谓，随意取

    @GetMapping("/hello2")
    String hello2(@RequestParam("name") String name);

    @PostMapping("/user")
    User addUser(@RequestBody User user);

    @DeleteMapping("/user/{id}")
    void deleteUser(@PathVariable("id") Integer id);

    @GetMapping("/user")
    void getUserByName(@RequestHeader("name") String name) throws UnsupportedEncodingException;
}

在 openfeign-client-provider 中新增 ProviderController2 类，实现 OpenFeignService 接口，并实现全部方法，如下：

@RestController
public class ProviderController2 implements OpenFeignService {
    @Value("${server.port}")
    Integer port; // 支持启动多个实例，做负载均衡，用端口区分

    @Override
    public String hello() {
        return "hello2 cxy35: " + port;
    }

    @Override
    public String hello2(String name) {
        System.out.println(new Date());
        return "hello2 " + name + ": " + port;
    }

    @Override
    public User addUser(@RequestBody User user) {
        return user;
    }

    @Override
    public void deleteUser(@PathVariable Integer id) {
        System.out.println(id);
    }

    @Override
    public void getUserByName(@RequestHeader String name) throws UnsupportedEncodingException {
        System.out.println(URLDecoder.decode(name, "UTF-8"));
    }
}

修改 ProviderController ，并注释掉 @RestController ，避免与 ProviderController2 重复，导致启动报错。

// @RestController
public class ProviderController {
  ......
}

在 openfeign-client-consumer 中新增 ConsumerService2 接口，继承 OpenFeignService 接口，如下：

@FeignClient("openfeign-client-provider")
public interface ConsumerService2 extends OpenFeignService {
}

修改 ConsumerService ，并注释掉 @FeignClient ，避免与 ConsumerService2 重复，导致启动报错。

// @FeignClient("openfeign-client-provider")
public interface ConsumerService {
  ......
}

修改 ConsumerController ，换成新的 ConsumerService ，避免找不到 ConsumerService ，导致启动报错

// @Autowired
// ConsumerService consumerService;
@Autowired
ConsumerService2 consumerService;

访问 http://127.0.0.1:4002/testOpenFeign 完成测试。

关于继承特性：

  1. 使用继承特性，代码简洁明了不易出错。服务端和消费端的代码统一，一改俱改，不易出错。这是优点也是缺点，这样会提高服务端和消费端的耦合度。
  2. 上文中所讲的参数传递，在使用了继承之后，依然不变，参数该怎么传还是怎么传。

6 日志配置

OpenFeign 中，我们可以通过配置日志，来查看整个请求的调用过程。日志级别一共分为四种：

  1. NONE：不开启日志，默认就是这个
  2. BASIC：记录请求方法、URL、响应状态码、执行时间
  3. HEADERS：在 BASIC 的基础上，加载请求/响应头
  4. FULL：在 HEADERS 基础上，再增加 Body 以及请求元数据。

配置方式如下：

@SpringBootApplication
@EnableFeignClients // 开启 OpenFeign 功能
public class OpenfeignClientConsumerApplication {

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

    @Bean
    Logger.Level loggerLevel() {
        return Logger.Level.FULL;
    }

}

另外，还要在 application.properties 中配置日志级别：

# 配置 OpenFeign 的日志级别
logging.level.com.cxy35.sample.springcloud.openfeign.client.consumer.service=debug

7 数据压缩

修改配置文件，如下：

# 开启请求的数据压缩
feign.compression.request.enabled=true
# 开启响应的数据压缩
feign.compression.response.enabled=true
# 压缩的数据类型，默认如下
feign.compression.request.mime-types=text/html,application/xml,application/json
# 压缩的数据下限，默认 2048 表示当要传输的数据大于 2048 时，才会进行数据压缩
feign.compression.request.min-request-size=2048

8 服务降级/容错

Hystrix 中的服务降级/容错等功能，在 OpenFeign 中一样要使用，有两种方式。

首先，在 application.properties 中开启 Hystrix 。

# 开启 Hystrix
feign.hystrix.enabled=true
  1. fallback

新增 ConsumerService2Fallback 类，实现 ConsumerService2 接口，实现对应服务降级的方法，如下：

@Component
@RequestMapping("/abc") // 防止请求地址重复，可随意定义
public class ConsumerService2Fallback implements ConsumerService2 {
    @Override
    public String hello() {
        return "error-fallback";
    }

    @Override
    public String hello2(String name) {
        return "error2-fallback";
    }

    @Override
    public User addUser(User user) {
        return null;
    }

    @Override
    public void deleteUser(Integer id) {
    }

    @Override
    public void getUserByName(String name) throws UnsupportedEncodingException {
    }
}

接着，在 ConsumerService2 中配置这个服务降级类，如下：

// @FeignClient("openfeign-client-provider")
@FeignClient(value = "openfeign-client-provider", fallback = ConsumerService2Fallback.class)
public interface ConsumerService2 extends OpenFeignService {
}

最后，关闭 openfeign-client-provider ，模拟服务调用失败，访问 http://127.0.0.1:4002/hello 完成测试。

  1. fallbackFactory

新增 ConsumerService2FallbackFactory 类，实现 ConsumerService2 接口，实现对应服务降级的方法，如下：

@Component
public class ConsumerService2FallbackFactory implements FallbackFactory<ConsumerService2> {
    @Override
    public ConsumerService2 create(Throwable throwable) {
        return new ConsumerService2() {
            @Override
            public String hello() {
                return "error-fallbackFactory";
            }

            @Override
            public String hello2(String name) {
                return "error2-fallbackFactory";
            }

            @Override
            public User addUser(User user) {
                return null;
            }

            @Override
            public void deleteUser(Integer id) {
            }

            @Override
            public void getUserByName(String name) throws UnsupportedEncodingException {
            }
        };
    }
}

接着，在 ConsumerService2 中配置这个服务降级类，如下：

// @FeignClient("openfeign-client-provider")
// @FeignClient(value = "openfeign-client-provider", fallback = ConsumerService2Fallback.class)
@FeignClient(value = "openfeign-client-provider", fallbackFactory = ConsumerService2FallbackFactory.class)
public interface ConsumerService2 extends OpenFeignService {
}

最后，关闭 openfeign-client-provider ，模拟服务调用失败，访问 http://127.0.0.1:4002/hello 完成测试。

扫码关注微信公众号 程序员35 ，获取最新技术干货，畅聊 #程序员的35，35的程序员# 。独立站点：https://cxy35.com

程序员35
关注
专栏目录
OpenFeign：声明式服务调用
woruosuifenglang的博客
09-05 462
OpenFeign 声明式服务调用
SpringCloud OpenFeign声明式服务调用
12程序猿的博客
11-21 751
SpringCloud OpenFeign声明式服务调用
微服务---声明式服务调用OpenFeign
Selenium
03-13 307
文章目录一、OpenFeign和Feign的区别二、OpenFeign的简单使用三、OpenFeign的常用配置1.OpenFeign超时设置2.OpenFeign日志设置 之前我们通过RestTemplate+Ribbon实现了服务远程调用和负载均衡，但是由于对服务依赖的调用往往不止一处，一个接口通常会被多处调用，可以发现基本上每次的调用都是模板化的代码。而OpenFeign就是在Ribbon的...
6.远程调用-OpenFeign
最新发布
xinhang10的博客
09-02 1439
本文章主要讲述了OpenFeign的简介，他的使用以及他在spring项目中的运用，他怎么实现服务部署，最后还为大家回顾了spring大部分只是的小复习。
SpringCloud 服务调用 - OpenFeign
方亚军的博客
05-06 251
OpenFeign概述 Feign是一个声明式的WebService客户端。使用Feign能让编写Web Service客户端更加简单。 它的使用方法是定义一个服务接口然后在 上面添加注解。Feign也支持可插拔式的编码器和解码器。 SpringCloud对Feign进行了封装使其支持了Spring MVC标准注解和HttpMessageConverters. Feign可以与Eureka和Ri...
SpringCloud无废话入门03：Feign声明式服务调用
weixin_34329187的博客
03-27 93
1.Feign概述 在上一篇的HelloService这个类中，我们有这样一行代码： return restTemplate.getForObject("http://hello-service/hello",String.class); 对于代码有一定洁癖的你来说，一定感觉到了，这个url应该是可以被配置的。既然说到配置，那我们首先想到的就是...
声明式服务调用Feign
qq_38516942的博客
09-12 238
Feign的启动、配置、原理和优化
05Spring Cloud OpenFeign：基于Ribbon和Hystrix的声明式服务调用1
08-04
在本篇文章中，我们将对 Spring Cloud OpenFeign 进行详细介绍，讨论其在声明式服务调用中的应用，包括与 Ribbon 和 Hystrix 的集成。 什么是 Spring Cloud OpenFeign？ Spring Cloud OpenFeign 是一个声明式的...
Springcloud基于OpenFeign实现服务调用代码实例
08-24
SpringCloud 基于 OpenFeign 实现服务调用代码实例 在微服务架构中，服务调用是必不可少的一部分。在 SpringCloud 中，我们可以使用 OpenFeign 来实现服务调用。本文将详细介绍如何使用 OpenFeign 实现服务调用代码...
SpringCloud-OpenFeign服务接口调用及代码
06-01
在SpringCloud生态系统中，OpenFeign是一个非常重要的组件，它为开发者提供了声明式的Web服务客户端。这个组件使得我们可以像编写本地方法一样调用远程服务，极大地简化了微服务之间的通信。下面将详细介绍OpenFeign...
Spring Cloud OpenFeign示例代码
10-28
Spring Cloud OpenFeign是Spring Cloud生态中的一个组件，主要用于简化微服务之间的调用，它提供了声明式的Web服务客户端实现。OpenFeign使得开发者能够通过简单的注解定义接口，即可实现远程服务的调用，如同调用...
微服务架构学习-进阶篇--02，声明式服务调用
tanwenfang的博客
01-05 841
第一节：声明式服务调用的作用是什么？它解决了什么问题？ 1，什么是Feign？ Feign是一种声明式，模板化的HTTP客户端（仅在consumer中使用） 2，什么是声明式？有什么作用？解决了什么问题？ a.声明式调用就像调用本地方法一样调用远程方法，无感知远程HTTP请求。 b.Spring cloud的声明式调用，可以做到使用HTTP请求远程服务时，就像调用本地方法一样的体验，开发者完全感知...
声明式服务调用 Feign
Lzc的博客
09-15 598
在前面几篇文章中，主要和大家介绍了服务的注册与消费。在介绍过程中，我们从最最原始的手动利用 DiscoveryClient 发现服务开始，手动实现负载均衡，再到最后的自动化配置。相信经过前面几篇文章的学习，大家对微服务之间的调用应该有了一个基本的认知。但是我们前面的所有服务调用都是手动写 RestTemplate 来实现的，大家可能已经发现这样写有点麻烦，每次都要写请求 Url 、配置响应数据类型...
OpenFeign
weixin_41640909的博客
05-05 75
整体概览 确实不是直接调用另一个微服务的service，是在controller层面的调用。本质是通过路径。 搭建步骤 第0步当然是新建模块 1_pom <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeig
Openfeign
weixin_43559850的博客
09-02 100
Openfeign服务调用
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值