npm 包 `create-graphql-server-logging` 使用教程

阅读时长 5 分钟读完

介绍

create-graphql-server-logging 是一个基于 create-graphql-server 的 npm 包,它可以方便地为 GraphQL 服务器添加日志功能,以便进行调试和追踪。使用该包可以轻松地在控制台或者日志系统中查看每一次 GraphQL 请求的详情。

安装

你需要在本地安装 Node.js 和 npm,才能开始使用这个工具包。安装命令如下:

使用方法

使用 create-graphql-server-logging 这个工具包非常简单。只需要在创建 GraphQL 服务器的时候初始化这个包,然后传入你自己的 GraphQL 选项即可。

-- -------------------- ---- -------
----- -  --------------------  - - ------------------------
----- -  ------------  - - ------------------------

----- ------------------- - ----------------------------------------

----- -------- - -
    ---- ----- -
        ------ ------
    -
-

----- --------- - -
  ------ -
    ------ -- -- ------ -------
  -
-

----- ------ - ----------------------
  ---------
  ---------
--

----- ------ - --- -------------
  ---------------------
    -------
    -------- -- --- -- -- --
      ------------ -------------------------
    --
  --
-

----------------------- --- -- -- -
  ---------------  ------ ----- -- --------
--

如上代码示例,我们引入了 create-graphql-server-logging 包,并且在创建 ApolloServer 时使用了 createLoggingServer 函数来装饰 GraphQL 选项对象。

参数

createLoggingServer 接受一个参数对象,其中有如下可用选项:

  • schema (required): 定义了 GraphQL Schema 的 ExecutableSchema 对象,用于预处理查询。
  • context: 用于解析上下文的选项对象,详见 Apollo 官网文档
  • loggingFunction: 作为请求日志的输出函数,你可以实现你自己的函数来打印日志,函数签名要求如下:(logEntry: string, context: any) => void。使用控制台打印日志的默认函数是: (logEntry, context) => console.log(logEntry).

示例

以下示例展示了如何在 createLoggingServer 中传递不同的选项参数,以及控制台中显示日志的效果。

-- -------------------- ---- -------
----- ------------------- - ----------------------------------------
----- -------- - -
    ---- ----- -
        ------ ------
    -
-

----- --------- - -
  ------ -
    ------ -- -- ------ -------
  -
-

----- ------ - ----------------------
  ---------
  ---------
--

----- --------------------- - ---------- -------- -- -
  ------------------- ------- -------- ---------
  ---------------------
  --------------------
-

----- ------ - --- -------------
  ---------------------
    -------
    -------- -- --- -- -- --
      ------------ -------------------------
    ---
    ---------------- ---------------------
  --
-

----------------------- --- -- -- -
  ---------------  ------ ----- -- --------
--

在这个示例中,我们向 createLoggingServer 函数中传递了 loggingFunction 参数,该参数使用了我们自己定义的打印函数 customLoggingFunction,输出如下日志:

-- -------------------- ---- -------
------ ------- -------- -------
-
  -------- ---  ---    -------  -----
  ------------ -----
  ---------------- -----
  ----------- -
    ------- -
      -------- ------ -------
    -
  --
  ----------- ------
  ---------- -
    -------------- ---------
  -
-

总结

使用 create-graphql-server-logging 可以轻松添加日志功能到你的 GraphQL 服务器,让你更容易地进行调试和追踪。这个工具包非常适合初学者,因为它简单易用。同时,我们也提供了一些灵活的选项,以便更好地满足你的需求。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005602681e8991b448de52e

纠错
反馈