使用 graphql-java-tools 和 graphql-spring-boot-starter 进行错误处理

Question

如何处理我的 graphQL API 中的错误？我正在使用graphql-java-tools和graphql-spring-boot-starter。我创建了错误处理程序，但每次我收到响应 200 时，即使抛出异常也是如此。你能告诉我如何设置错误代码，例如 400 作为响应吗？

@Component
public class CustomGraphQLErrorHandler implements GraphQLErrorHandler {
@Override
public List<GraphQLError> processErrors(List<GraphQLError> list) {
return list.stream().map(this::getNested).collect(Collectors.toList());
}
private GraphQLError getNested(GraphQLError error) {
if (error instanceof ExceptionWhileDataFetching) {
ExceptionWhileDataFetching exceptionError = (ExceptionWhileDataFetching) error;
if (exceptionError.getException() instanceof GraphQLError) {
return (GraphQLError) exceptionError.getException();
}
}
return error;
}
}

Answer 1

当 GraphQL 服务器可以接受请求时，它会返回一个 HTTP 200(语法有效，服务器已启动...)。

如果发生错误，它将返回 200 并填充响应中的错误列表。

因此，在客户端，您将拥有：

• 技术服务器错误，如果 HTTP 状态不同于 200
• 处理请求时出错(技术或非技术性)，如果 HTTP 状态为 200，错误列表不为空
• 如果 HTTP 没有错误 状态为 200，错误列表不存在(不应 存在和空，根据 GraphQL 规范)

Answer 2

您可以尝试在错误处理方法中抛出一些异常，例如

package my.company.graphql.error;
import java.util.List;
import java.util.stream.Collectors;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ResponseStatusException;
import graphql.GraphQLError;
import graphql.GraphQLException;
import graphql.servlet.core.GraphQLErrorHandler;
import graphql.validation.ValidationError;
import lombok.extern.slf4j.Slf4j;
@Slf4j
@Component
public class GraphQLErrorHandlerImpl implements GraphQLErrorHandler {
@Override
public List<GraphQLError> processErrors(List<GraphQLError> graphQLErrors) {
return graphQLErrors.stream().map(this::handleGraphQLError).collect(Collectors.toList());
}
private GraphQLError handleGraphQLError(GraphQLError error) {
if (error instanceof GraphQLException) {
throw new ResponseStatusException(HttpStatus.INTERNAL_SERVER_ERROR, "GraphQLException as GraphQLError...", (GraphQLException) error);
} else if (error instanceof ValidationError){
throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "ValidationError: " + error.getMessage());
} else {
log.error("Yet another GraphQLError...", error);
return error;
}
}
}

。除了你只会得到 400 状态代码，在你的响应中没有更多，因为 Spring 不在这里处理抛出的异常，因为你正在与 GraphQL servlet(不是 Spring 的)交谈

，例如 http://127.0.0.1:8080/graphql只有在日志中，您应该能够看到堆栈跟踪：(这只是一个示例，其中包含 GraphQL 查询中未使用片段的验证错误)

[2020-09-23 15:59:34.382]-[080-exec-2]-[INFO ]-[g.s.AbstractGraphQLHttpServlet]: Bad POST request: parsing failed
org.springframework.web.server.ResponseStatusException: 400 BAD_REQUEST "ValidationError: Validation error of type UnusedFragment: Unused fragment someUnusedFragment"
at my.company.graphql.error.GraphQLErrorHandlerImpl.handleGraphQLError(GraphQLErrorHandlerImpl.java:33) ~[classes/:na]

由你来引入更复杂的 GraphQL 错误处理，但这仅仅是测试和试验(正如我们在相当长的一段时间内所做的那样......