一、安装node.js
安装node.js 这里就不多说 点击 http://nodejs.cn/ 下载安装。
二、初始化一个express项目
- 全局安装express
npm install -g express
- 在电脑创建一个文件夹,并在文件中打开命令行,输入
npm install // 或者是用cnpm install 有使用yarn的直接 运行yarn
- 项目中需要使用到log4js来输出日志, 安装log4js
npm install log4js -D // 建议使用cnpm install log4js -D 或者使用 yarn add log4js
- 在项目的根目录创建一个log的文件夹,在文件夹中创建一个index.js文件 与 一个logs文件夹
index.js文件夹是配置log4js的代码, logs文件夹用来存储 , 记录错误信息日志的文件(*.log) - 配置log4js
直接上代码: -
const log4js = require('log4js'); log4js.configure({ appenders: { // 从log4js 2.0版本以后 这里从一个array变为了json形式。 dateFileLog: { // 定义存储为文件形式日志类型的名称(名称可随意起) type: 'dateFile', filename: "./log/logs/logs", // 项目根目录开始 pattern: "_yyyy-MM-dd_error.log", // 存储的文件名称为 logs_yyyy-MM-dd_error.log(当天的日期) alwaysIncludePattern: true, //文件名是否始终包含占位符 absolute: false //filename是否绝对路 }, logConLog: { // 定义在控制台输出的日志类型的名称 type: 'console' } }, categories: { // 这里面的配置是什么意思我也没仔细看过文档 default: { appenders: ['dateFileLog'], level: 'ALL' }, logConLog: { appenders: ['logConLog'], level: 'ALL' } } }); const dateFileLog = log4js.getLogger('dateFileLog'); // 可以理解为实例化一个日志输出对象吧 const logConLogs = log4js.getLogger('logConLog'); // 可以理解为实例化一个日志输出对象吧 exports.logger = dateFileLog; // 对外开发接口 在文件中输出 exports.logs = logConLogs; // 对外开发接口 在控制台输出 exports.use = function (app) { // 对外开发接口 这里在app.js中调用, 接管express在控制台的输出 app.use(log4js.connectLogger(logConLogs, { level: 'debug', // 他的等级我默认是DEBUG format: ':method :url' })); };
log4js在项目中的使用
/* 关于log4js的使用 */ /* 可以在build文件夹下的www.js文件中实验log4js */ /* 在你需要打印日志的文件中引入log文件夹下的index.js */ // 这里是引用时, 文件下有文件名称为index.js的时候 路径直接写到文件夹就可以, node会自己去寻找下面的index.js中的内容 const log = require('./log'); const logs = log.logs; // logs是在控制台输出信息 const logger = log.logger // logger是在文件中输出的信息(一般只输出错误信息) // 引入进来以后再以下函数中 function onListening() { const addr = server.address(); const bind = typeof addr === 'string' ? 'pipe ' + addr : 'port ' + addr.port; debug('Listening on ' + bind); // logs.info('服务已启动. 端口:' + port); // 这一句代码在控制台输出使用的是哪个端口 /* 在此处输入以下代码 */ logs.info('这是描述信息'); logs.debug('这是debug信息'); logs.error('这是错误信息'); logs.warn('这是警告信息'); // 可以在控制台中看到下面图片中的日志 }
可以看到每一种方法对应的就是一个颜色, 一般在控制台输出调试信息, 都采用debug方法, 现在你可以在你想要输出日志的地方调用logs的各个方法输出不同颜色的日志了。 - log4js 替换 express 自带日志
/* 在app.js中引入log文件下的index.js */ /*这里是引用时, 文件下有文件名称为index.js的时候 路径直接写到文件夹就可以, node会自己去寻找下面的index.js中的内容*/ const log = require('./log'); const logs = log.logs; // logs是在控制台输出信息 // 在 const app = express();这一句后面使用我们在log/index.js中暴露出来的use()方法 log.use(app) // 把 app 传进去 这样它就已经托管了express默认的日志输出 // 现在就可以把express默认的日志插件屏蔽掉了 屏蔽一下两行代码 const logger = require('morgan'); app.use(logger('dev')); // 寻找到下面代码中添加一句 app.use(function (err, req, res, next) { logs.error(err); // 添加此句在控制台输出详细的错误信息 // set locals, only providing error in development res.locals.message = err.message; res.locals.error = req.app.get('env') === 'development' ? err : {}; // render the error page res.status(err.status || 500); res.render('error'); });