构建基于 Rust 技术栈的 GraphQL 服务（2）- 查询服务第一部分

2022-06-30 16:35:54 浏览数 (1)

上一篇文章中，我们对后端基础工程进行了初始化。其中，笔者选择 Rust 生态中的 4 个 crate：tide、async-std、async-graphql、mongodb（bson 主要为 mongodb 应用）。虽然我们不打算对 Rust 生态中的 crate 进行介绍和比较，但想必有朋友对这几个选择有些疑问，比如：tide 相较于 actix-web，可称作冷门、不成熟，postgresql 相较于 mongodb 操作的便利性等。 笔者在 2018-2019 年间，GraphQL 服务后端，一直使用的是 actix-web juniper postgresql 的组合，应用前端使用了 typescript react apollo-client，有兴趣可以参阅开源项目 actix-graphql-react。 2020 年，笔者才开始了 tide async-graphql 的应用开发，在此，笔者简单提及下选型理由——

  1. Tide：tide 的定位是最小的、实用的 Rust web 应用服务框架。其相较于 Rust 社区中火热的 actix-web，确实可以说冷门。至于生态成熟度，也有诸多差距。但我们在提供 GraphQL 服务时，主要需要的是基础的 HTTP 服务器。tide 目前的功能和性能是完全满足的，并且笔者测试后，对其健壮性也很满意。
  2. async-graphql：优秀的 crate， 开发者功力深厚。测试性能很棒，以及开发时的简洁性。
  3. 至于 postgresql 转为 mongodb，只是一时兴起。本来计划 elasticsearch 的，只是个人服务器跑起来不给力。

Rust 社区生态中，健壮的 web 应用服务框架很多，您可以参考 Rust web 框架比较 一文自行比较选择。

上文中，未有进行任何代码编写。本文中，我们将开启基础 GraphQL 服务的历程。包括如下内容： 1、构建 GraphQL Schema； 2、整合 Tide 和 async-graphql； 3、验证 query 服务； 4、连接 MongoDB； 5、实现 query 服务。

构建 GraphQL Schema 首先，让我们将 GraphQL 服务相关的代码都放到一个模块中。为了避免下文啰嗦，我称其为 GraphQL 总线。

代码语言：javascript复制
cd ./rust-graphql/backend/src
mkdir gql
cd ./gql
touch mod.rs queries.rs mutations.rs

构建一个查询示例 首先，我们构建一个不连接数据库的查询示例：通过一个函数进行求合运算，将其返回给 graphql 查询服务。此实例改编自 async-graphql 文档，仅用于验证环境配置，实际环境没有意义。 下面代码中，注意变更 EmptyMutation 和订阅 EmptySubscription 都是空的，甚至 mutations.rs 文件都是空白，未有任何代码，仅为验证服务器正确配置。 在 mod.rs 文件中，写入以下代码：

代码语言：javascript复制
pub mod mutations;
pub mod queries;

use tide::{http::mime, Body, Request, Response, StatusCode};

use async_graphql::{
    http::{playground_source, receive_json, GraphQLPlaygroundConfig},
    EmptyMutation, EmptySubscription, Schema,
};

use crate::State;

use crate::gql::queries::QueryRoot;

pub async fn build_schema() -> Schema<QueryRoot, EmptyMutation, EmptySubscription> {
    // The root object for the query and Mutatio, and use EmptySubscription.
    // Add global mongodb datasource  in the schema object.
    // let mut schema = Schema::new(QueryRoot, MutationRoot, EmptySubscription)
    Schema::build(QueryRoot, EmptyMutation, EmptySubscription).finish()
}

pub async fn graphql(req: Request<State>) -> tide::Result {
    let schema = req.state().schema.clone();
    let gql_resp = schema.execute(receive_json(req).await?).await;

    let mut resp = Response::new(StatusCode::Ok);
    resp.set_body(Body::from_json(&gql_resp)?);

    Ok(resp.into())
}

pub async fn graphiql(_: Request<State>) -> tide::Result {
    let mut resp = Response::new(StatusCode::Ok);
    resp.set_body(playground_source(GraphQLPlaygroundConfig::new("graphql")));
    resp.set_content_type(mime::HTML);

    Ok(resp.into())
}

