带你了解Go项目标准目录布局

Android开发
• 阅读 1563

很多的时候,我们开发一个简单的Go项目的时候并不需要纠结于项目的的目录布局,因为我们会将所有go源码文件扔在项目的根目录中,就像下面这样:

demo
├── main.go
├── model.go
└── service.go

但当我们的项目变得复杂的时候,我们就需要好好思考怎么组织我们的项目了,这时候你可能会想,用官方的Go项目目录布局就好了,然而Go的官方并没有给出一个标准的Go项目标准目录布局。

目前,Go社区开发者比较推荐的是project-layout项目中给出的目录布局,如:

demo
├── api
├── assets
├── build
├── cmd
├── configs
├── deployments
├── docs
├── examples
├── githooks
├── init
├── internal
├── pkg
├── scripts
├── test
├── third_party
├── tools
├── vendor
├── web
└── website

然而官方并不推荐这种项目布局方式,下面是Go团队开发leader Russ Cox对project-layout目录的意见:
带你了解Go项目标准目录布局

大体上,我们可以将Go的项目分为两类,应用项目与库项目。

  • 应用项目:即包含可执行文件的项目,项目开发后,需要编译成可执行文件并上线运行。
  • 库项目:库文件一般用于暴露Api,被其他项目通过import关键字引入。

应用项目与库项目的目录布局方式稍有差异。

应用项目

对于应用项目,其目录布局方式我们可以参考Go项目自身,以及一些使用Go语言开发的优秀开源项目(如Docker,Kubernetes,etcd)等,通过研究这些项目的目录布局,我们可以抽象出以下标准目录:

demo
├── cmd
│   ├── app1
│   │   └── main.go
│   └── app2
│       └── main.go
├── go.mod
├── go.sum
├── internal
│   ├── pkga
│   │   └── pkg_a.go
│   └── pkgb
│       └── pkg_b.go
├── pkg1
│   └── pkg1.go
├── pkg2
│   └── pkg2.go
└── vendor

cmd

可执行文件目录,如果一个项目有多个可执行文件,可以放在不同的子目录中,如上面例子中的app1和app2目录。

internal

项目内部私有代码,其他项目引入时会报错。

pkgN:

注意,这里并不是说一定要pkg为前缀来命名,你可以对取任意符合包命名规范的名称,比如service,model等

即上面示例中的pkg1与pkg2,pkgN包与internal包一样存放项目的依赖代码,但存储在这里的代码,可以被其项目引入。

vendor

这个目录用于存储项目的依赖包,但由于现今Go项目都是使用go module进行依赖管理,因此这个目录是可省略的。

如果我们的项目只有一个可执行文件,可以将main.go文件直接写在根目录,而vendor可以省略,因此,项目目录可以进一步精简为:

demo
├── go.mod
├── go.sum
├── internal
│   ├── pkga
│   │   └── pkg_a.go
│   └── pkgb
│       └── pkg_b.go
├── main.go
├── pkg1
│   └── pkg1.go
└── pkg2
    └── pkg2.go

库项目

库项目不需要可执行文件,相比于应用项目,省略了cmd目录,其标准目录下:

demo
├── go.mod
├── go.sum
├── internal
│   ├── pkga
│   │   └── pkg_a.go
│   └── pkgb
│       └── pkg_b.go
├── pkg1
│   └── pkg1.go
└── pkg2
    └── pkg2.go

如果我们的库项目比较简单,可以采用平铺式项目布局,即将所有的功能写在一个包里,所有源码目录放在根目录下,如:

demo
├── feature1.go
├── feature2.go
├── feature3.go
├── go.mod
└── go.sum

平铺式的项目布局非常适合简单的库项目,事实上,很多复杂的库项目也会将大量的代码放在根目录下,因为这样,其他项目使用import引入项目的包时,路径会比较短,比如我们有一个结构体A,放在pkg1包下与放在根目录下,其引路径分别是:

import "demo"

import "demo/pkg1"

小结

好了,阅读到这里,想必你已经了解了Go应用项目与库项目目录布局的不同了吧。

不过,由于Go官方项目指定的项目布局,因此上述的几种项目目录都是社区开发的约定俗成,并不具备强制性,你也可以定制自己的Go项目目录布局,不过我想,使用社区开发都遵循的目录规范,还是有助于降低团队开发人员的认知与交流成本的。

点赞
收藏
评论区
推荐文章
blmius blmius
4年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
美凌格栋栋酱 美凌格栋栋酱
7个月前
Oracle 分组与拼接字符串同时使用
SELECTT.,ROWNUMIDFROM(SELECTT.EMPLID,T.NAME,T.BU,T.REALDEPART,T.FORMATDATE,SUM(T.S0)S0,MAX(UPDATETIME)CREATETIME,LISTAGG(TOCHAR(
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
Jacquelyn38 Jacquelyn38
4年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Wesley13 Wesley13
3年前
FLV文件格式
1.        FLV文件对齐方式FLV文件以大端对齐方式存放多字节整型。如存放数字无符号16位的数字300(0x012C),那么在FLV文件中存放的顺序是:|0x01|0x2C|。如果是无符号32位数字300(0x0000012C),那么在FLV文件中的存放顺序是:|0x00|0x00|0x00|0x01|0x2C。2.  
Easter79 Easter79
3年前
Twitter的分布式自增ID算法snowflake (Java版)
概述分布式系统中,有一些需要使用全局唯一ID的场景,这种时候为了防止ID冲突可以使用36位的UUID,但是UUID有一些缺点,首先他相对比较长,另外UUID一般是无序的。有些时候我们希望能使用一种简单一些的ID,并且希望ID能够按照时间有序生成。而twitter的snowflake解决了这种需求,最初Twitter把存储系统从MySQL迁移
Wesley13 Wesley13
3年前
mysql设置时区
mysql设置时区mysql\_query("SETtime\_zone'8:00'")ordie('时区设置失败,请联系管理员!');中国在东8区所以加8方法二:selectcount(user\_id)asdevice,CONVERT\_TZ(FROM\_UNIXTIME(reg\_time),'08:00','0
Wesley13 Wesley13
3年前
00:Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork),斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟,已经成为Web应用程序的首选开发语言。Java是简单易学,完全面向对象,安全可靠,与平台无关的编程语言。
wc 统计已过时,cloc 每一行代码都有效
上下文我们通常用代码量来评判一个程序员技术的高低或一个项目的大小,阅读新项目源码时,也需要了解其代码量,心里有个预期。那如何统计代码量呢?传统做法通过findwc命令完成shell$find.name".go"|xargswcl60./etcd/tutorial/distributedlock.go...3491total如上,统计命
Python进阶者 Python进阶者
1年前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这
Android开发
Android开发
Lv1
各有归舟,各有渡口。
文章
3
粉丝
0
获赞
0