npm 包 express-file-autorouter 使用教程

简介

express-file-autorouter 是一个可以自动化路由管理的 npm 包，它可以根据文件目录结构自动生成路由。通过使用 express-file-autorouter，我们可以更加方便地管理 express 服务器的路由，从而提高我们的开发效率。

安装

使用 npm 安装 express-file-autorouter：

npm install express-file-autorouter

使用方法

在 express 项目的入口文件中引入 express-file-autorouter：

const express = require('express')
const app = express()
const autoRouter = require('express-file-autorouter')

然后，我们可以通过以下方式来使用 express-file-autorouter：

autoRouter(app, {
    baseDir: `${__dirname}/routes`,
    controllersFolder: 'controllers'
})

其中，baseDir 为路由文件所在目录，controllersFolder 为路由文件的控制器所在目录。express-file-autorouter 会扫描指定目录中的所有 JavaScript 文件，并自动生成路由。

示例代码

假设我们有如下的目录结构：

routes/
├── index.js
└── users/
    ├── index.js
    ├── createUser.js
    ├── deleteUser.js
    ├── getUser.js
    └── updateUser.js

其中，routes/index.js 的代码如下：

const express = require('express')
const router = express.Router()

module.exports = router

routes/users/index.js 的代码如下：

const express = require('express')
const router = express.Router()

module.exports = router

routes/users/createUser.js 的代码如下：

exports.create = (req, res) => {
    // 创建用户
}

exports.validate = (req, res, next) => {
    // 验证参数
    next()
}

routes/users/deleteUser.js 的代码如下：

exports.delete = (req, res) => {
    // 删除用户
}

routes/users/getUser.js 的代码如下：

exports.get = (req, res) => {
    // 获取用户
}

routes/users/updateUser.js 的代码如下：

exports.update = (req, res) => {
    // 更新用户
}

我们可以通过以下方式使用 express-file-autorouter 自动生成路由：

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

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

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

这时，我们就会发现，express-file-autorouter 自动为我们生成了如下路由：

GET /users => users/index.js
POST /users => users/createUser.js#create | users/createUser.js#validate
PUT /users/:id => users/updateUser.js#update
DELETE /users/:id => users/deleteUser.js#delete
GET /users/:id => users/getUser.js#get

总结

express-file-autorouter 是一个方便管理路由的 npm 包，它可以根据目录结构自动生成路由。通过使用它，我们可以减少手工编写路由的时间，提高我们的开发效率。当然，在使用过程中，我们需要注意一些细节，例如控制器函数的导出方式等。相信在使用过程中，我们都可以掌握这些细节。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055bb681e8991b448d94ed