包相关

工作空间

Golang 工作空间 :编译工具对源码目录有严格要求,每个工作空间 (workspace) 必须由 bin、pkg、src 三个目录组成。

workspace
    |
    +--- bin                // go install 安装目录。
    |   |
    |   +--- learn
    |
    +--- pkg。             // go build 生成静态库 (.a) 存放目录。
    |     |
    |     +--- darwin_amd64 
    |               |
    |               +--- mylib.a 
    |               |
    |               +--- mylib 
    |                      |
    |                      +--- sublib.a
    |   
    +--- src            // 项目源码目录。
    |
    +--- learn
    |      |
    |      +--- main.go
    |  
    +--- mylib
           |        
           +--- mylib.go
           |        
           +--- sublib
                   |
                   +--- sublib.go

可在 GOPATH 环境变量列表中添加多个工作空间,但不能和 GOROOT 相同。

export GOPATH=$HOME/projects/golib:$HOME/projects/go

通常 go get使用第一个工作空间保存下载的第三方库。
Golang目前有150个标准的包,覆盖了几乎所有的基础库。
golang.org有所有包的文档。

源文件

Golang 源文件
编码: 源码文件必须是 UTF-8 格式,否则会导致编译器出错。
结束: 语句以 ";" 结束,多数时候可以省略。
注释: 持 "//"、"/**/" 两种注释方式,不能嵌套。
命名: 采用 camelCasing 风格(驼峰命名法),不建议使用下划线。

包结构

Golang 包结构 :所有代码都必须组织在 package 中。

• 源文件头部以 "package <name>" 声明包名称。
• 包由同一目录下的多个源码文件组成。
• 包名类似 namespace,与包所在目录名、编译文件名无关。 
• 目录名最好不用 main、all、std 这三个保留名称。
• 可执行文件必须包含 package main,入口函数 main。

说明:os.Args 返回命令行参数,os.Exit 终止进程。要获取正确的可执行文件路径,可用

说明:os.Args 返回命令行参数,os.Exit 终止进程。要获取正确的可执行文件路径,可用 

package 基本的管理单元:

同一个package下面,可以有非常多的不同文件,只要每个文件的头部 都有 如 "package xxx" 的相同name
就可以 在主方法中使用 xxx.Method()调用不同文件中的方法了。
文件夹名字可以和这个package 名称不一致,
比如我有个文件夹名字是mypackage,其中包含了a.go,b.go, c.go三个文件 :

mypackage   
  | --a.go
  | --b.go
  | --c.go

比如a.go中有 Saya(),b.go中有Sayb() 而几个文件共同的package name 确是testpackage。
所以在主函数中调用a.go 和b.go文件中的各自方法只要用,testpackage.Saya() ,testpackage.Sayb()即可
还有默认的init方法,在import进来的时候就去执行了,而且允许每个文件中都有init()这个方法,当然是每个都会执行。

导出包:

在 Go 中,包中成员以名称首字母大小写决定访问权限。首字母大写的名称是被导出的。
在导入包之后,你只能访问包所导出的名字,任何未导出的名字是不能被包外的代码访问的。
Foo 和 FOO 都是被导出的名称。名称 foo 是不会被导出的。

• public: 首字母大写,可被包外访问。
• internal: 首字母小写,仅包内成员可以访问。

该规则适用于全局变量、全局常量、类型、结构字段、函数、方法等。

导入包

使用包成员前,必须先用 import 关键字导入,但不能形成导入循环。

import "相对目录/包主文件名"

相对目录是指从<workspace>/pkg/<os_arch>开始的子目录,以标准库为例:

import "fmt"      ->  /usr/local/go/pkg/darwin_amd64/fmt.a
import "os/exec"  ->  /usr/local/go/pkg/darwin_amd64/os/exec.a

在导入时,可指定包成员访问方式。比如对包重命名,以避免同名冲突。

import用法:

import "fmt"        最常用的一种形式(系统包)
import "./test"     导入同一目录下test包中的内容(相对路径)
import "shorturl/model  加载gopath/src/shorturl/model模块(绝对路径)
import f "fmt"      导入fmt,并给他启别名f
import . "fmt"      将fmt启用别名".",这样就可以直接使用其内容,而不用再添加fmt。
    如fmt.Println可以直接写成Println
import  _ "fmt"     表示不使用该包,而是只是使用该包的init函数,并不显示的使用该包的其他内容。
    注意:这种形式的import,当import时就执行了fmt包中的init函数,而不能够使用该包的其他函数。

未使用的导入包,会被编译器视为错误 (不包括 "import _")。

./main.go:4: imported and not used: "fmt"

自定义路径 :可通过 meta 设置为代码库设置自定义路径。

server.go

package main

import (
    "fmt"
    "net/http" 
)

func handler(w http.ResponseWriter, r *http.Request) {
    fmt.Fprint(w, `<meta name="go-import"
                   content="test.com/qyuhen/test git https://github.com/qyuhen/test">`)
}

