使用Feign代替RestTemplate完成服务调用

于 2024-08-21 14:20:41 发布
阅读量744 收藏 24
点赞数 8
分类专栏： JavaEE 文章标签： java spring cloud spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_44746803/article/details/141170903
版权

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

文章目录

前言

Springboot集成Feign遇到了很多问题，配置成功后决定记录一下，方便后续查看，如果同时能帮助到有需要的人，我将不胜欣喜！

提示：以下是本篇文章正文内容，下面案例可供参考

一、版本

Springboot 3.3.2
Spring Cloud Alibaba 2023.0.1.0
Feign 4.1.3

二、工程创建

1. 创建工程文件

初始配置如下：
![在这里插入图片描述](https://i-blog.csdnimg.cn/direct/637fbcb9989a40b992878cccfa80cdb9.png

2. 添加依赖

在项目的pom.xml文件中添加 Spring Cloud Alibaba 的依赖：

<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>com.alibaba.cloud</groupId>
				<artifactId>spring-cloud-alibaba-dependencies</artifactId>
				<version>2023.0.1.0</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>

3. 创建微服务

按照图片一步步创建两个微服务 order-service 和 user-service 即可
（1）创建 Module

在这里插入图片描述

（2）配置 Module

在这里插入图片描述
（3）最终的目录结构
在这里插入图片描述
（4）pom.xml 内容

  • CloudNacos04 的 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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<packaging>pom</packaging>
	<modules>
		<module>order-service</module>
		<module>user-service</module>
	</modules>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>3.3.2</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.abc</groupId>
	<artifactId>CloudNacos04</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>CloudNacos04</name>
	<description>Demo project for Spring Boot</description>
	<url/>
	<licenses>
		<license/>
	</licenses>
	<developers>
		<developer/>
	</developers>
	<scm>
		<connection/>
		<developerConnection/>
		<tag/>
		<url/>
	</scm>
	<properties>
		<java.version>17</java.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.mybatis.spring.boot</groupId>
			<artifactId>mybatis-spring-boot-starter</artifactId>
			<version>3.0.3</version>
		</dependency>

		<dependency>
			<groupId>com.mysql</groupId>
			<artifactId>mysql-connector-j</artifactId>
			<scope>runtime</scope>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>org.mybatis.spring.boot</groupId>
			<artifactId>mybatis-spring-boot-starter-test</artifactId>
			<version>3.0.3</version>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>com.alibaba.cloud</groupId>
				<artifactId>spring-cloud-alibaba-dependencies</artifactId>
				<version>2023.0.1.0</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<configuration>
					<excludes>
						<exclude>
							<groupId>org.projectlombok</groupId>
							<artifactId>lombok</artifactId>
						</exclude>
					</excludes>
				</configuration>
			</plugin>
		</plugins>
	</build>

</project>
  • order-service 的 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">
    <parent>
        <artifactId>CloudNacos04</artifactId>
        <groupId>com.abc</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>order-service</artifactId>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
    </properties>

    <dependencies>
        <!--Nacos服务发现依赖-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        <!-- SpringCloud Loadbalancer -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
            <version>4.1.3</version>
        </dependency>
    </dependencies>
</project>
  • user-service 的 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">
    <parent>
        <artifactId>CloudNacos04</artifactId>
        <groupId>com.abc</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>user-service</artifactId>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
    </properties>

</project>

记得配置完pom.xml文件一定要点右上角蓝色图标的 ”Load Maven change” 导入依赖

（5）配置application.yaml

order-service 和 user-service 两个微服务都需要配置yaml文件，如何配置参考图片（这里就是最基本的配置，不涉及nacos的共享配置）。

在这里插入图片描述
（6）具体功能实现的编码

目录结构如下：

在这里插入图片描述

  • OrderMapper.java
package com.qmm.mapper;

import com.qmm.pojo.Order;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

@Mapper
public interface OrderMapper {
    @Select("select * from tb_order where id = #{id}")
    public Order findByID(int id);
}
  • OrderServiceImpl.java
package com.qmm.service.impl;

import com.qmm.mapper.OrderMapper;
import com.qmm.pojo.Order;
import com.qmm.pojo.User;
import com.qmm.service.OrderService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;

@Service
public class OrderServiceImpl implements OrderService {
    @Autowired
    OrderMapper orderMapper;

    @Autowired
    RestTemplate restTemplate;

    @Override
    public Order queryOrderById(int orderId) {
        // 1. 查询订单
        Order order = orderMapper.findByID(orderId);

        // 2. 利用RestTemplate发起http请求
        String url = "http://localhost:8082/user/" + order.getUserId();
        User user = restTemplate.getForObject(url, User.class);

        // 3. 封装user到order
        order.setUser(user);

        return order;
    }
}
  • OrderController.java
package com.qmm.controller;

import com.qmm.pojo.Order;
import com.qmm.service.OrderService;
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.RestController;

@RestController
public class OrderController {
    @Autowired
    OrderService orderService;

    @GetMapping("/order/{id}")
    public Order queryById(@PathVariable int id){
        return orderService.queryOrderById(id);
    }
}
  • order-service 的启动类 OrderApplication.java
package com.qmm;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

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

    @Bean
    @LoadBalanced
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
}
  • UserMapper.java
