什么是 GraphQL？
GraphQL 是一种用于 API 的查询语言，它使得客户端可以精确地请求需要的数据，而无需像 REST API 那样请求多个端点。 GraphQL 还提供了强大的类型系统，使得客户端可以在运行时确定所需数据的结构。
GraphQL 中的错误处理
在 GraphQL 中，错误处理是非常重要的一部分。当查询出现错误时，GraphQL 应该能够提供有用的错误信息，以便客户端可以轻松地诊断和解决问题。
GraphQL 中的错误类型
GraphQL 定义了一些标准的错误类型，包括：
GraphQLSyntaxError：当查询语法有误时抛出。GraphQLError：当查询有错误时抛出，包括语法错误、类型错误等。GraphQLValidationError：当查询中的参数无效时抛出。GraphQLFieldError：当查询中的字段有错误时抛出。
GraphQL 中的错误处理方式
在 GraphQL 中，有两种处理错误的方式：
- 抛出错误：当查询出现错误时，可以抛出一个错误，这样客户端就可以获取到错误信息。例如：
// www.javascriptcn.com code example
import { ApolloServer, gql } from 'apollo-server';
const typeDefs = gql`
type Query {
user(id: ID!): User
}
type User {
id: ID!
name: String!
email: String!
}
`;
const resolvers = {
Query: {
user: (_, { id }) => {
const user = getUserById(id);
if (!user) {
throw new Error(`User with ID ${id} not found`);
}
return user;
},
},
};
const server = new ApolloServer({ typeDefs, resolvers });
server.listen().then(({ url }) => {
console.log(`🚀 Server ready at ${url}`);
});- 返回错误：另一种处理错误的方式是返回一个错误对象，这样客户端就可以获取到错误信息。例如：
// www.javascriptcn.com code example
import { ApolloServer, gql } from 'apollo-server';
const typeDefs = gql`
type Query {
user(id: ID!): UserResult!
}
type UserResult {
success: Boolean!
message: String
user: User
}
type User {
id: ID!
name: String!
email: String!
}
`;
const resolvers = {
Query: {
user: (_, { id }) => {
const user = getUserById(id);
if (!user) {
return {
success: false,
message: `User with ID ${id} not found`,
user: null,
};
}
return {
success: true,
message: null,
user,
};
},
},
};
const server = new ApolloServer({ typeDefs, resolvers });
server.listen().then(({ url }) => {
console.log(`🚀 Server ready at ${url}`);
});以下是一些 GraphQL 中的错误处理最佳实践：
使用标准的错误类型：GraphQL 提供了标准的错误类型，使用这些错误类型可以使得客户端可以更轻松地诊断和解决问题。
提供有用的错误信息：当查询出现错误时，应该提供有用的错误信息，以便客户端可以轻松地诊断和解决问题。
使用抛出错误的方式：在大多数情况下，使用抛出错误的方式可以使得代码更加简洁和易于理解。
使用返回错误的方式：在一些情况下，例如当查询中的参数无效时，使用返回错误的方式可以使得客户端可以更轻松地诊断和解决问题。
示例代码
以下是一个使用 GraphQL 的错误处理最佳实践的示例代码：
// www.javascriptcn.com code example
import { ApolloServer, gql } from 'apollo-server';
const typeDefs = gql`
type Query {
user(id: ID!): User
}
type User {
id: ID!
name: String!
email: String!
}
`;
const resolvers = {
Query: {
user: (_, { id }) => {
const user = getUserById(id);
if (!user) {
throw new Error(`User with ID ${id} not found`);
}
return user;
},
},
};
const server = new ApolloServer({ typeDefs, resolvers });
server.listen().then(({ url }) => {
console.log(`🚀 Server ready at ${url}`);
});以上代码中，当查询中的参数无效时，会抛出一个错误，客户端可以获取到错误信息。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67d245d4a941bf713445303a