#教你写一个 color 日志库,不止有代码还有原理。
##前言 在计算机里面, ansi 转义码是使用带内信号去控制格式化,颜色,或者其他的输出选项在视频流或者文本终端中的一种办法。编码这些格式化信息,就是在确定的字节序列中,把上述所说的 ansi 码嵌入到这个文本中。终端会去寻找命令去解释这些字符,而不是把它看作简单的字符码( ascii )。
1970 年提出的 ansi 码,但是直到 1980 年的早期才普及在了迷你主机和大型机房中。它被使用在早期的电子公告板上,对比之前缺乏光标移动的系统,它改善了显示的效果,这导致了它被广泛的使用。
尽管硬件文本终端,在 21 世纪已经日益稀少。但是不动摇 ansi 标准的影响。因为大部分的文本模拟器的解释工作,至少还有相当一部分的文本存在 ansi 转义序列。唯一的例外就是微软的 win32 console 。不过这些在微软升级到 window10 之后已经被解决了。
所以这个古老的协议对我们现在的文本输出依然是有很重要的影响。
###一条小命令
echo -e "\033[1;31mI ♡ You \e[0m"
output:
不上图我写什么文档,对吧。这条命令可以用来简单的告白用。送给大家了。从这里我们引出了 ansi 对文本颜色的输出影响,看,就是图中字符的颜色发生了变化。利用这样的性质我们今天就要分享一下如何写一个彩色的日子库( color log )
###CSI
转义序列使用 ESC 控制字符开始,对于 2 个字符序列,第二个字符是 ASCII 的 64 到 95 。(@到_,还有所有大写英文字母和[]^),然而,序列中大多数是超过 2 个字符的,并以 ESC 控制字符和左中括号开始。序列被称作 CSI ,即控制序列引导器或者控制序列启动器的简称。这个序列的最后一个字符是在 ASCII 范围 64 到 126 。也还有一个单字符的 CSI (155/0x9B/0233 ) ESC[,这两个字符序列比单个字符形式用的更多,细节参看 C0 和 C1 控制编码。(下文会添加文档的链接),使用 UTF-8 编码的终端上,两种形式都使用 2 字节( CSI in UTF-8 is 0xC2, 0x9B ),但 ESC[序列更加明了。
###文本颜色
文本颜色(和 SGR (Select Graphic Rendition)参数)使用 CSI n1 [;n2 [; ...]] m 序列来处理,如上所示,序列中每一个 n1, n2, ...就是一个 SGR 参数。因此,例如,你使用 30 ~ 37 表示前景色, 40 ~ 47 表示背景色。下图是一张颜色过渡图。
###开始编码
package util
import (
"fmt"
"time"
)
const (
color_red = uint8(iota + 91)
color_green
color_yellow
color_blue
color_magenta //洋红
info = "[INFO]"
trac = "[TRAC]"
erro = "[ERRO]"
warn = "[WARN]"
succ = "[SUCC]"
)
// see complete color rules in document in https://en.wikipedia.org/wiki/ANSI_escape_code#cite_note-ecma48-13
func Trace(format string, a ...interface{}) {
prefix := yellow(trac)
fmt.Println(formatLog(prefix), fmt.Sprintf(format, a...))
}
func Info(format string, a ...interface{}) {
prefix := blue(info)
fmt.Println(formatLog(prefix), fmt.Sprintf(format, a...))
}
func Success(format string, a ...interface{}) {
prefix := green(succ)
fmt.Println(formatLog(prefix), fmt.Sprintf(format, a...))
}
func Warning(format string, a ...interface{}) {
prefix := magenta(warn)
fmt.Println(formatLog(prefix), fmt.Sprintf(format, a...))
}
func Error(format string, a ...interface{}) {
prefix := red(erro)
fmt.Println(formatLog(prefix), fmt.Sprintf(format, a...))
}
func red(s string) string {
return fmt.Sprintf("\x1b[%dm%s\x1b[0m", color_red, s)
}
func green(s string) string {
return fmt.Sprintf("\x1b[%dm%s\x1b[0m", color_green, s)
}
func yellow(s string) string {
return fmt.Sprintf("\x1b[%dm%s\x1b[0m", color_yellow, s)
}
func blue(s string) string {
return fmt.Sprintf("\x1b[%dm%s\x1b[0m", color_blue, s)
}
func magenta(s string) string {
return fmt.Sprintf("\x1b[%dm%s\x1b[0m", color_magenta, s)
}
func formatLog(prefix string) string {
return time.Now().Format("2006/01/02 15:04:05") + " " + prefix + " "
}
上面就是一个完整的彩色 log 的代码
输出的效果:
##完整代码 完整的 colorlog 代码 测试代码 如果你需要在本地测试,请确保你搭建了正确的 go 开发环境,并且 down 下 https://github.com/liyu4/chill 这个项目。找到 util 单元
yourpath 指的是你的项目路径。
cd yourpath/chill/util
go test -v
##后记
在其中 \x1b[ 实现 CSI :
转换前景色为黑色,使用\x1b[30m
转换为红色,使用\x1b[31m
如果使用加粗参数,灰色写作\x1b[30;1m
获取红色加粗,使用\x1b[31;1m
重置颜色为缺省值,使用\x1b[39;49m (或者使用 \x1b[0m 重置所有属性)
\033[0m 重置为正常
\033[1m 设置高亮度或加粗
\033[4m 下划线
\033[5m 闪烁
\033[7m 反显
\033[8m 消隐
\033[30m -- /33[37m 设置前景色
\033[40m -- /33[47m 设置背景色
控制符 ESC 的常用表示方法\e 、\x1b(\x1B)、\033 都可以
\e 指代 Escape ,对应八进制\033 ,对应十六进制\x1b
###参考文档
这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。
V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。
V2EX is a community of developers, designers and creative people.