日志记录器
这是一个用于 Node.JS 的轻量级日志记录器。
它可以以不同级别输出日志，并且可以自定义范围、ID 和时区。
安装
npm i @sumor/logger --save
先决条件
Node.JS 版本
需要 Node.JS 版本 16.x 或更高。
需要 Node.JS ES 模块
由于这个包是使用 ES 模块编写的，
请在您的 package.json 文件中更改以下代码：
{
"type": "module"
}
使用方法
通用使用
import Logger from '@sumor/logger'
const logger = new Logger()
logger.trace('Hello World!')
// 您会看到以下输出：
// 2020-01-01 00:00:00.000 TRACE MAIN - Hello World!
更改范围
在某些情况下，我们需要对日志进行分类。scope 用于此目的。
import Logger from '@sumor/logger'
const logger = new Logger({
scope: 'DEMO'
})
logger.trace('Hello World!')
// 您会看到以下输出：
// 2020-01-01 00:00:00.000 TRACE DEMO - Hello World!
标识用户
在某些情况下，我们需要标识用户。id 用于此目的。
import Logger from '@sumor/logger'
const logger = new Logger({
id: 'USER001'
})
logger.trace('Hello World!')
// 您会看到以下输出：
// 2020-01-01 00:00:00.000 TRACE MAIN USER001 - Hello World!
更改级别
大多数情况下，我们只需要输出特定级别的日志。然后我们可以决定是否存储和显示它。
import Logger from '@sumor/logger'
const logger = new Logger()
logger.trace('Hello World!') // trace 是最低级别，所有日志都将被输出
logger.debug('Hello World!')
logger.info('Hello World!')
logger.warn('Hello World!')
logger.error('Hello World!')
logger.fatal('Hello World!') // fatal 是最高级别，只会输出关键错误
更改时区
import Logger from '@sumor/logger'
const logger1 = new Logger({
offset: 2 * 60 // UTC+2 时区偏移为 2 小时
})
logger1.info('Hello World!')
// 您会看到以下输出：
// 2020-01-01 02:00:00.000 INFO MAIN - Hello World!
const logger2 = new Logger({
offset: 8 * 60 // UTC+8 时区偏移为 8 小时
})
logger2.info('Hello World!')
// 您会看到以下输出：
// 2020-01-01 08:00:00.000 INFO MAIN - Hello World!
预定义代码
import Logger from '@sumor/logger'
const code = {
trace: {
HTTP_ACCESS: '用户通过 HTTP 访问，IP 地址为 {ip}'
},
debug: {
USER_TOKEN_LOADED: '读取用户登录信息，用户 ID 为 {id}'
},
info: {
USER_LOGIN: '用户登录，用户 ID 为 {id}'
},
warn: {
USER_LOGOUT: '用户登出，用户 ID 为 {id}'
},
error: {
USER_LOGIN_FAILED: '用户登录失败，用户 ID 为 {id}'
},
fatal: {
USER_LOGIN_BLOCKED: '用户登录已阻止，用户 ID 为 {id}'
}
}
const i18n = {
zh: {
USER_LOGIN: '用户登录，用户 ID 为{id}'
}
}
const logger1 = new Logger({
code,
i18n
})
logger1.code('USER_LOGIN', { id: 'USER001' })
// 您会看到以下输出：
// 2020-01-01 00:00:00.000 INFO MAIN - 用户登录，用户 ID 为 USER001
const logger2 = new Logger({
code,
i18n,
language: 'zh-US'
})
logger2.code('USER_LOGIN', { id: 'USER001' })
// 您会看到以下输出：
// 2020-01-01 00:00:00.000 INFO MAIN - 用户登录，用户 ID 为 USER001
const logger3 = new Logger({
code,
i18n,
language: 'zh-CN'
})
logger3.code('USER_LOGIN', { id: 'USER001' })
// 您会看到以下输出：
// 2020-01-01 00:00:00.000 INFO MAIN - 用户登录，用户 ID 为 USER001
全局语言设置
process.env.LANGUAGE = 'zh-CN'
import Logger from '@sumor/logger'
const code = {
info: {
USER_LOGIN: '用户登录，用户 ID 为 {id}'
}
}
const i18n = {
zh: {
USER_LOGIN: '用户登录，用户 ID 为{id}'
}
}
const logger = new Logger({
code,
i18n
})
logger.code('USER_LOGIN', { id: 'USER001' })
// 您会看到以下输出：
// 2020-01-01 00:00:00.000 INFO MAIN - 用户登录，用户 ID 为 USER001
过滤级别
当您希望按级别过滤日志时，可以使用以下代码：
import Logger from '@sumor/logger'
const logger = new Logger({
level: 'info'
})
logger.trace('Hello World!') // trace 是最低级别，不会被输出
logger.debug('Hello World!') // debug 低于 info，不会被输出
logger.info('Hello World!') // info 与 info 相同，会被输出
logger.warn('Hello World!') // warn 高于 info，会被输出
logger.error('Hello World!') // error 高于 info，会被输出
logger.fatal('Hello World!') // fatal 是最高级别，会被输出
当您在多个库之间使用此库时，可以使用以下代码：
import Logger from '@sumor/logger'
const logger = new Logger()
process.env.LOG_LEVEL = 'info'
logger.trace('Hello World!') // trace 是最低级别，不会被输出
logger.debug('Hello World!') // debug 低于 info，不会被输出
logger.info('Hello World!') // info 与 info 相同，会被输出
logger.warn('Hello World!') // warn 高于 info，会被输出
logger.error('Hello World!') // error 高于 info，会被输出
process.env.LOG_LEVEL = 'warn' // 实时更改日志级别
logger.info('Hello World!') // info 低于 warn，不会被输出