解决no go source files/no buildable go source files问题

一、解决问题

最近在公司使用内部组件时,go get某个package报错:

在stackoverflow上找到了解决方案,顺便学习了一把go的build constraints(构建约束),参考:

https://stackoverflow.com/questions/24095004/cant-load-package-package-no-buildable-go-source-files/35583826#35583826?newreg=0cec882b010b454ea55ea74f1dab194d

这里写的很清楚了,只要在源文件里面包含了下面这个构建约束,该源文件就不会被编译;但使用go get pkg@v 命令的时候,是会把依赖包下载下来并自动编译的,因此使用go get某个pkg且这个pkg里面的所有源文件都使用了下面这个构建约束的时候,会提示no go source files/no buildable go source files的错误。

// +build ignore

我这里的解决方案是直接改了go.mod把依赖的pkg replace成了高版本,使用下面的命令即可replace。

go mod edit -replace=old@v1=new@v2

二、构建约束

build constrains的官方文档见下面:

​​​​​​https://pkg.go.dev/cmd/go#hdr-Build_constraints

中文的网上有很多解释文档,这里参考了一篇博文:

​​​​​​ Go1.17 新特性:新版构建约束-技术圈

原文如下:

Go 1.17 下个月就要正式发布了。很多人要问泛型了吧,泛型已经很明确了,Go1.18 会有。今天给大家介绍 Go1.17 的一个新特性:构建约束 — Build Constraints。

确切来说,这个特性相关的工作在 1.16 时就加入,但处于过度阶段,1.17 在各方面都更完善,更完整的支持,是时候了解它了。

01 什么是构建约束

构建约束(build constraint),也叫做构建标记(build tag),是在 Go 源文件最开始的注释行,比如:

// +build linux

看到这个,相信很多人都不陌生,因为这是 Go 一开始就有的特性,在 Go 源码中有很多这样的注释行。上面注释行的意思,这个文件只在 Linux 系统会包含在包中,其他系统会忽略这个文件。

几个注意点:

  • 约束可以出现在任何源文件中,比如 .go.s 等;

  • 必须在文件顶部附近,它的前面只能有空行或其他注释行;可见包子句也在约束之后;

  • 约束可以有多行;

  • 为了区别约束和包文档,在约束之后必须有空行;

针对某个构建约束,可使用的词如下:

  • 特定操作系统,对应 runtime.GOOS 的可用值,比如 linux、windows 等;

  • 特定的架构,对应 runtime.GOARCH 的可用值,比如 386、amd64 等;

  • 使用的编译器,比如 gc、gccgo;

  • 支持 cgo 命令时,可以使用 cgo;

  • Go 的主要发布版本,比如 go1.17、go1.16 等;(测试版本和 fixbug 版本不支持)

  • 自定义的 tag,编译时通过 -tags 传递的值;

  • 可以加入任意值,一般用 ignore 来忽略构建;

此外,文件名可以通过 GOOS 和 GOARCH 来做构建约束。

02 旧版构建约束

从上面看到,构建约束的语法是 // +build 这种形式,如果多个条件组合,通过空格、逗号或多行构建约束表示。比如:

// +build linux,386

你知道什么意思吗?表示在 linux AND 386。逗号表示 AND,空格表示 OR。那看一个复杂的:

// +build linux,386 darwin,!cgo

是不是有点懵?我也有点懵!它表示的意思是:(linux AND 386) OR (darwin AND (NOT cgo)) 。

有些时候,多个约束分成多行书写,会更易读些:

// +build linux darwin
// +build amd64

这相当于:(linux OR darwin) AND amd64 。

是不是很复杂,很难记忆?

正因为太复杂,很容易出错。而且,Go 中有不少注释是有特殊意义的,也为了一致性考虑,因此有了新版的构建约束。

03 新版构建约束

在 Go 源码中,经常会见到类似下面开头的注释:

//go:link

新版的构建约束,也使用了 //go: 开头:

