15分钟学Go 实战项目一：命令行工具

实战项目一：命令行工具

1. 引言

命令行工具是开发者常用的工具之一，它可以帮助用户通过命令行界面对程序进行控制和交互。在这节中，我们将创建一个简单的命令行工具，以帮助你理解Go语言的基本语法和如何处理命令行输入。在这个过程中，我们将使用Go的内置库，如flag，用以处理命令行参数。

2. 项目概述

我们将构建一个简单的命令行工具，该工具可以执行基本的数学运算，如加法、减法、乘法和除法。用户可以通过命令行输入操作数和运算类型，工具将打印出结果。

2.1 项目结构

我们的项目结构可以如下：

mathcli/
├── main.go

3. 创建项目

3.1 设置工作环境

在命令行中创建一个新的目录来存放我们的项目：

mkdir %GOPATH%\src\mathcli
cd %GOPATH%\src\mathcli

3.2 创建文件

在这个目录下，创建一个名为main.go的文件。

3.3 编写代码

在main.go文件中，输入以下代码：

package main

import (
    "flag"
    "fmt"
    "os"
)

func main() {
    // 定义命令行参数
    op := flag.String("op", "add", "Operation to perform: add, sub, mul, div")
    a := flag.Float64("a", 0, "First operand")
    b := flag.Float64("b", 0, "Second operand")

    // 解析命令行参数
    flag.Parse()

    // 执行运算
    var result float64
    switch *op {
    case "add":
        result = *a + *b
    case "sub":
        result = *a - *b
    case "mul":
        result = *a * *b
    case "div":
        if *b == 0 {
            fmt.Println("Error: Division by zero")
            os.Exit(1)
        }
        result = *a / *b
    default:
        fmt.Println("Unsupported operation:", *op)
        os.Exit(1)
    }

    // 打印结果
    fmt.Printf("Result: %.2f\n", result)
}

4. 代码解析

4.1 包声明

package main：每个Go程序都要声明包，main包是程序的入口。

4.2 导入必要的库

import (
    "flag"
    "fmt"
    "os"
)

flag：用于解析命令行参数。
fmt：用于格式化和输出文本。
os：用于处理操作系统功能，如退出程序。

4.3 定义命令行参数

op := flag.String("op", "add", "Operation to perform: add, sub, mul, div")
a := flag.Float64("a", 0, "First operand")
b := flag.Float64("b", 0, "Second operand")

flag.String、flag.Float64用于定义对应的命令行参数及其默认值。

4.4 解析命令行参数

flag.Parse()

用于解析从命令行输入的参数。

4.5 执行运算

switch *op {
case "add":
    result = *a + *b
case "sub":
    result = *a - *b
case "mul":
    result = *a * *b
case "div":
    if *b == 0 {
        fmt.Println("Error: Division by zero")
        os.Exit(1)
    }
    result = *a / *b
default:
    fmt.Println("Unsupported operation:", *op)
    os.Exit(1)
}

使用切换语句来选择不同的运算。
加入对除以零的异常处理。

4.6 输出结果

fmt.Printf("Result: %.2f\n", result)

格式化输出结果，保留两位小数。

5. 运行程序

5.1 使用命令行运行

打开命令提示符，并进入项目目录。
运行以下命令进行加法运算：

go run main.go -op=add -a=5 -b=3

运行乘法运算：

go run main.go -op=mul -a=4 -b=2

5.2 预期输出

加法运算输出：

Result: 8.00

乘法运算输出：

Result: 8.00

5.3 参数说明表

参数	类型	默认值	说明
`-op`	string	`add`	操作类型：`add`、`sub`、`mul`、`div`
`-a`	float64	`0`	第一个操作数
`-b`	float64	`0`	第二个操作数

6. 代码运行流程图

以下是mathcli程序的运行流程图：

+------------------+
|      程序启动      |
+------------------+
        |
        v
+------------------+
|  定义命令行参数    |
+------------------+
        |
        v
+------------------+
|   解析命令行参数   |
+------------------+
        |
        v
+------------------+
|   根据运算类型执行 |
|     相关运算      |
+------------------+
        |
        v
+------------------+
|   输出计算结果    |
+------------------+
        |
        v
+------------------+
|      程序结束      |
+------------------+

7. 扩展功能

在熟悉了基本的命令行工具后，可以考虑添加更多功能，例如：

7.1 支持更多运算

可以扩展支持指数运算、平方根等功能。

7.2 提供帮助信息

当用户输入-h时，输出命令行参数的说明：

flag.PrintDefaults()

7.3 记录计算历史

通过引入文件操作，记录每次运算的操作数、运算符和结果到一个日志文件中。

func logOperation(op string, a, b, result float64) {
    f, err := os.OpenFile("operations.log", os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
    if err != nil {
        fmt.Println("Error opening log file:", err)
        return
    }
    defer f.Close()
    logLine := fmt.Sprintf("%s: %.2f %s %.2f = %.2f\n", time.Now().Format(time.RFC3339), a, op, b, result)
    f.WriteString(logLine)
}