SpringBoot系列教程web篇之Get請求參數解析姿式彙總

時間  2019-11-07
標籤 springboot 系列 教程 web 請求 參數 解析 彙總 欄目 Spring 简体版
原文   原文鏈接

通常在開發web應用的時候，若是提供http接口，最多見的http請求方式爲GET/POST，咱們知道這兩種請求方式的一個顯著區別是GET請求的參數在url中，而post請求能夠不在url中；那麼一個SpringBoot搭建的web應用能夠如何解析發起的http請求參數呢？java

下面咱們將結合實例彙總一下GET請求參數的幾種常見的解析姿式git

原文：190824-SpringBoot系列教程web篇之Get請求參數解析姿式彙總github

I. 環境搭建

首先得搭建一個web應用纔有可能繼續後續的測試，藉助SpringBoot搭建一個web應用屬於比較簡單的活;web

建立一個maven項目，pom文件以下spring

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.7</version>
    <relativePath/> <!-- lookup parent from update -->
</parent>

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
    <java.version>1.8</java.version>
</properties>

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

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </pluginManagement>
</build>
<repositories>
    <repository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>https://repo.spring.io/milestone</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>
複製代碼

添加項目啓動類Application.cass數組

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
}
複製代碼

在演示請求參數的解析實例中，咱們使用終端的curl命令來發起http請求（主要緣由是截圖上傳太麻煩，仍是終端的文本輸出比較方便；缺點是不太直觀）bash

II. GET請求參數解析

接下來咱們正式進入參數解析的妖嬈姿式篇，會介紹一下常見的一些case（並不能說包含了全部的使用case）app

下面全部的方法都放在 ParamGetRest 這個Controller中curl

@RestController
@RequestMapping(path = "get")
public class ParamGetRest {
}
複製代碼

1. HttpServletRequest

直接使用HttpServletRequest來獲取請求參數，屬於比較原始，可是靈活性最高的使用方法了。maven

常規使用姿式是方法的請求參數中有一個HttpServletRequest，咱們經過ServletRequest#getParameter(參數名)來獲取具體的請求參數，下面演示返回全部請求參數的case

@GetMapping(path = "req")
public String requestParam(HttpServletRequest httpRequest) {
    Map<String, String[]> ans = httpRequest.getParameterMap();
    return JSON.toJSONString(ans);
}
複製代碼

測試case，注意下使用curl請求參數中有中文時，進行了url編碼（後續會針對這個問題進行說明）

➜  ~ curl 'http://127.0.0.1:8080/get/req?name=yihuihiu&age=19'
{"name":["yihuihiu"],"age":["19"]}%                                                                                                                                       ➜  ~ curl 'http://127.0.0.1:8080/get/req?name=%E4%B8%80%E7%81%B0%E7%81%B0&age=19'
{"name":["一灰灰"],"age":["19"]}%
複製代碼

使用HttpServletRequest獲取請求參數，還有另一種使用case，不經過參數傳遞的方式獲取Request實例，而是藉助RequestContextHolder；這樣的一個好處就是，假設咱們想寫一個AOP，攔截GET請求並輸出請求參數時，能夠經過下面這種方式來處理

@GetMapping(path = "req2")
public String requestParam2() {
    HttpServletRequest request =
            ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();
    String name = request.getParameter("name");
    return "param Name=" + name;
}
複製代碼

測試case

➜  ~ curl 'http://127.0.0.1:8080/get/req2?name=%E4%B8%80%E7%81%B0%E7%81%B0&age=19'
param Name=一灰灰%
複製代碼

2. 方法參數

這種解析方式比較厲害了，將GET參數與方法的參數根據參數名進行映射，從感官上來看，就像是直接調用這個同樣

@GetMapping(path = "arg")
public String argParam(String name, Integer age) {
    return "name: " + name + " age: " + age;
}
複製代碼

針對上面提供的方式，咱們的測試天然會區分爲下面幾種，看下會怎樣

  • 正好兩個參數，與定義一直
  • 缺乏一個請求參數
  • 多一個請求參數
  • 參數類型不一致
