SpringBoot圖文教程17—上手就會 RestTemplate 使用指南「Get Post」「設置請求頭」

来源:https://www.cnblogs.com/bingyang-py/archive/2020/03/20/12534913.html
-Advertisement-
Play Games

有天上飛的概念，就要有落地的實現 概念十遍不如代碼一遍，朋友，希望你把文中所有的代碼案例都敲一遍 先贊後看，養成習慣 SpringBoot 圖文教程系列文章目錄 1. "SpringBoot圖文教程1—SpringBoot+Mybatis 環境搭建" 2. "SpringBoot圖文教程2—日誌的使 ...


有天上飛的概念，就要有落地的實現

  • 概念十遍不如代碼一遍，朋友，希望你把文中所有的代碼案例都敲一遍

  • 先贊後看，養成習慣

SpringBoot 圖文教程系列文章目錄

  1. SpringBoot圖文教程1—SpringBoot+Mybatis 環境搭建
  2. SpringBoot圖文教程2—日誌的使用「logback」「log4j」
  3. SpringBoot圖文教程3—「‘初戀’情結」集成Jsp
  4. SpringBoot圖文教程4—SpringBoot 實現文件上傳下載
  5. SpringBoot圖文教程5—SpringBoot 中使用Aop
  6. SpringBoot圖文教程6—SpringBoot中過濾器的使用
  7. SpringBoot圖文教程7—SpringBoot攔截器的使用姿勢這都有
  8. SpringBoot圖文教程8—SpringBoot集成MBG「代碼生成器」
  9. SpringBoot圖文教程9—SpringBoot 導入導出 Excel 「Apache Poi」
  10. SpringBoot圖文教程10—模板導出|百萬數據Excel導出|圖片導出「easypoi」
  11. SpringBoot圖文教程11—從此不寫mapper文件「SpringBoot集成MybatisPlus」
  12. SpringBoot圖文教程12—SpringData Jpa的基本使用
  13. SpringBoot圖文教程13—SpringBoot+IDEA實現代碼熱部署
  14. SpringBoot圖文教程14—阿裡開源EasyExcel「為百萬數據讀寫設計」
  15. SpringBoot圖文教程15—項目異常怎麼辦？「跳轉404錯誤頁面」「全局異常捕獲」
  16. SpringBoot圖文教程16—SpringBoot 多模塊開發「web」「打包」

前言

問個問題：通過Java代碼怎麼發送Http請求，請求另一個Java程式的Controller方法呢？

好像真的有點觸及到知識盲區了呦

在以前的代碼中，Java程式都是被請求的一方，發送請求的要麼是Ajax，要麼是瀏覽器，要麼是postman等，今天就來一起學習一下如何通過Java代碼發送Http請求。

RestTemplate 的使用

準備工作「可以跳過，不影響教程學習」

因為我們要通過RestTemplate發送請求，請求另外一個項目的Controller層方法（介面），所以我們首先需要一個被請求的項目。
關於這個項目，我已經搭建好了，碼雲地址為：https://gitee.com/bingqilinpeishenme/boot-demo/tree/master/boot-base-rest

在項目中有三個方法，分別是測試Get請求和Post請求如下

package com.lby.controller;

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

/**
 * @author luxiaoyang
 * @create 2020-03-18-20:02
 */
@Controller
public class TestController {
    /**
     * @GetMapping("testRestGet") 當前方法只接受Get請求
     * 等價於
     * @RequestMapping(path = "testRestGet",method = RequestMethod.GET)
     */
    @GetMapping("testRestGet")
    @ResponseBody
    public String testRestGet(String username){
        return "這是一個Get請求，接受參數："+username;
    }

    /**
     * @PostMapping("") 當前方法只接受Post請求
     * 等價於
     * @RequestMapping(path = "testRestPost",method = RequestMethod.POST)
     */
    @PostMapping("testRestPost")
    @ResponseBody
    public String testRestPost(String username){
        return "這是一個Post請求，接受參數："+username;
    }

