feign漫谈

已于 2023-01-17 16:15:34 修改
阅读量442 收藏
点赞数
分类专栏： 分布式 java 文章标签： java spring cloud feign nacos
于 2023-01-16 17:29:19 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/imVainiycos/article/details/128707185
版权

feign的简单使用。

文章目录

一. 什么是feign

远程调用框架

二. 准备工作

需要nacos环境：

涉及到feign调用，就没法抛开注册中心，接下来我们使用主流的nacos作为注册中心进行搭建本地环境。具体参见之前的nacos系列：https://blog.csdn.net/imVainiycos/article/details/122917022

三. 如何使用

3.1 定义pom文件

  1. 新建一个maven项目作为父工程

image-20230116160204225

父工程的pom文件如下：

<?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>com.vainycos</groupId>
    <artifactId>demo-spring-cloud</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

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

    <modules>
        <module>core</module>
        <module>customer</module>
        <module>supermarket</module>
    </modules>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <springboot.version>2.2.5.RELEASE</springboot.version>
        <spring.cloud.version>Hoxton.SR3</spring.cloud.version>
        <spring.cloud.alibaba.version>2.2.1.RELEASE</spring.cloud.alibaba.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <!--支持Spring Boot 2.1.X-->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${springboot.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>
            <!-- alibaba-cloud -->
            <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>

    <dependencies>
        <!--服务调用-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-okhttp</artifactId>
        </dependency>
        <!--注册中心-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
    </dependencies>
</project>
  1. 新建三个子模块，模拟一个超市购物行为和结账会员身份识别场景，分别是：
  • core - 核心模块，feign接口层或者其他核心类
  • customer - 会员模块，依赖[core]模块，通过core模块的feign统一调用[supermarket]服务
  • supermarket - 超市模块，依赖[core]模块，通过core模块的feign统一调用[customer]服务

​ core模块的pom文件：

<?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>
    <packaging>jar</packaging>
    <parent>
        <groupId>com.vainycos</groupId>
        <artifactId>demo-spring-cloud</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <groupId>com.vainycos</groupId>
    <artifactId>core</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>core</name>
    <description>core</description>
    <properties>
        <java.version>8</java.version>
    </properties>
    <dependencies>
        <!-- spring-boot-starter-web -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

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

</project>

​ customer模块的pom文件：

<?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>
    <packaging>jar</packaging>
    <parent>
        <groupId>com.vainycos</groupId>
        <artifactId>demo-spring-cloud</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <groupId>com.vainycos</groupId>
    <artifactId>customer</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>customer</name>
    <description>customer</description>
    <properties>
        <java.version>8</java.version>
    </properties>
    <dependencies>

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

        <dependency>
            <groupId>com.vainycos</groupId>
            <artifactId>core</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

    </dependencies>

    <build>
        <finalName>customer</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

​ supermarket模块的pom文件：

<?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>
    <packaging>jar</packaging>
    <parent>
        <groupId>com.vainycos</groupId>
        <artifactId>demo-spring-cloud</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <groupId>com.example</groupId>
    <artifactId>supermarket</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>supermarket</name>
    <description>supermarket</description>
    <properties>
        <java.version>8</java.version>
    </properties>
    <dependencies>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.vainycos</groupId>
            <artifactId>core</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>

    <build>
        <finalName>market</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

3.2 定义配置文件及启动类注解

假设你本地的nacos已经启动完成了，启动端口为默认的8848。

两个模块的配置均大同小异，这里以customer模块为例。

这里需要注意由于使用微服务的配置需要优先加载，所以我们不在原来的application.yaml或者application.yml上进行配置，而是新建一个bootstrap.yml文件进行配置，配置内容如下：

server:
  # 定义另一个模块的启动端口为8082
  port: 8081

spring:
  application:
  	# 定义另一个模块的值为market
    name: customer
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848

在启动类CustomerApplication上加注解@EnableDiscoveryClient以及@EnableFeignClients(basePackageClasses = {CustomerApplication.class, CoreApplication.class})，这里需要依赖core模块，所以把core的启动类也注入。

@EnableDiscoveryClient
@EnableFeignClients(basePackageClasses = {CustomerApplication.class, CoreApplication.class})
@SpringBootApplication
public class CustomerApplication {

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

}

3.3 定义feign接口

首先我们在customer模块定义一个接口，根据id查询客户信息：

@RequestMapping("/customer")
@RestController
public class CustomerController {

    @Autowired
    private MarketService marketService;

    @GetMapping("/getUser/{id}")
    public String getById(@PathVariable("id") Integer id){
        return "获取id=" + id + "的用户";
    }
}

调用本服务进行测试，访问http://localhost:8081/customer/getUser/1，结果如下表示通过：

image-20230116155257137

我们到core模块下定义一个feign接口CustomerService，在类名上加注解@FeignClient(name = “customer”)，该注解name的值需要注意与调用服务方配置文件重的application.name保持一致，比如这里是customer：

image-20230116171123037

完整的feign接口定义如下，这里需要注意每个入参都需要定义入参格式，比如这里是路径参数即加上@PathVariable，其他的还有@RequestParameter，@RequestBody等等，并且@GetMapping的请求地址需要与对应模块的请求地址保持一致：

package com.vainycos.core.feign.customer;

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

@FeignClient(name = "customer")
public interface CustomerService {

    @GetMapping("/customer/getUser/{id}")
    String getCustomerById(@PathVariable("id") Integer id);
}

这个时候我们模拟一个场景，即在supermarket模块结账的时候需要调用customer模块获取会员信息。

在supermarket模块中定义controller，把上面的feign接口注入进来即可调用：

package com.example.supermarket.controller;

import com.vainycos.core.feign.customer.CustomerService;
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;

/**
 * @author: Vainycos
 * @description
 * @date: 2023/1/16 13:30
 */
@RequestMapping("/market")
@RestController
public class MarketController {

    @Autowired
    private CustomerService customerService;

    @GetMapping("/buy")
    public String order(String things, Integer id){
        String customerById = customerService.getCustomerById(id);
        return customerById + "购买了" +things;
    }
}

我们启动这两个服务之后，观察nacos的服务列表发现已经成功注册上去了：

image-20230117100055168

我们访问http://localhost:8082/market/buy?things=苹果电脑&id=1，结果如下表示成功进行了跨服务间的调用：

image-20230116171607683

到这里，完整的feign调用链路就已经搭建完成了。

同理，我们也可以在supermarket定义获取商品列表的服务，然后提供给customer调用：

package com.example.supermarket.controller;

import com.vainycos.core.feign.customer.CustomerService;
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;

/**
 * @author: Vainycos
 * @description
 * @date: 2023/1/16 13:30
 */
@RequestMapping("/market")
@RestController
public class MarketController {

    @Autowired
    private CustomerService customerService;

    /**
     * 获取商品列表
     * @return
     */
    @GetMapping("/listMarket")
    public String listMarket(){
        return "啤酒，瓜子，花生米";
    }
    
    @GetMapping("/buy")
    public String order(String things, Integer id){
        // 调用feign接口
        String customerById = customerService.getCustomerById(id);
        return customerById + "购买了" +things;
    }
    
}

然后在core模块下定义feign接口

package com.vainycos.core.feign.supermarket;

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

/**
 * @author: Vainycos
 * @description
 * @date: 2023/1/16 16:18
 */
@FeignClient(name = "market")
public interface MarketService {

    @GetMapping("/market/listMarket")
    String listMarket();
}

最后在customer模块中注入feign接口MarketService进行使用：

package com.vainycos.customer.controller;

import com.vainycos.core.feign.supermarket.MarketService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author: Vainycos
 * @description
 * @date: 2023/1/16 13:27
 */
@RequestMapping("/customer")
@RestController
public class CustomerController {

    @Autowired
    private MarketService marketService;

    @GetMapping("/listMarket/{id}")
    public String listMarket(@PathVariable("id") Integer id){
        // 调用feign接口
        String goods = marketService.listMarket();
        return "用户id=" + id + "查询商品列表：" + goods;
    }
    
    @GetMapping("/getUser/{id}")
    public String getById(@PathVariable("id") Integer id){
        return "获取id=" + id + "的用户";
    }
    
}

访问http://localhost:8081/customer/listMarket/1，结果如下：

image-20230116172124042

四. 部署

我们在项目工程的根目录下执行如下命令，关于打包的build节点配置可以参考该文：maven的build节点配置：

mvn clean install -Dmaven.test.skip=true

在supermarket\target以及customer\target目录下即可看到对应的jar包，我们可以部署多份jar包作为微服务的扩展，只需要启动的时候指定不同的端口即可

java -jar customer.jar --server.port=8081
java -jar customer.jar --server.port=8091
java -jar customer.jar --server.port=8101

同理，market也分别设置指定三个启动端口为8082，8092，8102

java -jar market.jar --server.port=8082
java -jar market.jar --server.port=8092
java -jar market.jar --server.port=8102

我们观察nacos上的服务列表，就可以发现对应的market和customer服务分别都有了3个实例。

image-20230117105425049

这里我们就实现了服务的简单扩展，只要启动的三个实例有一个还活着就不会导致整个服务挂掉，但是还没有实现如何将请求均匀的分摊到各个实例上，以及其中一个服务的所有实例都挂掉之后该怎么处理，这个课题我们留到之后再来探讨。

以上代码示例可参考该仓库：https://gitee.com/dearvainycos/demo-spring-cloud.git

参考资料：

Vainycos
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
阿里P8架构师漫谈Spring Cloud 微服务架构的底层原理
Java_supermanNO1的博客
09-18 284
毫无疑问，Spring Cloud 是目前微服务架构领域的翘楚，无数的书籍博客都在讲解这个技术。 不过大多数讲解还停留在对 Spring Cloud 功能使用的层面，其底层的很多原理，很多人可能并不知晓。 实际上，Spring Cloud 是一个全家桶式的技术栈，它包含了很多组件。本文先从最核心的几个组件，也就是 Eureka、Ribbon、Feign、Hystrix、Zuul 入手，来剖析其底...
手写RPC框架Feign
09-17
了解RPC框架Feign并实现简单RPC框架
(一)漫谈微服务架构及演变过程
Autism、陌亡
03-28 1036
SpringCloud微服务框架网站架构演变过程传统架构分布式架构SOA架构微服务架构微服务架构产生的原因什么是微服务微服务架构特征微服务架构如何拆分微服务架构与SOA架构区别SpringCloud微服务框架1、为什么选择SpringCloud2、SpringCloud简介 网站架构演变过程 传统架构 传统的SSH架构，分为三层架构 web控制层、业务逻辑层、数据库访问层。 传统架构也就是单点应用...
看完直接怼产品经理！漫谈MySQL权限安全
fanzhang_vip0723的博客
06-27 46
一、基础知识 比较简单的一些基础入门： 二、微服务构建：Spring boot 三、服务治理：Spring Cloud Euraka 四、客户端负载均衡：Spring Cloud Ribbon 五、服务器容错保护：Spring Cloud Hystrix 六、声明式服务调用：Spring Cloud Feign 七、API网关服务：Spring Cloud Zuul 八、分布式配置中心：Spring Cloud Config 九、消息总件：Spring Cloud Bus 十、消息驱动的微
视频教程-漫谈spring cloud分布式服务架构视频教程-Java
weixin_30349475的博客
05-28 147
漫谈spring cloud分布式服务架构视频教程 从事互联网开发架构11年...
后端feign学习资料
最新发布
12-22
后端feign学习资料
feign+springboot的使用
01-18
feign+springboot的使用
FeignConfig.java
01-07
Spring Cloud Feign的Decoder 在HTTP协议不是很规范的情况下，需要配置Decoder 具体来说：就是返回数据是JSON，而ContentType 为 text/html;charset=UTF-8
springcloud应用之feign
03-10
springcloud应用之feign
@DateTimeFormat与@JsonFormat详解
热门推荐
imVainiycos的博客
10-23 4万+
前后端进行时间类型的传值经常会遇到各种问题，并且对于java中的Date类也有util包与sql包的区别，在本文中我将会围绕实际业务进行展开解释。 一、时间传值 前端时间控件，一般情况下直接会传一个yyyy-MM-dd的日期字符串到后台。这个时候如果我们直接用java.util.Date类型就无法正确接收到。或者我们从数据库里查到DateTime类型并且用java的Date类型接收并返回给前台...
排查生产环境：MySQLTransactionRollbackException数据库死锁
imVainiycos的博客
08-02 8104
至此，本次MySQL线上死锁问题就已结束排查。由于线上问题一般都比较复杂或者比较难复现，所以排查线上问题首先需要分析日志，这个时候就要求我们程序的日志要尽可能做到完善。然后就是大胆猜测，小心验证，其中不免会经历多次推到重来的历程。此后该问题再次出现就不会再成为你的问题。记一次生产环境Java服务synchronized死锁的处理过程注意Synchronized与@Transactional不能在同一方法上使用的bug@transactional和synchronized同时使用不能同步的问题。......
IDEA中对于JSON字符串的处理（使用内置支持+插件提高效率）
imVainiycos的博客
08-21 7577
在Java语言中，字符串由双引号里的内容组成，例如String name = “Vainycos”。而JSON字符串则是一种最常见的数据格式串，通常格式模板为:[{“name”:“Vainycos”}]。如果我们想要在Java中使用JSON字符串，则需要在字符串的双引号中间加许多转义符来达到效果，即最终结果应该是String jsonName = “[{/“name/”：/“Vainycos/”...
Java实现DFA算法敏感词过滤
imVainiycos的博客
03-02 5335
Java实现DFA算法敏感词过滤。 文章目录一. 应用场景二. 实现思路三. 源码实现 一. 应用场景 模拟非法词汇自动替换成*字符，且敏感词汇支持动态调整。 效果如下，若配置了敏感词：今天，则当用户在输入：今天，天气真不错。实际应该输出：** **，天气真不错 ** 二. 实现思路 使用MySQL作为敏感词库 使用DFA算法实现文字过滤 Q：什么是DFA？ DFA全称为：Deterministic Finite Automaton,即确定有穷自动机。其特征为：有一个有限状态集合和一些从一个状态通向.
Sa-Token浅谈
imVainiycos的博客
12-14 4866
官网介绍的非常详细，主要突出这是一个轻量级鉴权框架的特点，详情可自行访问：https://sa-token.dev33.cn/doc.html#/
springsecurity-shiro获取登录用户详解
imVainiycos的博客
10-26 4820
SpringSecurity与Shiro实现原理类似。Shiro更轻量，SpringSecurity与Spring结合度更高也更复杂。安全认证之SecurityContextHolderSpringSecurity登录用户数据获取Spring Security 详解Shiro - Shiro简介；Shiro与Spring Security区别；Spring Boot集成Shiro。
通过Java批量导出带有图片的Excel文件数据
imVainiycos的博客
07-21 4766
批量导出带有图片的Excel文件一、思路解析二、关键源码三、总结 Java通过POI或者一些常见的Excel工具类能够轻易导出后台的结构化数据，但是最近面临一个新需求，需要将对应记录数据和图片网络地址在同一行中导出。 一、思路解析 一般我们看到的Excel表格是这样的。 首先，我们考虑需要使用List存放每一行的值，并且规定第一行即为表头，从第二行开始是数据。 伪代码是这样的： List<List<Object>> rowList = new ArrayList<List
HttpClientUtil发送Post/Get请求，使用fastjson解析json结果集
imVainiycos的博客
06-25 4751
由于经常需要通过后台服务端发起接口请求，在联调过程中借助HttpClientUtil工具类进行发送两位常见的网络请求，并且对返回的json结果集进行解析。作此文以方便后续查阅和学习，留个档。 一、HttpClientUtil pom依赖 <dependency> <groupId>org.wso2.apache.httpcomponents</group...
Spring Boot使用Retry机制实现失败重试
imVainiycos的博客
02-24 3947
在实际应用过程中，我们时常会遇到需要重试的机制。例如发送短信的时候，发送失败一次后需要再次发起第二次或者第三次重试，常规的思路就是记录当前短信对应的发送失败次数，当小于三次且均为失败时就发起请求。这里我们介绍一种极为方便的重试机制，springboot下整合retry。 一. 使用场景 发送短信请求，若失败则需要再次发起请求，若一直失败则需要满足达到了两次重试请求。 若不引入任何重试机制，我们的实现逻辑大体如下，记录短信唯一标识以及对应的请求历史和请求结果，若失败则累加失败次数，直到某一次成功了，或者重.
feign.FeignException
10-10
feign.FeignException是一个在使用Feign进行服务间通信时可能会抛出的异常。它表示在调用远程服务时发生了错误。FeignException是一个具体的RuntimeException，它包含了以下几个常见的字段： 1. status：HTTP响应的状态码。 2. reason：HTTP响应的原因短语。 3. message：错误消息的详细描述。 4. content：HTTP响应的内容。 通常情况下，我们可以通过捕获FeignException来处理发生的异常，并根据具体的错误信息做出相应的处理。 例如，以下是一个捕获FeignException并处理的示例代码： ```java try { // 调用远程服务 Response response = someClient.remoteCall(); // 处理响应 // ... } catch (FeignException e) { // 捕获FeignException并处理 int status = e.status(); String reason = e.reason(); String message = e.getMessage(); byte[] content = e.content(); // 处理异常 // ... } ```

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值