[[351545]]

1. 前言

開發中我們經常會操作 URL，比如提取端口、提取路徑以及最常用的提取參數等等。很多時候需要借助于一些第三方類庫或者自己編寫工具類來實現，今天胖哥給大家介紹一種方法，無需新的類庫引入，只要你使用了 Spring Web 模塊都可以輕松來完成對 URL 的組裝和分解提取。

2. UriComponents

JDK 雖然提供了java.net.URI，但是終歸還是不夠強大，所以 Spring 封裝了一個不可變量的 URI 表示org.springframework.web.util.UriComponents。

UriComponentsBuilder

我們可以利用其構造類UriComponentsBuilder從URI、Http 鏈接、URI 路徑中初始化UriComponents。以 Http 鏈接為例：

String httpUrl= "https://felord.cn/spring-security/{article}?version=1&timestamp=123123325"; 
UriComponents uriComponents = UriComponentsBuilder.fromHttpUrl(httpUrl).build(); 

如果不是 Http 就不能使用上面的方法了，需要使用fromUriString(String uri)。

我們也可以直接構造一個UriComponents:

UriComponents https = UriComponentsBuilder.newInstance() 
        .scheme("https") 
        .host("www.felord.cn") 
        .port("8080") 
        .path("/spring-boot/{article}") 
        .queryParam("version","9527") 
        .encode(StandardCharsets.UTF_8) 
        .build(); 
// https://www.felord.cn:8080/spring-boot/{article}?version=9527 

3. 操作 UriComponents

提取協議頭

如果想提取協議頭，如上面的例子我們想提取https。

String scheme = uriComponents.getScheme(); 
// scheme = https 
System.out.println("scheme = " + scheme); 

提取 Host

獲取host也是很常見的操作。

String host = uriComponents.getHost(); 
// host = felord.cn 
System.out.println("host = " + host); 

提取 Port

獲取 uri 的端口。

int port = uriComponents.getPort(); 
// port = -1 
System.out.println("port = " + port); 

但是很奇怪的是上面的是 -1,很多人誤以為會是80。其實 Http 協議確實是80，但是java.net.URL#getPort()規定，若 URL 的實例未申明(省略)端口號，則返回值為-1。所以當返回了-1就等同于80，但是 URL 中不直接體現它們。

提取 Path

提取路徑，這個還是經常用做判斷的。

String path = uriComponents.getPath(); 
// path = /spring-security/{article} 
System.out.println("path = " + path); 

提取 Query

提取路徑中的 Query 參數可以說是我們最常使用的功能了。

String query = uriComponents.getQuery(); 
// query = version=1&timestamp=123123325 
System.out.println("query = " + query); 

更加合理的提取方式：

MultiValueMap<String, String> queryParams = uriComponents.getQueryParams(); 
// queryParams = {version=[1], timestamp=[123123325]} 
System.out.println("queryParams = " + queryParams); 

填充路徑參數

假如我們想填充章節 2中代碼中聲明的的httpUrl中的路徑參數{article}，我們可以這樣：

UriComponents expand = uriComponents.expand("oauth2-authorization-request.html"); 
//expand = https://felord.cn/spring-security/oauth2-authorization-request.html?version=1&timestamp=123123325 
System.out.println("expand = " + expand); 

4. 總結

Spring 作為目前 Java Web 開發中幾乎不可避免的框架其實已經提供了很多有用的工具來方便我們操作。UriComponents只是其中一個用于操作URI的工具，今天我們對它的一些常用功能進行了演示，希望能夠幫你解決一些相關的操作難題。

本文轉載自微信公眾號「碼農小胖哥」，可以通過以下二維碼關注。轉載本文請聯系碼農小胖哥公眾號。