func main() {
    http.HandleFunc("/qyuhen/test", handler)
    http.ListenAndServe(":80", nil)
}

该示例使用自定义域名 test.com 重定向到 github。

$ go get -v test.com/qyuhen/test

Fetching https://test.com/qyuhen/test?go-get=1
https fetch failed.
Fetching http://test.com/qyuhen/test?go-get=1
Parsing meta tags from http://test.com/qyuhen/test?go-get=1 (status code 200)
get "test.com/qyuhen/test": found meta tag http://test.com/qyuhen/test?go-get=1
test.com/qyuhen/test (download)
test.com/qyuhen/test

如此,该库就有两个有效导入路径,可能会导致存储两个本地副本。为此,可以给库添加专门的 "import comment"。当 go get 下载完成后,会检查本地存储路径和该注释是否一致。

github.com/qyuhen/test/abc.go

package test // import "test.com/qyuhen/test"

func Hello() {
    println("Hello, Custom import path!")
}

如继续用 github 路径,会导致 go build 失败。

$ go get -v github.com/qyuhen/test

github.com/qyuhen/test (download)
package github.com/qyuhen/test
    imports github.com/qyuhen/test
    imports github.com/qyuhen/test: expects import "test.com/qyuhen/test"

这就强制包用户使用唯一路径,也便于日后将包迁移到其他位置。

Golang初始化

初始化函数:

    • 每个源文件都可以定义一个或多个初始化函数。 
    • 编译器不保证多个初始化函数执行次序。
    • 初始化函数在单一线程被调 ,仅执行一次。 
    • 初始化函数在包所有全局变量初始化后执行。 
    • 在所有初始化函数结束后才执行 main.main()。 
    • 无法调用初始化函数。

因为无法保证初始化函数执行顺序,因此全局变量应该直接用 var 初始化。

var now = time.Now()

func init() {
    fmt.Printf("now: %v\n", now)
}

func init() {
    fmt.Printf("since: %v\n", time.Now().Sub(now))
}

可在初始化函数中使用 goroutine,可等待其结束。

var now = time.Now()

func main() {
    fmt.Println("main:", int(time.Now().Sub(now).Seconds()))
}

func init() {
    fmt.Println("init:", int(time.Now().Sub(now).Seconds()))
    w := make(chan bool)

    go func() {
        time.Sleep(time.Second * 3)
        w <- true
    }()

    <-w 
}

输出:

init: 0
main: 3

不应该滥用初始化函数,仅适合完成当前文件中的相关环境设置。

文档

Golang 文档 :扩展工具 godoc 能自动提取注释生成帮助文档。

• 仅和成员相邻 (中间没有空行) 的注释被当做帮助信息。 
• 相邻行会合并成同一段落,用空行分隔段落。
• 缩进表示格式化文本,比如示例代码。
• 自动转换 URL 为链接。
• 自动合并多个源码文件中的 package 文档。 
• 无法显式 package main 中的成员文档。

Package

• 建议用专门的 doc.go 保存 package 帮助信息。
• 包文档第一整句 (中英文句号结束) 被当做 packages 列表说明。

Example
只要 Example 测试函数名称符合以下规范即可。


WX20190216-013639@2x.png

说明:使用 suffix 作为示例名称,其首字母必须小写。如果文件中仅有一个 Example 函数,且调用了该文件中的其他成员,那么示例会显示整个文件内容,而不仅仅是测试函数自己。
Bug
非测试源码文件中以 BUG(author) 开始的注释,会在帮助文档 Bugs 节点中显示。

// BUG(yuhen): memory leak.
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,717评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,501评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,311评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,417评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,500评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,538评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,557评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,310评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,759评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,065评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,233评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,909评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,548评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,172评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,420评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,103评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,098评论 2 352

推荐阅读更多精彩内容

  • 安装和删除 安装软件包 删除已安装的软件包(保留配置文件),不会删除依赖软件包,且保留配置文件。 删除已安装包(不...
    彬哲阅读 547评论 0 0
  • WeMobileDev | 2015-09-24 13:34 用户抱怨安装包越来越大?印度友人反馈装不上微信?欢迎...
    发财哥阅读 673评论 0 5
  • 本人所有文章均为学习过程中的总结,不同程度地参考了互联网上其他的文章,如果不正恳请指出,共同进步 闭包 我们有一些...
    始悔不悟阅读 277评论 0 9
  • 一、渠道包应用场景: 打包完一个母包.ipa 后,各个渠道商可能会使用到不同的域名,icon 等等,所以各个渠道商...
    蚂蚁牙齿不黑阅读 2,338评论 1 1
  • 感觉js闭包可以引发一系列面试中比较常考的问题,打算单独写一篇文章加以总结 如果之前对作用域的相关知识点了解的话,...
    Mavericker阅读 279评论 0 0