    /**
     * 測試 postForLocation 給RestTemplate響應url地址
     */
    @PostMapping("testRestPostLocation")
    public String testRestPostLocation(String username){
        System.out.println(username);
        return "redirect:/success.html";
    }
}

什麼是RestTemplate

Spring中封裝的通過Java代碼發送RestFul請求的模板類，內置發送get post delete等請求的方法，在SpringBoot中只要導入spring-boot-starter-web的依賴可以直接使用。

快速開始

確定項目中導入spring-boot-starter-web的依賴。

第一步：配置RestTemplate

/**
 * RestTemplate配置
 */
@Configuration
public class RestTemplateConfig {

    @Bean
    public RestTemplate restTemplate(ClientHttpRequestFactory factory) {
        return new RestTemplate(factory);
    }

    @Bean
    public ClientHttpRequestFactory simpleClientHttpRequestFactory() {
        SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();
        //        超時設置
        factory.setReadTimeout(5000);//ms
        factory.setConnectTimeout(15000);//ms
        return factory;
    }
}

第二步：直接使用RestTemplate的Api發送請求

這一步，我們直接在測試類中發送Get方式的請求，進行簡單的測試，感受到效果之後，再進行更多API深入的學習。

package com.lby;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.web.client.RestTemplate;

@RunWith(SpringRunner.class)
@SpringBootTest(classes = {BootResttemplateApplication.class})
public class BootResttemplateApplicationTests {

    @Autowired
    private RestTemplate restTemplate;


    /**
     * 測試get請求
     */
    @Test
    public void test1(){
        /**
         * getForObject
         * 
         * 參數1 要請求的地址的url  必填項
         * 參數2 響應數據的類型 是String 還是 Map等 必填項
         * 參數3 請求攜帶參數 選填
         *
         * getForObject 方法的返回值就是 被調用介面響應的數據
         */
        String result = restTemplate.getForObject("http://localhost:8802/product/showProductById?id=1", String.class);

        System.out.println(result);
    }

}

RestTemplate的主要API

HTTP Method RestTemplate Methods
Get getForObject, getForEntity
Post postForEntity, postForObject, postForLocation
PUT put
any exchange, execute
DELETE delete
HEAD headForHeaders
OPTIONS optionsForAllow

以上是RestTemplate的主要API，其中大部分的API會在後續的代碼中詳細講解。

Get請求的所有使用方式

Get請求方式：

  1. url拼接參數
  2. url拼接參數「占位符的方式」
  3. 獲取響應實體對象「響應狀態碼」
     /**
     * 測試get請求
     */
    @Test
    public void test1(){
        /**
         * getForObject
         *
         * 參數1 要請求的地址的url  必填項
         * 參數2 響應數據的類型 是String 還是 Map等 必填項
         * 參數3 請求攜帶參數 選填
         *
         * getForObject 方法的返回值就是 被調用介面響應的數據
         */
        String result = restTemplate.getForObject("http://localhost:8802/testRestGet?username=zhangsan", String.class);

        System.out.println(result);
        /**
         * getForEntity 方法
         * 參數1 要請求的地址的url  必填項
         * 參數2 響應數據的類型 是String 還是 Map等 必填項
         * 參數3 請求攜帶參數 選填
         *
         * 返回值類型為 ResponseEntity
         *
         * 可以通過ResponseEntity 獲取響應的數據，響應的狀態碼等信息
         */
        ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://localhost:8802/testRestGet?username=zhangsan", String.class);

        System.out.println("獲取響應的狀態："+responseEntity.getStatusCode());

        System.out.println("獲取響應的數據："+responseEntity.getBody());

        /**
         * 通過Map傳參
         */
        Map map= new HashMap();
        map.put("name","zhangsan");

        String resultId = restTemplate.getForObject("http://localhost:8802/testRestGet?username={name}",
                String.class,map);

        System.out.println(resultId);

    }

需要註意的是通過Map方式傳參

執行測試類代碼，可以看到如下效果：

