Console 模块

控制台输入输出模块,提供类似浏览器console的日志记录和格式化输出功能。

功能特性

✅ 多级别日志输出（log, info, warn, error, debug）

✅ 格式化输出支持

✅ 日志级别控制

✅ JSON格式输出

✅ 模块化日志标签

✅ 用户输入功能

✅ 控制台清屏

基本使用

基本日志输出

格式化输出

日志级别设置

模块化日志

自定义徽章

JSON格式输出

用户输入

清屏

创建新的控制台实例

API参考

console.log(message, ...args)

输出普通日志信息。

参数：

message (any): 要输出的消息

...args (any): 额外的参数

console.info(message, ...args)

输出信息级别日志。

参数：

message (any): 信息消息

...args (any): 额外的参数

console.warn(message, ...args)

输出警告级别日志。

参数：

message (any): 警告消息

...args (any): 额外的参数

console.error(message, ...args)

输出错误级别日志。

参数：

message (any): 错误消息

...args (any): 额外的参数

console.debug(message, ...args)

输出调试级别日志。

参数：

message (any): 调试消息

...args (any): 额外的参数

console.print(format, ...args)

格式化打印,不换行。

参数：

format (string): 格式字符串

...args (any): 格式化参数

console.setLevel(level)

设置日志输出级别。

参数：

level (string): 日志级别 ('debug', 'info', 'warn', 'error')

console.getLevel()

获取当前日志级别。

返回值： string - 当前日志级别

console.mod(module)

设置模块标签。

参数：

module (string): 模块名称

console.fn(function)

设置函数标签。

参数：

function (string): 函数名称

console.proc(process)

设置处理过程标签。

参数：

process (string): 处理过程名称

console.badge(text)

添加自定义徽章。

参数：

text (string): 徽章文本

console.setJson(enabled)

设置是否使用JSON格式输出。

参数：

enabled (boolean): 是否启用JSON格式

console.input()

读取用户输入(阻塞)。

返回值： string - 用户输入的内容

console.inline(prompt)

显示提示并读取用户输入。

参数：

prompt (string): 提示文本

返回值： string - 用户输入

console.clear()

清空控制台屏幕。

console.format(value)

格式化值为字符串。

参数：

value (any): 要格式化的值

返回值： string - 格式化后的字符串

console.new()

创建新的控制台实例。

返回值： Console - 新的控制台对象

日志级别

日志按严重程度分为以下级别：

debug - 调试信息（最详细）

info - 一般信息

warn - 警告信息

error - 错误信息（最严重）

设置级别后,只显示该级别及更高级别的日志。

实际应用场景

应用程序日志系统

调试工具

交互式CLI工具

错误追踪

结构化日志

进度指示器

注意事项

性能影响：频繁的日志输出可能影响性能,生产环境应适当控制日志级别。

敏感信息：避免在日志中输出密码、密钥等敏感信息。

日志格式：JSON格式日志便于机器处理,但可读性较差。

输入阻塞：input()和 inline()会阻塞执行,注意使用场景。

清屏限制：clear()在某些终端环境可能不起作用。

最佳实践

统一日志格式：在项目中使用一致的日志格式和标签

合理分级：根据信息重要性选择合适的日志级别

上下文信息：使用mod/fn/proc提供清晰的日志上下文

错误详情：error日志应包含足够的上下文信息便于排查

开发vs生产：开发环境使用debug级别,生产环境使用info或warn

日志轮转：长期运行的应用应实现日志轮转机制

与Node.js console的对比

XScript的console模块提供了与Node.js相似但增强的功能：

功能	XScript	Node.js
log/info/warn/error	✅	✅
级别控制	✅	❌
模块标签	✅	❌
JSON格式	✅	❌
用户输入	✅	❌
清屏	✅	✅

console

Console 模块#

功能特性#

基本使用#

基本日志输出#

格式化输出#

日志级别设置#

模块化日志#

自定义徽章#

JSON格式输出#

用户输入#

清屏#

创建新的控制台实例#

API参考#

console.log(message, ...args)#

console.info(message, ...args)#

console.warn(message, ...args)#

console.error(message, ...args)#

console.debug(message, ...args)#

console.print(format, ...args)#

console.setLevel(level)#

console.getLevel()#

console.mod(module)#

console.fn(function)#

console.proc(process)#

console.badge(text)#

console.setJson(enabled)#

console.input()#

console.inline(prompt)#

console.clear()#

console.format(value)#

console.new()#

日志级别#

实际应用场景#

应用程序日志系统#

调试工具#

交互式CLI工具#

错误追踪#

结构化日志#

进度指示器#

注意事项#

最佳实践#

与Node.js console的对比#

调试技巧#

Console 模块

功能特性

基本使用

基本日志输出

格式化输出

日志级别设置

模块化日志

自定义徽章

JSON格式输出

用户输入

清屏

创建新的控制台实例

API参考

console.log(message, ...args)

console.info(message, ...args)

console.warn(message, ...args)

console.error(message, ...args)

console.debug(message, ...args)

console.print(format, ...args)

console.setLevel(level)

console.getLevel()

console.mod(module)

console.fn(function)

console.proc(process)

console.badge(text)

console.setJson(enabled)

console.input()

console.inline(prompt)

console.clear()

console.format(value)

console.new()

日志级别

实际应用场景

应用程序日志系统

调试工具

交互式CLI工具

错误追踪

结构化日志

进度指示器

注意事项

最佳实践

与Node.js console的对比

调试技巧