在前端开发中，我们经常需要向服务器发送 HTTP 请求来获取数据。对于 SharePoint 环境下的前端开发，@microsoft/sp-http 包是一个不可或缺的工具。本文将介绍如何使用 @microsoft/sp-http 包来发送 HTTP 请求，并提供一些示例代码来帮助你更好地理解其使用方法。
安装和引入 @microsoft/sp-http 包
要使用 @microsoft/sp-http 包，我们需要先安装它。在你的项目根目录下运行以下命令来安装它：
npm install @microsoft/sp-http --save
在你的 TypeScript 或 JavaScript 代码中，可以使用以下语句来引入该包：
import { SPHttpClient } from '@microsoft/sp-http';发送 GET 请求
使用 @microsoft/sp-http 包，发送 GET 请求非常简单。以下是一个发送 GET 请求的示例代码：
-- -------------------- ---- -------
------ - ------------- -------------------- - ---- ---------------------
----- ------- ------ - -------------------------------
----- -------- -------------------- - -
-------- -
--------- -----------------------------------
-
--
------------------------------------- ------------------------------- --------
---------------- --------------------- -- -
-- ------------- -
------ ----------------
-
----- --- ---------------
--
------------ ---- -- -
------------------
--
-------------- ---- -- -
-------------------
---在这个示例中，我们首先构造了一个 apiUrl 变量，它表示要请求的 API 的 URL。接下来，我们定义了一个包含 Accept 标头的 options 对象。SPHttpClient 的 get 方法接受三个参数：API URL、SPHttpClientConfiguration 和 options。其中，options 参数是可选的。
get 方法返回一个 Promise，它包含一个 SPHttpClientResponse 对象。我们使用 SPHttpClientResponse 对象的 ok 属性来检查响应是否成功。如果它是 true，我们使用 response.json() 方法解析响应体并获得响应数据。
发送 POST 请求
和发送 GET 请求类似，使用 @microsoft/sp-http 包发送 POST 请求也非常简单。以下是一个发送 POST 请求的示例代码：
-- -------------------- ---- -------
------ - ------------- -------------------- - ---- ---------------------
----- ------- ------ - -------------------------------
----- -------- -------------------- - -
-------- -
--------------- ------------------
--
----- --------------------
--
-------------------------------------- ------------------------------- --------
---------------- --------------------- -- -
-- ------------- -
----------------- ------ ---------------
-
----- --- ---------------
--
-------------- ---- -- -
-------------------
---在这个示例中，我们首先构造了一个 apiUrl 变量，它表示要请求的 API 的 URL。接下来，我们定义了一个包含 Content-Type 标头和请求体的 options 对象。SPHttpClient 的 post 方法接受三个参数：API URL、SPHttpClientConfiguration 和 options。
post 方法也返回一个 Promise。我们使用 SPHttpClientResponse 对象的 ok 属性来检查响应是否成功。如果它是 true，我们将在控制台中打印一条消息。
发送其它类型的请求
除了 GET 和 POST 请求，@microsoft/sp-http 包也可以发送其它类型的请求，例如 PUT、DELETE、PATCH 等。以下是一个发送 PUT 请求的示例代码：
-- -------------------- ---- -------
------ - ------------- -------------------- - ---- ---------------------
----- ------- ------ - -------------------------------
----- -------- -------------------- - -
-------- -
--------------- ------------------
--
----- --------------------
--
------------------------------------- ------------------------------- --------
---------------- --------------------- -- -
-- ------------- -
----------------- ------- ---------------
-
----- --- ---------------
--
-------------- ---- -- -
-------------------
---在这个示例中，我们使用了和发送 POST 请求类似的方法来发送 PUT 请求。
总结
本文介绍了如何使用 @microsoft/sp-http 包来发送 HTTP 请求。我们讨论了如何发送 GET、POST 和其它类型的请求，并提供了示例代码来帮助你更好地理解其使用方法。希望这篇文章对你在 SharePoint 环境下的前端开发工作有所帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/microsoft-sp-http