Spring Cloud Alibaba 快速学习之 OpenFeign

已于 2024-08-17 15:06:55 修改
阅读量1.2k 收藏 13
点赞数 50
文章标签： 学习 spring boot spring cloud 负载均衡
于 2024-08-17 14:58:57 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_40718345/article/details/141279591
版权

1. 引言

OpenFeign是一种声明式、模板化的HTTP客户端，它简化了远程调用的编程体验。OpenFeign还支持通过 Ribbon 进行负载均衡，可以实现多个服务提供方的负载均衡。

本章将快速讲解OpenFeign和Ribbon的简单应用，由于本章需要用到Nacos组件，如果不了解的请先行阅读 Spring Cloud Alibaba 快速学习之 Nacos。

2. 创建项目

创建一个名为spring-cloud-alibaba-demo的项目作为父级项目，使用Maven+JDK17。不会的请看IntelliJ IDEA快速创建Spring Boot项目。再创建三个子项目（Module）分别名为server-a、server-b、user-a。最终项目结构，如下图。
在这里插入图片描述

3. 代码展示

3.1 父项目spring-cloud-alibaba-demo

父级项目，用于管理公用的依赖，本项目只有一个pom.xml文件。
在这里插入图片描述

3.1.1 pom.xml

注意，当引入了spring-cloud-starter-alibaba-nacos-config依赖后，所有子项目的application.properties中需要配置spring.config.import=xx或者spring.cloud.nacos.config.import-check.enabled=false，否则启动会报错。

<?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>org.example</groupId>
    <artifactId>spring-cloud-alibaba-demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>
    <modules>
        <module>server-a</module>
        <module>user-a</module>
        <module>server-b</module>
    </modules>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <!--  为Spring Boot项目提供一系列默认的配置和依赖管理-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.3.2</version>
        <relativePath/>
    </parent>

    <dependencies>
        <!--  Spring Boot核心-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!-- Spring Boot单元测试和集成测试-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- Spring Boot构建Web应用程序-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- Nacos 配置管理-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
            <version>2023.0.1.2</version>
        </dependency>
        <!-- Nacos 服务发现-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <version>2023.0.1.2</version>
        </dependency>
        <!-- spring cloud 负载均衡-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
            <version>4.1.4</version>
        </dependency>
        <!-- spring cloud openfeign-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
            <version>4.1.3</version>
        </dependency>

    </dependencies>

</project>

3.2 子项目server-a

服务提供者之一，用于测试负载均衡和服务调用。
在这里插入图片描述

3.2.1 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>
    <parent>
        <groupId>org.example</groupId>
        <artifactId>spring-cloud-alibaba-demo</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>server-a</artifactId>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

</project>

3.2.2 application.properties

#spring应用程序监听的端口号
server.port=8080
#spring应用程序的名称
spring.application.name=server-a
#spring当前激活的配置文件
spring.profiles.active=dev
#nacos服务地址
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
#nacos远程配置的命名空间，默认值为public
spring.cloud.nacos.config.namespace=public
#nacos远程配置的分组，默认值为DEFAULT_GROUP
spring.cloud.nacos.config.group=DEFAULT_GROUP
#nacos远程配置导入,必须在nacos配置中心创建对应的配置文件，否则会报错
spring.config.import=optional:nacos:${spring.application.name}-${spring.profiles.active}.properties

3.2.3 org/example/MainServerA.java

package org.example;


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

@SpringBootApplication
@EnableDiscoveryClient //spring cloud开启服务发现功能
public class MainServerA {

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

}

3.2.4 org/example/controller/TestController.java

用于测试服务调用，和负载均衡。

package org.example.controller;

import org.springframework.web.bind.annotation.*;

import java.util.Date;
import java.util.HashMap;
import java.util.Map;


@RestController
@RequestMapping("/test")
public class TestController {


    private static final String serverName = "this is server-a";

    @GetMapping("/get")
    public String get() {
        return serverName;
    }


    @GetMapping("/get/{string}")
    public String get(@PathVariable String string) {
        return serverName + ":" + string;
    }

    @PostMapping("/getObj")
    @ResponseBody
    public Object getObj(@RequestBody Map<String, Object> info) {
        if (null == info) {
            info = new HashMap<>();
        }
        info.put("serverName", serverName);
        info.put("milliseconds", new Date().getTime());
        return info;
    }

    @GetMapping("/sleep")
    public String sleep() {
        try {
            Thread.sleep(5000L);
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }
        return serverName + ":sleep 5000ms ok";
    }


}

3.2.5 org/example/controller/ConfigController.java

用于测试读取nacos远程配置文件中的属性

package org.example.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.*;

