GOPATH 与工作空间

GOPATH 与工作空间

前面我们在安装 Go 的时候看到需要设置 GOPATH 变量,Go 从 1.1 版本到 1.7 必须设置这个变量,而且不能和 Go 的安装目录一样,这个目录用来存放 Go 源码,Go 的可运行文件,以及相应的编译之后的包文件。所以这个目录下面有三个子目录:src、bin、pkg

从 go 1.8 开始,GOPATH 环境变量现在有一个默认值,如果它没有被设置。 它在 Unix 上默认为 $HOME/go, 在 Windows 上默认为 %USERPROFILE%/go。

GOPATH 设置

go 命令依赖一个重要的环境变量:$GOPATH

Windows 系统中环境变量的形式为%GOPATH%,本书主要使用 Unix 形式,Windows 用户请自行替换。

(注:这个不是 Go 安装目录。下面以笔者的工作目录为示例,如果你想不一样请把 GOPATH 替换成你的工作目录。)

在类 Unix 环境下大概这样设置:

export GOPATH=/home/apple/mygo

为了方便,应该新建以上文件夹,并且上一行加入到 .bashrc 或者 .zshrc 或者自己的 sh 的配置文件中。

Windows 设置如下,新建一个环境变量名称叫做 GOPATH:

GOPATH=c:\mygo

GOPATH 允许多个目录,当有多个目录时,请注意分隔符,多个目录的时候 Windows 是分号,Linux 系统是冒号,当有多个 GOPATH 时,默认会将 go get 的内容放在第一个目录下。

以上 $GOPATH 目录约定有三个子目录:

  • src 存放源代码(比如:.go .c .h .s 等)
  • pkg 编译后生成的文件(比如:.a)
  • bin 编译后生成的可执行文件(为了方便,可以把此目录加入到 $PATH 变量中,如果有多个 gopath,那么使用${GOPATH//://bin:}/bin添加所有的 bin 目录)

以后我所有的例子都是以 mygo 作为我的 gopath 目录

代码目录结构规划

GOPATH 下的 src 目录就是接下来开发程序的主要目录,所有的源码都是放在这个目录下面,那么一般我们的做法就是一个目录一个项目,例如: $GOPATH/src/mymath 表示 mymath 这个应用包或者可执行应用,这个根据 package 是 main 还是其他来决定,main 的话就是可执行应用,其他的话就是应用包,这个会在后续详细介绍 package。

所以当新建应用或者一个代码包时都是在 src 目录下新建一个文件夹,文件夹名称一般是代码包名称,当然也允许多级目录,例如在 src 下面新建了目录 $GOPATH/src/github.com/astaxie/beedb 那么这个包路径就是 "github.com/astaxie/beedb",包名称是最后一个目录 beedb

下面我就以 mymath 为例来讲述如何编写应用包,执行如下代码

cd $GOPATH/src
mkdir mymath

新建文件 sqrt.go,内容如下

// $GOPATH/src/mymath/sqrt.go源码如下:
package mymath

func Sqrt(x float64) float64 {
    z := 0.0
    for i := 0; i < 1000; i++ {
        z -= (z*z - x) / (2 * x)
    }
    return z
}

这样我的应用包目录和代码已经新建完毕,注意:一般建议 package 的名称和目录名保持一致

编译应用

上面我们已经建立了自己的应用包,如何进行编译安装呢?有两种方式可以进行安装

1、只要进入对应的应用包目录,然后执行go install,就可以安装了

2、在任意的目录执行如下代码go install mymath

安装完之后,我们可以进入如下目录

cd $GOPATH/pkg/${GOOS}_${GOARCH}
//可以看到如下文件
mymath.a

这个. a 文件是应用包,那么我们如何进行调用呢?

接下来我们新建一个应用程序来调用这个应用包

新建应用包 mathapp

cd $GOPATH/src
mkdir mathapp
cd mathapp
vim main.go

$GOPATH/src/mathapp/main.go源码:

package main

import (
    "mymath"
    "fmt"
)

func main() {
    fmt.Printf("Hello, world.  Sqrt(2) = %v\n", mymath.Sqrt(2))
}

可以看到这个的 package 是main,import 里面调用的包是mymath, 这个就是相对于$GOPATH/src的路径,如果是多级目录,就在 import 里面引入多级目录,如果你有多个 GOPATH,也是一样,Go 会自动在多个$GOPATH/src中寻找。

如何编译程序呢?进入该应用目录,然后执行go build,那么在该目录下面会生成一个 mathapp 的可执行文件

./mathapp

输出如下内容

Hello, world.  Sqrt(2) = 1.414213562373095

如何安装该应用,进入该目录执行go install, 那么在 $GOPATH/bin / 下增加了一个可执行文件 mathapp, 还记得前面我们把$GOPATH/bin加到我们的 PATH 里面了,这样可以在命令行输入如下命令就可以执行

mathapp

也是输出如下内容

Hello, world.  Sqrt(2) = 1.414213562373095

这里我们展示如何编译和安装一个可运行的应用,以及如何设计我们的目录结构。

获取远程包

go 语言有一个获取远程包的工具就是go get,目前 go get 支持多数开源社区 (例如:github、googlecode、bitbucket、Launchpad)

go get github.com/astaxie/beedb

go get -u 参数可以自动更新包,而且当 go get 的时候会自动获取该包依赖的其他第三方包

通过这个命令可以获取相应的源码,对应的开源平台采用不同的源码控制工具,例如 github 采用 git、googlecode 采用 hg,所以要想获取这些源码,必须先安装相应的源码控制工具

通过上面获取的代码在我们本地的源码相应的代码结构如下

$GOPATH
  src
   |--github.com
          |-astaxie
              |-beedb
   pkg
    |--相应平台
         |-github.com
               |--astaxie
                    |beedb.a

go get 本质上可以理解为首先第一步是通过源码工具 clone 代码到 src 下面,然后执行go install

在代码中如何使用远程包,很简单的就是和使用本地包一样,只要在开头 import 相应的路径就可以

import "github.com/astaxie/beedb"

程序的整体结构

通过上面建立的我本地的 mygo 的目录结构如下所示

bin/
    mathapp
pkg/
    平台名/ 如:darwin_amd64、linux_amd64
         mymath.a
         github.com/
              astaxie/
                   beedb.a
src/
    mathapp
          main.go
    mymath/
          sqrt.go
    github.com/
           astaxie/
                beedb/
                    beedb.go
                    util.go

从上面的结构我们可以很清晰的看到,bin 目录下面存的是编译之后可执行的文件,pkg 下面存放的是应用包,src 下面保存的是应用源代码

原文地址 astaxie.gitbooks.io

文章作者:  BigYoung
版权声明:  本网站所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 BigYoung !