本文档旨在指导开发者如何在 spring boot graphql 客户端中处理对象列表。我们将重点介绍如何构建 graphql 查询，传递对象列表作为参数，并处理服务器返回的响应。通过本文，您将掌握使用 spring boot 构建 graphql 客户端，并有效处理复杂数据结构的技巧。
在使用 Spring Boot 构建 GraphQL 客户端时，处理对象列表是一个常见的需求。例如，你可能需要根据一组 ID 查询多个用户的信息。本文将详细介绍如何使用 GraphQLTemplate (或类似的库) 来实现这一目标，并提供代码示例和注意事项。
1. 定义 GraphQL Schema
首先，确保你的 GraphQL 服务端定义了正确的数据结构。例如，假设你有一个 Person 类型：
type Person {
firstName: String
middleName: String
lastName: String
birthDt: String
}
type Query {
getPersonsByIds(personIds: [String]): [Person]
}这个 Schema 定义了一个 Person 类型，以及一个名为 getPersonsByIds 的查询，它接受一个字符串列表 personIds 作为参数，并返回一个 Person 类型的列表。
2. 构建 GraphQL 查询
接下来，在你的 Spring Boot 客户端中，你需要构建一个 GraphQL 查询，该查询包含一个变量，用于传递 ID 列表。以下是一个示例：
import com.fasterxml.jackson.databind.ObjectMapper;
import com.github.americanexpress.graphql.spring.GraphQLTemplate;
import com.github.americanexpress.graphql.spring.operations.GraphQLRequestEntity;
import org.springframework.stereotype.Service;
import java.net.MalformedURLException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@Service
public class PersonService {
private final GraphQLTemplate graphQLTemplate = new GraphQLTemplate();
private final String url = "http://localhost:8084/graphql";
public List getPersonsByIds(List personIds) {
GraphQLRequestEntity requestEntity;
try {
// 使用 Jackson ObjectMapper 构建变量
ObjectMapper mapper = new ObjectMapper();
Map variables = new HashMap<>();
variables.put("personIds", personIds);
requestEntity = GraphQLRequestEntity.Builder()
.url(url)
.requestMethod(GraphQLTemplate.GraphQLMethod.QUERY)
.request("query($personIds: [String]) {\n" +
" getPersonsByIds(personIds : $personIds ) {\n" +
" firstName\n" +
" middleName\n" +
" lastName\n" +
" birthDt\n" +
" }\n" +
"}"
)
// 使用 Map 传递变量
.variables(variables)
.build();
} catch (MalformedURLException e) {
throw new RuntimeException(e);
}
// 假设 ResponseGetPersonsByIds 包含一个 getGetPersonsByIds() 方法
return graphQLTemplate.query(requestEntity, ResponseGetPersonsByIds.class).getResponse().getGetPersonsByIds();
}
// 内部类，用于模拟响应结构
private static class ResponseGetPersonsByIds {
private List getPersonsByIds;
public List getGetPersonsByIds() {
return getPersonsByIds;
}
public void setGetPersonsByIds(List getPersonsByIds) {
this.getPersonsByIds = getPersonsByIds;
}
}
// 内部类，用于模拟 Person 对象
public static class Person {
private String firstName;
private String middleName;
private String lastName;
private String birthDt;
// Getters and setters
public String getFirstName() {
return firstName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
}
public String getMiddleName() {
return middleName;
}
public void setMiddleName(String middleName) {
this.middleName = middleName;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public String getBirthDt() {
return birthDt;
}
public void setBirthDt(String birthDt) {
this.birthDt = birthDt;
}
}
public static void main(String[] args) {
PersonService personService = new PersonService();
List ids = Arrays.asList("2477142261427744786", "2477142261427744787");
List persons = personService.getPersonsByIds(ids);
if (persons != null) {
persons.forEach(person -> System.out.println(person.getFirstName()));
} else {
System.out.println("No persons found.");
}
}
} 3. 传递对象列表作为参数
在上面的代码中，我们使用 HashMap 来构造 GraphQL 查询的变量。关键在于将 personIds 列表作为变量的值传递给 GraphQL 查询。
4. 处理响应
graphQLTemplate.query() 方法会执行查询，并将结果映射到 ResponseGetPersonsByIds 类。你需要根据你的实际响应结构来定义这个类。 在这个例子中，ResponseGetPersonsByIds 包含一个 getPersonsByIds 字段，它是一个 Person 对象的列表。
5. 注意事项
- 数据类型匹配: 确保 GraphQL 查询中定义的变量类型与你传递的参数类型匹配。如果服务端期望的是 BigInteger 类型的列表，你需要将字符串 ID 转换为 BigInteger 对象。
- 依赖管理: 确保你已经添加了 com.github.americanexpress:nodes 依赖到你的项目中。如果使用其他GraphQL客户端库，例如 Spring for GraphQL，则依赖和实现方式会有所不同。
- 错误处理: 在实际应用中，你需要添加适当的错误处理机制，例如处理网络错误、GraphQL 错误等。
- 对象序列化: 如果需要传递复杂的对象列表，需要确保这些对象可以被正确地序列化为 JSON 格式。可以使用 Jackson 或 Gson 等库来完成序列化。
6. 总结
通过本文，你学习了如何在 Spring Boot GraphQL 客户端中处理对象列表。关键步骤包括定义 GraphQL Schema、构建 GraphQL 查询、传递对象列表作为参数，以及处理响应。记住，确保数据类型匹配，添加适当的错误处理机制，并正确处理对象序列化，以确保你的 GraphQL 客户端能够正常工作。
