最终效果
1. 自定义表格样式
2. 自定义主题颜色
- 支持三系普通颜色
- 支持16色彩虹色
- 支持单颜色
回顾一下shell语法
1. shell传递参数
我们可以在执行shell
脚本时实时传递参数从而指定某些具体的参数(在本例中包括表格的样式、颜色等),脚本中获取参数的格式为$n
。其中除n
为0
表示执行的文件名外,1
表示第一个参数,2
表示第二个参数,以此类推。
- 每一模式必须以右括号结束
- 匹配到取值符合某一模式后,执行模式所有命令直到
;;
- 一旦模式匹配则不会执行其他模式
- 如果无一模式匹配,可以使用
*
捕获该值
case 值 in
模式1)
command1
command2
...
commandN
;;
模式2)
command1
command2
...
commandN
;;
esac
在实例中,我们通过第一个参数指定style
的值来选择不同的表格形式(具体的表格形式由制表符向量tbs
实现)。另外当第一个参数以-h
或者--h
开头时,我们可以输出help
信息:
style="$1"
case $style in
# 根据第一个参数为-0或-1或-2来实现不同的表格样式, 即给tbs赋不同的值
-0) tbs=" ";;
-1) tbs="└┴┘├┼┤┌┬┐ ───│││";;
-2) tbs="└─┘│┼│┌─┐ ───│││";;
# 如果第一个参数以%开头, 意味着我们可以外部指定tbs的值
# 把style变量开头的%去掉赋值给tbs
"%"*) tbs="${style/"%"/}";;
-h*|--h*)
echo \'
\t [ --- HELP --- ]
\t command : draw_table.sh [style] [colors] < <file >
\t pipo : echo -e A\\tB\\na\\tb | draw_table.sh [style] [colors]
\t [style] : input 16 characters
\t 1~9 is Num. keypad as table,10 is not used
\t 11~13 are left,middle,right in a row
\t 14~16 are left,middle,right in a column
\t
\t [colors]: input a list,like "-3,-4,-8" sames "-green,-yellow,-white"
\t It set color,table cross ,font ,middle. Or \\033[xxm .
\t And support custom color set every characters of sytle
\t Like "\\033[30m,-red,-yellow,,,,,,,,,,,,," sum 16.
\'
exit
;;
esac
# ${var:-DEFAULT}: 如果var没有被声明, 或者其值为空, 那么就以$DEFAULT作为其值
tbs="${tbs:-"+++++++++,---|||"}"
2. awk命令
awk
命令:依次对每一行进行处理,但是相比于sed
更擅长取列,个人感觉是类SQL
的文本搜索工具。
awk
的基本形式如下:
awk [-F|-f|-v] \'BEGIN{ 命令 } pattern{ 命令 } END{ 命令 }\' file
参数:
-F: 指定分隔符
-f: 调用脚本
-v: 使用var=value的格式定义变量
特殊变量:
NF: 字段数量
NR: 当前处理的行数
FILENAME: 当前文件名
三个语句块:
BEGIN{ 命令 }: 执行前的命令
pattern{ 命令 }: 处理每一行执行的命令
END{ 命令 }: 执行完所有行后的命令
3. 自定义输出颜色
格式如下:
echo -e "\033[字背景颜色;字体颜色m字符串\033[0m"
# 颜色调用始末是固定的:
\033[ ; m …… \033[0m
# 实例:
echo -e "\033[41;36m someword \033[0m"
设计思路
1. 计算和绘制表格相关的全局变量
cols_len[NF]
:存储了每一列的最大长度, 每列最大长度等于该列最长的元素的长度rows[NR][NF]
:将文件的每行每列的数据记录到rows
二维数组中rows[NR][0]
:rows
第0
列存储前一行和后一行的列数, 用于确定当行的表格样式colors[16]
:存储每个制表符对应的着色方案tbs[16]
:存储已经着色的制表符,其中制表符样式类似于╚ ╩ ╝ ╠ ╬ ╣ ╔ ╦ ╗ , ═ ═ ═ ║ ║ ║
,前1~9
个为表格骨架的样式,第10
表示着表格元素空格的填充,11~13
分别表示上边框、中间和下边框的连接符,第14~16
表示左边框、中间和右边框的连接符
2. 生成表格样式
由于涉及到单列,因此需要考虑到单列的情况生成如下一些表格样式变量:
# ------------------------------------------预存所有的表格线, 减少不必要的重复计算------------------------------------------
title_top = line_val("title_top")
title_mid = line_val("title_mid")
title_btm_mid = line_val("title_btm_mid")
title_top_mid = line_val("title_top_mid")
title_btm = line_val("title_btm")
top = line_val("top")
mid = line_val("mid")
btm = line_val("btm")
print "title_top: "title_top"\n"
pring "title_mid: "title_mid"\n"
print "title_btm_mid:"title_btm_mid"\n"
print "title_top_mid:"title_top_mid"\n"
print "title_btm: "title_btm"\n"
print "top: "top"\n"
print "mid: "mid"\n"
print "btm: "btm"\n"
注意事项
Mac
和Linux
很多命令参数不同是因为Mac
自带的是BSD
系的命令,而Linux
用的是GNU
系的命令。可以在Mac
中使用带g
前缀的命令解决这一问题。
在Linux
下直接使用awk
命令即可,在MAC
下需要下载gawk
命令,否则awk
命令会一直报错。
# 安装GNU工具链
brew install coreutils
brew install gawk
运行方法
# 管道方法
$ echo -e "A\tB\na\tb" | sh draw_table.sh
+---+---+
|,A,|,B,|
+---+---+
|,a,|,b,|
+---+---+
# 文件方法
$ echo -e "Your Topic\nA\tB\tC\td\na\tb\th\ts\td\n5\n78\t34" > list.txt
# 第一个参数控制表格形式
$ sh draw_table.sh < list.txt
+---------------------+
|,,,,,Your Topic,,,, ,|
+----+----+---+---+---+
|,A,,|,B,,|,C,|,d,|,,,|
+----+----+---+---+---+
|,a,,|,b,,|,h,|,s,|,d,|
+----+----+---+---+---+
|,,,,,,,,,,5,,,,,,,,,,|
+----+----+---+---+---+
|,78,|,34,|,,,|,,,|,,,|
+----+----+---+---+---+
# 自定义模式
# 自定义表格边框:需要用"%"开头,前9位表示表格边框,第10位没有用处,第11-13 表示行的上、中、下分隔符,第14-16表示列的左、中、右分隔符
# 自定义颜色:第一个参数表示表格框架的颜色,第二个参数表示表格内容的颜色,第三个参数表示其他颜色
# 最后可以传入16个颜色参数,表示style中每个字符的颜色
$ sh draw_table.sh \'%123456789 abcABC\' -red,-blue,-green < list.txt
7aaaaaaaaaaaaaaaaaaaaa9
A Your Topic C
4bbbb8bbbb8bbb8bbb8bbb6
A A B B B C B d B C
4bbbb5bbbb5bbb5bbb5bbb6
A a B b B h B s B d C
4bbbb2bbbb2bbb2bbb2bbb6
A 5 C
4bbbb8bbbb8bbb8bbb8bbb6
A 78 B 34 B B B C
1cccc2cccc2ccc2ccc2ccc3
代码
#!/bin/bash
#############################################################################
# 作者:banemon
# 邮箱:banemon@
# 修改: tomocat
# Git: https://gitee.com/banemon/linux_sh_script
# 使用说明: https://zhuanlan.zhihu.com/p/144802861
# 命令:sh draw_table.sh < file.txt 或 echo -e "A\tB\na\tb" | sh draw_table.sh
# 帮助:draw_table.sh --help
#############################################################################
# 表格样式style
style="$1"
case ${style} in
# tbs包含16个符号, 每个符号表示的含义如下:
# 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
# 1 2 3 4 5 6 7 8 9 txt_empt top_row mid_row btm_row left_col mid_col right_col
-0) tbs=" ";;
-1) tbs="└┴┘├┼┤┌┬┐ ───│││";;
-2) tbs="└─┘│┼│┌─┐ ───│││";;
-3) tbs="╚╩╝╠╬╣╔╦╗ ═══║║║";;
-4) tbs="╚═╝║╬║╔═╗ ═══║║║";;
-5) tbs="╙╨╜╟╫╢╓╥╖ ───║║║";;
-6) tbs="╘╧╛╞╪╡╒╤╕ ═══│││";;
-7) tbs="└┴┘├┼┤┌┬┐ ─ ─│ │";;
-8) tbs="└─┘│┼│┌─┐ ─ ─│ │";;
-9) tbs="╚╩╝╠╬╣╔╦╗ ═ ═║ ║";;
-10) tbs="╚═╝║╬║╔═╗ ═ ═║ ║";;
-11) tbs="╙╨╜╟╫╢╓╥╖ ─ ─║ ║";;
-12) tbs="╘╧╛╞╪╡╒╤╕ ═ ═│ │";;
-13) tbs="╘╧╛╞╪╡╒╤╕ ═ ═│ │";;
-14) tbs="╚╩╝╠╬╣╔╦╗ ───│││";;
-15) tbs="+++++++++ ---|||";;
# 自定义表格边框:需要用"%"开头,前9位表示表格边框,第10位表示填充字符,第11-13 表示行的上、中、下分隔符,第14-16表示列的左、中、右分隔符
# ${string/substring/replacement}: 使用$replacement, 来代替第一个匹配的$substring, 这里是去掉开头的%, 另外由于%是特殊字符需要加上双引号(或者反斜杠)
"%"*) tbs="${style/"%"/}";;
# 等价于: \%*) tbs="${style/\%/}";;
-h*|--h*)
# -e 参数激活转移字符, 比如\t表示制表符
echo -e \'
\t [ --- HELP --- ]
\t command : sh draw_table.sh [style] [colors] < <file>
\t pipo : echo -e A\\tB\\na\\tb | draw_table.sh [style] [colors]
\t [style] : input 16 characters
\t 1~9 is Num. keypad as table,10 is not used
\t 11~13 are up,middle,down in a row
\t 14~16 are left,middle,right in a column
\t
\t -0 :
\t -1 :└┴┘├┼┤┌┬┐ ───│││ -9 :╚╩╝╠╬╣╔╦╗ ═ ═║ ║
\t -2 :└─┘│┼│┌─┐ ───│││ -10 :╚═╝║╬║╔═╗ ═ ═║ ║
\t -3 :╚╩╝╠╬╣╔╦╗ ═══║║║ -11 :╙╨╜╟╫╢╓╥╖ ─ ─║ ║
\t -4 :╚═╝║╬║╔═╗ ═══║║║ -12 :╘╧╛╞╪╡╒╤╕ ═ ═│ │
\t -5 :╙╨╜╟╫╢╓╥╖ ───║║║ -13 :╘╧╛╞╪╡╒╤╕ ═ ═│ │
\t -6 :╘╧╛╞╪╡╒╤╕ ═══│││ -14 :╚╩╝╠╬╣╔╦╗ ───│││
\t -7 :└┴┘├┼┤┌┬┐ ─ ─│ │ -15 :+++++++++ ---|||
\t -8 :└─┘│┼│┌─┐ ─ ─│ │
\t
\t [colors]: input a list,like "-3,-4,-8" sames "-green,-yellow,-white"
\t It set color,table cross ,font ,middle. Or \\033[xxm .
\t And support custom color set every characters of sytle
\t Like "\\033[30m,-red,-yellow,,,,,,,,,,,,," sum 16.
\t
\t -1|-black -5|-blue
\t -2|-red -6|-purple
\t -3|-green -7|-cyan
\t -4|-yellow -8|-white
\'
exit
;;
esac
# 当没有参数时, 设定tbs的默认值
tbs="${tbs:-"+++++++++,---|||"}"
# 颜色
color="$2"
case $color in
# 1~3可用于设置自己喜欢的自定义样式, 设置${color}的值即可
1) ;;
2) ;;
3) ;;
"-"*|"\033"*)
# 3位数标,词
colors="$color"
;;
"%"*) :
# %号开头的全自定义
colors="${color/"%"/}"
;;
esac
colors="${colors:-"-4,-8,-4"}"
# 主体函数
gawk -F \'\t\' \
-v table_s="${tbs}" \
-v color_s="${colors}" \
\'BEGIN{
}{
# ------------------------------------------遍历每行记录全局变量------------------------------------------
# cols_len[NF]: 存储了每一列的最大长度, 每列最大长度等于该列最长的元素的长度
# rows[NR][NF]: 将文件的每行每列的数据记录到rows二维数组中
# rows[NR][0]: 第0列存储前一行和后一行的列数, 用于确定当行的表格样式
# max_single_col_length: 单列行的最大长度
# ps: 由于单列是直接合并整行的单元格, 为图表美观(防止cols_len[1]因为某些特长的单列而增长), 单独记录单列的最大长度
# 计算单列行的最大长度
if (NF == 1) {
max_single_col_length = max_single_col_length < super_length($1) ? super_length($1) : max_single_col_length
rows[NR][1] = $1
} else { # 非单列行更新每一列的最大长度
for(i=1; i<=NF; i++){
cols_len[i]=cols_len[i] < super_length($i) ? super_length($i) : cols_len[i]
rows[NR][i]=$i
}
}
# 前后行状态
if (NR == 1) {PrevNF=0}
# 每行第0列存储前一行和当前行的列数, 用于确定当行的表格样式
rows[NR][0] = PrevNF "," NF
PrevNF=NF
}END{
# ------------------------------------------colors变量着色, 生成colors和tbs变量------------------------------------------
# 构建颜色向量: colors, 长度为16
color_sum = split(color_s,clr_id,",")
if (color_sum == 3){ # 简易自定义模式: 传入三种颜色
for (i=1; i<=3; i++) {
if (color_s ~ "-") {
clr_id[i] = color_var(clr_id[i])
}
}
# 组建色表: 三种颜色构造colors向量
for (i=1; i<=16; i++) {
if (i < 10) {
colors[i] = clr_id[1]
} else if (i == 10){
colors[i] = clr_id[2]
} else if (i > 10){
colors[i] = clr_id[3]
}
}
} else if (color_sum == 16){ # 全自定义模式: 传入16种颜色
for (i=1; i<=16; i++){
if(color_s ~ "-"){
clr_id[i] = color_var(clr_id[i])
}
colors[i] = clr_id[i]
}
}
# 设置颜色变量
clr_end = "\033[0m" # shell着色的尾部标识
clr_font = colors[10] # 第10位制表符的颜色, 也就是单元格内填充字符的颜色
# 构建已着色的制表符向量: tbs, 长度16
for (i=1; i<=length(table_s); i++){
if(colors[i]=="")
tbs[i] = substr(table_s, i, 1) # 获取第i个制表符
else
tbs[i] = colors[i] substr(table_s,i,1) clr_end # 给制表符着色, 例如红色 `\033[31m制表符\033[0m`
fi
}
# ------------------------------------------如果单列长度大于非单列最大行长度则调整各列长度------------------------------------------
max_line_len = 0 # 统计非单列的最大行长度
for (i=1; i<=length(cols_len); i++) {
max_line_len = max_line_len + cols_len[i] + 2 # 每列需要包含2个空格, 防止内容和制表符紧挨着
}
max_line_len = max_line_len + length(cols_len) - 1 # 多列的行最大总长度需要包含每列之间的制表符个数(列数 -1)
# 如果单列最大总长度大于多列的行最大总长度时, 需要把超出的部分平均分给每列, 保证图表美观
diff_length = max_single_col_length + 2 - max_line_len
if (diff_length > 0) {
for(j=1; j<=diff_length; j++){
i = (j - 1) % length(cols_len) + 1
cols_len[i] = cols_len[i] + 1
}
# 由于增加了每列长度, 故需要调整单列最大行长度
# max_line_len = max_single_col_length + 2
} else { # 如果单列最大总长度小于行的最大总长度, 那么单列长度要和最大行总长度保持一致
max_single_col_length = max_line_len - 2
}
# ------------------------------------------预存所有的表格线, 减少不必要的重复计算------------------------------------------
title_top = line_val("title_top")
title_mid = line_val("title_mid")
title_btm_mid = line_val("title_btm_mid")
title_top_mid = line_val("title_top_mid")
title_btm = line_val("title_btm")
top = line_val("top")
mid = line_val("mid")
btm = line_val("btm")
# debug
# print "title_top: " title_top "\n"
# pring "title_mid: " title_mid "\n"
# print "title_btm_mid:" title_btm_mid "\n"
# print "title_top_mid:" title_top_mid" \n"
# print "title_btm: " title_btm" \n"
# print "top: " top" \n"
# print "mid: " mid" \n"
# print "btm: " btm" \n"
# ------------------------------------------绘制表格------------------------------------------
row_num = length(rows)
for(i=1; i<=row_num; i++){
# 解析出前一行和当前行的列数
split(rows[i][0], col_num_list, ",")
prev_col_num = int(col_num_list[1])
curr_col_num = int(col_num_list[2])
# 绘制首行
if (i==1 && prev_col_num == 0) {
if (curr_col_num <= 1) {
# 单列
print title_top
print line_val("title_txt", rows[i][1], max_single_col_length)
} else if (curr_col_num >= 2) {
# 多列
print top
print line_val("txt", rows[i])
}
} else if (prev_col_num <=1 ) {
# 前一行为单列时
if (curr_col_num <=1 ) {
# 单列
print title_mid
print line_val("title_txt", rows[i][1], max_single_col_length)
} else if (curr_col_num >= 2) {
# 多列
print title_btm_mid
print line_val("txt", rows[i])
}
}else if (prev_col_num >= 2) {
# 前一行为多列时
if (curr_col_num <= 1) {
# 单列
print title_top_mid
print line_val("title_txt", rows[i][1], max_single_col_length)
} else if (curr_col_num >= 2) {
# 多列
print mid
print line_val("txt", rows[i])
}
}
# 表格底边
if (i == row_num && curr_col_num <= 1) {
# 尾行单列时
print title_btm
} else if (i == row_num && curr_col_num >= 2){
# 尾行多列时
print btm
}
}
}
# 返回字符串的长度, 支持中文等双字节字符
# eg: 内置函数length("中文")返回2, super_length("中文")返回4
function super_length(txt){
leng_base = length(txt);
leng_plus = gsub(/[^\x00-\xff]/, "x", txt) # 返回Ascii码大于255的字符匹配个数
return leng_base + leng_plus
}
# color_var函数: 解析形如"-n"开头的颜色配置
function color_var(color){
if(color=="-1" ||color=="-black"){
n=30
}else if(color=="-2" || color=="-red"){
n=31
}else if(color=="-3" || color=="-green"){
n=32
}else if(color=="-4" || color=="-yellow"){
n=33
}else if(color=="-5" || color=="-blue"){
n=34
}else if(color=="-6" || color=="-purple"){
n=35
}else if(color=="-7" || color=="-cyan"){
n=36
}else if(color=="-8" || color=="-white"){
n=37
}else if(color=="-0" || color=="-reset"){
n=0
}else{
n=0
}
return "\033[" n "m"
}
# ------------------------------------------生成绘制内容的函数------------------------------------------
# 参数: part绘制的位置; txt绘制的文本内容; cell_lens绘制的单元格长度
# eg: tbs为已着色的制表符 ╚ ╩ ╝ ╠ ╬ ╣ ╔ ╦ ╗ , ═ ═ ═ ║ ║ ║
# TODO: cell_len, line, i这三个参数的意义何在, awk的特殊用法?
function line_val(part, txt, cell_lens, cell_len, line, i) {
# 更新本次行标
if (part=="top") {
tbs_l=tbs[7]
tbs_m=tbs[8]
tbs_r=tbs[9]
tbs_b=tbs[11]
} else if (part=="mid") {
tbs_l=tbs[4]
tbs_m=tbs[5]
tbs_r=tbs[6]
tbs_b=tbs[12]
} else if (part=="txt") { # tbs[10]为填充字符, 用于填充单元格内的空格
tbs_l=tbs[14] tbs[10]
tbs_m=tbs[10] tbs[15] tbs[10]
tbs_r=tbs[10] tbs[16]
tbs_b=tbs[10]
} else if (part=="btm"){
tbs_l=tbs[1]
tbs_m=tbs[2]
tbs_r=tbs[3]
tbs_b=tbs[13]
} else if (part=="title_top"){
tbs_l=tbs[7]
tbs_m=tbs[11]
tbs_r=tbs[9]
tbs_b=tbs[11]
} else if (part=="title_top_mid"){
tbs_l=tbs[4]
tbs_m=tbs[2]
tbs_r=tbs[6]
tbs_b=tbs[12]
} else if (part=="title_mid"){
tbs_l=tbs[4]
tbs_m=tbs[12]
tbs_r=tbs[6]
tbs_b=tbs[12]
} else if (part=="title_txt"){
tbs_l=tbs[14] tbs[10]
tbs_m=tbs[10] tbs[15] tbs[10]
tbs_r=tbs[10] tbs[16]
tbs_b=tbs[10]
} else if (part=="title_btm"){
tbs_l=tbs[1]
tbs_m=tbs[13]
tbs_r=tbs[3]
tbs_b=tbs[13]
} else if (part=="title_btm_mid"){
tbs_l=tbs[4]
tbs_m=tbs[8]
tbs_r=tbs[6]
tbs_b=tbs[12]
}
# title行只有一列文本
if (part == "title_txt") {
cols_count=1
} else {
cols_count = length(cols_len)
}
# 遍历该行所有列, 构造改行的内容
line_content = ""
# 对于一行内的每一个单元格, 计算单元格文本cell_txt 和 对应的空白字符填充数fill_len
for (i=1; i<=cols_count; i++) {
if (part == "txt") {
# 多列左对齐
cell_txt = txt[i]
fill_len = cols_len[i] - super_length(cell_txt)
}else if(part=="title_txt"){
# 单列居中
cell_txt = txt
fill_len = (cell_lens - super_length(cell_txt)) / 2
is_need_fix = (cell_lens - super_length(cell_txt)) % 2 # 如果填充字符长度非偶数则需要fix
} else {
cell_txt = ""
fill_len = cols_len[i] + 2
}
# 单元格文本着色
cell_txt = clr_font cell_txt clr_end
# 单元格内空白补全
if (part == "title_txt") {
# 单列居中, 在单元格文本两侧补全空格字符
for (cell_len=1; cell_len <= fill_len; cell_len++) {
cell_txt = tbs_b cell_txt tbs_b
}
# 单列非偶长度补全
if (is_need_fix == 1) {
cell_txt = cell_txt " "
}
}else{
# 多列左对齐
for (cell_len=1; cell_len<=fill_len; cell_len++) {
cell_txt = cell_txt tbs_b
}
}
# 首格
if (i == 1) {
line_content = line_content cell_txt
} else {
# 中格
line_content = line_content tbs_m cell_txt
}
# 尾格
if ( i == cols_count ) {
line_content = line_content tbs_r
}
}
# 返回行: tbs_l表示最左侧的表格样式, line_content表示该行的内容
return tbs_l line_content
}
\'
使用实例
实际中经常碰到日志采集分析的问题,可以在shell
脚本加入如下的语句用于可视化输出表格数据:
echo -e "Module Log Analyse
Function Name\tCount
Function1\t20
Function2\t1113
Function3\t257
Function4\t113" | sh draw_table.sh -4 -red,-white,-blue
Reference
[1] https://www.runoob.com/linux/linux-shell-process-control.html
[2] https://www.cnblogs.com/gaochsh/p/6901809.html
[3] https://www.cnblogs.com/nb-blog/p/5780424.html
[4] https://www.cnblogs.com/knowlegefield/p/7774693.html