上面的示例代码中，函数 graphql 和 graphiql 作为 tide 服务器的请求处理程序，因此必须返回 tide::Result。 tide 开发很简便，本文不是重点。请参阅 tide 中文文档，很短时间即可掌握。 编写求和实例，作为 query 服务 在 queries.rs 文件中，写入以下代码：

代码语言：javascript复制
pub struct QueryRoot;

#[async_graphql::Object]
impl QueryRoot {
    async fn add(&self, a: i32, b: i32) -> i32 {
        a   b
    }
}

整合 Tide 和 async-graphql 终于，我们要进行 tide 服务器主程序开发和启动了。进入 ./backend/src 目录，迭代 main.rs 文件：

代码语言：javascript复制

mod gql;

use crate::gql::{build_schema, graphiql, graphql};

#[async_std::main]
async fn main() -> Result<(), std::io::Error> {
    // tide logger
    tide::log::start();

    // 初始 Tide 应用程序状态
    let schema = build_schema().await;
    let app_state = State { schema: schema };
    let mut app = tide::with_state(app_state);

    // 路由配置
    app.at("graphql").post(graphql);
    app.at("graphiql").get(graphiql);

    app.listen(format!("{}:{}", "127.0.0.1", "8080")).await?;

    Ok(())
}

//  Tide 应用程序作用域状态 state.
#[derive(Clone)]
pub struct State {
    pub schema: async_graphql::Schema<
        gql::queries::QueryRoot,
        async_graphql::EmptyMutation,
        async_graphql::EmptySubscription,
    >,
}

注1：上面代码中，我们将 schema 放在了 tide 的状态 State 中，其作用域是应用程序级别的，可以很方便地进行原子操作。 注2：另外，关于 tide 和 async-graphql 的整合，async-graphql 提供了整合 crate：async_graphql_tide。但笔者测试后未使用，本文也未涉及，您感兴趣的话可以选择。 验证 query 服务 启动 tide 服务 以上，一个基础的基于 Rust 技术栈的 GraphQL 服务器已经开发成功了。我们验证以下是否正常，请执行——

代码语言：javascript复制
cargo run

更推荐您使用我们前一篇文章中安装的 cargo watch 来启动服务器，这样后续代码的修改，可以自动部署，无需您反复对服务器进行停止和启动操作。

代码语言：javascript复制
cargo watch -x "run"

但遗憾的是——此时，你会发现服务器无法启动，因为上面的代码中，我们使用了 #[async_std::main] 此类的 Rust 属性标记。所以，我们还需要稍微更改一下 backend/Cargo.toml 文件。 请注意，不是根目录 rust-graphql/Cargo.toml 文件。 同时，MongoDB 驱动程序中，支持的异步运行时 crate 为 tokio，我们其它如 tide 和 async-graphql 都是基于 async-std 异步库的，所以我们一并修改。最终，backend/Cargo.toml 文件内容如下（有强迫症，也调整了一下顺序，您随意）：

代码语言：javascript复制
...
[dependencies]
tide = "0.16.0"
async-std = { version = "1.9.0", features = ["attributes"] }

async-graphql = "2.6.0"
mongodb = { version = "1.2.0", default-features = false, features = ["async-std-runtime"] }
bson = "1.2.0"
...

再次执行 cargo run 命令，您会发现服务器已经启动成功，启动成功后的消息为：

代码语言：javascript复制
tide::log Logger started    level Infotide::server Server listening on http://127.0.0.1:8080

执行 GraphQL 查询

请打开您的浏览器，输入 http://127.0.0.1:8080/graphiql，您会看到如下界面（点击右侧卡片 docs 和 schema 查看详细）：

如图中示例，在左侧输入：

代码语言：javascript复制
query {
  add(a: 110, b: 11)
}

右侧的返回结果为：

代码语言：javascript复制
{
  "data": {
    "add": 121
  }
}

基础的 GraphQL 查询服务成功！

因篇幅太长，分为2篇，此为第一部分，第二部分为连接 MongoDB，以及实现 GraphQL query 服务。

谢谢您的阅读。

api javascript node.js rust

0 人点赞