美文网首页
如何使用Go编程(环境准备)

如何使用Go编程(环境准备)

作者: 张云飞Vir | 来源:发表于2020-03-10 00:19 被阅读0次

    背景

    本章描述了如何配置本地环境,开始使用Go编程
    我的机器是 mac ,本文按此环境配置。

    本文结构

    1. 介绍 go 的工作空间的概念
    2. 配置 GOPATH 环境变量
    3. 介绍 包 的路径名
    4. 创建第一个程序和包的实践
    5. 测试框架

    工作空间

    go 工具为公共代码仓库中维护的开源代码而设计。 无论你会不会公布代码,该模型设置工作环境的方法都是相同的。

    Go代码必须放在工作空间内。它其实就是一个目录,其中包含三个子目录:

    src 目录包含Go的源文件,它们被组织成包(每个目录都对应一个包),
    pkg 目录包含包对象,
    bin 目录包含可执行命令。
    go 工具用于构建源码包,并将其生成的二进制文件安装到 pkg 和 bin 目录中。

    bin/
        hello                        # 可执行命令
    pkg/
      ...... 
    src/
    github.com/vir56k/hello
    

    配置 GOPATH 环境变量

    首先创建一个工作空间目录,并设置相应的 GOPATH。你的工作空间可以放在任何地方, 在此文档中我们使用$HOME/go 。(另一种常见的设置是 GOPATH=$HOME。)

      $ mkdir $HOME/work
      $ export GOPATH=$HOME/work
    

    作为约定,请将此工作空间的 bin 子目录添加到你的 PATH 中:

    $ export PATH=$PATH:$GOPATH/bin
    

    注意 mac 下 HOME 即是你账户的根目录。像我的机器,我把 工作空间放置个人名称的路径下HOME/go ,其实就是 /Users/zhangyunfei/go。

    修改环境变量文件: .bash_profile ,命令行为: vi ~/.bash_profile
    在文件尾部添加

    export GOPATH=$HOME/go
    export PATH=$PATH:$GOPATH/bin
    

    包路径

    标准库中的包有给定的短路径,比如 "fmt""net/http"。 对于你自己的包,你必须选择一个基本路径,来保证它不会与将来添加到标准库, 或其它扩展库中的包相冲突。

    如果你将你的代码放到了某处的源码库,那就应当使用该源码库的根目录作为你的基本路径。 例如,若你在 GitHub 上有账户 github.com/user 那么它就应该是你的基本路径。

    比如:我把自己的包放到 src 下的 github.com/vir56k 目录下,这个名字使得具有唯一性,它类似 java 中的 包的概念。

    你的第一个程序

    在 src/github.com/user/hello 目录下 创建名为 hello.go 的文件,其内容为以下Go代码:

    package main
    
    import "fmt"
    
    func main() {
        fmt.Printf("Hello, world.\n")
    }
    

    现在你可以用 go 工具构建并安装此程序了:

    $ cd src/github.com/user/hello
    $ go install
    

    现在,你可以在命令行下输入它的完整路径来运行它了:

    $ hello
    Hello, world.
    

    刚刚我们创建了一个程序,其实就是 带有 main 函数的 go 文件,下面我们创建个 包(package)

    你的第一个库

    让我们编写一个库,并让 hello 程序来使用它。

    同样,第一步还是选择包路径

    $ mkdir src/github.com/user/stringutil
    

    创建名为 reverse.go 的文件,内容如下:

        // stringutil 包含有用于处理字符串的工具函数。
    package stringutil
    
    // Reverse 将其实参字符串以符文为单位左右反转。
    func Reverse(s string) string {
        r := []rune(s)
        for i, j := 0, len(r)-1; i < len(r)/2; i, j = i+1, j-1 {
            r[i], r[j] = r[j], r[i]
        }
        return string(r)
      }
    

    编译它 ,在命令行输入:

    $ go build
    

    即可。这不会产生输出文件。想要输出的话,必须使用 go install 命令,它会将包的对象放到工作空间的 pkg 目录中。

    确认 stringutil 包构建完毕后,修改原来的 hello.go 文件(它位于 $GOPATH/src/github.com/user/hello)去使用它:

    package main
    
    import (
    "fmt"
    
    "github.com/user/stringutil"
    )
    
    func main() {
        fmt.Printf(stringutil.Reverse("!oG ,olleH"))
      }
    

    无论是安装包还是二进制文件,go 工具都会安装它所依赖的任何东西。 因此当我们通过

      $ go install github.com/user/hello
    

    来安装 hello 程序时,stringutil 包也会被自动安装。

    运行此程序的新版本,你应该能看到一条新的,反向的信息:

    $ hello
    Hello, Go!
    

    完成上面后,你的目录应该是这样的:

    bin/
        hello                        # 可执行命令
    pkg/
      ...... 
    src/
        github.com/vir56k/hello/hello.go
        github.com/vir56k/stringutil/reverse.go
    

    包名

    Go源文件中的第一个语句必须是

    package 名称
    

    这里的 名称 即为导入该包时使用的默认名称。 (一个包中的所有文件都必须使用相同的 名称。)

    Go的约定是包名为导入路径的最后一个元素:作为 “crypto/rot13” 导入的包应命名为 rot13。

    可执行命令必须使用 package main。

    链接成单个二进制文件的所有包,其包名无需是唯一的,只有导入路径(它们的完整文件名) 才是唯一的。

    测试

    Go拥有一个轻量级的测试框架,它由 go test 命令和 testing 包构成。

    你可以通过创建一个名字以 _test.go 结尾的,包含名为 TestXXX 且签名为 func (t *testing.T) 函数的文件来编写测试。 测试框架会运行每一个这样的函数;若该函数调用了像 t.Error 或 t.Fail 这样表示失败的函数,此测试即表示失败。

    我们可通过创建文件

    $GOPATH/src/github.com/user/stringutil/reverse_test.go 来为 
    

    stringutil 添加测试,其内容如下:

      package stringutil
    
    import "testing"
    
    func TestReverse(t *testing.T) {
    cases := []struct {
        in, want string
    }{
        {"Hello, world", "dlrow ,olleH"},
        {"Hello, 世界", "界世 ,olleH"},
        {"", ""},
    }
    for _, c := range cases {
        got := Reverse(c.in)
        if got != c.want {
            t.Errorf("Reverse(%q) == %q, want %q", c.in, got, c.want)
          }
        }
    }
    

    接着使用 go test 运行该测试:

    $ go test
    ok      github.com/user/stringutil 0.165s
    

    END

    相关文章

      网友评论

          本文标题:如何使用Go编程(环境准备)

          本文链接:https://www.haomeiwen.com/subject/gauvdhtx.html