/*
 * 用于测试读取nacos远程配置文件中的属性
 * */
@RestController
@RequestMapping("/config")
@RefreshScope  //@RefreshScope用来实现Bean中属性的动态刷新
public class ConfigController {

    @Value("${project.id}")
    private String projectId;

    @Value("${project.name}")
    private String projectName;

    @RequestMapping("/get")
    public String get() {
        return "server-a:" + "project.id=" + projectId + ",project.name=" + projectName;
    }


}

3.3 子项目server-b

服务提供者之一，用于测试负载均衡和服务调用。
在这里插入图片描述

3.3.1 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>
    <parent>
        <groupId>org.example</groupId>
        <artifactId>spring-cloud-alibaba-demo</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>server-b</artifactId>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

</project>

3.3.2 application.properties

注意，这里的spring.application.name，需要和server-a项目一直，以便测试负载均衡。

#spring应用程序监听的端口号
server.port=8081
#spring应用程序的名称
spring.application.name=server-a
#spring当前激活的配置文件
spring.profiles.active=dev
#nacos服务地址
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
#nacos不导入配置文件，也能正常启动项目
spring.cloud.nacos.config.import-check.enabled=false

3.3.3 org/example/MainServerB.java

package org.example;


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

@SpringBootApplication
@EnableDiscoveryClient //spring cloud开启服务发现功能
public class MainServerB {

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

}

3.3.4 org/example/controller/TestController.java

注意，这里的方法需要和server-a项目的一直，只是serverName属性稍作区别，变成 “this is server-b”，以便测试负载均衡。

package org.example.controller;

import org.springframework.web.bind.annotation.*;

import java.util.Date;
import java.util.HashMap;
import java.util.Map;


@RestController
@RequestMapping("/test")
public class TestController {


    private static final String serverName = "this is server-b";

    @GetMapping("/get")
    public String get() {
        return serverName;
    }


    @GetMapping("/get/{string}")
    public String get(@PathVariable String string) {
        return serverName + ":" + string;
    }

    @PostMapping("/getObj")
    @ResponseBody
    public Object getObj(@RequestBody Map<String, Object> info) {
        if (null == info) {
            info = new HashMap<>();
        }
        info.put("serverName", serverName);
        info.put("milliseconds", new Date().getTime());
        return info;
    }

    @GetMapping("/sleep")
    public String sleep() {
        try {
            Thread.sleep(5000L);
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }
        return serverName + ":sleep 5000ms ok";
    }


}

3.4 子项目user-a

服务调用者、消费者，用于测试负载均衡和服务调用。
在这里插入图片描述

3.4.1 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>
    <parent>
        <groupId>org.example</groupId>
        <artifactId>spring-cloud-alibaba-demo</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>server-b</artifactId>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

</project>

3.4.2 application.properties

#spring应用程序监听的端口号
server.port=8082
#spring应用程序的名称
spring.application.name=user-a
#spring当前激活的配置文件
spring.profiles.active=dev
#nacos服务地址
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
#nacos不导入配置文件，也能正常启动项目
spring.cloud.nacos.config.import-check.enabled=false

3.4.4 org/example/MainUserA.java

package org.example;

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 //spring cloud开启服务发现功能
@EnableFeignClients //spring cloud开启openfeign客户端的功能
public class MainUserA {

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

}

3.4.5 org/example/openfeign/ServerAClient.java

这个接口就是用于配置openfeign的服务，在@FeignClient注解中，name对应服务提供方的spring.application.name。接口中的方法与服务提供者的方法保持对应即可。

package org.example.openfeign;


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

import java.util.Map;


@FeignClient(name = "server-a", path = "/test")
public interface ServerAClient {

    @RequestMapping("/get")
    String get();

    @GetMapping("/get/{string}")
    String get(@PathVariable String string);

    @PostMapping("/getObj")
    Object getObj(@RequestBody Map<String, Object> info);

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


}

3.4.6 org/example/controller/TestController.java

用于测试服务调用，和负载均衡。

package org.example.controller;


import org.example.openfeign.ServerAClient;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;


import java.util.Map;


@RestController
@RequestMapping("/test")
public class TestController {

    @Autowired
    private ServerAClient serverAClient;

    @RequestMapping("/get")
    public String get() {
        return serverAClient.get();
    }

    @GetMapping("/get/{string}")
    public String get(@PathVariable String string) {
        return serverAClient.get(string);
    }

    @PostMapping("/getObj")
    @ResponseBody
    public Object getObj(@RequestBody Map<String, Object> info) {
        return serverAClient.getObj(info);
    }

    @GetMapping("/sleep")
    public String sleep() {
        return serverAClient.sleep();
    }
}

3. 代码测试

3.1 同时启动三个子项目