Post請求的所有使用方式

post請求三種情況

  1. 模擬攜帶表單參數
  2. url拼接參數
  3. 請求成功之後，獲取跳轉地址
 /**
     * 測試Post請求
     */
    @Test
    public void test2(){
        /**
         * postForObject 返回值為響應的數據
         * 參數1 要請求地址的url
         * 參數2 通過LinkedMultiValueMap對象封裝請求參數  模擬表單參數，封裝在請求體中
         * 參數3 響應數據的類型
         */
        LinkedMultiValueMap<String, String> request = new LinkedMultiValueMap<>();
        request.set("username","zhangsan");

        String result = restTemplate.postForObject("http://localhost:8802/testRestPost",request,String.class);

        System.out.println(result);

        /**
         * Post請求的時候同樣也可以進行參數拼接，使用方式和Get一樣
         * 示例如下,通過map封裝數據，利用占位符的方式可以將參數拼接到url上
         * 和Get請求url拼接一樣
         */
        Map map = new HashMap();
        map.put("password","123456");

        String result2 = restTemplate.postForObject("http://localhost:8802/testRestPost?password={password}",request,
                String.class,map);

        /**
         * postForLocation 這個API和前兩個都不一樣
         *
         * 登錄or註冊都是post請求，而這些操作完成之後呢？大部分都是跳轉到別的頁面去了，這種場景下，就可以使用 postForLocation 了，提交數據，並獲取返回的URI
         * 響應參數要跳轉的地址
         */
        URI uri = restTemplate.postForLocation("http://localhost:8802/testRestPostLocation", request);
        System.out.println("postForLocation請求到的地址為："+uri);
    }

執行測試方法，效果如下：

Tips：delete，put等請求方式的使用類似Get和Post，模仿Get和Post 即可搞定。

Get和Post如何設置請求頭

通用方式設置請求頭「適合Get，Post等請求」

1.創建ClientHttpRequestInterceptor類，添加請求頭

package com.lby;

import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpRequest;
import org.springframework.http.client.ClientHttpRequestExecution;
import org.springframework.http.client.ClientHttpRequestInterceptor;
import org.springframework.http.client.ClientHttpResponse;

import java.io.IOException;

/**
 * @author luxiaoyang
 * @create 2020-03-20-20:37
 */
public class UserAgentInterceptor implements ClientHttpRequestInterceptor {
    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {

        HttpHeaders headers = request.getHeaders();
//        設置請求頭參數
        headers.add(HttpHeaders.USER_AGENT,
                "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36");
        return execution.execute(request, body);
    }
}

2.在Get請求的時候，使用請求頭

  /**
     * 通用方式設置請求頭
     */
    @Test
    public void test3(){
        /**
         * RestTemplate設置使用請求頭的攔截器
         */
        restTemplate.setInterceptors(Collections.singletonList(new UserAgentInterceptor()));

        /**
         * 正常的發送請求
         */
        String result = restTemplate.getForObject("http://localhost:8802/testRestGet?username=zhangsan", String.class);

        System.out.println(result);
    }

Post請求設置請求頭的第二種方式

Post請求的第二個參數是Request，可以根據請求頭 + 請求參數，構建 HttpEntity 對象，將這個作為post的請求request參數傳入。具體的代碼如下：

  /**
     * Post方式設置請求頭
     */
    @Test
    public void test4(){
        //1. 設置請求頭參數
        HttpHeaders requestHeaders = new HttpHeaders();
        requestHeaders.add(HttpHeaders.USER_AGENT, "Mozilla/5.0 (Windows NT 10.0; Win64; x64) " +
                "AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36");
        //2. 模擬表單參數 請求體攜帶參數
        MultiValueMap<String, String> requestBody = new LinkedMultiValueMap<>();
        requestBody.add("username", "zhangsan");
        //3. 封裝HttpEntity對象
        HttpEntity<MultiValueMap> requestEntity = new HttpEntity<MultiValueMap>(requestBody, requestHeaders);
        RestTemplate restTemplate = new RestTemplate();

        //4. 發送Post請求
        ResponseEntity<String> responseEntity = restTemplate.postForEntity("http://localhost:8802/testRestPost", requestEntity, String.class);
        System.out.println(responseEntity.getBody());
    }

