如何深入理解并高效使用Node.js中的log4js日志管理？

本文共计1793个文字，预计阅读时间需要8分钟。

《log4js v4.3 使用指南：基础用法总结》

本文针对 log4js v4.3 版本，简要记录了其基本用法，并针对一些技术点进行说明。部分功能因未实际使用，或未在后续应用中体现，故未详细展开。后续如有需要，将进行更新。

一、log4js 基本用法

1. 安装：使用 npm 安装 log4js：

bash npm install log4js

2. 配置：创建 log4js 配置文件（如：log4js.config.js）：

javascript const log4js=require('log4js');

log4js.configure({ appenders: { console: { type: 'console' }, file: { type: 'file', filename: 'logs/app.log' } }, categories: { default: { appenders: ['console', 'file'], level: 'info' } } });

const logger=log4js.getLogger('myLogger');

3. 使用：在代码中使用 logger：

javascript logger.info('This is an info message'); logger.error('This is an error message');

二、技术点说明

1. 日志级别：log4js 支持多种日志级别，如：trace、debug、info、warn、error、fatal。

2. appenders：appenders 用于指定日志输出方式，如：控制台输出、文件输出等。

3. categories：categories 用于配置不同模块的日志输出设置。

4. pattern：pattern 用于配置日志格式，如：时间、日志级别、日志内容等。

三、总结

本文简要介绍了 log4js v4.3 的基本用法，并针对部分技术点进行了说明。希望对您有所帮助。后续如有需要，将进行更新。

本文章针对 log4js v4.3

本文对自己用log4js的技术点简单的做一个记录，有一些技术点没有用到或者写全，会在后面用到的时候进行更新。

先大概的对log4js 的基本用法做一个总结，使用configure()方法对日志输出进行配置，使用 getlogger()方法获取logger对象，然后使用logger 对象进行打印各个级别的日志。其中比较复杂的是 configure()方法中的配置对象appenders 和 categories 下面重点讲解这两个对象

安装

npm install --save log4js

日志级别level

log4js的分为以下几个级别，级别的顺序也是按如下排列，logger只会打印大于等于logger对象设置的level的日志。

• trace
• debug
• info
• warn
• error
• fatal

简单的用法

var log4js = require('log4js'); var logger = log4js.getLogger(); logger.level = 'debug'; logger.debug("Some debug messages");

getLogger()方法返回一个logger对象，想对日志进行记录就必须使用logger对象，将logger对象的 level设置为debug（默认为OFF不会输出任何日志）

在node 环境运行上面的代码之后发现在控制台打印出了对应的日志信息，但是这跟我想要的完全不一样，我想要的是根据我自己的想法将日志进行分类方便查找和统计。接下来我们就看如何对日志进行分类。

configure(string | object) 方法

通过调用configure 方法就可以实现我们对日志进行分类管理的目的。方法的参数可以是一个字符串或者是一个object 字符串参数被视为用于加载配置的文件名，配置文件是一个json 文件，也可以直接将配置对象传给configure。

配置对象

本次只对配置对象中最常用的appenders 和categories 进行介绍，还有部分属性暂时还没有用到等用到的时候在进行补充，如果平常用的话这两个属性应该就够了。

简单的总结一下这两个属性，先有一个概念性的认识了解一下他们分别是干什么的。

appenders 主要是用来定义以怎样的方式输出，输出到哪里(主要功能不仅限于)

categories 是用来定义日志输出的规则然后调用之前定义好的 appenders 进行输出

写一个简单的例子方便理解一下

const log4js = require('log4js'); log4js.configure({ appenders: { out: { type: 'stdout' }, app: { type: 'file', filename: 'application.log' } }, categories: { default: { appenders: [ 'out', 'app' ], level: 'debug' } } }); var logger = log4js.getLogger(); logger.debug("Some debug messages");

运行上的代码将会创建application.log 文件在项目目录下，同时会把日志打到控制台和 application.log文件中.
上面定义了两个appender 一个是输出到 stdout 一个是输出到 file ，可以看出appender主要使用来定义输出位置的
同时在categories 中定义了一个规则，调用了appender中定义的输出，并且输出级别为 debug

appenders

appenders 的是一个map, key 代表的是appender的名字是一个字符串，value里面有一个必选的属性是type，根据type 的不同value 的格式也不一样，下面我们说几种常用的 type

file

file 日志将会输出到指定的文件中。

例子

log4js.configure({ appenders: { everything: { type: 'file', filename: 'all-the-logs.log' } }, categories: { default: { appenders: [ 'everything' ], level: 'debug' } } }); const logger = log4js.getLogger(); logger.debug('I will be logged in all-the-logs.log');

常用配置属性

1. type:'file'
2. filename string 输出文件的名字
3. maxLogSize integer日志文件的最大大小（以字节为单位）。如果未指定，则不会发生日志滚动。
4. backups日志滚动期间要保留的旧日志文件数默认为5
5. layout 默认是basic layout
6. keepFileExt boolean 默认为false 滚动日志文件时保留文件扩展名（file.log变为file.1.log而不是file.log.1）
7. compress 对滚动的日志文件进行压缩

dateFile

dateFile 日志的滚动将根据配置的时间格式进行滚动而不是文件大小

例子

log4js.configure({ appenders: { everything: { type: 'dateFile', filename: 'all-the-logs.log' } }, categories: { default: { appenders: [ 'everything' ], level: 'debug' } } });

常用配置属性

1. type:'dateFile'
2. filename string 输出文件的名字
3. pattern(默认为.yyyy-MM-dd） - 用于确定何时滚动日志的模式。
4. layout 默认是basic layout
5. daysToKeep integer（默认为0） - 如果此值大于零，则在日志滚动期间将删除早于该天数的文件。
6. keepFileExt （默认为false） - 在滚动日志文件时保留文件扩展名（file.log变为file.2017-05-30.log而不是file.log.2017-05-30
7. compress 对滚动的日志文件进行压缩

categories

categories 也是一个map类型的数据，key是 category 的名字是一个字符串，value 是一个对象。

value 的常用属性

1. level 定义打印日志的级别
2. appenders 定义打印的appender

getLogger([category]) 方法

getLogger 方法返回的是一个logger 对象,logger对象用来打印各个级别的日志。

getlogger 方法有一个可选参数category的名字，不写的情况会使用 categories 中default 定义的规则进行打印，填写之后会根据对应的 category定义的规则进行打印日志。

参考文档 api

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持自由互联。