简介
@toryjs/server 是一个基于 Node.js 的 Web 应用程序框架。它可以让你更快地开发前端应用程序，不需要过多关注底层实现。
该框架提供了包括路由、中间件、插件等在内的一系列组件，用于帮助你组织和构建 Web 应用程序。@toryjs/server 基于 Express 和 GraphQL，是 TypeScript 编写的。
本文将详细介绍如何使用 @toryjs/server，包括安装、使用、配置和示例代码等。
安装
你可以使用 npm 安装 @toryjs/server，步骤如下：
npm install --save @toryjs/server
使用
使用 @toryjs/server 构建的 Web 应用程序，通常需要两部分代码：
- 服务端代码：构建 Web 应用程序提供的接口和服务。
- 客户端代码：构建 Web 应用程序的可视化界面（如：HTML、CSS、JavaScript）。
下面我们将分别介绍如何编写服务端和客户端代码。
服务端
在新建一个 @toryjs/server 项目之前，你需要了解一些概念，如：路由、中间件、插件等。
路由
路由对应的是 Web 应用程序提供的接口和服务以及对应的 URL。例如：/api/user 对应着获取用户信息的接口。
@toryjs/server 默认使用 GraphQL，路由通过 schema 文件来定义，如下所示：
-- -------------------- ---- -------
------ - --- - ---- -----------------
----- -------- - ----
---- ----- -
------ ------
-
--
----- --------- - -
------ -
------ -- -- ------ -------
--
--
------ ------- - --------- --------- --上面的代码表示定义了一个 hello 接口，当用户访问接口时就会返回字符串 Hello World。
中间件
中间件是一种提供预处理逻辑的机制，通常用于解析请求参数、处理请求头、日志记录等。@toryjs/server 框架内置了大量的中间件组件，你也可以定义自己的中间件。
-- -------------------- ---- -------
------ ------- ---- ----------
------ - ----------- - ---- ------------------
------ ---- ---- -------
------ ---------- ---- --------------
------ ------------ ---- ----------------
-- ------
------ ------------ ---- -----------------
----- --- - ----------
----- ---- - ---------------- -- -----
-- -- ----
----------------
-- -- ---- --
---------------------------
------------------------------- --------- ---- ----
-- -- ------
------------------------
-- --------
----------------------
-- ------- ---
--------
-------
-------------
------- -------
--------- -----
--
--
---------------- -- -- -
------------------- ------- -- ---- ----------
---插件
插件是一种可重用的组件，通常用于提供一些通用的功能。@toryjs/server 内置了一些插件，如：数据库插件、框架插件、日志插件等。
-- -------------------- ---- -------
------ - ---------- - ---- -----------------
------ - ------------ - ---- ------------------------
------ ------------- ---- -----------
------ ---------- ---- ----------------------------------------
----- --- - ------------
-------- -
-
------- -------- ------------- -- -
---------------------- ------------ --------- ------ ----
--
--
--
---
-- ------- ---
--------
-------
-------------
------- ---------------------
--
--
------ ------- ----上面的代码中，我们将 graphql-playground-middleware-express 插件扩展到了 @toryjs/server 框架中，用户在访问 /playground 接口时，可以看到 GraphQL Playground 的 UI 界面。
客户端
客户端通常是 Web 应用程序的可视化界面。你可以使用任何前端框架来构建你的客户端代码。
-- -------------------- ---- -------
------ - ------------- ------------- - ---- -----------------
------ - -------------- - ---- -----------------------
------ --- ---- --------------
------ - ------------- - ---- -------------------
----- ------ - --- --------------
---- ------- -- -- ------- ----
------ --- ----------------
---
----------------
--------------- ----------------
---------------
---- --
----------------
------------------
-------------------------------
--上面的代码中，我们使用了 React 框架和 @apollo/client 库来构建客户端。
配置
@toryjs/server 框架提供了一些配置项，可以帮助你快速搭建 Web 应用程序。
环境变量
NODE_ENV：Node.js 运行环境，默认为 'development'。PORT：Web 应用程序监听的端口号，默认为 4000。DATABASE_URL：数据库连接地址。
初始化配置
@toryjs/server 提供了 initServer 函数，用于初始化 Web 应用程序的配置。
import { initServer } from '@toryjs/server';
const app = initServer({
port: process.env.PORT || 4000,
dbUrl: process.env.DATABASE_URL,
});示例代码
下面是一个完整的示例代码，包括服务端和客户端：
服务端代码
-- -------------------- ---- -------
------ - ---------- - ---- -----------------
------ - ------- - ---- ----------
------ - ------------ - ---- ------------------------
------ ------------- ---- -----------
------ ---------- ---- ----------------------------------------
----- ------- --- - -- -- -
----- ------- - -
-
------- -------- ------------- -- -
---------------------- ------------ --------- ------ ----
--
--
--
----- ---- ------- - ------------
--------
---
-- ------- ---
--------------- ------------- ------- -------------------- ----
------ ----
--
------ ------- -------客户端代码
-- -------------------- ---- -------
------ ----- ---- --------
------ -------- ---- ------------
------ - ------------- ------------- - ---- -----------------
------ - -------------- - ---- -----------------------
------ --- ---- --------------
------ - ------------- - ---- -------------------
----- ------ - --- --------------
---- -------
------ --- ----------------
---
----------------
--------------- ----------------
---------------
---- --
----------------
------------------
-------------------------------
--结束语
本文我们介绍了 @toryjs/server 的基本使用和配置方式，希望读者可以通过本文快速上手使用该框架。如果你想深入了解该框架，可以前往该项目的 GitHub 主页查看更多详细文档信息。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60067357890c4f7277583daf