npm 包 routing-controllers 使用教程

在现代 Web 应用程序开发中,基于 TypeScript 的后端框架越来越受欢迎,其中一个很受欢迎的选择是 routing-controllers。 routing-controllers 是一个基于 Typescript 的 Node.js Web 框架,允许开发者使用注释使控制器可以配合不同的 Web 框架使用,例如 express、koa 和 fastify。routing-controllers 提供了一种类似于 Spring MVC 或 Ruby on Rails 的路由控制器基元,使开发者能够专注于应用程序的处理逻辑。

本文将介绍 npm 包 routing-controllers 的使用,并提供一份详细的教程,帮助您在 Node.js 中通过 TypeScript 构建出高效且易于维护的 Web 应用程序。

路由 (Routing)

路由是 Web 应用程序中非常重要的一部分,通常是决定如何处理 HTTP 请求的核心机制。routing-controllers 允许您使用装饰器(decorators)配置控制器和方法,从而提供更加便捷的路由配置方式。这样可以使您的代码更加清晰易懂,同时也更加灵活。

例如,使用 routing-controllers 声明 GET 请求的 /users 路由的控制器和方法如下所示:

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

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

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

在上面的示例中,我们使用了 JsonController 装饰器来定义一个控制器,控制器名称是 UserController,并将其设置为 /users。然后,我们使用 @Get 装饰器定义在 /users 控制器下的方法 getAll。如果此时向 http://localhost:3000/users 发送 GET 请求,将会执行 getAll 方法。

类似的,可以使用其他 HTTP 方法来定义路由。以下是示例代码:

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

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

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

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

中间件 (Middleware)

中间件是另外一个非常重要的概念,它允许开发者在请求到达路由之前、处理之前或区分一些请求对路由做出特殊操作。在 routing-controllers 中,您可以很容易地配置和使用中间件来拦截和处理 HTTP 请求。

以下是通过在控制器类级别和方法级别注册的中间件运行的示例代码:

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

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

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

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

在上面的示例代码中,定义了一个全局的 logger 中间件,它记录了每个请求的 HTTP 方法和 URL,然后使用 @UseBefore 装饰器将其使用到 UserController 控制器上。

输入数据转化 (Input Data Conversion)

当然,传入的 HTTP 请求很少直接使用它们接收到的数据,因为这些数据的格式可能需要进行转换和验证。routing-controllers 允许您在控制器和方法级别上使用类似 DTO (Data Transfer Object,数据传输对象) 的模式来定义输入数据,并从原始数据中自动从生成这些 DTO 对象。例如:

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

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

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

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

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

在上面的示例中,CreateUserDto 提供了一个可以被序列化和反序列化的对象格式,它有 firstNamelastNameemailpassword 这样几个属性。此后,我们使用 @Body 装饰器,将 HTTP 请求中的数据体自动注入到 createUser 方法中,同时也将这些数据从原始数据进行了类型转换。

总结

总而言之,routing-controllers 是一个优秀的 Node.js Web 框架,允许您使用 TypeScript 构建高效且可维护的 Web 应用程序。在本文中,我们简要介绍了 routing-controllers 的几个核心概念,如路由、中间件和输入数据转换。如果您是 Node.js 开发者或使用 TypeScript 编写 Web 应用程序,则可以考虑使用 routing-controllers,这样可以使得代码更加清晰易懂。

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