總結

所有示例代碼下載地址：https://gitee.com/bingqilinpeishenme/boot-demo/tree/master

恭喜你完成了本章的學習，為你鼓掌！如果本文對你有幫助，請幫忙點贊，評論，轉發，這對作者很重要，謝謝。

讓我們再次回顧本文的學習目標

  • 掌握SpringBoot中RestTemplate的使用

要掌握SpringBoot更多的用法，請持續關註本系列教程。

歡迎關註本人公眾號：鹿老師的Java筆記，將在長期更新Java技術圖文教程和視頻教程，Java學習經驗，Java面試經驗以及Java實戰開發經驗。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • C++ 類(const修飾普通成員函數)
    const修飾普通成員函數 我們知道this指針指向的是具體的對象,普通的成員函數存在(加深記憶),設計this指針的時候格式為*const this（常量指針）。 const修飾變數一般有兩種方式：const T *a，或者 T const *a，這兩者都是一樣的，主要看const位於*的左邊還是 ...
  • 【java框架】MyBatis(1)—MyBatis入門
    1. MyBatis認識 MyBatis是一款優秀的持久層框架，它支持定製化SQL、存儲過程以及高級映射。MyBatis可以使用簡單的XML配置或註解來配置和映射原生信息，將介面和Java的POJO（Plain Ordinary Java Object，普通Java對象）映射成資料庫中的數據。 2. ...
  • python中多線程與多進程中的數據共用問題
    之前在寫多線程與多進程的時候，因為一般情況下都是各自完成各自的任務，各個子線程或者各個子進程之前並沒有太多的聯繫，如果需要通信的話我會使用隊列或者資料庫來完成，但是最近我在寫一些多線程與多進程的代碼時，發現如果它們需要用到共用變數的話，需要有一些註意的地方 多線程之間的共用數據 標準數據類型線上程間 ...
  • 基於ssm開發畢業設計管理系統 源碼 使用MySQL資料庫
    畢業設計管理系統 畢業設計管理系統可以分為五個模塊：登錄模塊，選題模塊，信息管理模塊，流程管理模塊，文件管理模塊。 該系統在技術上使用Spring+SpringMVC+MyBatis整合框架作為後臺開發框架，AmazeUI作為前端開發框架。 並使用Ehcache作為項目的緩存，druid作為項目的數 ...
  • 五分鐘學Java：如何學習Java面試必考的網路編程
    原創聲明 本文作者：黃小斜 轉載請務必在文章開頭註明出處和作者。 本文思維導圖 簡介 Java作為一門後端語言，對於網路編程的支持是必不可少的，但是，作為一個經常CRUD的Java工程師，很多時候都不需要接觸到網路編程，自然而然地對這個東西不那麼重視了，畢竟，即使像是JVM虛擬機，Java多線程，在 ...
  • 《自拍教程47》Python_adb重啟設備100次
    做Android手機/電視機/車載系統穩定性測試， 需要進行100次的系統重啟，確保啟動過程中，不出現卡死起不來， 或者起來後Home界面異常等情況。 還有涉及首次使用開機激活界面的測試，要確保每次系統重啟， 只要設備沒激活，就得每次都彈出激活界面。 準備階段 1. adb reboot 或者adb ...
  • 使用python生成包含1000個隨機字元的字元串，然後統計每個字元的出現次數。（使用字典）
    1 # 導入random模塊和string模塊 2 import random 3 import string 4 5 # string.ascii_letters表示26個大小寫字母 6 # string.digits表示10個阿拉伯數字 7 # string.punctuation表示標點字元 ...
  • 2020Python作業12——函數對象和閉包函數（一）
    @2020.3.20 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類