在前端开发中，我们经常需要编写控制器来处理用户的交互请求和数据处理。而编写控制器常常需要大量的重复代码，尤其是在处理 CRUD 操作时更是如此。为了解决这个问题，我们可以使用 npm 包 controller-factory。
controller-factory 是什么？
controller-factor 是一个可以生成通用 CRUD 控制器的 npm 包。使用它可以帮助我们减少大量的重复代码，提高开发效率。
安装和使用
你可以使用 npm 来安装 controller-factory。在终端输入以下命令：
npm install controller-factory
安装成功后，你需要通过以下内容来使用它。
首先，你需要创建一个配置文件。在项目的根目录下创建一个名为 controllers.js 的文件，内容如下：
-- -------------------- ---- ------- ----- ----------------- - ------------------------------ ----- ------ - - --------- ------------- -------- -------- ------ ------- ----------- --- ------ --- -- -------------- - --------------------------
这个配置文件中的内容是通用的配置，后续会针对这个文件进行解释。如果你需要创建多个控制器，可以在这个文件中添加多个配置信息即可。
接着，在你的 Express 应用中启动这个通用控制器，代码如下：
const express = require('express');
const controllers = require('./controllers');
const app = express();
app.use('/api', controllers);现在，你就可以访问 http://localhost:3000/api/users，来访问你创建的用户管理控制器。
controller-factory 默认会创建 5 个路由：GET /、GET /:id、POST /、PUT /:id 和 DELETE /:id。你只需要传递对应的参数即可，controller-factory 会自动处理对应的请求。
配置文件详解
上面我们提到了创建通用控制器的配置文件内容。下面我们来详细的解释一下这些配置信息的含义和用法。
const config = {
endpoint: '/api/users',
adapter: 'mongo',
model: 'User',
middleware: [],
scope: [],
};endpoint
- 类型：String
- 必填项：是
这个属性指定了控制器要映射的端点。在上面的示例中，我们指定了控制器映射到 /api/users 这个端点。
adapter
- 类型：String
- 必填项：是
controller-factory 中有两个数据适配器可以使用：memory 和 mongo。这个属性用于指定使用哪个适配器来处理数据请求。
model
- 类型：String
- 必填项：是
这个属性用于指定控制器要使用的数据模型名称。在 MongoDB 中，这个名称对应的是集合名称。
middleware
- 类型：Array
- 必填项：否
这个属性用于指定在执行 CRUD 操作之前需要使用的中间件数组。中间件的使用与 Express 中的使用类似。
scope
- 类型：Array
- 必填项：否
这个属性用于指定在查询操作时应该查询哪些字段。默认情况下，controller-factory 会查询所有的字段。你可以使用这个属性来指定需要查询的字段。
示例代码
如果你还没有使用 controller-factory，下面的示例代码可以帮助你更好的理解它的使用方法。
路由文件（routes.js）
const express = require('express');
const controllers = require('./controllers');
const router = express.Router();
router.use('/api', controllers);
module.exports = router;控制器配置文件（controllers.js）
-- -------------------- ---- ------- ----- ----------------- - ------------------------------ ----- ---- - -------------------------- ----- ------ - - ------ ------- -------- -------- --------- ------------- ----------- --- ------ --- -- -------------- - --------------------------
数据模型文件（users.js）
-- -------------------- ---- ------- ----- -------- - -------------------- ----- ---------- - --- ----------------- --------- ------- --------- ------- ------ ------- --- -------------- - ---------------------- ------------
上面的代码创建了一个用户管理的控制器，使用了 MongoDB 作为数据适配器，数据模型为 User。这个控制器默认包含 GET、POST、PUT 和 DELETE 四种操作，使用起来十分方便。
结语
controller-factory 是一个非常实用的 npm 包，可以大大提高前端开发效率。它的使用方法简单，几分钟内就可以上手。如果你是一个忙碌的开发者，一定不要错过它。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600556aa81e8991b448d3745