当前短讯!基于Go语言实现类似tree命令的小程序

时间:2022-10-30 09:27:51       来源:脚本之家

目录

需求目的需求分析

需求

写一个简版类似于unix tree命令的go语言小程序,如下参数仿照于tree命令的文档

该小程序支持的功能如下:

mtree命令默认打印以层级结构打印所有目录和文件,默认以字母排序,支持以下参数

mtree [-adfLopugshDtr]

列出相关参数

-d 仅列出目录

-L 指定需要打印目录结构的层数

-o filename 将结果输出到指定文件

文件相关参数

-f 打印每个文件基于当前位置的全路径

-p 打印每个文件的权限

-u 打印属主名称

-g 打印属组名称

-s 打印文件大小

-h 打印文件大小,以更加人化的方式,会带上单位,比如 K、M、G、T

-D 打印文件最后的修改时间

排序相关参数

-t 以最后修改时间排序输出

eg:

命令: ./main -u -g -p -D -s -o tmp.txt

tmp.txt文件内容如下

.

├── [-rwxr-xr-x root root 2138809 Oct 26 2022] main

├── [-rw-r--r-- root root 2009 Oct 25 2022] tmp.txt

└── [drwxr-xr-x root root 4096 Mar 14 2022] workspace

├── [drwxr-xr-x root root 4096 Mar 14 2022] cppProj

│ ├── [drwxr-xr-x root root 4096 Mar 14 2022] dockerExecDemo

│ ├── [-rw-r--r-- root root 398 Mar 14 2022] exec.cpp

│ └── [-rwxr-xr-x root root 16872 Mar 14 2022] set_ns

├── [drwxr-xr-x root root 4096 Mar 16 2022] k8s

│ ├── [drwxr-xr-x root root 4096 Mar 17 2022] _05

│ │ ├── [drwxr-xr-x root root 4096 Mar 16 2022] _15

│ │ │ ├── [-rw-r--r-- root root 10 Mar 16 2022] password.txt

│ │ │ ├── [-rw-r--r-- root root 405 Mar 16 2022] test_projected_volumn.yml

│ │ │ └── [-rw-r--r-- root root 7 Mar 16 2022] username.txt

│ │ ├── [drwxr-xr-x root root 4096 Mar 17 2022] _17

│ │ │ └── [-rw-r--r-- root root 340 Mar 16 2022] nginx-deployment.yaml

│ │ └── [drwxr-xr-x root root 4096 Mar 17 2022] _18

│ │ ├── [-rw-r--r-- root root 165 Mar 17 2022] srv.yml

│ │ └── [-rw-r--r-- root root 346 Mar 17 2022] statefulset.yaml

│ ├── [-rwxrwxrwx root root 313 Jan 26 2022] nginx.yaml

│ ├── [-rw-r--r-- root root 197 Mar 16 2022] nginx2.yml

│ └── [-rw-r--r-- root root 188 Jan 26 2022] nginx_service.yaml

└── [drwxr-xr-x root root 4096 Jan 28 2022] podDemo

└── [-rw-r--r-- root root 201 Jan 28 2022] nginx.yaml

目的

在个人mac电脑上,想在终端里面看看目录结构,奈何网络条件不好,tree命令没有安装成功,于是动手自己写一个tree命令的想法油然而生; 同时又可以熟悉go语言标准库,提高编码能力,本程序主要涉及go pkg有:flag、os、fs、path、filepath等

需求分析

针对上面的输出显示,可以把每一行的信息分为

文件路径,文件名称,文件的相对路径, eg:./workspace/k8s/_05/_15/password.txt文件属,权限,属主,属组,大小,时间 eg:[root root 10]前缀 eg:│ │ │ └──

代码思路:针对程序当前执行路径,遍历子目录节点,如果子节点同样是目录的话,则递归遍历;在递归遍历的过程中,获取每一个文件的相关属信息; 同时,对于程序指定的参数,可以分为属类参数和控制类参数

类参数有: -u -g -f -p -s -h控制类参数有: -L -o -d -D -t

