Golang命令行工具开发项目示例

P粉602998670

发布： 2025-10-08 20:48:03

原创

681人浏览过

开发命令行工具是Go语言的强项，结合其静态编译和跨平台特性。2. 示例项目filestat使用Go构建，具备统计目录文件数量、按扩展名分类、递归遍历及可选行数统计功能。3. 项目结构清晰，包含main.go、cmd/root.go、pkg/scanner/scanner.go和go.mod文件。4. 核心扫描逻辑在scanner.go中实现，利用filepath.WalkDir遍历文件系统，os.ReadFile读取内容并统计行数。5. 命令行接口基于Cobra库构建，支持参数解析、标志设置（如-l统计行数）和帮助文档生成。6. 主入口main.go调用cmd.Execute()启动程序。7. 使用go build编译后可执行filestat命令，支持路径参数和选项。8. 进阶建议包括添加子命令、输出格式化、配置文件支持、日志与测试等。9. 整体体现Go在CLI开发中的高效性与简洁性。

golang命令行工具开发项目示例

开发命令行工具是 Go 语言非常擅长的领域，得益于其静态编译、跨平台支持和简洁的标准库。下面通过一个简单的示例项目来展示如何用 Go 开发一个实用的命令行工具。

项目目标：构建一个文件统计工具

我们开发一个名为 filestat 的命令行工具，它可以：

统计指定目录下文件的数量
按文件类型（扩展名）分类统计
支持递归遍历子目录
显示总行数（可选）

项目结构

项目目录结构如下：

filestat/
├── main.go
├── cmd/
│   └── root.go
├── pkg/
│   └── scanner/
│       └── scanner.go
└── go.mod

登录后复制

初始化项目

在项目根目录执行：

立即学习“go语言免费学习笔记（深入）”；

go mod init filestat

这会生成 go.mod 文件，用于管理依赖。

核心功能实现（scanner.go）

在 pkg/scanner/scanner.go 中实现文件扫描逻辑：

package scanner

import ( "io/fs" "os" "path/filepath" "strings" )

type Stats struct { FileCount map[string]int LineCount int }

func Scan(path string, includeLines bool) (*Stats, error) { stats := &Stats{ FileCount: make(map[string]int), }

err := filepath.WalkDir(path, func(path string, d fs.DirEntry, err error) error {
    if err != nil {
        return err
    }
    if d.IsDir() {
        return nil
    }

    ext := strings.ToLower(filepath.Ext(d.Name()))
    if ext == "" {
        ext = "noext"
    }
    stats.FileCount[ext]++

    if includeLines {
        data, err := os.ReadFile(path)
        if err == nil {
            lines := len(strings.Split(string(data), "\n"))
            stats.LineCount += lines
        }
    }

    return nil
})

return stats, err

登录后复制

}

命令行接口（cmd/root.go）

定义主命令：

package cmd

import ( "fmt" "log"

"filestat/pkg/scanner"
"github.com/spf13/cobra"

登录后复制

)

天工SkyMusic

基于昆仑万维“天工3.0”打造的AI音乐生成工具，是目前国内唯一公开可用的AI音乐生成大模型

247

查看详情

var includeLines bool var targetPath string

var rootCmd = &cobra.Command{ Use: "filestat [path]", Short: "统计目录中的文件信息", Args: cobra.MaximumNArgs(1), Run: func(cmd *cobra.Command, args []string) { path := "." if len(args) > 0 { path = args[0] }

    stats, err := scanner.Scan(path, includeLines)
    if err != nil {
        log.Fatal(err)
    }

    fmt.Printf("文件统计结果（路径：%s）:\n", path)
    for ext, count := range stats.FileCount {
        fmt.Printf("%s: %d 个\n", ext, count)
    }
    if includeLines {
        fmt.Printf("总行数: %d\n", stats.LineCount)
    }
},

登录后复制

}

func Execute() { if err := rootCmd.Execute(); err != nil { log.Fatal(err) } }

func init() { rootCmd.Flags().BoolVarP(&includeLines, "lines", "l", false, "统计文件总行数") }