基于 Hapi 框架搭建 GraphQL 服务时常见错误及排查方法-JavaScript中文网-JavaScript教程资源分享门户

随着 GraphQL 在前端领域的普及，搭建一个基于 Hapi 框架的 GraphQL 服务已成为一个必备技能。然而，在搭建过程中，我们经常会遇到各种错误。本文将介绍一些常见的错误以及解决方法，帮助读者更快地定位问题。

环境准备

在开始之前，需要完成以下准备工作：

安装 Node.js 和 npm；
熟悉 Hapi 框架和 GraphQL 语言；
安装 Hapi 和 GraphQL 的相关依赖，并配置好项目文件。

问题一：路由无法识别

在启动服务后，当通过 GraphiQL 查询面板或 API 请求访问路由时，可能会遇到以下错误信息：

// javascriptcn.com 代码示例
{
  "errors": [
    {
      "message": "Unknown endpoint: /graphql",
      "extensions": {
        "code": "UNKNOWN_ENDPOINT",
        "response": "Not Found"
      }
    }
  ]
}

这是因为 Hapi 框架无法识别路由。可能的原因是：

路由配置出现错误；
缺少路由文件。

解决方案：

确认路由配置是否正确；
确认路由文件是否存在，并按照正确的方式进行引入；
检查端口号是否正确配置。

示例代码：

// javascriptcn.com 代码示例
const Hapi = require('@hapi/hapi');
const { graphqlHapi } = require('apollo-server-hapi');
const { makeExecutableSchema } = require('@graphql-tools/schema');

const typeDefs = `
  type Query {
    hello: String
  }
`;

const resolvers = {
  Query: {
    hello: () => 'Hello World',
  },
};

const schema = makeExecutableSchema({
  typeDefs,
  resolvers,
});

const server = new Hapi.server({
  port: 4000,
  host: 'localhost',
});

const routes = [
  {
    method: 'GET',
    path: '/',
    handler: (request, h) => {
      return 'Welcome to Hapi GraphQL Server';
    },
  },
  {
    method: 'POST',
    path: '/graphql',
    options: {
      handler: graphqlHapi({
        schema,
        pretty: true,
      }),
      // ...
    },
  },
];

const init = async () => {
  await server.register({
    plugin: require('hapi-pino'),
    options: {
      prettyPrint: true,
      logEvents: ['response', 'onPostStart'],
    },
  });

  server.route(routes);

  await server.start();

  console.log(`Server running at: ${server.info.uri}`);
};

process.on('unhandledRejection', (err) => {
  console.log(err);
  process.exit(1);
});

init();

问题二：GraphQL 查询错误

在进行 GraphQL 查询时，可能会遇到类似以下错误信息：

// javascriptcn.com 代码示例
{
  "errors": [
    {
      "message": "Cannot query field \"foo\" on type \"Query\". Did you mean \"hello\"?",
      "locations": [
        {
          "line": 2,
          "column": 3
        }
      ]
    }
  ]
}

这是因为查询中使用了未定义或不存在的字段或类型。可能的原因是：

GraphQL Schema 配置有误；
查询中使用了错误的字段或类型。

解决方案：

确认 Schema 配置是否正确；
确认查询语句中是否使用了正确的字段和类型。

示例代码：

// javascriptcn.com 代码示例
const Hapi = require('@hapi/hapi');
const { graphqlHapi } = require('apollo-server-hapi');
const { makeExecutableSchema } = require('@graphql-tools/schema');

const typeDefs = `
  type Query {
    hello: String
  }
`;

const resolvers = {
  Query: {
    // 修正错误：名称应与 typeDefs 中的定义保持一致
    hello: () => 'Hello World',
  },
};

const schema = makeExecutableSchema({
  typeDefs,
  resolvers,
});

const server = new Hapi.server({
  port: 4000,
  host: 'localhost',
});

const routes = [
  // 修正错误：HTTP method 应该为 POST
  {
    method: 'POST',
    path: '/graphql',
    options: {
      handler: graphqlHapi({
        schema,
        pretty: true,
      }),
      // ...
    },
  },
];

const init = async () => {
  await server.register({
    plugin: require('hapi-pino'),
    options: {
      prettyPrint: true,
      logEvents: ['response', 'onPostStart'],
    },
  });

  server.route(routes);

  await server.start();

  console.log(`Server running at: ${server.info.uri}`);
};

process.on('unhandledRejection', (err) => {
  console.log(err);
  process.exit(1);
});

init();

问题三：使用外部数据源时的错误

在使用外部数据源进行数据查询时，可能会遇到以下错误信息：

// javascriptcn.com 代码示例
{
  "errors": [
    {
      "message": "connect ECONNREFUSED 127.0.0.1:3306",
      "locations": [
        {
          "line": 2,
          "column": 3
        }
      ]
    }
  ]
}

这是因为连接到外部数据源出现错误。可能的原因是：

外部数据源的配置有误；
数据源无法连接。

解决方案：

确认数据源连接配置是否正确；
检查数据源是否开启；
确认是否有防火墙等安全软件阻止了数据源的请求。

示例代码：

// javascriptcn.com 代码示例
const Hapi = require('@hapi/hapi');
const mysql = require('mysql');
const { graphqlHapi } = require('apollo-server-hapi');
const { makeExecutableSchema } = require('@graphql-tools/schema');

const typeDefs = `
  type Query {
    users: [User]
  }

  type User {
    id: ID!
    name: String
  }
`;

const resolvers = {
  Query: {
    users: () => {
      const connection = mysql.createConnection({
        host: '127.0.0.1',
        user: 'root',
        password: '',
        database: 'graphql',
      });

      connection.connect();

      return new Promise((resolve, reject) => {
        connection.query('SELECT * FROM users', (err, rows, fields) => {
          if (err) reject(err);

          resolve(rows);
        });

        connection.end();
      });
    },
  },
};

const schema = makeExecutableSchema({
  typeDefs,
  resolvers,
});

const server = new Hapi.server({
  port: 4000,
  host: 'localhost',
});

const routes = [
  {
    method: 'POST',
    path: '/graphql',
    options: {
      handler: graphqlHapi({
        schema,
        pretty: true,
      }),
      // ...
    },
  },
];

const init = async () => {
  await server.register({
    plugin: require('hapi-pino'),
    options: {
      prettyPrint: true,
      logEvents: ['response', 'onPostStart'],
    },
  });

  server.route(routes);

  await server.start();

  console.log(`Server running at: ${server.info.uri}`);
};

process.on('unhandledRejection', (err) => {
  console.log(err);
  process.exit(1);
});

init();

总结

本文介绍了在搭建基于 Hapi 框架的 GraphQL 服务时经常出现的错误以及解决方案，并给出了相应的示例代码。希望读者能够了解到问题的本质并能够快速定位和解决问题。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/651daf6d95b1f8cacd54eba3