如何通过 Spring Boot 获取完整请求的 URL 和查询参数

在开发 Web 应用时，我们有时需要获取客户端发起的完整请求 URL，尤其是在做一些统计或日志记录时。Spring Boot 提供了方便的方式通过 HttpServletRequest 来获取请求的相关信息。

本文将介绍如何使用 Spring Boot 获取客户端的完整请求 URL 及其查询参数。

1. 引入必要依赖

假设你已经创建了一个基于 Spring Boot 的项目，你需要在项目的 pom.xml 中引入以下依赖来确保 Web 功能可以正常工作：

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

2. 实现 UrlController 控制器

我们创建一个 UrlController，其中包含一个 API 端点 /get-url。每当客户端发起该端点的请求时，我们将返回完整的请求 URL（包括查询参数部分）。

import javax.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
public class UrlController {

    @GetMapping("/get-url")
    public String getUrl(HttpServletRequest request) {
        // 获取完整的请求URL
        String url = request.getRequestURL().toString();
        
        // 获取查询参数部分
        String queryString = request.getQueryString(); 
        
        // 如果存在查询参数，将其添加到URL
        if (queryString != null) {
            url += "?" + queryString;
        }
        return url;
    }
}

代码详解

1. 获取完整 URL
   我们通过 request.getRequestURL() 方法获取到请求的完整 URL（不包含查询参数部分）。

2. 获取查询参数
   通过 request.getQueryString() 方法来获取查询参数。查询参数是位于 URL 中 ? 之后的部分，例如：?id=123&name=test。

3. 拼接查询参数
   如果存在查询参数，我们将其添加到获取到的 URL 后，形成完整的请求路径。

3. 启动项目并测试

启动你的 Spring Boot 应用，然后使用浏览器或工具（如 Postman）访问以下 URL：

http://localhost:8080/get-url?id=123&name=test
你将看到返回的结果为：

http://localhost:8080/get-url?id=123&name=test

这证明我们成功获取了完整的请求 URL 和查询参数。

4. 应用场景

在很多场景下，我们可能需要获取完整的 URL 来进行处理，例如：

• 记录用户访问的路径和参数。
• 重定向或转发请求时，将原始请求路径附加到新请求中。
• 在 OAuth 或 API 调用中构建回调 URL。

通过 HttpServletRequest 获取 URL 是一种简单而高效的方式，能够很好地适应不同的业务需求。

总结

通过本文的介绍，我们学习了如何使用 Spring Boot 中的 HttpServletRequest 来获取客户端发起的完整请求 URL 以及查询参数。你可以将这种方法应用于项目中需要获取请求信息的场景中。

希望这篇文章对你有帮助！