GraphQL 与 TypeScript 的深度融合

常规情况下的GraphQL

GraphQL 是一个用于API的查询语言与运行时环境,它使得客户端可以精确地请求数据,并仅仅获取需要的内容,从而提高数据请求效率。通常情况下,在前端开发中,GraphQL 会配合 Apollo 客户端使用,可以快速开发出强大而又灵活的应用程序。

在使用GraphQL时,我们通常会定义自己的Schema、Resolver以及Types等一系列相关的类型。其中,Schema 定义的是数据的结构,而 Types(包括Query、Mutation等)则是针对这个结构的操作。在对这些类型进行定义时,我们需要在其中添加对应的数据类型和变量。

GraphQL 与 TypeScript 结合

虽然GraphQL和Apollo的配合在开发中已经显得越来越流行,不过当应用切换到 TypeScript 开发时,我们会发现在这种架构下使用这种组件变得不那么直观、不那么明显,需要更多的类型定义和较多的类型检查等等。因此,开发者也提出了自己独特的解决方案,那就是 TypeScript 与 GraphQL 深度结合,让我们来具体了解一下。

首先,让我们来看一下GraphQL的一个Query:

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

上述代码表示我们希望从服务端获取用户信息,需要给出该用户的 ID,从而得到对应的名字和年龄等信息。但是在写这样的Query时,我们会发现变量的类型并没有被声明,只有在构建使用它的代码时才会发现。

如果我们再使用 TypeScript 的话,则可以通过声明类型的方式,不仅使得变量的代码层面更加强健,还能够将GraphQL的定义和现实代码结合更加紧密。下面就让我们来看下面的 TypeScript 代码实现这个Query:

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

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

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

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

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

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

上面的代码中,我们使用了 interface 来声明类型,通过这种方式来对Query中所需的数据类型进行声明。在接下来的函数 getUserInfo 的实现中,还需要额外处理哪些字段是必要的、哪些是可选的等问题,这样做也可以有效避免由于开发疏忽所产生的不必要错误。

案例

下面让我们来看一个具体的案例吧。

在这个案例中,我们需要开发一个支持登录和注册的前后端分离的应用程序。前端通过GraphQL来请求后端数据,并将相关数据展示给用户。其中,前端应用采用React进行开发,使用TypeScript来支持GraphQL服务。启动方式为,进入 src 目录后,运行 npm run start 即可。

后端服务

提供GraphQL API,代码如下:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

前端代码

然后,我们需要为前端代码添加几个必要的包。可以通过以下命令来添加:

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

该程序需要我们在 React 项目中启动 Apollo Client 来使得前端可以访问 GraphQL API。而在使用 Apollo Client 时,我们需要先创建这个客户端,然后将其传递给其中的其他组件,使得这些组件可以通过这个 API 来请求数据。

代码如下:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

运行结果

启动后端服务,并运行前端应用。首先,我们需要在浏览器中输入 http://localhost:3000,然后就可以通过登录或者注册操作来获取一个Token。这个 Token 可以用于后续的持久化登录操作。

接着,在获取到Token后,通过在 http header 中设置该 Token 的值来实现持久化登录,这样,用户在进行资料查询时,可以实现自动登录的效果。

总结

通过对以上代码理解和实践,相信你已经了解了 GraphQL 和 TypeScript 结合的过程。如果你正在开发一个大型的应用程序,这些实践将非常有用,因为它们使得您能够更好地管理和维护代码,并确保您的代码不会产生意外的错误。

当然,本文所给出的示例只是冰山一角,更多详细信息可以上官网获取:https://www.graphql.com/learn/type-system/

希望本文能够帮助到您!

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/654df0a67d4982a6eb74c332


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言,它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据,避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events? Server-sent Events(简称 SSE)是一种基于 HTTP 的服务器推送技术,它可以让服务器向客户端发送事件流,客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020(ES11)中的新特性:BigInt 转换

    在 ECMAScript 2020(ES11)中,新增了一种数据类型:BigInt。它是一种可以表示任意大整数的数据类型,可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式,消除不同浏览器之间的差异,从而实现更加一致的样式效果的技术手段。在前端开发中,使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中,引入了 class 关键字,使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间,有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系,并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时,表单数据的处理是非常常见的需求。然而,由于 React 的单向数据流和组件化特性,传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具,可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展,高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库,也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略,并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中,图片适配是一个比较棘手的问题。如果不加以处理,可能会导致图片在不同设备上显示不佳,影响用户体验。本文将介绍响应式设计中的图片适配问题,并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation(封装)的实现方式

    解析 TypeScript 中 encapsulation(封装)的实现方式 在 TypeScript 中,封装(encapsulation)是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理:如何避免由于 PM2 进程奔溃导致应用崩溃?

    在前端开发中,我们经常使用 PM2 进行进程管理和部署。但是,当 PM2 进程崩溃时,应用也会跟着崩溃。如何避免这种情况的发生?本文将介绍 PM2 崩溃处理的方法和技巧,帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境,它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时,安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准,其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法,分别是:扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时,我们经常需要使用 Enzyme 来测试组件。然而,当我们测试涉及到动画的组件时,我们可能会遇到一些问题:动画无法渲染,导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展,单页应用(Single Page Application,SPA)已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面,提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中,ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中,Promise.all 是一个非常常用的功能,它可以让我们在多个异步操作完成后再执行一些操作,这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中,经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具,它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候,如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候,我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而,Shadow DOM 的封闭性也带来了一些挑战,其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤?

    随着互联网的发展,越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验,还可以让用户在不同的环境下选择适合自己的主题,增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数?

    在前端开发中,样式表是不可或缺的一部分。而 Less 是一种动态样式语言,它是 CSS 的一种扩展。在 Less 中,我们可以使用字符串操作函数来处理字符串,这些函数可以帮助我们更加方便地操作字符串,...

    2 个月前