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

原创文章,作者:CGHNY,如若转载,请注明出处:http://www.wangzhanshi.com/n/6160.html

(0)
CGHNY的头像CGHNY
上一篇 2024年12月29日 12:46:25
下一篇 2024年12月29日 12:46:45

相关推荐

  • go语言time.After()的作用

    time.After是一个非常实用的函数,它返回一个用于读取的单向通道(<-chan time.Time),这个通道会在指定的时间间隔之后发送当前时间。这个机制常被用于实现超…

    Golang 2024年12月17日
  • Go语言使用sqlx操作MySQL

    Go 语言以其高效和简洁的语法逐渐受到开发者的青睐。在实际开发中,数据库操作是不可避免的任务之一。虽然标准库提供了 database/sql 包来支持数据库操作,但使用起来略显繁琐…

    Golang 2024年12月17日
  • 详解Go语言中空结构体的惯用法

    在 Go 语言中,空结构体 struct{} 是一个非常特殊的类型,它不包含任何字段并且不占用任何内存空间。虽然听起来似乎没什么用,但空结构体在 Go 编程中实…

    Golang 2024年12月17日
  • 如何使用工具自动监测SSL证书有效期并发送提醒邮件

    前言 自从云厂商的免费ssl证书改成3个月,而且证书数量还是20个之后,自己网站的ssl证书就换成了其它免费方案。但是免费方案不会提醒证书过期,所以写个工具每天定时查询证书剩余有效…

    Golang 2024年12月26日
  • 一文详解Go语言中的Defer机制

    在Go语言中,defer是一个关键字,用于确保资源的清理和释放,特别是在函数中创建的资源。defer语句会将其后的函数调用推迟到包含它的函数即将返回时执行。这使得defer成为处理…

    Golang 2024年12月17日
  • golang如何实现抓取IP地址的蜘蛛程序详解

    背景 要做IP地址归属地查询,量比较大,所以想先从网上找到大部分的分配数据,写个蜘蛛程序来抓取入库,以后在程序的运行中不断进行维护、更新、完善。 一些关键点 goroutine的使…

    Golang 2024年12月29日
  • go语言串口通信的项目实践

    Go语言(Golang)作为一种现代、高效且支持并发的编程语言,在处理硬件通信任务时表现出色,尤其是在实现串口通信方面。以下是对Go语言实现串口通信的关键步骤、库使用以及示例代码的…

    Golang 2024年12月17日
  • 通过Go channel批量读取数据的示例详解

    引言 在 Go 语言中,我们可以利用 channel 作为数据的传输通道,通过定期批量读取 channel 中的数据,并将这些数据批量发送到 Kafka 或者进行网络写入。这样可以…

    Golang 2024年12月17日
  • golang gin ShouldBind的介绍和使用示例详解

    在 Go 语言的 Gin 框架中,ShouldBind 是用于将请求中的数据绑定到结构体的一个方法。它简化了从请求中提取参数的过程,支持多种数据格式(如 JSON、表单、查询参数等…

    Golang 2024年12月17日
  • Go语言web框架Gin响应客户端的方式

    前言 Gin是一个用Go语言编写的web框架。它是一个类似于martini但拥有更好性能的API框架, 由于使用了httprouter,速度提高了近40倍。如果你是性能和高效的追求…

    2024年12月17日

发表回复

登录后才能评论