简介
oase 是一个基于 Node.js 和 TypeScript 构建的开发框架，可以帮助开发者快速地构建高质量的 Web 应用程序。该框架提供了丰富的功能，包括路由、中间件、控制器、依赖注入等，使得开发过程变得更加容易、高效和可维护。
如果你正在寻找一个相对简单的框架来快速开发 Web 应用程序，那么 oase 是一个不错的选择。在本教程中，我们将介绍如何使用 npm 包 oase 进行 Web 应用程序的开发。
安装
使用 npm 包管理工具安装 oase，可以在终端中输入以下命令：
npm install oase快速开始
创建应用程序
首先，我们需要创建一个新的应用程序。在本教程中，我们将创建一个简单的 Web 应用程序，该程序仅显示一个欢迎消息。
在终端中创建一个新目录，进入该目录并执行以下命令：
npm init这个命令将创建一个新的 package.json 文件，其中包含了与应用程序相关的信息。
接下来，我们需要在项目中安装 oase。在终端中执行以下命令：
npm install oase编写路由
在 Oase 框架中，默认情况下会启用路由，因此我们需要编写路由来处理请求。
在项目的根目录中创建一个新文件 index.ts（也可以选择其他的文件名），输入以下代码：
-- -------------------- ---- ------- ------ - ------ ---- ---- - ---- ------- ----------- ----- -------------- - --------- ------ -------- ------ - ------ -------- -- ------- - - ------ ------- ---------------展开代码
这段代码引入了 Route、Get 和 Post 装饰器，用于指定路由和 HTTP 请求方法。在这段代码中，我们使用 Route 装饰器将该类路由到根目录下。然后，我们使用 Get 装饰器指定当 HTTP GET 请求到达“/”路径时，将调用 index 方法，并返回一个欢迎消息。
启动应用程序
现在我们已经写好了路由，接下来需要启动应用程序。在终端中输入以下命令：
npx ts-node index.ts
该命令会使用 ts-node 运行 TypeScript 文件并启动本地服务器。如果一切正常，应用程序将运行在 http://localhost:8080 上，您可以在浏览器中查看结果。
深入研究
现在我们已经创建好了我们的第一个 oase 应用程序，接下来让我们深入研究如何使用 oase 框架提供的各种特性。
控制器
控制器是 oase 中的核心概念之一，用于处理来自客户端的请求，并返回相应的响应。控制器通常由方法组成，这些方法处理不同的 HTTP 请求方法和 URL 路径。
-- -------------------- ---- ------- ------ - ------ ---- ----- ---- ------ - ---- ------- -------------- ----- -------------- - --------- ------ -------------- ------ - ------ ---- --- ------- - ------------ ------ --------------- -------- ------ - ------ ---- ---- ---- -- ------- - ---------- ------ ------------- ------ - ------ ------- --- ------ - ------------ ------ ------------------ -------- ------ - ------ ------- ---- ---- -- ------- - --------------- ------ ------------------ -------- ------ - ------ ------- ---- ---- -- ------- - - ------ ------- ---------------展开代码
上述代码展示了使用 Get、Post、Put 和 Delete 装饰器来定义控制器类中的不同方法以进行 CRUD 操作。
值得注意的是，在这里使用参数来指定路由的路径参数（:id）。这些参数可以通过将它们作为方法参数进行捕获来使用。
中间件
中间件是框架的另一个核心概念，用于在请求到达控制器之前或响应返回客户端之前执行一些操作。中间件可以是请求级别的，也可以是全局的。
-- -------------------- ---- ------- ------ - ------------ - ---- ------- -------- ---------------------- -------- ---- --------- ----- ------------- - ------------------- ---------------------- ------------- ------------- ------- - -------------- ----- -------------- - --------- ------ -------------- ------ - ------ ---- --- ------- - ------------ ------ --------------- -------- ------ - ------ ---- ---- ---- -- ------- - - ------ ------- ---------------展开代码
在上述代码中，我们定义了一个简单的 loggingMiddleware 中间件，该中间件将在每个请求到达控制器之前输出请求的基本信息。
要将中间件应用于路由或控制器，我们只需将中间件函数作为 use 方法的参数传递即可。
-- -------------------- ---- ------- ------ - ----------- - ---- ------- ------ -------------- ---- ------------------------------- ------ ----------------- ---- ---------------------------------- ----- --- - --- -------------- --------------------------- ----------------- ---------------- ---------------- -- -- ------------------- -- ------- -- ---- --------展开代码
依赖注入
依赖注入是一种设计模式，用于将一个对象的依赖项注入到该对象中。这可以使我们更加方便地管理依赖关系，并将其分离为单独的组件，以便更好地重用代码。
oase 框架支持依赖注入，并且使用了一种名为 "Inversify" 的流行注入库。在使用之前，需要将其安装：
npm install inversify reflect-metadata
-- -------------------- ---- ------- ------ - ----------- ------ - ---- ------------ ------------- ----- ----------- - ------ -------------- ------ - ------ ---- --- ------- - - -------------- ----- -------------- - -------------------------------- ------- ------------ ------------ -- --------- ------ -------------- ------ - ------ ------------------------------- - - ------ ------- ---------------展开代码
在这个例子中，我们定义了一个 UserService 类来处理用户的业务逻辑，并将其注入到 UserController 类中。在 UserController 中，我们将 UserService 作为构造函数的参数来注入。
要使用依赖注入，我们需要将其配置为全局和本地服务。对于全局服务，我们需要在应用程序启动时对它进行配置。在本教程中，我们将创建一个 inversify.config.ts 文件：
import { Container } from 'inversify'; import UserService from './services/UserService'; const container = new Container(); container.bind<UserService>(UserService).toSelf(); export default container;
上述代码将 UserService 绑定到自身。这意味着每当我们需要 UserService 时，Inversify 将使用它的构造函数创建一个新的实例。
要将 Inversify 与 oase 框架集成，我们需要在应用程序中使用 useContainer 方法。在应用程序的入口文件中，我们可以使用以下代码：
-- -------------------- ---- ------- ------ - ----------- - ---- ------- ------ -------------- ---- ------------------------------- ------ ----------------- ---- ---------------------------------- ------ --------- ---- --------------------- ----- --- - --- -------------- --------------------------- ----------------- ------------------------------- ---------------- -- -- ------------------- -- ------- -- ---- --------展开代码
上述代码创建了一个名为 “container” 的实例，并将其用于创建 UserController 的实例。在 UserController 的构造函数中传入了 UserService 实例，使得它能够处理用户的业务逻辑。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066f9d3d1de16d83a6700d