package com.qmm.mapper;

import com.qmm.pojo.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

@Mapper
public interface UserMapper {
    @Select("select * from tb_user where id = #{id}")
    public User findById(int id);
}
  • UserServiceImpl.java
package com.qmm.service.impl;

import com.qmm.mapper.UserMapper;
import com.qmm.pojo.User;
import com.qmm.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    UserMapper userMapper;

    @Override
    public User findById(int id) {
        return userMapper.findById(id);
    }
}
  • UserController.java
package com.qmm.controller;

import com.qmm.pojo.User;
import com.qmm.service.UserService;
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.RestController;

@RestController
public class UserController {
    @Autowired
    UserService userService;

    @GetMapping("/user/{id}")
    public User findUserById(@PathVariable int id) {
        return userService.findById(id);
    }
}
  • user-service 的启动类 UserApplication.java
package com.qmm;

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

@SpringBootApplication
public class UserApplication {
    public static void main(String[] args) {
        SpringApplication.run(UserApplication.class, args);
    }
}
  • 实体类 User.java
package com.qmm.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Integer id;
    private String username;
    private String address;
}
  • 实体类 Order.java
package com.qmm.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Order {
   private Integer id;
   private Integer price;
   private String name;
   private Integer num;
   private Integer userId;
   private User user;
}

4. 启动微服务

  • 单机模式启动nacos，命令如下：
    startup.cmd -m standalone
  • 运行启动类 UserApplicaiton.java 和 OrderApplication.java
  • 地址栏输入 localhost:8848/nacos
  • 若在服务列表看到两个服务的信息，则说明注册成功
    在这里插入图片描述
  • 服务调用
    在这里插入图片描述

5. Feign远程调用

使用Feign代替ResTemplate发送http请求

5.1 引入依赖

在order-service的pom.xml中添加如下依赖：

<dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-openfeign</artifactId>
      <version>4.1.3</version>
</dependency>

一定要注意Spring Cloud Alibaba 与 Feign 的版本匹配

5.2 添加注解

在order-service的启动类添加注解 @EnableFeignClients 开启Feign功能
在这里插入图片描述

5.3 编写Feign客户端

package com.qmm.client;

import com.qmm.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

// 声明远程调用信息
@FeignClient("userservice") //指定服务名称
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable int id);
}

这个客户端主要是基于SpringMVC的注解来声明远程调用的信息，比如：

  • 服务名称：userservice
  • 请求方式：GET
  • 请求路径：/user/{id}
  • 请求参数：int id
  • 返回值类型：User

这样，Feign就可以帮助我们发送http请求，无需自己使用RestTemplate来发送了。

5.4 利用Feign发送http请求

修改OrderServiceImpl.java：

package com.qmm.service.impl;

import com.qmm.client.UserClient;
import com.qmm.mapper.OrderMapper;
import com.qmm.pojo.Order;
import com.qmm.pojo.User;
import com.qmm.service.OrderService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;

@Service
public class OrderServiceImpl implements OrderService {
    @Autowired
    OrderMapper orderMapper;

    @Autowired
    RestTemplate restTemplate;

    @Autowired
    UserClient userClient;

