Go / 系统课时

组织 package 与导出标识符

组织 package 与导出标识符

Go 的包边界同时决定代码放在哪里、调用方用什么导入路径,以及哪些名字可以跨包访问。本篇从一个两包小程序开始,完成模块初始化、跨包调用、导出规则验证,并给出循环依赖的拆解方法。

学习目标

  • 能根据模块路径和目录位置写出正确的 import 路径。
  • 能用首字母大小写控制函数、类型、变量和常量是否对其他包可见。
  • 能识别 import cycle,并通过调整职责或依赖方向消除循环依赖。

用模块路径确定 import 路径

先创建一个最小模块。下面命令以 Bash 为例,要求本机已安装 Go:

bash
mkdir packdemo
cd packdemo
go mod init example.com/packdemo
mkdir greet

预期输出:

text
go: creating new go.mod: module example.com/packdemo

go.mod 中的模块路径是 example.com/packdemo,子目录 greet 的导入路径因此是 example.com/packdemo/greet。import 使用的是模块路径加目录路径,不是文件名。

在 greet/greet.go 写入:

go
package greet

const prefix = "Hello"

func Hello(name string) string {
	return prefix + ", " + name
}

在项目根目录的 main.go 写入:

go
package main

import (
	"fmt"

	"example.com/packdemo/greet"
)

func main() {
	fmt.Println(greet.Hello("Gopher"))
}

保存两个文件后,在模块根目录执行 go run .。

预期输出:

text
Hello, Gopher

用首字母大小写控制跨包可见性

Hello 的首字母大写,因此它是导出标识符,main 包可以写 greet.Hello。prefix 首字母小写,只能在 greet 包内部使用;如果在 main.go 中写 greet.prefix,编译不会通过。

同一规则适用于包级函数、类型、变量、常量,以及结构体字段和方法。一个常用做法是只导出调用方真正需要的入口:本例导出 Hello,但把拼接所需的 prefix 留在包内,这样后续更改问候前缀不会扩大公共 API。

包名与导入路径也要区分开。"example.com/packdemo/greet" 是导入路径,而 package greet 决定默认使用的本地包名。确有命名冲突时可以使用导入别名,但常规代码优先让目录名与包名保持一致,减少阅读成本。

按职责拆包并限制依赖方向

拆包的目标不是“一个文件一个包”,而是让一组高度相关的类型和行为共同维护。实际项目里,order 可以拥有订单领域规则,store 负责持久化,httpapi 负责 HTTP 适配;不要把零散函数全部塞进 util 或 common 后再让所有包互相依赖。

当两个包互相 import 时,Go 会直接拒绝编译。典型错误是 service import store,随后 store 又为了复用业务类型 import service,形成环。

包依赖从循环关系拆成单向关系

消除循环依赖时,优先采用两种做法:把双方共同使用且稳定的数据类型下沉到中立包,例如 model;或者把接口定义在“使用能力的一方”,由更上层的 main 负责注入实现。不要通过复制类型、全局变量或反射绕过循环依赖,这些做法只会隐藏边界问题。

用工具验证包边界

完成拆包后,先格式化再运行:

bash
gofmt -w main.go greet/greet.go
go run .

预期输出:

text
Hello, Gopher

如果出现 import cycle not allowed,先沿报错中的导入链找出第一个回边,而不是尝试调整 import 顺序;Go 的循环依赖是语言和构建规则禁止的,换顺序不会解决。

只希望模块内部使用的实现还可以放入 internal 目录,例如 internal/clock。Go 工具链会限制其可见范围:只有 internal 上级目录树中的代码可以导入它。对于不准备成为公共 API 的适配器、测试辅助实现或基础设施细节,这比单纯依靠命名约定更可靠。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

组织 package 与导出标识符

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通