猜你喜欢

  • npm 包 @pushrocks/smartunique 使用教程

    作为前端开发者,我们经常需要处理数据,其中去重是最常见的问题之一。在 JavaScript 中,我们可以通过使用 Set 数据结构来实现简单去重操作。然而,对于大规模数据的去重操作,Set 的性能往往...

    5 年前
  • npm 包 @pushrocks/smarttime 使用教程

    在前端开发中,处理时间是一个非常基础的操作。尤其是当我们需要进行处理某些事件发生的时间时,JavaScript 的 Date 对象和相关 API 显得非常不友好。为了方便我们的时间处理,@pushro...

    5 年前
  • npm 包 @pushrocks/smartrx 使用教程

    在前端开发中,npm 无疑是一个不可或缺的工具。一个好用的开源 npm 包可以提高前端开发效率和质量。本文将介绍一个优秀的 npm 包 @pushrocks/smartrx,教你如何在项目中使用它,并...

    5 年前
  • npm 包 @pushrocks/tapbundle 使用教程

    前端开发不仅需要掌握 HTML、CSS、JavaScript等技术,还需要熟悉 npm 包的使用。npm 是 Node.js 的包管理器,通过 npm 可以获取和管理 node.js 包,也可以分享和...

    5 年前
  • npm 包 @gitzone/tsrun 使用教程

    简介 在前端开发中,我们经常需要将 TypeScript 编译成 JavaScript。通常情况下,我们使用如下命令进行编译: --- -------但是,在进行较大规模的开发时,我们通常有多个 Ty...

    5 年前
  • npm 包 @pushrocks/smartpromise 使用教程

    前言 在前端开发中,我们经常使用异步请求来获取数据,但是 JavaScript 中的异步操作往往是一个非常麻烦的问题。这时就需要使用 Promise 来解决这个问题。

    5 年前
  • npm 包 @pushrocks/consolecolor 使用教程

    前言 在前端领域中,我们经常需要在控制台中输出日志信息。然而,控制台中的内容通常都是单调的黑白色调,这使得我们很难分辨各类日志的信息等级和内容,增加了排查 bug 的难度。

    5 年前
  • npm 包 dots 使用教程

    在前端开发中,我们经常需要在页面中使用动态效果。dots是一个轻量级的 JavaScript 库,用于在网页中创建动态效果。这个库可以帮助开发者轻松地在页面上添加斑点效果、心动效果等。

    5 年前
  • npm 包 @chix/iobox 使用教程

    简介 在前端开发中,我们经常需要处理与 IO 相关的操作,例如读写文件、向服务器发送请求、处理本地缓存等。虽然在不同的项目中,我们可以采用不同的方式来实现这些操作,但是在实际开发中,我们往往需要一个简...

    5 年前
  • npm 包 dyslexer 使用教程

    简介 dyslexer 是一个基于正则表达式构建的文本分词工具。它可以将一段文本分解成一个个单词,并根据已经定义好的规则进行解析。对于前端开发者来说,这是一个十分实用的工具。

    5 年前
  • npm 包 @types/babylon 使用教程

    介绍 在前端开发中,我们经常需要进行代码解析。而 Babylong 是一个非常流行的 JavaScript 代码解析器。为了让 TypeScript 开发者能够更好地使用 Babylon,社区开发了 ...

    5 年前
  • npm 包 @types/babel-template 使用教程

    概述 Babel 是一个广泛使用的 JavaScript 编译器,它可以将最新版本的 JavaScript 转换成可以在当前浏览器中运行的版本。在 Babel 中,模板被称为“模板字符串”,它们允许您...

    5 年前
  • npm 包 @types/babel-generator 使用教程

    在前端开发中,Babel 是一个非常常用的编译工具,它可以将 ES6+ 写的代码编译成 ES5 的语法,以便于浏览器的兼容。而 @types/babel-generator 则是 Babel 的代码生...

    5 年前
  • npm 包 @atlas.js/atlas 使用教程

    本文介绍了如何使用npm包@atlas.js/atlas进行前端开发。 简介 @atlas.js/atlas 是一个基于 JavaScript 的前端应用程序开发框架。

    5 年前
  • 详解 npm 包 @atlas.js/service 的使用

    前言 在前端开发中,使用 npm 包是非常普遍的。npm 包的使用可以大大提高开发效率,同时也有很多成熟的 npm 包可供选择。 本文将介绍一个名为 @atlas.js/service 的 npm 包...

    5 年前
  • npm 包 @atlas.js/hook 使用教程

    什么是 @atlas.js/hook @atlas.js/hook 是一个 Node.js 模块,它提供了一个灵活且易于使用的钩子系统,可以用于在 Node.js 应用程序中实现插件、中间件或模块。

    5 年前
  • npm 包 @atlas.js/errors 使用教程

    在前端开发过程中,错误处理是一个必要的环节。npm 包 @atlas.js/errors 是一个前端错误处理库,提供了一种方便的方式来处理和记录错误,支持多种级别的错误和日志记录,同时也提供了很多有用...

    5 年前
  • npm 包 @atlas.js/action 使用教程

    简介 在前端开发过程中,我们经常需要封装一些通用的方法或者组件,以便于复用。npm 是一个非常强大的 Node.js 包管理工具,它可以方便我们管理依赖、发布与安装包。

    5 年前
  • npm 包 tsyringe 使用教程

    在前端开发中,依赖注入(Dependency Injection)是一种非常重要的设计模式。它可以帮助我们减少代码的耦合度,提高代码的复用性和可测试性。tsyringe 是一款可以实现依赖注入的 np...

    5 年前
  • npm 包 tslint-config-shopify 使用教程

    简介 tslint 是一个 TypeScript 代码静态分析工具,用于在开发过程中标记潜在问题和编码样式错误,并提供指导意义,以增强代码质量和可维护性。tslint-config-shopify 是...

    5 年前

相关推荐

    暂无文章