Golang项目目录结构组织

忆往昔:

从接触golang到现在满打满算两周时间,总的来说,语法够简单,不过现在可以看、可以参照的资料数量太少了。

还记得我刚开始写的第一个有点用的程序,1000多行代码吧,完全挤在一个文件里,我不知道如果把这些内容分拆到不同的文件中去,该怎样编译,网上搜了一圈,都寥寥数语,没有成体系的讲解。可能玩golang的都是大牛吧,这些东西都水到渠成,认为没有必要写出来。

后来看许式伟的《go语言编程》里提到了一点工程管理的信息,这才知道怎么去拆分,怎样编译。

想来,当初的代码是这样的:

01 package main
02 
03 import(
04     ...
05 )
06 
07 func ...{
08     ...
09 }
10 
11 ...
12 
13 func main(){
14     ...
15 }

 

叹今朝:

其实golang的工程管理还是挺简单的,完全使用目录结构还有package名来推导工程结构和构建顺序。

当然,首先要说的是环境变量$GOPATH,项目构建全靠它。这么说吧,想要构建一个项目,就要将这个项目添加到$GOPATH中,多个项目用";"分隔。

Golang项目目录下一般有三个子目录:

  • src存放源代码
  • pkg编译后生成的文件
  • bin编译后生成的可执行文件

我们重点要关注的其实就是src文件夹中的目录结构。

举个例子比啥都强,目录结构如下:

<proj>
   |--<src>
       |--<a>
           |--<a1>
               |--al.go
           |--<a2>
               |--a2.go
       |--<b>
           |--b1.go
           |--b2.go

       |--<c>
           |--c.go
   |--<pkg>
   |--<bin>

 

各文件代码:

a1.go

package a1

import "fmt"

func PrintA1(){
   fmt.Println("a/a1")
}

 

a2.go

package a2

import "fmt"

func PrintA2(){
   fmt.Println("a/a2")
}

 

b1.go

package b

import "fmt"

func printB1(){
   fmt.Println("b.b1")
}

 

b2.go

package b

import "fmt"

func PrintB(){

   printB1()
   fmt.Println("b.b2")
}

 

c.go

01 package main
02 
03 import(
04    "a/a1"
05    "a/a2"
06    "b"
07 )
08 func main(){
09    a1.PrintA1()
10    a2.PrintA2()
11    b.PrintB()
12 }

 

将proj加入$GOPATH:

在windows下有个问题要注意,就是中文路径问题,如果proj路径有中文,那么在编译的时候可能出问题,我被这个问题折磨了半个多小时,左右挑不出错,就是不能编译。

go build a/a1
go install a/a1
go build a/a2
go install a/a2
go build b
go install b

go build c
go install c

执行相关命令。

可以看到pkg文件夹下生成了,a文件夹、b.a,a文件夹下有a1.a、a2.a

bin文件夹下有c.exe(当然,在执行go build c的位置也存在c.exe)

运行下c.exe

可以看出,分门别类,非常清楚。

其实b文件夹下的两个.go文件完全可以合并成一个的,没有任何影响。

package中的名称最好与目录名一样,这样在import的时候直接import目录名就好了。如果两者不一致,例如上面的b1.go、b2.go里面的package是package bbbbb,则在c.go里import的时候要import "b",然后下面的b.PrintB(),则需要改为bbbbb.PrintB()

go项目的目录结构我感觉说得挺明白的了。

posted @ 2013-06-01 12:21  trirocky  阅读(15353)  评论(3编辑  收藏