    @Override
    public Order queryOrderById(int orderId) {
        // 1. 查询订单
        Order order = orderMapper.findByID(orderId);

//        // 2. 利用RestTemplate发起http请求
//        String url = "http://userservice/user/" + order.getUserId();
//        User user = restTemplate.getForObject(url, User.class);

        // 2. 利用Feign发起http请求，查询用户
        User user = userClient.findById(order.getUserId());

        // 3. 封装user到order
        order.setUser(user);

        return order;
    }
}

5.5 启动微服务，完成自测即可

总结

本文只是利用Nacos和Feign完成服务注册与远程调用的基本配置，就上述这样的一个配置过程我实践了很多次，恐怕现在还是不能一次调通，这期间遇到的问题包括但不限于：

  • Spring Cloud Alibaba 与 Feign 版本不匹配
  • pom.xml 依赖导入后，忘记刷新"Load Maven changes"

在写这篇文章的时候，我又发现了一个新问题且至今不知道原因，如下图，不添加注解@LoadBalanced会报错
在这里插入图片描述
报错如下：

Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed: org.springframework.web.client.ResourceAccessException: I/O error on GET request for "http://userservice/user/3": userservice] with root

就写到这吧，如有问题或者建议，欢迎提出！

睡眠不足8小时
关注
  • 8
    点赞
  • 踩
  • 24
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
【Spring Cloud服务与服务之间的调用：Feign、RestTemplate】
学无止境
03-27 2319
在Spring Cloud中，服务之间的调用通常使用RESTful API进行，即通过HTTP请求进行通信。具体来说，服务提供方将API暴露在特定的URL上，服务消费方通过HTTP客户端调用该URL，从而实现服务之间的交互。
【云原生】Spring Cloud Alibaba 之 Feign 远程调用 实战
wanghuichen的博客
08-01 5597
分布式系统下远程调用该如何选择？RestTemplate 与 Feign，Feign是最佳选择！
使用RestTemplate进行feignclient调用
05-31
使用RestTemplate进行feignclient调用
使用RestTemplate进行feignclient调用（附源码）
cucgyfjklx的博客
05-31 1万+
使用RestTemplate进行feignclient调用（附源码）
RestTemplate与Feign
2301_79205460的博客
08-06 718
远程调用，RestTemplate基本使用，Feign基本使用，Feign自定义设置，Feign使用优化，最佳解决方案
调用接口的几种方式：RestTemplate和feign
weixin_44841849的博客
04-09 5964
RestTemplate： 先在一个项目的controller中写入一个接口： 他的应用名字为server： spring: application: name: server 但其实打开eureka看到的是SERVER大写的。 。。。。。。。。。。。。。。。。。。。。。。。。。。。。。 开启第二个项目：来调用第一个项目中的接口 第一种方式：直接调用 RestTemp...
Feign和RestTemplate 的使用比较
Gufang617的博客
09-01 3791
Feign和RestTemplate 的使用比较 一.RestTemplate 基于RestTemplate 进行远程服务调用,但是在调用之前基于loadBalancerClient对象去从nacos注册中心基于服务名查找服务实例(可能有多个),此时会在本地按照一定算法去选择服务实例,然后进行服务调用. 1.首先创建RestTemplate的实例,交给IOC容器管理 2.在Controller类中注入loadBalancerTemplate 3.通过@LoadBalancer,可以通过服务名sca-pr
教你使用Feign替换RestTemplate
weixin_71690375的博客
06-01 383
类型作用说明修改日志级别包含四种不同的级别：NONE、BASIC、HEADERS、FULL响应结果的解析器http远程调用的结果做解析，例如解析json字符串为java对象请求参数编码将请求参数编码，便于通过http请求发送支持的注解格式默认是SpringMVC的注解失败重试机制请求失败的重试机制，默认是没有，不过会使用Ribbon的重试一般情况下，默认值就能满足我们使用，如果要自定义时，只需要创建自定义的@Bean覆盖默认Bean即可。下面以日志为例来演示如何自定义配置。
feign实现微服务之间的远程调用
m0_61206788的博客
09-07 2467
feign实现微服务之间的远程调用
RestTemplate与Feign使用对比
诚的博客
10-20 3946
RestTemplate： 添加相关注解参数即可，使用简单方便 熔断节点易控制，方便后续基于业务作出相应调整 异常捕获简单，同页面下添加对应方法即可 请求更贴近httpclient，使用更有熟悉感 Feign： 编写方式优雅，基于面向接口的风格，但是开发起来较为繁琐 yml需要添加配置启动hystrix组件 需要创建对应类来执行fallback方法 捕获异常信息和不捕获异常实现的接口不同 需要在feign注解上作出相应参数配置 feign中作出任何操作需要创建各种类来对应不同参数 ...
Feign的使用方法以及与RestTemplate的区别
热门推荐
a602389093的博客
08-02 1万+
版权声明：本文为博主ExcelMann的原创文章，未经博主允许不得转载。 作者：ExcelMann，转载需注明。 Feign的使用方法 第一步：导入依赖 第二步：在消费者服务，开启Feign客户端 @SpringBootApplication @EnableFeignClients // 开启Feign客户端 public class MircoRouteApplication { public static void main(String[] args) { SpringApp
RestTemplate和Feign的区别
weixin_41539721的博客
12-13 7163
然后接口方法里面，就是消费者order-service调用提供者user-service的方法。属性name：指定FeignClient的名称，如果项目使用了Ribbon，name属性会作为微服务的名称，用于服务发现。本案例用于简单的远程调用，所有name没太大意义，只是为了不报错而已。2.拼接转发到user-service的路径，并通过restTemplate方法发起调用，并获得user-service执行结果。属性url：手动指定@FeignClient调用的地址。3.编写Feign的客户端。
SpringCloud微服务之间的通讯，Feign和RestTemplate概念实例详解
alan_liuyue的博客
09-19 8830
前言： 在springcloud微服务的实际项目开发中，多个微服务之间不仅是相对独立的，而且也是相对关联的；也就是说，微服务之间需要相互访问，多个微服务之间的接口可能会被互相多次调用，我们称之为微服务之间的通信； 微服务之间的通信方式有很多，一般使用以下两种方法：一种是RestTemplate,另一种是Feign； 概念简介： RestTemplate，是spring中方便使用rest资源的...
【spring Cloud】微服务通信的三种方式RestTemplate、Feign远程调用与Dubbo的使用
别倒在黎明之前的博客
08-23 1227
分布式中的远程调用大概分为两种REST，即Representational State Transfer的缩写，如果一个架构符合REST原则，就称它为RESTful架构。RPC（ Remote Procedure Call ）一种进程间通信方式。允许像调用本地服务一样调用远程服务。RPC框架的主要目标就是让远程服务调用更简单、透明。RPC框架负责屏蔽底层的传输方式（TCP或者UDP）、序列化方式（XML/JSON/二进制）和通信细节。
＜学习笔记＞ 为什么还要使用Feign来代替RestTemplate
X_T_X_的博客
06-23 388
Feign是一个声明式的http客户端，（要实现发送http请求不好发，只需要把发请求所需要的信息声明出来，剩下的事情就不需要管了，由Feign帮你来做）其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。可读性差：上面的一段代码，是一个http请求的代码，有url路径，又有复杂的请求方式，对于没有接触过远程调用的人来讲，这段代码根本看不懂。太优雅了，只需要一行代码，并且也符合学习springboot时候编写代码的习惯，先注入再调用。请求路径：/user/{id}请求参数：Long id。
SpringCloud 利用 RestTemplate 或 Feign 发起http请求 请求服务提供者的接口
05-11 1213
2，服务远程调用 RestTemplate 3，RestTemplate常用方法: 3.1 Get请求之getForObject。以JSON形式自动化转换responseType指定返回类型 3.2 POST之postForObject 3.3 exchange自定义请求方式 Feign介绍: Feign是一个声明式的http客户端，官方地址：https://github.com/OpenFeign/feign1,引入依赖 2，在服务启动类里添加注解开启Feign的功
微服务中的RestTemplate和Feign
weixin_43488724的博客
02-25 2580
一、它们都可以用来调用远程服务。 二、 1、RestTemplate可以直接调用远程服务 @GetMapping("/consumer/doRest1") public String doRest1(){ //远端服务的url地址 String url="http://localhost:8081/provider/echo/{msg}"; return restTemplate.getForObject(url, St
feign和resttemplate选型
最新发布
08-28
但如果你的项目已经使用了RestTemplate，并且没有特别需要引入Feign的理由，那么可以继续沿用RestTemplate。 总之，Feign和RestTemplate都是可行的选择，具体取决于你的需求、技术栈和项目背景。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值