# 參數解析正常
➜  ~ curl 'http://127.0.0.1:8080/get/arg?name=%E4%B8%80%E7%81%B0%E7%81%B0&age=19'
name: 一灰灰 age: 19%
# 缺乏一個參數時，爲null
➜  ~ curl 'http://127.0.0.1:8080/get/arg?name=%E4%B8%80%E7%81%B0%E7%81%B0'
name: 一灰灰 age: null% 
# 多了一個參數，沒法被解析
➜  ~ curl 'http://127.0.0.1:8080/get/arg?name=%E4%B8%80%E7%81%B0%E7%81%B0&age=19&id=10'
name: 一灰灰 age: 19%                                                              
# 類型不一致，500 
➜  ~ curl 'http://127.0.0.1:8080/get/arg?name=%E4%B8%80%E7%81%B0%E7%81%B0&age=haha' -i
HTTP/1.1 500
Content-Length: 0
Date: Sat, 24 Aug 2019 01:45:14 GMT
Connection: close
複製代碼

從上面實際的case能夠看出，利用方法參數解析GET傳參時，實際效果是：

  • 方法參數與GET傳參，經過參數簽名進行綁定
  • 方法參數類型，須要與接收的GET傳參類型一致
  • 方法參數非基本類型時，若傳參沒有，則爲null；（也就是說若是爲基本類型，沒法轉null，拋異常）
  • 實際的GET傳參能夠多於方法定義的參數

接下來給一個數組傳參解析的實例

@GetMapping(path = "arg2")
public String argParam2(String[] names, int size) {
    return "name: " + (names != null ? Arrays.asList(names) : "null") + " size: " + size;
}
複製代碼

測試case以下，傳數組時參數值用逗號分隔；基本類型，必須傳參，不然解析異常

➜  ~ curl 'http://127.0.0.1:8080/get/arg2?name=yihui,erhui&size=2'
name: null size: 2%                                                                                                                                                       ➜  ~ curl 'http://127.0.0.1:8080/get/arg2?name=yihui,erhui' -i
HTTP/1.1 500
Content-Length: 0
Date: Sat, 24 Aug 2019 01:53:30 GMT
Connection: close
複製代碼

3. RequestParam 註解

這種方式看起來和前面有些類似，但更加靈活，咱們先看一下註解

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestParam {
  // 指定請求參數名
	String value() default "";
	// 指定請求參數名
	String name() default "";
	// true表示發起請求時這個參數必須存在
	boolean required() default true;
	String defaultValue() default ValueConstants.DEFAULT_NONE;
}
複製代碼

有兩個參數須要注意，一個是name表示這個參數與GET傳參的哪一個關聯；required表示這個參數是否可選

下面是一個簡單的使用方式

@GetMapping(path = "ano")
public String anoParam(@RequestParam(name = "name") String uname, @RequestParam(name = "age", required = false) Integer age, @RequestParam(name = "uids", required = false) Integer[] uids) {
    return "name: " + uname + " age: " + age + " uids: " + (uids != null ? Arrays.asList(uids) : "null");
}
複製代碼

測試以下:

# 三個參數全在
➜  ~ curl 'http://localhost:8080/get/ano?name=%E4%B8%80%E7%81%B0%E7%81%B0blog&age=18&uids=1,3,4'
name: 一灰灰blog age: 18 uids: [1, 3, 4]%
# age不傳
➜  ~ curl 'http://localhost:8080/get/ano?name=%E4%B8%80%E7%81%B0%E7%81%B0blog&uids=1,3,4'
name: 一灰灰blog age: null uids: [1, 3, 4]% 
# 必選參數name不傳時
➜  ~ curl 'http://localhost:8080/get/ano?uids=1,3,4' -i
HTTP/1.1 500
Content-Length: 0
Date: Sat, 24 Aug 2019 13:09:07 GMT
Connection: close
複製代碼

使用RequestParam註解時，若是指定了name/value，這個參數就與指定的GETGET傳參關聯；若是不指定時，則根據參數簽名來關聯

下面給出兩個更有意思的使用方式，一個是枚舉參數解析，一個是Map容納參數，一個是數組參數解析

public enum TYPE {
    A, B, C;
}

@GetMapping(path = "enum")
public String enumParam(TYPE type) {
    return type.name();
}

@GetMapping(path = "enum2")
public String enumParam2(@RequestParam TYPE type) {
    return type.name();
}

@GetMapping(path = "mapper")
public String mapperParam(@RequestParam Map<String, Object> params) {
    return params.toString();
}

