使用RestTemplate调用GraphQL查询时遇400或语法错误问题

核心问题 #

你的问题根源在于手动拼接JSON格式的GraphQL请求体时，引号转义处理错误，导致两种异常情况：

1. 第一次未给参数加引号：GraphQL将Limit50-120视为标识符，但GraphQL标识符不允许包含连字符，直接触发语法错误。
2. 第二次手动加引号：因Java字符串转义和JSON格式规则冲突，最终生成的JSON不合法，服务无法解析返回400。

解决方案 #

放弃手动拼接JSON字符串，改用对象（如Map）构建请求体，让RestTemplate自动处理JSON序列化与转义，彻底规避转义错误。

方案1：直接构建带正确参数的查询请求 #

// 1. 编写合法的GraphQL查询语句，参数用引号包裹
String graphqlQuery = "{ parameterByName(name: \"%s\") { name, value } }";
String formattedQuery = String.format(graphqlQuery, "Limit50-120");

// 2. 构建请求体Map，RestTemplate会自动序列化为合法JSON
Map<String, String> requestBody = new HashMap<>();
requestBody.put("query", formattedQuery);

// 3. 设置请求头（必须指定Content-Type为application/json）
HttpHeaders httpHeaders = new HttpHeaders();
httpHeaders.setContentType(MediaType.APPLICATION_JSON);
// 补充其他业务所需header...

// 4. 发送请求
URI endpointUri = new URI("http://myservice.com/graphql");
HttpEntity<Map<String, String>> requestEntity = new HttpEntity<>(requestBody, httpHeaders);

ResponseEntity<ParametersResponse> response = this.restTemplate.postForEntity(
    endpointUri, 
    requestEntity, 
    ParametersResponse.class
);

方案2：使用GraphQL变量（更规范，推荐） #

这种方式完全避免参数拼接，适配复杂参数或含特殊字符的场景：

// 1. 定义带变量的GraphQL查询
String graphqlQuery = "query GetParameterByName($name: String!) { " +
    "  parameterByName(name: $name) { name, value } " +
"}";

// 2. 定义变量Map
Map<String, Object> variables = new HashMap<>();
variables.put("name", "Limit50-120");

// 3. 构建请求体
Map<String, Object> requestBody = new HashMap<>();
requestBody.put("query", graphqlQuery);
requestBody.put("variables", variables);

// 4. 设置请求头并发送请求
HttpHeaders httpHeaders = new HttpHeaders();
httpHeaders.setContentType(MediaType.APPLICATION_JSON);
// 补充其他业务所需header...

URI endpointUri = new URI("http://myservice.com/graphql");
HttpEntity<Map<String, Object>> requestEntity = new HttpEntity<>(requestBody, httpHeaders);

ResponseEntity<ParametersResponse> response = this.restTemplate.postForEntity(
    endpointUri, 
    requestEntity, 
    ParametersResponse.class
);

关键说明 #

• 手动拼接JSON时，Java字符串转义规则与JSON转义规则易冲突，多层嵌套时出错概率极高。用Map作为请求体，Spring的消息转换器会自动处理所有转义，生成完全合法的JSON。
• 务必确保请求头中设置Content-Type: application/json，这是GraphQL服务接收请求的标准格式，缺失会导致服务解析失败。

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