很好用的URL工具类

news2024/11/28 20:11:20

📢 📢 📢 📣 📣 📣
哈喽！大家好，我是「奇点」，江湖人称 singularity。刚工作几年，想和大家一同进步 🤝 🤝
一位上进心十足的【Java ToB端大厂领域博主】！ 😜 😜 😜
喜欢java和python，平时比较懒，能用程序解决的坚决不手动解决 😜 😜 😜
✨ 如果有对【java】感兴趣的【小可爱】，欢迎关注我
❤️ ❤️ ❤️感谢各位大可爱小可爱！ ❤️ ❤️ ❤️
————————————————
如果觉得本文对你有帮助，欢迎点赞，欢迎关注我，如果有补充欢迎评论交流，我将努力创作更多更好的文章。

前言

开发中我们经常会操作 URL，比如提取端口、提取路径以及最常用的提取参数等等。很多时候需要借助于一些第三方类库或者自己编写工具类来实现，今天项目需求需要对url进行操作，虽然很简单，但是由于自己写的话可能会有想不到的地方，会有一些坑，为了避坑，找了一个Spring的工具类，其实想resttemplate就是使用这个工具类进行解析的。

我的需求是获取url中的参数，这里也将这个工具类的方法都简单唠一下，大家有啥其他的工具类，可以告诉我再进行补充。

UriComponents

JDK 虽然提供了java.net.URI，但是终归还是不够强大，所以 Spring 封装了一个不可变量的 URI 表示org.springframework.web.util.UriComponents。

UriComponentsBuilder

我们可以利用其构造类UriComponentsBuilder从URI、Http 链接、URI 路径中初始化UriComponents。以Http 链接为例

String httpUrl= "https://bii.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.bii.cn")
        .port("8080")
        .path("/spring-boot/{article}")
        .queryParam("version","9527")
        .encode(StandardCharsets.UTF_8)
        .build();
// https://www.bii.cn:8080/spring-boot/{article}?version=9527

操作 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);

上面的方法还能直接转换成我们常用的map

private Map<String, String> contractParamMap(String decodeUrl) {
        Map<String, String> map = new HashMap<>();
        if (StringUtils.isBlank(decodeUrl)) {
            return map;
        }
        UriComponents uriComponents = UriComponentsBuilder.fromHttpUrl(decodeUrl).build();
        MultiValueMap<String, String> queryParams = uriComponents.getQueryParams();
        return queryParams.toSingleValueMap();
    }

填充路径参数

假如我们想填充上面中代码中声明的的httpUrl中的路径参数{article}，我们可以这样：

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


        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);