功能实现——使用 RestTemplate 进行跨项目接口调用

目录

  • 1.需求说明
  • 2.项目环境搭建
  • 3.代码实现
    • 3.1.使用 RestTemplate 进行调用
      • 3.1.1.项目 A
      • 3.1.2.项目 B
    • 3.2.测试
    • 3.3.使用 JsonObject 来传递和接收 json 数据
      • 3.3.1.说明
      • 3.3.2.代码实现
    • 3.4.其它说明
      • 3.4.1.restTemplate.exchange()
      • 3.4.2.restTemplate.postForObject()
      • 3.4.3.区别总结

1.需求说明

现在项目 A 需要通过调用项目 B 中的接口(传递的信息有员工 id 和员工姓名)来获得某一员工的其它信息,现在要使用 RestTemplate 来完成这一跨项目接口调用。

注:项目 A 和项目 B 并未在同一个 Spring Cloud 或类似微服务框架中,因此这里暂不考虑使用 Feign 来进行服务调用。

2.项目环境搭建

(1)在 IDEA 中创建两个 Spring Boot 项目(分别称为项目 A 和项目 B),具体可以参考【环境搭建】使用IDEA创建SpringBoot项目详细步骤这篇文章。

(2)项目 A 的配置文件 application.yml 中的内容如下:

server:port: 8080rpc:# 项目 B 的接口地址url: http://localhost:8081/employ/info

(3)项目 B 的配置文件 application.yml 中的内容如下:

server:port: 8081

为了方便,本文创建的两个项目都是在本地运行的,因此它们的端口号不能一样。

3.代码实现

3.1.使用 RestTemplate 进行调用

(1)RestTemplate 是一个用于访问 RESTful 服务的 Spring Framework 类。它基于 HTTP 协议,可以进行 GET、POST、PUT、DELETE 等 HTTP 操作,用于向远程服务器发送请求并处理响应。因此本文选择使用 RestTemplate 来进行接口调用。

(2)RestTemplate 的详细信息见官网文档。

在这里插入图片描述

3.1.1.项目 A

EmployeeEntity.java

import lombok.Data;@Data
public class EmployeeEntity {private String id;private String name;private String posName;private String jobLevelName;private String departmentName;
}

RPCController.java

import com.example.htmltopdf.domain.EmployeeEntity;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.client.RestTemplate;import java.util.Collections;@Slf4j
@RestController
@RequestMapping("/rpc")
public class RPCController {@Value("${rpc.url}")private String URL;@Autowiredprivate RestTemplate restTemplate;/*** @description: 模拟通过调用项目 B 的接口来根据员工 id 和 name 获取员工的其它信息* @param employeeEntity 员工信息,只包含 id 和 name* @return: 员工信息* */@PostMapping()public EmployeeEntity getEmpInfo(EmployeeEntity employeeEntity) {//设置请求头,特别是 Content-Type 和 Accept 头HttpHeaders headers = new HttpHeaders();headers.setContentType(MediaType.APPLICATION_JSON);headers.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON));//设置请求体,这里是将员工 id 和员工 name 封装到 EmployeeEntity 对象中HttpEntity<EmployeeEntity> requestEntity = new HttpEntity<>(employeeEntity, headers);//发送 POST 请求,并接收返回的 JSON 结果EmployeeEntity result = restTemplate.postForObject(URL, requestEntity, EmployeeEntity.class);assert result != null;log.info(result.toString());return result;}
}

3.1.2.项目 B

EmployeeEntity.java

//代码同上

EmployeeController.java

import com.example.oss.domain.EmployeeEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
@RequestMapping("/employ")
public class EmployeeController {@PostMapping("/info")public EmployeeEntity getEmployeeInfo(@RequestBody EmployeeEntity employeeEntity) {//根据项目 A 传过来的 employeeEntity 进行相关操作,下面就直接设置了,并没有真的去数据库中查找employeeEntity.setPosName("软件开发工程师");employeeEntity.setJobLevelName("高级");employeeEntity.setDepartmentName("软件开发部");return employeeEntity;}
}

3.2.测试

启动项目 A 和 B 后,在 Postman 中进行接口测试(注意是 POST 请求):

http://localhost:8080/rpc

在这里插入图片描述

3.3.使用 JsonObject 来传递和接收 json 数据

3.3.1.说明

(1)通过上面的代码可知,项目 A 在向项目 B 发送 Post 请求时,将请求体中的信息(员工 id 和员工 name)封装到 EmployeeEntity对象中,而此时项目 B 中的接口也需要用相同的类对象来进行接收(如果通过 id 和 name 来接收会接收不到)。为了提高接口调用时传递和接收 json 数据的灵活性,我们可以考虑使用 JsonObject

(2)JsonObject 是指在 Java 中用来表示 JSON 对象的类或数据结构。它通常是指在 JSON 解析过程中,将 JSON 字符串解析为 Java 对象的一种表示形式。具体来说:

  • JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式,它以键值对的形式组织数据,并使用逗号分隔,大括号 {} 包裹对象,方括号 [] 包裹数组。
  • JsonObject 是 Gson、Jackson 等库在 Java 中提供的类,用来表示一个 JSON 对象。它可以包含各种类型的数据:字符串、数字、布尔值、数组、甚至嵌套的对象。
  • 在 Java 中使用 JsonObject 可以方便地解析、操作和生成 JSON 数据。例如,当从 HTTP 请求中接收到 JSON 数据时,可以使用 JsonObject 将其解析为 Java 对象,或者在构建 HTTP 响应时,将 Java 对象转换为 JSON 字符串格式。

3.3.2.代码实现

(1)在项目 A 和项目 B 的 pom.xml 文件中引入如下依赖:

<dependency><groupId>com.google.code.gson</groupId><artifactId>gson</artifactId><version>2.8.8</version>
</dependency>

(2)在项目 A 的配置文件 application.yml 中添加第二种方式的 url:

server:port: 8080rpc:url: http://localhost:8081/employ/infourl2: http://localhost:8081/employ/info/jsonobject

(3)项目 A 的 RPCController.java中添加如下代码:

@Value("${rpc.url2}")
private String URL2;/*** @description: 模拟通过调用项目 B 的接口来根据员工 id 和 name 获取员工的其它信息* @param id 员工 id* @param name 员工姓名* @return: 员工信息* */
@PostMapping("/jsonobject")
public String getEmpInfoByJsonObject(String id, String name) {//设置请求头,特别是 Content-Type 和 Accept 头HttpHeaders headers = new HttpHeaders();headers.setContentType(MediaType.APPLICATION_JSON);headers.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON));//构建 JsonObject 对象JsonObject jsonObject = new JsonObject();jsonObject.addProperty("id", id);jsonObject.addProperty("name", name);//设置请求体,即要发送的员工信息 JSON 字符串HttpEntity<String> requestEntity = new HttpEntity<>(jsonObject.toString(), headers);//发送 POST 请求,并接收返回的 JSON 结果ResponseEntity<String> responseEntity = restTemplate.exchange(URL2, HttpMethod.POST, requestEntity, String.class);//获取响应体return responseEntity.getBody();
}

(4)项目 B 的 EmployeeController.java中添加如下代码:

@PostMapping("/info/jsonobject")
public ResponseEntity<String> getEmpInfoByJsonObject(@RequestBody String requestBody) {//使用 Gson 解析 JSON 字符串为 JsonObjectJsonObject jsonObject = new Gson().fromJson(requestBody, JsonObject.class);//从 JsonObject 中获取需要的员工信息String id = jsonObject.get("id").getAsString();String name = jsonObject.get("name").getAsString();//构建返回的 JSON 字符串JsonObject responseJson = new JsonObject();responseJson.addProperty("id", id);responseJson.addProperty("name", name);responseJson.addProperty("posName", "软件开发工程师2");responseJson.addProperty("jobLevelName", "高级2");responseJson.addProperty("departmentName", "软件开发部2");//返回 JSON 格式的响应return new ResponseEntity<>(responseJson.toString(), HttpStatus.OK);
}

(5)测试:启动项目 A 和 B 后,在 Postman 中进行接口测试(注意是 POST 请求):

http://localhost:8080/rpc/jsonobject

在这里插入图片描述

3.4.其它说明

RestTemplate 是 Spring Framework 提供的一个用于访问 RESTful 服务的模板类,它提供了多种方法来发送 HTTP 请求并处理响应。其中涉及到的两个方法 exchange()postForObject() 在功能和使用上有一些区别:

3.4.1.restTemplate.exchange()

(1)exchange() 方法是 RestTemplate 提供的通用方法,用于执行 HTTP 请求并返回 ResponseEntity 对象。它支持所有 HTTP 方法(GET、POST、PUT、DELETE 等),并允许指定请求的 URL、HTTP 方法、请求头、请求体和响应类型等。主要特点包括:

  • 通用性:支持所有的 HTTP 方法。
  • 返回类型:返回 ResponseEntity<T>,其中 T 是请求返回的对象类型。
  • 参数:可以设置请求的 URL、HTTP 方法、请求体、请求头等。
  • 灵活性:可以处理各种复杂的 HTTP 请求和响应情况。

(2)使用示例:

ResponseEntity<User> response = restTemplate.exchange("http://api.example.com/users/{id}",HttpMethod.GET,null,User.class,1);
User user = response.getBody();

3.4.2.restTemplate.postForObject()

(1)postForObject() 方法是 RestTemplate 提供的简化方法,专门用于发送 HTTP POST 请求并返回结果对象。它适用于那些只需要发送 POST 请求并直接获得返回结果的场景。主要特点包括:

  • HTTP 方法:固定为 POST 方法。
  • 返回类型:直接返回请求的对象类型,而不是 ResponseEntity
  • 参数:可以设置请求的 URL、请求体和返回对象的类型。

(2)使用示例:

User newUser = new User("John", 30);
User createdUser = restTemplate.postForObject("http://api.example.com/users",newUser,User.class);

在这个示例中,postForObject() 方法发送了一个 POST 请求到 http://api.example.com/users,并将 newUser 对象作为请求体发送,期望返回一个 User 类型的对象作为响应结果。

3.4.3.区别总结

  • 功能exchange() 更通用,支持所有 HTTP 方法;postForObject() 专门用于发送 POST 请求。
  • 返回类型exchange() 返回 ResponseEntity<T>,可以获取完整的 HTTP 响应信息;postForObject() 直接返回请求的对象类型,简化了结果处理。
  • 使用场景:如果需要更多的 HTTP 控制和灵活性,或者处理非 POST 请求,可以使用 exchange();如果只需简单地发送 POST 请求并获得结果对象,可以使用 postForObject()

根据具体的需求和场景选择合适的方法来使用 RestTemplate,可以更高效地与 RESTful 服务进行交互。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/391174.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

8.4 字符串中等 443 String Compression 467 Unique Substrings in Wraparound String

443 String Compression 注意&#xff1a;这里是按照顺序压缩&#xff0c;不忽略顺序就不能用字母表计数再还原了。 如果char num 1 只需要压入char本身 num > 1 时还需要压入char的个数 按字符压入 class Solution { public:vector<char> Push(vector<char>&a…

Debug-019-git reflog的两种使用场景

前情&#xff1a;最近在开发项目中对版本管理有了新的理解&#xff0c;感觉在这方面有了新的收获。同时学习了一个新的git指令&#xff1a;git reflog 实际了解之后&#xff0c;发现这个指令不是很常用&#xff0c;但是对于特定的场景的话它还是非常比较方便 这里我列举两种我…

Nextjs——国际化那些事儿

背景&#xff1a; 某一天&#xff0c;产品经理跟我说&#xff0c;我们的产品需要搞国际化 国际化的需求说白了就是把项目中的文案翻译成不同的语言&#xff0c;用户想用啥语言来浏览网页就用啥语言&#xff0c;虽然说英语是通用语言&#xff0c;但国际化了嘛&#xff0c;产品才…

算法--初阶

1、tips 1.1、set求交集 {1,2,3} & {2,3} & {1,2} {2} 其实就是位运算&#xff0c; 只有set可以这样使用&#xff0c; list没有这种用法 {1,2,3} | {2,3, 4} | {1,2} {1, 2, 3, 4} 并集 1.2、*与** * 序列(列表、元组)解包&#xff0c;如果是字典&#xff0c;那…

第一个 Flask 项目

第一个 Flask 项目 安装环境创建项目启动程序访问项目参数说明Flask对象的初始化参数app.run()参数 应用程序配置参数使用 Flask 的 config.from_object() 方法使用 Flask 的 config.from_pyfile() 方法使用 Flask 的 config.from_envvar() 方法步骤 1: 设置环境变量步骤 2: 编…

【C++学习第19天】最小生成树(对应无向图)

一、最小生成树 二、代码 1、Prim算法 #include <cstring> #include <iostream> #include <algorithm>using namespace std;const int N 510, INF 0x3f3f3f3f;int n, m; int g[N][N]; int dist[N]; bool st[N];int prim() {memset(dist, 0x3f, sizeof di…

学习分享:解析电商 API 接入的技术重难点及解决方案

在当今电商业务迅速发展的时代&#xff0c;接入电商 API 已成为许多企业提升竞争力和拓展业务的重要手段。然而&#xff0c;在这个过程中&#xff0c;往往会遇到一系列的技术重难点。本文将深入解析这些问题&#xff0c;并提供相应的解决方案。 一、电商 API 接入的技术重难点 …

c++ 初始值设定项列表(initializer_list)

引例 我们在写c代码的时候&#xff0c;多多少少会遇到这样写的&#xff1a; 如果是这样写还好说&#xff1a; 第一个是因为编译器强制匹配参数。 其他都是因为在有对应构造函数的情况下支持的隐式类型转换。 而支持的构造函数是这个&#xff1a; 如果有不懂的可以开这一篇&a…

麦田物语第十八天

系列文章目录 麦田物语第十八天 文章目录 系列文章目录一、(Editor)制作 [SceneName] Attribute 特性二、场景切换淡入淡出和动态 UI 显示一、(Editor)制作 [SceneName] Attribute 特性 在本节课我们编写Unity的特性Attribute来更好的完善我们项目,具体是什么呢,就是当…

深入理解 ReLU 激活函数及其在深度学习中的应用【激活函数、Sigmoid、Tanh】

ReLU&#xff08;Rectified Linear Unit&#xff09;激活函数 ReLU&#xff08;Rectified Linear Unit&#xff09;激活函数是一种广泛应用于神经网络中的非线性激活函数。其公式如下&#xff1a; ReLU ( x ) max ⁡ ( 0 , x ) \text{ReLU}(x) \max(0, x) ReLU(x)max(0,x) 在…

docker部署elasticsearch和Kibana

部署elasticsearch 通过下面的Docker命令即可安装单机版本的elasticsearch&#xff1a; docker run -d \--name es \-e "ES_JAVA_OPTS-Xms512m -Xmx512m" \-e "discovery.typesingle-node" \-v es-data:/usr/share/elasticsearch/data \-v es-plugins:/u…

《LeetCode热题100》---<5.①普通数组篇五道>

本篇博客讲解LeetCode热题100道普通数组篇中的五道题 第一道&#xff1a;最大子数组和&#xff08;中等&#xff09; 第二道&#xff1a;合并区间&#xff08;中等&#xff09; 第一道&#xff1a;最大子数组和&#xff08;中等&#xff09; 法一&#xff1a;贪心算法 class So…

我的256天创作纪念日

机缘 ————今天一大早收到CSDN的推送消息&#xff0c;告诉我这是我的256天创作纪念日。在这个特别的日子里&#xff0c;我回望自己踏上创作之路的点点滴滴&#xff0c;心中充满了感慨与感激。从最初的懵懂尝试到如今能够自信地分享见解&#xff0c;这段旅程不仅见证了我的成…

【教学类-73-01】20240804镂空瓶子01

背景需求&#xff1a; 瓶子里的春天呀&#xff01; - 小红书 (xiaohongshu.com)https://www.xiaohongshu.com/explore/63ef87f8000000000703acae?app_platformandroid&ignoreEngagetrue&app_version8.47.0&share_from_user_hiddentrue&xsec_sourceapp_share&…

揭秘Matplotlib等高线图:让数据‘高山流水‘间,笑点与深度并存!

1. 引言 在这个数据如山的时代&#xff0c;你是不是也曾在茫茫数海中迷失方向&#xff0c;渴望找到那片隐藏的“数据绿洲”&#xff1f;别怕&#xff0c;今天咱们就来聊聊Matplotlib这位绘图界的魔术师&#xff0c;特别是它那令人叹为观止的等高线图技能。想象一下&#xff0c…

MySQL:数据库用户

数据库用户 在关系型数据库管理系统中&#xff0c;数据库用户&#xff08;USER&#xff09;是指具有特定权限和访问权限的登录账户。每个用户都有自己的用户名和密码&#xff0c;以便系统可以通过认证来识别他们的身份。数据库用户可以登录数据库&#xff0c;在其中执行各种类…

【QT】常用控件-上

欢迎来到Cefler的博客&#x1f601; &#x1f54c;博客主页&#xff1a;折纸花满衣 目录 &#x1f449;&#x1f3fb;QWidgetenabledgeometryrect制作上下左右按钮 window frame 的影响window titlewindowIcon代码示例: 通过 qrc 管理图片作为图标 windowOpacitycursor使用qrc自…

【论文笔记】SEED: A Simple and Effective 3D DETR in Point Clouds

原文链接&#xff1a;https://arxiv.org/abs/2407.10749 简介&#xff1a;基于DETR的3D点云检测器难以达到较高的性能&#xff0c;这可能有两个原因&#xff1a;&#xff08;1&#xff09;由于点云的稀疏性和分布不均匀&#xff0c;获取合适的物体查询较为困难&#xff1b;&…

基于微信小程序的微课堂笔记的设计与实现(源码+论文+部署讲解等)

博主介绍&#xff1a;✌全网粉丝10W,csdn特邀作者、博客专家、CSDN新星计划导师、Java领域优质创作者,博客之星、掘金/华为云/阿里云/InfoQ等平台优质作者、专注于Java技术领域和学生毕业项目实战,高校老师/讲师/同行前辈交流✌ 技术栈介绍&#xff1a;我是程序员阿龙&#xff…

给虚拟机Ubuntu扩展硬盘且不丢数据

1.Ubuntu关机状态下先扩展&#xff0c;如扩展20GB 2.进入ubuntu&#xff0c;切换root登录&#xff0c;必须是root全选&#xff0c;否则启动不了分区工具gparted 将新的20GB创建好后&#xff0c;选择ext4,primary&#xff1b; 3.永久挂载 我的主目录在/并挂载到/dev/sda1 从图…