nodejs的express使用全局拦截器保存用户请求和响应日志_express保存请求接口的日志信息

前言：为了记录用户的请求记录，想要记录用户的ip，请求入参，请求方法，以及返回内容，我使用中间件收集用户请求数据保存到数据库

1.数据库表结构

CREATE TABLE `admin_request_log` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',
  `user_id` int(11) DEFAULT NULL COMMENT '用户id',
  `url` varchar(1000) DEFAULT NULL COMMENT '请求地址',
  `method` varchar(10) DEFAULT NULL COMMENT '请求方式',
  `body` text COMMENT '请求body',
  `params` varchar(1000) DEFAULT NULL COMMENT '请求params',
  `ip_address` varchar(100) DEFAULT NULL COMMENT 'ip地址',
  `result` text COMMENT '响应内容',
  `created_time` datetime DEFAULT NULL COMMENT '创建时间',
  `updated_time` datetime DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=89 DEFAULT CHARSET=utf8mb4;
1
2
3
4
5
6
7
8
9
10
11
12
13

2.日志拦截器的方法

// 全局日志拦截器
const endMiddleware = (req, res, next) => {
  const defaultWrite = res.write;
  const defaultEnd = res.end;
  const chunks = [];
  res.write = (...restArgs) => {
    chunks.push(Buffer.from(restArgs[0]));
    defaultWrite.apply(res, restArgs);
  };
  res.end = (...restArgs) => {
    let mList = ["POST","GET"]
    if(mList.indexOf(req.method) !== -1){
      if (restArgs[0]) {
        chunks.push(Buffer.from(restArgs[0]));
      }
      const body = Buffer.concat(chunks).toString('utf8');
      const time = moment(new Date()).format("YYYY-MM-DD HH:mm:ss");
      AdminRequestLog.create({
        user_id: (req.data && req.data.user_id) ? req.data.user_id : null,
        url:req.url,
        method: req.method,
        body: JSON.stringify(req.body),
        params: "",
        ip_address: getClientIp(req),
        result: JSON.stringify(body),
        create_time: time,
        updated_time: time,
      });
    }
    defaultEnd.apply(res, restArgs);
  };
  next();
};

app.use(endMiddleware)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

使用的是res.end方法等待方法返回，然后将返回数据解析出来保存到数据库

3.缺省方法说明
（1）AdminRequestLog 这个是使用的数据库orm框架sequelize模型插入数据

（2）getClientIp 这和是获取用户ip的方法，如下：

//函数返回ip地址
 function getClientIp(req) {
     return req.headers['x-forwarded-for'] ||
         req.connection.remoteAddress ||
         req.socket.remoteAddress ||
         req.connection.socket.remoteAddress;
 }
1
2
3
4
5
6
7

4.最终效果