您的位置：首页 > 编程技术 > Golang  >  Go项目的目录结构详解

Go项目的目录结构详解

 更新时间：2020年5月1日 09:42  点击：2688

项目目录结构如何组织，一般语言都是没有规定。但Go语言这方面做了规定，这样可以保持一致性。

1、一般的，一个Go项目在GOPATH下，会有如下三个目录：

复制代码 代码如下:

|--bin
|--pkg
|--src

其中，bin存放编译后的可执行文件；pkg存放编译后的包文件；src存放项目源文件。一般，bin和pkg目录可以不创建，go命令会自动创建（如 go install），只需要创建src目录即可。

对于pkg目录，曾经有人问：我把Go中的包放入pkg下面，怎么不行啊？他直接把Go包的源文件放入了pkg中。这显然是不对的。pkg中的文件是Go编译生成的，而不是手动放进去的。（一般文件后缀.a）

对于src目录，存放源文件，Go中源文件以包（package）的形式组织。通常，新建一个包就在src目录中新建一个文件夹。

2、举例说明

比如：我新建一个项目，test，开始的目录结构如下：

复制代码 代码如下:

test--|--src

为了编译方便，我在其中增加了一个install文件，目录结构：

复制代码 代码如下:

test/
|-- install
`-- src

其中install的内容如下：（linux下）

复制代码 代码如下:

#!/usr/bin/env bash

if [ ! -f install ]; then
echo 'install must be run within its container folder' 1>&2
exit 1
fi

CURDIR=`pwd`
OLDGOPATH="$GOPATH"
export GOPATH="$CURDIR"

gofmt -w src

go install test

export GOPATH="$OLDGOPATH"

echo 'finished'

之所以加上这个install，是不用配置GOPATH（避免新增一个GO项目就要往GOPATH中增加一个路径）

接下来，增加一个包：config和一个main程序。目录结构如下：

复制代码 代码如下:

test
|-- install
`-- src
    |-- config
    |   `-- config.go
    `-- test
        `-- main.go

注意，config.go中的package名称必须最好和目录config一致，而文件名可以随便。main.go表示main包，文件名建议为main.go。（注：不一致时，生成的.a文件名和目录名一致，这样，在import 时，应该是目录名，而引用包时，需要包名。例如：目录为myconfig，包名为config，则生产的静态包文件是：myconfig.a，引用该包：import “myconfig”，使用包中成员：config.LoadConfig()）

config.go和main.go的代码如下：

config.go代码

复制代码 代码如下:

package config

func LoadConfig() {
 
}

main.go代码

复制代码 代码如下:

package main

import (
 "config"
 "fmt"
)

func main() {
 config.LoadConfig()
 fmt.Println("Hello, GO!")
}

接下来，在项目根目录执行./install

这时候的目录结构为：

复制代码 代码如下:

test
|-- bin
|   `-- test
|-- install
|-- pkg
|   `-- linux_amd64
|       `-- config.a
`-- src
    |-- config
    |   `-- config.go
    `-- test
        `-- main.go
  （linux_amd64表示我使用的操作系统和架构，你的可能不一样）

其中config.a是包config编译后生成的；bin/test是生成的二进制文件

这个时候可以执行：bin/test了。会输出：Hello, GO!

3、补充说明

1）包可以多层目录，比如：net/http包，表示源文件在src/net/http目录下面，不过源文件中的包名是最后一个目录的名字，如http
而在import包时，必须完整的路径，如：import “net/http”

2）有时候会见到local import（不建议使用），语法类似这样：

复制代码 代码如下:

import “./config”

当代码中有这样的语句时，很多时候都会见到类似这样的错误：local import “./config” in non-local package

我所了解的这种导入方式的使用是：当写一个简单的测试脚本，想要使用go run命令时，可以使用这种导入方式。
比如上面的例子，把test/main.go移到src目录中，test目录删除，修改main.go中的import “config”为import “./config”，然后可以在src目录下执行：go run main.go

可见，local import不依赖于GOPATH

4、Windows下的install.bat

复制代码 代码如下:

@echo off

setlocal

if exist install.bat goto ok
echo install.bat must be run from its folder
goto end

: ok

