Skip to content

Go 项目启动记录 ​

我把一个最小 Go 项目的目录、模块、构建和依赖命令记在这里,方便开新仓库时查用。

1. 设置GOPATH和项目目录 ​

GOPATH 是 Go 工作空间的根目录。在 shell 配置文件(如.bashrc或.zshrc)里加上:

sh
export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin

然后,创建项目目录。假设你要创建一个名为myproject的项目:

sh
mkdir -p $GOPATH/src/github.com/yourusername/myproject
cd $GOPATH/src/github.com/yourusername/myproject

2. 初始化Go模块 ​

Go 模块是 Go 1.11 引入的依赖管理方式,依赖关系记录在go.mod里。在项目目录下初始化一个新的 Go 模块:

sh
go mod init github.com/yourusername/myproject

这将创建一个go.mod文件,记录项目的模块路径和依赖项。

3. 创建项目结构 ​

一个典型的Go项目结构可能如下:

myproject/
├── go.mod
├── go.sum
├── cmd/
│   └── myproject/
│       └── main.go
├── pkg/
│   └── ...
└── internal/
    └── ...
  • cmd/:存放项目的主应用程序入口。
  • pkg/:存放可以被其他项目使用的库代码。
  • internal/:存放只能被本项目使用的包。

创建这些目录和文件:

sh
mkdir -p cmd/myproject
touch cmd/myproject/main.go
mkdir -p pkg
mkdir -p internal

4. 编写代码 ​

在cmd/myproject/main.go中编写你的Go代码,例如一个简单的"Hello, World!"程序:

go
package main

import "fmt"

func main() {
    fmt.Println("Hello, World!")
}

5. 构建和运行项目 ​

你可以使用以下命令来构建和运行你的项目:

sh
go build -o bin/myproject ./cmd/myproject
./bin/myproject

或者直接运行:

sh
go run ./cmd/myproject

6. 添加依赖 ​

如果你的项目需要使用外部包,可以使用go get命令。例如,要使用gin框架,你可以运行:

sh
go get -u github.com/gin-gonic/gin

这将自动更新你的go.mod和go.sum文件以包含新的依赖项。

7. 管理依赖 ​

当你添加或更新依赖时,go mod tidy命令可以帮助你清理和整理go.mod和go.sum文件:

sh
go mod tidy

完整示例 ​

sh
# 设置项目目录
mkdir -p $GOPATH/src/github.com/yourusername/myproject
cd $GOPATH/src/github.com/yourusername/myproject

# 初始化Go模块
go mod init github.com/yourusername/myproject

# 创建项目结构
mkdir -p cmd/myproject
touch cmd/myproject/main.go
mkdir -p pkg
mkdir -p internal

# 编写代码
echo 'package main

import "fmt"

func main() {
    fmt.Println("Hello, World!")
}' > cmd/myproject/main.go

# 构建和运行项目
go build -o bin/myproject ./cmd/myproject
./bin/myproject

# 或者直接运行
go run ./cmd/myproject

# 添加依赖
go get -u github.com/gin-gonic/gin

# 管理依赖
go mod tidy

照这组命令执行后,bin/myproject 会打印出 Hello, World!。后续加依赖用 go get,清理用 go mod tidy。

参考资料 ​

同层页面 ​

相关页面 ​

Hello Golang