Sails-count-middleware 是一个能够进行请求计数的 express 中间件,能够方便的统计你的 sails 项目的 API 接口调用频率。本教程将会介绍 sails-count-middleware 的使用方法。
安装
需要先安装 nodejs 和 npm。
使用 npm 进行全局安装:
npm install sails-count-middleware -g
使用方法
在你的 sails 项目中使用 sails-count-middleware,需要先进行如下配置:
在 config/http.js 文件中加入如下中间件内容:
-- -------------------- ---- ------- ------------------- - - ----------- - -- ------ --------- ---------- -------- ----- ------- ---------- ------------- - ----- ---- ----- -- - -------------- - --- ------- ------- -- --------------------------------- - - --
在该配置文件中,http 配置项中的 middleware 数组添加了名为 countRequest 的中间件,配置了此中间件的函数执行顺序为:记录请求开始时间 -> 记录请求结束时间 -> 中间件结束。
示例代码
接下来,将在一个简单的 sails 项目中展示一个例子,以便了解 sails-count-middleware 的具体使用方法。
第一步:安装 sails
已经安装了 sails 跳过此步骤。
可以使用如下命令在本地快速创建一个 sails 项目。
npm install sails -g sails new sails-demo
第二步:安装 sails-count-middleware
在命令行中进入 sails 项目的根目录,输入如下命令:
npm install sails-count-middleware --save
第三步:配置中间件
在 sails 项目的 config/http.js 文件中进行配置,如下:
-- -------------------- ---- ------- ------------------- - - ----------- - -- ----- ------------- - ----- ---- ----- -- - -------------- - --- ------- ------- -- ---------------------------------- ----- ---- ----- -- - ----------------------- ------ - -------------------- ------- - - - --
这里通过 console.log 输出了每个 API 接口的请求耗时时间,方便运维人员进行性能监控。
第四步:利用 API 接口测试中间件
在 sails 项目中创建一个 UserController。在 routes.js 中创建一个 /user/add 的路由,分别定义用户增加接口 /user/add 和用户查询接口 /user/query,并且在 UserController 中添加以下代码。
-- -------------------- ---- ------- --- - -------------- - - ------------ -- ----------- ----- --- -------- ----- - ----- -- --- -------------------------------------------------------- -- -------------- - - ---- -------- ----- ---- - ------------------------------- ----- --------- ------ ---------- ----- ------ --- -- ------ -------- ----- ---- - ------------------------------- ------- --------- ------ ---------- ----- -------- --- - --
在浏览器中访问 http://localhost:1337/user/add 这个路径,则会在命令中看到如下调试信息,表示请求已经被正常记录。
2021-03-26T01:31:22.852Z [debug] Middleware (countRequest) hit for request to /user/add
第五步:计数数据统计
在浏览器中访问 http://localhost:1337/admin/_stats/count 中间路径,则可以查看计数结果。
以上就是 sails-count-middleware 的使用方法。通过使用这个中间件,可以快速统计 sails 项目的 API 调用量,方便运维人员进行性能监控和调优。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056cd781e8991b448e6772