Spring获取所有查询参数为字符串方法咨询及API网关GET请求转发实现

Hey there! Let's break down your two needs clearly—how to convert all query parameters to a string in Spring, and how to polish your API gateway's GET request forwarding logic.

一、将所有查询参数转换为字符串的几种实现方法 #

1. 直接从HttpServletRequest获取原始查询字符串 #

这是最简单直接的方式，HttpServletRequest的getQueryString()方法会直接返回请求中?后面的完整查询参数字符串（比如请求是/api?name=alice&age=30，这个方法返回name=alice&age=30；如果没有查询参数则返回null）。

示例代码：

@RequestMapping(value = "/test", method = RequestMethod.GET)
public ResponseEntity<String> testQueryString(HttpServletRequest req) {
    String queryParams = req.getQueryString();
    // 处理无参数的情况
    String queryStr = queryParams != null ? "?" + queryParams : "";
    return ResponseEntity.ok("Query string: " + queryStr);
}

2. 通过@RequestParam接收参数后手动拼接 #

如果你需要自定义拼接格式（比如用分号分隔、调整参数顺序），可以用@RequestParam Map<String, String>接收所有参数，再遍历拼接。

示例代码：

@RequestMapping(value = "/test-map", method = RequestMethod.GET)
public ResponseEntity<String> testQueryMap(@RequestParam Map<String, String> params) {
    if (params.isEmpty()) {
        return ResponseEntity.ok("No query parameters");
    }
    StringBuilder sb = new StringBuilder("?");
    for (Map.Entry<String, String> entry : params.entrySet()) {
        sb.append(entry.getKey()).append("=").append(entry.getValue()).append("&");
    }
    // 去掉最后一个多余的&
    String queryStr = sb.substring(0, sb.length() - 1);
    return ResponseEntity.ok("Custom query string: " + queryStr);
}

3. 利用UriComponentsBuilder构建查询字符串 #

这种方式能自动处理URL编码，适合需要规范格式的场景，还能和URI构建结合起来。

示例代码：

@RequestMapping(value = "/test-uri", method = RequestMethod.GET)
public ResponseEntity<String> testUriBuilder(HttpServletRequest req) {
    UriComponents uriComponents = UriComponentsBuilder.fromHttpRequest(new ServletServerHttpRequest(req)).build();
    // 获取查询部分（不带?）
    String queryStr = uriComponents.getQuery();
    String fullQuery = queryStr != null ? "?" + queryStr : "";
    return ResponseEntity.ok("Encoded query string: " + fullQuery);
}

二、你的API网关代码优化建议 #

先看你现有的核心代码，这里有几个需要调整的点，同时结合查询参数转发的需求，我整理了优化后的版本：

1. 修复targetHost拆分的问题 #

原代码中uriString.split("/")[0]会在uriString以/开头时返回空字符串（比如/example.com/api），需要先处理开头的斜杠。

2. 补充协议前缀 #

构建URI时，如果targetHost没有http://或https://前缀，会抛出IllegalArgumentException，所以要提前判断并补充。

3. 转发原请求的查询参数 #

把原请求的查询参数也带上，避免丢失参数。

优化后的完整代码示例 #

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.HandlerMapping;
import org.springframework.web.util.UriComponentsBuilder;
import javax.servlet.http.HttpServletRequest;
import java.net.URI;

@RequestMapping(value = "**", method = RequestMethod.GET)
public @ResponseBody ResponseEntity<String> doGet(HttpServletRequest req) {
    // 获取完整的路径（包含所有层级）
    String uriString = (String) req.getAttribute(HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE);
    
    // 处理开头的斜杠，拆分出目标主机
    String[] pathSegments = uriString.replaceFirst("^/", "").split("/");
    if (pathSegments.length == 0) {
        return ResponseEntity.badRequest().body("Invalid request URI");
    }
    String targetHost = pathSegments[0];
    
    // 补充协议前缀（这里默认用http，你可以改成从配置读取，或者匹配原请求的协议）
    if (!targetHost.startsWith("http://") && !targetHost.startsWith("https://")) {
        targetHost = "http://" + targetHost;
    }
    
    // 构建目标URI：拼接剩余路径 + 原请求的查询参数
    UriComponentsBuilder uriBuilder = UriComponentsBuilder.fromUriString(targetHost)
            // 拼接除了targetHost之外的剩余路径部分
            .path(uriString.replaceFirst("^/?[^/]+", ""))
            // 添加原请求的查询参数
            .query(req.getQueryString());
    
    URI targetUri = uriBuilder.build().normalize().encode().toUri();
    
    try {
        // 建议将RestTemplate声明为Spring Bean，避免重复创建
        RestTemplate restTemplate = new RestTemplate();
        ResponseEntity<String> response = restTemplate.getForEntity(targetUri, String.class);
        
        // 转发响应状态码和内容
        return ResponseEntity.status(response.getStatusCode()).body(response.getBody());
    } catch (Exception e) {
        // 异常处理，根据实际情况调整
        return ResponseEntity.internalServerError().body("Forward request failed: " + e.getMessage());
    }
}

额外提示 #

• 不要每次都new RestTemplate，建议用@Bean声明为Spring单例Bean，提升性能。
• 如果需要处理高并发请求，推荐用非阻塞的WebClient替代RestTemplate。
• 可以添加日志记录，比如打印目标URI、请求耗时等，方便排查问题。

内容的提问来源于stack exchange，提问作者Garuuk