GraphQL 是一种新兴的 API 查询语言，它允许客户端指定需要的数据，从而避免了传统 RESTful API 中可能出现的过多或过少的数据传输问题。在前端开发中，使用 GraphQL 可以更好地满足客户端的需求，提高应用程序的性能和可扩展性。
本文将介绍如何使用 Java 构建 GraphQL 服务器，包括最佳实践、示例代码以及指导意义，帮助读者更好地理解和应用 GraphQL 技术。
1. 什么是 GraphQL
GraphQL 是一种 API 查询语言和运行时，由 Facebook 开发。它提供了一种更高效、强大和灵活的方式来设计、发布和使用 API，可以避免传统 RESTful API 中可能出现的数据过多或过少的问题。
GraphQL 的核心思想是让客户端指定需要的数据，而不是服务端返回固定的数据结构。客户端可以通过 GraphQL 查询语言来指定需要的数据，并且可以精确地指定每个字段的类型和数量。服务端将根据客户端的查询语句返回对应的数据，从而避免了传统 API 中不必要的网络传输和数据处理。
2. Java 中的 GraphQL 库
Java 中有多个 GraphQL 库可供选择，包括 graphql-java、graphql-spqr、sangria 等。其中，graphql-java 是最流行的 GraphQL 库之一，它提供了完整的 GraphQL 实现，并且可以与 Spring Boot 等常用框架集成。
在本文中，我们将使用 graphql-java 来构建 GraphQL 服务器，并讨论最佳实践和示例代码。
3. 构建 GraphQL 服务器的最佳实践
3.1 定义 Schema
在使用 GraphQL 时，首先需要定义 Schema，即数据模型和查询语言。Schema 中包含了所有可查询的字段、类型和关系，客户端可以根据 Schema 来构建查询语言。
在 graphql-java 中，可以使用 GraphQLSchema.Builder 来定义 Schema。例如，下面的代码定义了一个简单的 Schema：
// www.javascriptcn.com code example
GraphQLObjectType userType = GraphQLObjectType.newObject()
.name("User")
.field(GraphQLFieldDefinition.newFieldDefinition()
.name("id")
.type(Scalars.GraphQLInt))
.field(GraphQLFieldDefinition.newFieldDefinition()
.name("name")
.type(Scalars.GraphQLString))
.build();
GraphQLSchema schema = GraphQLSchema.newSchema()
.query(GraphQLObjectType.newObject()
.name("Query")
.field(GraphQLFieldDefinition.newFieldDefinition()
.name("user")
.type(userType)
.argument(GraphQLArgument.newArgument()
.name("id")
.type(Scalars.GraphQLInt)))
.build())
.build();上面的代码定义了一个 User 类型，包含 id 和 name 两个字段。然后定义了一个 Query 类型，包含 user 字段，用于查询 User 数据。user 字段接受一个 id 参数，返回符合条件的 User 数据。
3.2 定义 DataFetcher
在定义 Schema 后，需要定义 DataFetcher 用于获取数据。在 graphql-java 中，可以使用 DataFetcher 接口来实现数据获取逻辑。例如，下面的代码实现了获取 User 数据的 DataFetcher：
DataFetcher userFetcher = environment -> {
int id = environment.getArgument("id");
// 从数据库或其他数据源中获取 User 数据
User user = userService.getUserById(id);
return user;
};上面的代码定义了一个 DataFetcher，接受一个 id 参数，返回符合条件的 User 数据。在实际应用中，可以从数据库或其他数据源中获取 User 数据。
3.3 注册 DataFetcher
在定义 DataFetcher 后，需要将其注册到 Schema 中。在 graphql-java 中，可以使用 GraphQLObjectType.Builder.field() 方法来注册 DataFetcher。例如，下面的代码将 userFetcher 注册到 Schema 中：
// www.javascriptcn.com code example
GraphQLObjectType userType = GraphQLObjectType.newObject()
.name("User")
.field(GraphQLFieldDefinition.newFieldDefinition()
.name("id")
.type(Scalars.GraphQLInt))
.field(GraphQLFieldDefinition.newFieldDefinition()
.name("name")
.type(Scalars.GraphQLString))
.build();
GraphQLSchema schema = GraphQLSchema.newSchema()
.query(GraphQLObjectType.newObject()
.name("Query")
.field(GraphQLFieldDefinition.newFieldDefinition()
.name("user")
.type(userType)
.argument(GraphQLArgument.newArgument()
.name("id")
.type(Scalars.GraphQLInt))
.dataFetcher(userFetcher))
.build())
.build();上面的代码将 userFetcher 注册到 user 字段中，客户端查询 user 字段时将调用 userFetcher 获取数据。
3.4 处理错误
在使用 GraphQL 时，需要处理可能出现的错误。在 graphql-java 中，可以使用 DataFetcherExceptionHandler 接口来处理错误。例如，下面的代码实现了一个简单的错误处理器：
// www.javascriptcn.com code example
DataFetcherExceptionHandler exceptionHandler = new DataFetcherExceptionHandler() {
@Override
public void accept(DataFetcherExceptionHandlerParameters handlerParameters) {
Throwable exception = handlerParameters.getException();
handlerParameters.getExecutionContext().addError(
GraphqlErrorBuilder.newError(handlerParameters.getExecutionContext().getExecutionId())
.message(exception.getMessage())
.build());
}
};上面的代码实现了一个简单的错误处理器，将异常信息添加到 GraphQLExecutionContext 中，客户端可以通过查询错误信息来获取错误详情。
3.5 集成 Spring Boot
在实际应用中，通常需要将 GraphQL 服务器集成到 Spring Boot 中。在 graphql-java 中，可以使用 graphql-spring-boot-starter 来快速集成 GraphQL 服务器。
首先，需要在 pom.xml 文件中添加以下依赖：
<dependency>
<groupId>com.graphql-java-kickstart</groupId>
<artifactId>graphql-spring-boot-starter</artifactId>
<version>10.0.0</version>
</dependency>然后，在 Spring Boot 应用程序中添加以下代码：
// www.javascriptcn.com code example
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
@Bean
public GraphQLSchema schema() {
return GraphQLSchema.newSchema()
.query(GraphQLObjectType.newObject()
.name("Query")
.field(GraphQLFieldDefinition.newFieldDefinition()
.name("hello")
.type(Scalars.GraphQLString)
.argument(GraphQLArgument.newArgument()
.name("name")
.type(Scalars.GraphQLString))
.dataFetcher(environment -> {
String name = environment.getArgument("name");
return "Hello, " + (name != null ? name : "World") + "!";
}))
.build();
}
}上面的代码定义了一个简单的 GraphQL Schema，包含一个 hello 字段，用于返回 Hello, name! 或 Hello, World!。然后将 schema() 方法注入到 Spring Boot 应用程序中，即可快速集成 GraphQL 服务器。
4. 示例代码
下面是一个完整的示例代码，演示了如何使用 Java 构建 GraphQL 服务器：
// www.javascriptcn.com code example
public class Application {
public static void main(String[] args) {
GraphQLObjectType userType = GraphQLObjectType.newObject()
.name("User")
.field(GraphQLFieldDefinition.newFieldDefinition()
.name("id")
.type(Scalars.GraphQLInt))
.field(GraphQLFieldDefinition.newFieldDefinition()
.name("name")
.type(Scalars.GraphQLString))
.build();
DataFetcher userFetcher = environment -> {
int id = environment.getArgument("id");
// 从数据库或其他数据源中获取 User 数据
User user = userService.getUserById(id);
return user;
};
GraphQLSchema schema = GraphQLSchema.newSchema()
.query(GraphQLObjectType.newObject()
.name("Query")
.field(GraphQLFieldDefinition.newFieldDefinition()
.name("user")
.type(userType)
.argument(GraphQLArgument.newArgument()
.name("id")
.type(Scalars.GraphQLInt))
.dataFetcher(userFetcher))
.build())
.build();
GraphQL graphQL = GraphQL.newGraphQL(schema)
.build();
ExecutionResult result = graphQL.execute("{ user(id: 123) { id name } }");
System.out.println(result.getData().toString());
}
// 其他代码
}上面的代码定义了一个 User 类型，包含 id 和 name 两个字段。然后定义了一个 userFetcher，用于获取 User 数据。最后定义了一个 Schema，并使用 GraphQL 执行查询语句。
5. 指导意义
使用 Java 构建 GraphQL 服务器可以更好地满足客户端的需求，提高应用程序的性能和可扩展性。本文介绍了使用 graphql-java 构建 GraphQL 服务器的最佳实践，包括定义 Schema、定义 DataFetcher、注册 DataFetcher、处理错误和集成 Spring Boot 等。同时，本文提供了完整的示例代码，帮助读者更好地理解和应用 GraphQL 技术。
在实际应用中，需要根据具体的业务需求来设计和实现 GraphQL 服务器。同时，需要注意安全性和性能等方面的问题，避免出现潜在的漏洞和性能问题。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67d1546fa941bf71342d2d45