对于属类的参数,定义不同的filter,在遍历的过程中,每一个文件节点,都经过过滤器过滤,用于填充对应的属信息; 对于控制类的参数,则贯穿于程序过程中,用于控制不同的行为

这里重点分析下如何输出前缀的这种层级关系的前缀,以下述目录结构进行举例说明:

目录结构

.

└── workspace

├── cppProj

│ └── dockerExecDemo

├── k8s

│ └── _05

│ ├── _15

│ ├── _17

│ └── _18

└── podDemo

众所周知,unix文件系统是树状结构;因此,这里首先就目录结构抽象成树结构,如下图,左上角是对应的目录结构,右边是抽象的树状结构:

图竖着看可能还不够清晰,把该树结构横过来,这样就可以很好的用该树结构和目录的层级关系进行一一类比了

下面重点分析下如何输出每一层目录的前缀,先看└──和├──是如何确定的,如上目录结构所示,_18节点属于目录_05的最后一个节点,因此_18节点前面为字符串└──; 一个目录中,除了最后一个节点前面的字符串为└──,其他节点前面的字符串都是├──,这里的前缀字符串很容易就可以总结得出; 但是对于节点dockerExecDemo前面的字符串│, 和_18节点前面的字符串│,该如何打印呢? 通过分析我们的树状结构可以总结得出,如果一个节点的父亲没有右兄弟,则添加前缀, 否则添加前缀│, 每一个节点都以这样的方式追随到根结点,就可以得出该节点的前缀关系;这里已_15节点来完整的举例说明:

_15节点属于第一个节点,因此首先添加前缀 "├──"; 前缀结果为: "├──"_15节点的父亲_05没有右兄弟,因此继续添加前缀 " "; 前缀结果为:" ├──"_05节点的父亲k8s有右兄弟,因此继续添加前缀 "│ "; 前缀结果为:"│ ├──"k8s节点的父亲workspace没有右兄弟,因此继续添加前缀 " "; 前缀结果为:" │ ├──"最终_15节点的整体前缀为 " │ ├── "

上面所述的树结构,go语言的定义如下:

type MFileNode struct {

Level int

ModTime time.Time

UserName string

Size int64

GroupName string

FileName string

IsDir bool

Children []*MFileNode

Parent *MFileNode

Left *MFileNode

Right *MFileNode

Prefix strings.Builder

Attr strings.Builder

Path strings.Builder

}

核心遍历目录树的代码如下,

// Walk 文件结构遍历目录树,构造MTree,同时每一文件节点,都经过参数过滤器进行格式化输出

func Walk(parentMFile *MFileNode, parent, base string, filters *MFilter) error {

if parentMFile.Level >= level {

return nil

}

dirEntries, err := os.ReadDir(filepath.Join(parent, base))

if err != nil {

return err

}

if len(dirEntries) == 0 {

return nil

}

parentMFile.Children = make([]*MFileNode, 0, len(dirEntries))

var pre *MFileNode = nil

for _, dir := range dirEntries {

if onlyDir && !dir.IsDir() {

continue

}

childMFile := &MFileNode{

Level: parentMFile.Level + 1,

Children: nil,

FileName: dir.Name(),

Parent: parentMFile,

Left: pre,

IsDir: dir.IsDir(),

}

// 维护左右兄弟节点关系

if pre != nil {

pre.Right = childMFile

}

pre = childMFile

info, err := dir.Info()

if err != nil {

return err

}

// 参数过滤器

filters.Exec(childMFile, info)

parentMFile.Children = append(parentMFile.Children, childMFile)

if dir.IsDir() {

err1 := Walk(childMFile, filepath.Join(parent, base), dir.Name(), filters)

if err1 != nil {

return err1

}

}

}

return nil

}

最终程序实现的输出和 unix tree命令输出对比如下图所示,几乎完整的实现了自己的目的:

关键词: 基于Go语言实现类似tree命令的小程序 小程序支持的功能 以字母排序 相关参数

频道推荐