typescript node.js 表达路由分离文件最佳实践 [英] typescript node.js express routes separated files best practices

问题描述

在 Node 项目中使用 Express 和 Typescript 什么是 express.Router 的最佳实践".

using Express in a Node project along with Typescript what would be the "best practices" for express.Router.

示例目录结构

|directory_name
  ---server.js
  |--node_modules
  |--routes
     ---index.ts
     |--admin
        ---admin.ts
     |--products
        ---products.ts
     |--authentication
        ---authentication.ts

所以在 index.ts 里面会封装和管理所有的子路由器

so inside index.ts it would encapsulate and manage all the sub-routers

    //admin.ts (nested inside of index.ts)
    import * as express from "express";

    export = (() => {
        
        let router = express.Router();
              
        router.get('/admin', (req, res) => {
            res.json({success: true});
        });
        
        return router;
    })();

    //index.ts (master file for express.Router)

    import * as express from "express";

    //import sub-routers
    import * as adminRouter from "./admin/admin";
    import * as productRouter from "./products/products";

    export = (() => {

      let router = express.Router();

      // mount express paths, any addition middleware can be added as well.
      // ex. router.use('/pathway', middleware_function, sub-router);

      router.use('/products', productRouter);
      router.use('/admin', adminRouter);

      //return for revealing module pattern
      return router;
    })(); //<--- this is where I don't understand something....

最后我们将设置我们的 server.js

lastly we would set-up our server.js

    //the usual node setup
    //import * as *** http, body-parser, morgan, mongoose, express <-- psudocode

    import * as masterRouter from './routes/index'

    var app = express();
    //set-up all app.use()

    app.use('/api', masterRouter);

    http.createServer(app).listen(8080, () => {
          console.log('listening on port 8080')
        };

我的主要问题是 index.ts(masterRouter 文件)，它是 IIFe 的嵌套路由

my main question really is, is index.ts (masterRouter file) and it's nested routes that are IIFe's

export = (function(){})();

export = (function(){})();

这应该是为路由器编写打字稿模块的正确/最佳方式吗?

should that be the correct/best way to write typescript modules for routers?

或者使用另一种模式会更好，也许使用该模式的一种

or would it be better to use another pattern, perhaps one the utilizes the pattern

export function fnName() {} -- export class cName {} -- 导出默认值.

export function fnName() {} -- export class cName {} -- export default.

使用 IIFe 的原因是，当我将它们导入另一个文件时，我不需要初始化模块，并且每种类型的路由器只会有 1 个实例.

the reason for the IIFe is that when i import them into another file i won't need to initialize the module and there will only ever be 1 instance of each type of router.

推荐答案

在 NodeJS 中每个文件都是一个模块.声明变量不会污染全局命名空间.所以你不需要使用旧的 IIFE 技巧来正确地限定变量的范围(并防止全局污染/冲突).

In NodeJS each file is a module. Declaring variables does not pollute the global namespace. So you don't need to use the good old IIFE trick to properly scope variables (and prevent global pollution / collision).

你会写:

  import * as express from "express";

  // import sub-routers
  import * as adminRouter from "./admin/admin";
  import * as productRouter from "./products/products";

  let router = express.Router();

  // mount express paths, any addition middleware can be added as well.
  // ex. router.use('/pathway', middleware_function, sub-router);

  router.use('/products', productRouter);
  router.use('/admin', adminRouter);

  // Export the router
  export = router;

关于模块的更多信息:https://basarat.gitbooks.io/typescript/content/docs/项目/modules.html

这篇关于typescript node.js 表达路由分离文件最佳实践的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！