// 注意下面這個寫法，沒法正常獲取請求參數，這裏用來對比列出
@GetMapping(path = "mapper2")
public String mapperParam2(Map<String, Object> params) {
    return params.toString();
}


@GetMapping(path = "ano1")
public String anoParam1(@RequestParam(name = "names") List<String> names) {
    return "name: " + names;
}

// 注意下面這個寫法沒法正常解析數組
@GetMapping(path = "arg3")
public String anoParam2(List<String> names) {
    return "names: " + names;
}
複製代碼

測試case以下

➜  ~ curl 'http://localhost:8080/get/enum?type=A'
A%
➜  ~ curl 'http://localhost:8080/get/enum2?type=A'
A%
➜  ~ curl 'http://localhost:8080/get/mapper?type=A&age=3'
{type=A, age=3}%
➜  ~ curl 'http://localhost:8080/get/mapper2?type=A&age=3'
{}%
➜  ~ curl 'http://localhost:8080/get/ano1?names=yi,hui,ha'
name: [yi, hui, ha]%
➜  ~ curl 'http://localhost:8080/get/arg3?names=yi,hui,ha' -i
HTTP/1.1 500
Content-Length: 0
Date: Sat, 24 Aug 2019 13:50:55 GMT
Connection: close
複製代碼

從測試結果能夠知道：

  • GET傳參映射到枚舉時，根據enum.valueOf()來實例的
  • 若是但願使用Map來容納全部的傳參，須要加上註解@RequestParam
  • 若是參數爲List類型，必須添加註解@RequestParam；不然用數組來接收

4. PathVariable

從請求的url路徑中解析參數，使用方法和前面的差異不大

@GetMapping(path = "url/{name}/{index}")
public String urlParam(@PathVariable(name = "name") String name, @PathVariable(name = "index", required = false) Integer index) {
    return "name: " + name + " index: " + index;
}
複製代碼

上面是一個常見的使用方式，對此咱們帶着幾個疑問設計case

  • 只有name沒有index，會怎樣？
  • 有name，有index，後面還有路徑，會怎樣？
➜  ~ curl http://127.0.0.1:8080/get/url/yihhuihui/1
name: yihhuihui index: 1%

➜  ~ curl 'http://127.0.0.1:8080/get/url/yihhuihui' -i
HTTP/1.1 500
Content-Length: 0
Date: Sat, 24 Aug 2019 13:27:08 GMT
Connection: close

➜  ~ curl 'http://127.0.0.1:8080/get/url/yihhuihui/1/test' -i
HTTP/1.1 500
Content-Length: 0
Date: Sat, 24 Aug 2019 13:27:12 GMT
Connection: close
複製代碼

從path中獲取參數時，對url有相對嚴格的要求，注意使用

5. POJO

這種case，我我的用得比較多，特別是基於SpringCloud的生態下，藉助Feign來調用第三方微服務，能夠說是很舒爽了；下面看一下這種方式的使用姿式

首先定義一個POJO

@Data
public class BaseReqDO implements Serializable {
    private static final long serialVersionUID = 8706843673978981262L;

    private String name;

    private Integer age;

    private List<Integer> uIds;
}
複製代碼

提供一個服務

@GetMapping(path = "bean")
public String beanParam(BaseReqDO req) {
    return req.toString();
}
複製代碼

POJO中定義了三個參數，咱們再測試的時候，看一下這些參數是否必選

# GET傳參與POJO中成員名進行關聯
➜  ~ curl 'http://127.0.0.1:8080/get/bean?name=yihuihui&age=18&uIds=1,3,4'
BaseReqDO(name=yihuihui, age=18, uIds=[1, 3, 4])%
# 沒有傳參的屬性爲null；所以若是POJO中成員爲基本類型，則參數必傳
➜  ~ curl 'http://127.0.0.1:8080/get/bean?name=yihuihui&age=18'
BaseReqDO(name=yihuihui, age=18, uIds=null)%
複製代碼

II. 其餘

0. 項目

1. 一灰灰Blog

盡信書則不如，以上內容，純屬一家之言，因我的能力有限，不免有疏漏和錯誤之處，如發現bug或者有更好的建議，歡迎批評指正，不吝感激

下面一灰灰的我的博客，記錄全部學習和工做中的博文，歡迎你們前去逛逛

一灰灰blog
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程