前言
随着 Firebase 的应用逐渐普及，越来越多的开发者开始使用 Firebase 作为其应用数据存储和后端服务的基础。GraphQL，则是近年来云开发的新宠，它提供了一种更加便利和直观的数据查询方式。在这样的背景下，将 Firebase 与 GraphQL 结合起来，能够更好地满足开发者的需求。本文将介绍 npm 包 graphql-firebase-schema 的使用教程，以帮助前端开发者更好地利用 Firebase 和 GraphQL。
graphql-firebase-schema 简介
graphql-firebase-schema 是一项由 Waseem Dahman 开发的 npm 包，它能够将 Firebase 数据库快速转换为 GraphQL 模式，从而可以使用 GraphQL 查询、突变等功能。graphql-firebase-schema 主要有以下优点：
- 快速：每次更改后自动重新生成 GraphQL 模式；
- 简单：只需少量的代 码便可实现数据操作；
- 动态：您的 Firebase 数据架构将自动作为 GraphQL 模式导入。
通过这些特点，使用 graphql-firebase-schema 能够帮助前端开发者更快地搭建起 Firebase 与 GraphQL 的连接，并以一种高效和简单的方式生成和使用 GraphQL API。
graphql-firebase-schema 安装
通过 npm 可以很方便地安装 graphql-firebase-schema：
npm i graphql-firebase-schema
安装完成后，可以使用以下 import 语句导入 graphql-firebase-schema：
import { makeExecutableSchema } from 'graphql-tools'
import firebase from 'firebase/app'
import config from './firebase.config.json'
import { createResolver } from 'graphql-firebase-schema'其中的 firebase.config.json 是 Firebase 的配置文件，需要开发者自己创建。由于 graphql-firebase-schema 的依赖包需要同时安装，因此建议在安装后查看 package.json，确认 graphql-firebase-schema 的依赖是否也已安装完成。
graphql-firebase-schema 使用
生成 Firebase Schema
graphql-firebase-schema 提供了 createSchema 函数，通过该函数可以将 Firebase 数据库中的数据快速转换为 GraphQL API。创建 GraphQl API 的步骤如下：
- 使用 Firebase admin SDK 连接 Firebase 数据库：
import admin from 'firebase-admin'
import serviceAccount from './serviceAccount.json'
admin.initializeApp({
credential: admin.credential.cert(serviceAccount),
databaseURL: 'https://<DATABASE_NAME>.firebaseio.com'
})- 创建 Type 名称：
const type = 'MyData'
- 定义 Firebase 数据结构：
-- -------------------- ---- -------
----- ------ - -
----- --------
------- ------
-------- ----------
------ -
----- ---------
--
------- -
----- ---------
---- -----
-
-在上面这个例子中，我们为 text 定义了 String 类型，将 number 定义为 Int 类型，boolean 作为 Boolean 类型，array 嵌套类型是一个 String 数组，而 nested 类型则包含了两个属性：name 和 age，分别被定义为 String 和 Int 类型。
- 通过 createSchema 函数生成 GraphQL Schema：
const graphqlSchema = createSchema({
db: admin.database(),
schema: {
[type]: schema
}
})- 生成 resolver：
位于 github.com/waseemdohman/graphql-firebase-schema 解决方案的文档中。
示例代码
以下是一个可以连接 Firebase Database 并使用 graphql-firebase-schema 的示例代码，以方便理解。
-- -------------------- ---- -------
------ ----- ---- ----------------
------ -------------- ---- -----------------------
------ -------- ---- --------------
------ ---------------
------ -------------------
------ - -------------------- - ---- ---------------
------ - -------------- - ---- -------------------------
-- -- -------- ---
---------------------
----------- --------------------------------------
------------ ----------------------------------------
--
--------------------------------------
-- -- ---- --
----- ---- - --------
-- -- -------- ----
----- ------ - -
------ ---------
------- ---------
------ ------
---------- ----------
-------- -
----- ---------
--
----------- -
----- ---------
---- -----
-
-
-- -- ------- ------
----- ------------- - --------------
--- -----------------
------- -
------- ------
-
--
-- -- ------- --------
----- -------- - ----------------
--- -----------------
------- -
------- ------
-
--
-- -- --- --------------
----- -------- - -
---- ------- -
------ -------
------- -------
------ ----
---------- --------
-------- ---------
----------- -----------
-
---- ---------- -
----- -------
---- ----
-
---- ----- -
--------- -----------
----------- --------- --------
-
---- -------- -
------------------------------------ ------------- --------
-
----- ---------- -
------ -------
------- -------
------ ----
---------- --------
-------- ---------
----------- --------------
-
----- ------------- -
----- -------
---- ----
-
-
-- ------
------------------------------------------------- ----------------- -- -
---------------------- ------------
-- -- --- ---
----- ------ - --- -------------- --------- ---------- -------- ---
----------------------- --- -- -- -
--------------- ------ ----- -- ---------
---
---以上示例代码中，我们定义了 MyData 的 GraphQL API，其中包括 Query 和 Mutation，用于查询、操作数据库中的数据。在 typeDefs 中定义了数据类型和 API 的 Query 和 Mutation，其中包括列表查询、单个 ID 查询和数据添加等操作。对于作者信息来说，我们定义了 AuthorInfo 类型。
通过以上代码与配置，我们可以在 Firebase 中方便地创建 GraphQL API 查询数据、添加数据等操作。同时，作为前端开发者，我们需要了解如何使用 graphql-firebase-schema 和 GraphQL 的相关知识，才能从中获得最大的收益。
结论
graphql-firebase-schema 是一项方便、快速和简单的 npm 包，可以帮助前端开发者更加便捷地使用 Firebase 和 GraphQL 结合起来。它提供了一种快速转换 Firebase 数据库为 GraphQL 模式的方式，并简化了 GraphQL API 的生成和使用。如果您需要将 Firebase 数据库与 GraphQL 结合起来，那么 graphql-firebase-schema 肯定是一项应当考虑使用的工具。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600672693660cf7123b36738