set OLDGOPATH=%GOPATH%
set GOPATH=%~dp0

gofmt -w src

go install test

:end
echo finished

注,冒号和ok之间不应该有空格，但是放在一起总是会被wordpress转成一个表情。汗……

5、更新日志

1）2012-12-05 发布
2）2013-04-13 修正：目录名可以和包名不同，但建议一致；将make文件名改为install

[!--infotagslink--]

相关文章

  • Go应用中优雅处理Error的技巧总结

    在程序员中,尤其是go新手,经常听到的一个讨论话题是：如何处理错误,这篇文章主要给大家介绍了关于Go应用中优雅处理Error的一些相关技巧,需要的朋友可以参考下...2021-09-08

  • Django def clean()函数对表单中的数据进行验证操作

    这篇文章主要介绍了Django def clean()函数对表单中的数据进行验证操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2020-07-09

  • golang官方嵌入文件到可执行程序的示例详解

    这篇文章主要介绍了golang官方嵌入文件到可执行程序,本文通过示例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下...2021-02-20

  • go浮点数转字符串保留小数点后N位的完美解决方法

    这篇文章主要介绍了go浮点数转字符串保留小数点后N位解决办法,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下...2020-05-11

  • Go语言使用读写OPC详解

    这篇文章主要介绍了Go语言使用读写OPC详解，图文讲解的很清晰，有感兴趣的同学可以学习下...2021-03-05

  • Go中string与[]byte高效互转的方法实例

    string与[]byte经常需要互相转化,普通转化会发生底层数据的复制,下面这篇文章主要给大家介绍了关于Go中string与[]byte高效互转的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下...2021-09-20

  • Go项目的目录结构详解

    这篇文章主要介绍了Go项目的目录结构,对基础目录做了讲解,对项目开发中的其它目录也一并做了介绍,需要的朋友可以参考下...2020-05-01

  • Go 容器遍历的实现示例

    Go 语言提供的基础容器，免不了要查询容器中的数据，那么是如何实现遍历的呢？本文将会介绍几种常用容易的遍历及其使用。感兴趣的可以了解一下...2021-06-13

  • 创建第一个Go语言程序Hello,Go!

    这篇文章主要介绍了创建第一个Go语言程序Hello,Go!本文详细的给出项目创建、代码编写的过程,同时讲解了GOPATH、Go install等内容,需要的朋友可以参考下...2020-05-01

  • 在Django中使用MQTT的方法

    这篇文章主要介绍了在Django中使用MQTT的方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2021-05-10

  • go语言中的Carbon库时间处理技巧

    这篇文章主要介绍了go语言中的Carbon库时间处理,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下...2021-02-05

  • go嵌套匿名结构体的初始化详解

    这篇文章主要介绍了go嵌套匿名结构体的初始化详解，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2020-12-16

  • 解决导入django_filters不成功问题No module named 'django_filter'

    这篇文章主要介绍了解决导入django_filters不成功问题No module named 'django_filter'，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2020-07-15

  • 详解如何使用Docker部署Django+MySQL8开发环境

    这篇文章主要介绍了详解如何使用Docker部署Django+MySQL8开发环境，文中通过示例代码以及图文介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧...2020-07-19

  • Go语言json编码驼峰转下划线、下划线转驼峰的实现

    这篇文章主要介绍了Go语言json编码驼峰转下划线、下划线转驼峰的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2020-06-09

  • Django 解决由save方法引发的错误

    这篇文章主要介绍了Django 解决由save方法引发的错误，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2020-05-21

  • django前端页面下拉选择框默认值设置方式

    这篇文章主要介绍了django前端页面下拉选择框默认值设置方式，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2020-08-10

  • django数据模型中null和blank的区别说明

    这篇文章主要介绍了django数据模型中null和blank的区别说明，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2020-09-03

  • Go 自定义package包设置与导入操作

    这篇文章主要介绍了Go 自定义package包设置与导入操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2021-05-06

  • Go语言实现汉诺塔算法

    之前的文章，我们给大家分享了不少汉诺塔算法的实现语言，包括C、c++、java、python等，今天我们就来使用go语言来实现一下，需要的小伙伴来参考下吧。...2020-05-07