启动成功后，在NACOS控制台，可以看到有一个user-a服务，两个server-a服务。说明我们的三个服务都注册成功。
在这里插入图片描述

3.2 测试服务调用

当调用user-a的/test/get服务时，就会通过注入的ServerAClient，再通过配置的openfeign服务，调用到spring.application.name=server-a的/test/get服务。
在这里插入图片描述在这里插入图片描述用浏览器访问：http://localhost:8082/test/get，可以看到返回了“this is server-a”，这与server-a项目中/test/get方法返回一直，说明调用成功。
在这里插入图片描述在这里插入图片描述

3.2 测试负载均衡

然后不停的用浏览器访问：http://localhost:8082/test/get，可以看到返回值在“this is server-a”和“this is server-b”之间切换，说明负载均衡测试成功。
在这里插入图片描述

D_J_Dragon
关注
Spring Cloud Alibaba 同时兼容dubbo与openfeign
congge
05-30 5999
Spring Cloud Alibaba 整合dubbo与openfeign
Spring Cloud Alibaba 实现 gRPC 服务调用
AI天才研究院
08-02 1144
2017年6月2日，Netflix发布开源项目Spring Cloud，推出了 Spring Cloud Netflix，这是一套基于Spring Boot微服务框架的分布式系统的开发工具包。该项目拥有多个子项目，其中最重要的一个子项目是 Spring Cloud Loadbalancer，它提供了客户端负载均衡器功能。2019年6月，阿里巴巴宣布将其在微服务体系中的地位上升到了第一名。他们推出了阿里巴巴微服务生态圈 Spring Cloud Alibaba（简称SCA），作为其内部微服务框架的一部分。
金三银四面试必备：“SpringCloudAlibaba学习笔记” 阿里腾讯字节都稳了
Java6888的博客
04-12 1073
SpringCloud Alibaba 为什么会出现？ Spring Cloud Netflix 项目进入维护模式，Spring Cloud Netflix 将不再开发新的组件，我们知道Spring Cloud 版本迭代算是比较快的，因而出现了很多中岛的 ISSUE 都来不及 Fix 就又推另一个 Release 了 。进入维护模式意思就是目前已知以后一段时间 Spring Cloud Netflix 提供的服务和功能就这么多了， 不再开发性的组件和功能了。 以后将以维护和 Merge 分支 Full R
Spring cloud alibaba——OpenFeign
weixin_44712778的博客
07-11 1817
openFeign
SpringCloud Alibaba】（十三）学习 RocketMQ 消息队列
最新发布
sco5282的博客
09-01 1378
引入MQ最大的优点就是异步解耦和流量削峰，但是引入 MQ 后也有很多需要注意的事项和问题，主要包括：系统的整体可用性降低、系统的复杂度变高、引入了消息一致性的问题。重新打开 cmd 命令行，进入 RocketMQ 的 bin 目录，在命令行输入如下命令调用 RocketMQ 自带的消费者程序消费 RocketMQ 中的消息。下单成功后将订单的信息发送到 RocketMQ，然后用户微服务订阅 RocketMQ 的消息，接收到消息后进行打印。说明生产者发送到 RocketMQ 的消息，被消费者成功消费到了。
SpringCloudAlibaba:OpenFeign
一条没有梦想的闲鱼的博客
12-19 916
什么是Feign Feign是Netflix开发的声明式，模板化的http客户端，可以帮助我们更加便捷、优雅的调用HTTP API。 Feign支持多种注解，例如Feign自带的注解或者JAX-RS注解等 SpringCloud OpenFeign对Feign进行了增强，使其支持SpringMvc注解，另外还整合了Ribbon和Nacos，从而使得Feign的使用更加方便。 优势：Feign可以做到使用Http请求远程服务时就像调本地方法一样的体验，开发者完全感知不到这是远程方法，更感知不到这是.
SpringCloud-Alibaba之OpenFeign
qq_43144261的博客
05-26 1282
此文章主要讲解springcloud中OpenFeign服务接口调用相关知识。 Feign简介 Feign是Netflix公司开发的声明式、模板化的HTTP客户端，其灵感来自Retrofit、JAXRS-2.0以及WebSocket。 Feign可以帮助我们更加便捷、优雅的调用HTTP的API。 在SpringCloud中，使用Feign非常简单–创建一个接口，并在接口上添加一些注解，代码就完成了。 Feign支持多种注解，例如Feign自带的注解或者JAX-RS注解等。 SpringC
03.SpringcloudAlibaba-OpenFeign
qq_26477149的博客
03-08 2369
1.什么是本地负载均衡器 消费者从注册中心获取接口调用地址列表，本地实现负载均衡策略。（轮询、随机、hash一致性、权重） 2.本地负载均衡器有哪些 OpenFeign 默认引入ribbon 3.本地负载均衡器与nginx有什么区别 nginx是属于服务器端负载均衡器，客户端所有的请求都统一叫nginx再进行准发 本地负载均衡器：属于客户端进行负载均衡 4.搭建member服务 链接：https://pan.baidu.com/s/1puN2uwKITgjvwoM3tz-jsQ.
[SpringCloud Alibaba]小白快速入门Spring Cloud Alibaba
06-20
Alibaba nacos于2018年7月开源，并开始逐步拥抱springcloud社区，alibaba微服务框架大有超越之势，目前热度非常高，其中注册中心nacos就像人之心脏，值得分享与学习下，课件markdown资料及课程源码都已经上传。
Springcloud_alibaba学习笔记
三明治文鱼的博客
04-21 2903
文章目录0. 简介区别特点组件1. 环境搭建2. Nacosa.作为服务注册中心启动Nacos Client简单上手服务间通信（和之前一样）应用搭建Controller具体实现RestTemplate+Ribbon：OpenFeignb.作为统一配置中心Config Client简单上手ControllerNacos中创建配置Nacos config自动刷新细节1、配置集(Data ID)2、配置分组(Group)3、命名空间(Namespace)4、最佳实践c.配置持久化d. 高可用（集群）nacos高可
一个分布式学习系统，融合大部分springcloud组件如openfeign，nacos，gateway等，使用OR.zip
02-24
Nacos是阿里巴巴开源的一款服务发现和服务配置中心，它集成了服务注册与发现、配置管理、健康检查等多种功能。在Spring Cloud中，Nacos可以作为服务治理的核心，各个微服务可以在启动时向Nacos注册，其他服务则可以...
Spring Cloud Alibaba全套学习资料（包含源码、学习文档以及所需要的工具）
03-03
Spring Cloud Alibaba全套学习资料（包含源码、学习文档以及所需要的工具）
SpringCloudAlibaba — — OpenFeign的简单应用
weixin_45565886的博客
08-06 400
SpringCloudAlibaba — — OpenFeign的简单应用
Spring Cloud Alibaba------OpenFeign的使用
weixin_43994761的博客
12-06 536
Spring Cloud Alibaba------OpenFeign的使用
SpringCloud Alibaba 微服务（三）：OpenFeign
分享是一种积极的生活态度~~
07-29 1865
在微服务架构中，服务之间的通信是一个非常重要的环节。为了简化和高效地进行服务间通信，Spring Cloud 提供了 OpenFeign 这个强大的工具。本文将介绍 OpenFeign 的概念、优点、基本用法以及在实际项目中的应用。也希望通过本文，能够帮助你们在 Spring Cloud 项目中轻松地集成和使用 OpenFeign。一、什么是OpenFeign？OpenFeign 是一个声明式的 HTTP 客户端，用于简化微服务间的 HTTP 调用。
SpringCloudAlibaba---OpenFeign学习篇
qq_44692851的博客
11-18 750
SpringCloudAlibaba---OpenFeign学习篇
SpringCloud alibaba整合OpenFeign
qq_65142821的博客
04-25 923
原生的 Feign 是不支持 Spring MVC 注解的，如果你想在 Spring Cloud 中使用原生的注解方式来定义客户端也是可以的，通过配置契约来改变这个配置，Spring Cloud 中默认的是 SpringMvcContract。Feign 提供了日志打印功能，我们可以通过配置来调整日志级别，从而了解 Feign 中 Http 请求的细节。有时候我们遇到 Bug，比如接口调用失败、参数没收到等问题，或者想看看调用性能，就需要配置 Feign 的日志了，以此让 Feign 把请求信息输出来。
Spring Cloud Alibaba - 13 OpenFeign应用篇
热门推荐
小工匠
02-03 3万+
文章目录What's Feign What’s Feign Feign是Netflix开发的声明式、模板化的HTTP客户端，其灵感来自Retrofit、JAXRS­2.0以及WebSocket。 Feign可帮助我们更加便捷、优雅地调用HTTP API. 在Spring Cloud中，使用Feign非常简单——只需创建接口，并在接口上添加注解即可。 Feign支持多种注解，例如Feign自带的注解或者JAX­RS注解等。Spring Cloud对Feign进行了增强，使其支持SpringMVC注解，另外
Spring Cloud Alibaba微服务第8章之OpenFeign
qq_57756904的博客
06-26 1331
feign默认集成了Ribbon，看看feign是不是更加方便服务之间调用，面向接口编程，不需要到处拼接URL，完全就像调用controller一样。代码清晰明了，编程风格类似Controller。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值