脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 脚本专栏 → Golang → Go项目目录结构

Go项目的目录结构详解

 更新时间：2014年10月27日 13:06:55   投稿：junjie  
这篇文章主要介绍了Go项目的目录结构,对基础目录做了讲解,对项目开发中的其它目录也一并做了介绍,需要的朋友可以参考下

项目目录结构如何组织，一般语言都是没有规定。但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

您可能感兴趣的文章:

相关文章

  • 四种Golang实现middleware框架的方式小结

    四种Golang实现middleware框架的方式小结

    middleware是一般框架里面常用的形式,比如web框架、rpc框架等,本文为大家详细介绍了四种实现middleawre的方式,感兴趣的可以了解一下
    2024-03-03
  • Go语言中的指针运算实例分析

    Go语言中的指针运算实例分析

    这篇文章主要介绍了Go语言中的指针运算技巧,实例分析了Go语言指针运算的实现方法,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-02-02
  • Golang实现smtp邮件发送的示例代码

    Golang实现smtp邮件发送的示例代码

    这篇文章主要为大家详细介绍了Golang实现smtp邮件发送的相关知识，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2023-03-03
  • golang的Pseudo-versions使用问题解析

    golang的Pseudo-versions使用问题解析

    这篇文章主要为大家介绍有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪了golang的Pseudo-versions使用问题解析，
    2023-07-07
  • go语言通过odbc访问Sql Server数据库的方法

    go语言通过odbc访问Sql Server数据库的方法

    这篇文章主要介绍了go语言通过odbc访问Sql Server数据库的方法,实例分析了Go语言通过odbc连接与查SQL Server询数据库的技巧,需要的朋友可以参考下
    2015-03-03
  • Golang网络模型netpoll源码解析(具体流程)

    Golang网络模型netpoll源码解析(具体流程)

    本文介绍了Golang的网络模型netpoll的实现原理,本文将从为什么需要使用netpoll模型,以及netpoll的具体流程实现两个主要角度来展开学习,感兴趣的朋友跟随小编一起看看吧
    2024-11-11
  • golang日志框架之logrus的使用

    golang日志框架之logrus的使用

    这篇文章主要介绍了golang日志框架之logrus的使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-08-08
  • Go语言并发之通知退出机制的实现

    Go语言并发之通知退出机制的实现

    本文主要介绍了Go语言并发之通知退出机制的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-07-07
  • 基于go实例网络存储协议详解

    基于go实例网络存储协议详解

    这篇文章主要为大家介绍了基于go实例网络存储协议详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2023-03-03
  • Go 语言中的 Struct Tag 的用法详解

    Go 语言中的 Struct Tag 的用法详解

    在 Go 语言中,结构体字段标签（Struct Tag） 是一种用于给字段添加元信息（metadata）的机制,常用于序列化（如 JSON、XML）、ORM 映射、验证等场景,本文给大家介绍Go 语言中的 Struct Tag 的用法,感兴趣的朋友一起看看吧
    2025-05-05

最新评论