//go:build

注意 // 和 go 之间不能有空格。

同时新版语法使用布尔表达式,而不是逗号、空格等。布尔表达式,会更清晰易懂,出错可能性大大降低。

比如旧语法:

// +build linux,386

对应的新语法:

//go:build linux && 386

构建标记的基础语法与其当前形式没有变化,但是构建标记的组合现在是用 Go 的 || 、 && 和 ! 运算符和括号。(请注意,构建标记并不总是有效的 Go 表达式,即使它们共享操作符,因为标记并不总是有效的标识符。例如:”go1.1"。)

新语法可以使用 Go spec 的 EBNF 标记来表示:

BuildLine      = "//go:build" Expr
Expr           = OrExpr
OrExpr         = AndExpr   { "||" AndExpr }
AndExpr        = UnaryExpr { "&&" UnaryExpr }
UnaryExpr      = "!" UnaryExpr | "(" Expr ")" | tag
tag            = tag_letter { tag_letter }
tag_letter     = unicode_letter | unicode_digit | "_" | "."

采用新语法后,一个文件只能有一行构建语句,而不是像旧版那样有多行。这样可以避免多行的关系到底是什么的问题。

Go1.17 中,gofmt 工具会自动根据旧版语法生成对应的新版语法,为了兼容性,两者都会保留。比如原来是这样的:

// +build !windows,!plan9

执行 Go1.17 的 gofmt 后,变成了这样:

//go:build !windows && !plan9
// +build !windows,!plan9

如果文件中已经有了这两种约束形式,gofmt 会根据 //go:buid 自动覆盖 // +build 的形式,确保两者表示的意思一致。如果只有新版语法,不会自动生成旧版的,这时,你需要注意,它不兼容旧版本了。

另外,Vet 工具现在能够检测出两种语法的不一致。所以,建议大家在编辑器中保存文件时自动执行 gofmt。

早在 Go1.16 时就新增了一个包:go/build/constraint,专门处理新版构建约束。

关于新版约束的设计文档请移步:https://go.googlesource.com/proposal/+/master/design/draft-gobuild.md。

04 总结

新版本的构建约束可读性更强,更容易书写,不容易出错。有兴趣的可以自己针对构建约束,同时书写两种形式,体会下新版的好处。

最后提醒一点,新版约束中,一定要注意 // 和 go 之间不能有空格!

  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
"CGo是Go语言的一个特性,用于在Go语言程序中调用C语言的函数和访问C语言的数据结构。但是,当我们使用命令'go build'或'go install'编译或安装一个使用CGo的Go语言项目时,有时会遇到错误消息'cgo go: no go source files'。 这个错误消息的意思是在当前目录下没有找到任何的Go源文件。造成这个错误的原因可能是以下几种情况: 1. 当前目录下确实没有任何的Go源文件。这时我们需要检查项目目录结构,确保所有Go源文件的位置和命名都正确。 2. 当前目录下只有C文件,并且没有Go源文件。CGo需要至少一个Go源文件来实现C语言的函数和数据结构的绑定。我们需要为项目添加一个或多个Go源文件来解决这个问题。 3. 当前目录下有Go源文件,但它们没有被正确命名或没有包含有效的Go代码。我们需要检查Go源文件的命名和内容,确保它们符合Go语言的语法和规范。 为了解决'cgo go: no go source files'错误,我们可以采取以下步骤: 1. 确认当前目录下是否有正确命名和包含有效Go代码的Go源文件。 2. 如果当前目录下只有C文件,需要添加至少一个Go源文件。 3. 检查项目目录结构,确保所有Go源文件的位置和命名都正确。 4. 确保使用正确的命令进行编译或安装,如'go build'或'go install'。 总之,当我们使用CGo时,如果遇到'cgo go: no go source files'错误,需要检查当前目录下是否有正确的Go源文件,并确认它们的命名和内容是否正确。同时,也要注意使用正确的命令进行编译或安装。"
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值