模块级私有访问权限 internal 包的使用规则,use of internal package xxx not allowed

本文深入讲解了Go语言中internal包的使用方式与访问权限限制,包括GOPATH与GOMODULE时代的不同表现,并提供了详细的代码示例。

在 Go 1.5 及后续版本中,可以通过创建 internal 代码包让一些程序实体仅仅能被当前模块中的其他代码引用。这是第三种访问权限:模块级私有。

1. GOPATH 时代
具体规则是:

internal 代码包中声明的公开程序实体仅能被该代码包的直接父包及其子包中的代码引用。当然,引用前需要先导入这个 internal 包。
对于其他代码包,导入该 internal 包都是非法的,无法通过编译。
这里的名称必须是 internal 。

代码目录结构如下:

wohu@wohu:~/GoCode/src$ tree chapter/
chapter/
└── demo3
    ├── demo3.go
    └── lib
        ├── demo3_lib.go
        └── internal
            └── internal.go

3 directories, 3 files
wohu@wohu:~/GoCode/src$ 
1
2
3
4
5
6
7
8
9
10
11
demo3.go 源码如下:

package main

import (
    "chapter/demo3/lib"
    //in "chapter/demo3/lib/internal" // 此行无法通过编译。
    //"os"
)

func main() {
    name := "wohu"
    lib.Hello(name)
    //in.Hello(os.Stdout, name)
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
demo3_lib.go 源码如下:

package lib

import (
    in "chapter/demo3/lib/internal"
    "os"
)

func Hello(name string) {
    in.Hello(os.Stdout, name)
}

1
2
3
4
5
6
7
8
9
10
11
internal.go 源码如下:

package internal

import (
    "fmt"
    "io"
)

func Hello(w io.Writer, name string) {
    fmt.Fprintf(w, "Hello, %s!\n", name)
}

1
2
3
4
5
6
7
8
9
10
11
运行 demo3.go 结果如下:

[Running] cd "/home/wohu/GoCode/src/chapter/demo3/" && go run .
Hello, wohu!
1
2
如果修改 demo3.go 源码如下,试图调用 internal 包,

package main

import (
    "chapter/demo3/lib"
    in "chapter/demo3/lib/internal" // 此行无法通过编译。
    "os"
)

func main() {
    name := "wohu"
    lib.Hello(name)
    in.Hello(os.Stdout, name)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
模块级私有的 internal 包,仅能被直接父包及其子包中的代码引用。上面如果要在父级里调用孙级目录的 internal 包,则会报错:

demo3.go:5:2: use of internal package chapter/demo3/lib/internal not allowed
1
2. GOMODULE 时代
一个 Go 项目里的 internal 目录下的 Go 包,只可以被本项目内部的包导入。项目外部是无法导入这个 internal 目录下面的包的。

举个例子,假设我们有两个 go module,两个 module 的结构如下:

.
├── module1
│   ├── go.mod
│   ├── internal
│   │   └── pkga
│   ├── pkg1
│   └── pkg2
└── module2
    ├── go.mod
    └── pkg1
1
2
3
4
5
6
7
8
9
10
module1 中的 internal/pkga 包可以被 module1 的 pkg1 和 pkg2 包所导入。但无法被 module2 的pkg1 包所导入。
————————————————
版权声明:本文为CSDN博主「wohu1104」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/wohu1104/article/details/109608579

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值