Go语言包和包管理详解

目录
  • 1 包简介
    • 1.1 工作空间
    • 1.2 源文件
    • 1.3 包命名
    • 1.4 main 包
  • 2导包
    • 2.1 两种方式
    • 2.2 包的别名
    • 2.3 简洁模式
    • 2.4非导入模式(匿名导入)
    • 2.5 导包的路径
    • 2.6 远程导入
  • 3 初始化 init
    • 3.1 init总结
  • 4 包管理
    • 4.1 演变过程
    • 4.2 Go Model优点
    • 4.3 启用go module
    • 4.4 GOPROXY
  • 5 go mod详解
    • 5.1 go mod命令
    • 5.2 go.mod说明
      • 5.2.1 依赖的版本
      • 5.2.2 replace
    • 5.3 go get
      • 5.3.1 整理依赖
    • 5.4 go mod edit
      • 5.4.1 格式化
      • 5.4.2 添加依赖项
      • 5.4.3 移除依赖项
  • 6 项目中使用go module
    • 6.1 现有项目
    • 6.2 新项目

1 包简介

1.1 工作空间

go语言的工作空间必须由 bin、pkg、src三个目录组成,可以在GOPATH环境变量中添加多个工作空间,但不能和GOROOT相同。通常go get使用第一个工作空间保存下载的第三方库

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.g

1.2 源文件

  • 编码:源码⽂件必须是 UTF-8 格式,否则会导致编译器出错。
  • 结束:语句以 “;” 结束,多数时候可以省略。
  • 注释:⽀持 “//”、 “/**/” 两种注释⽅式,不能嵌套。
  • 命名:采⽤ camelCasing ⻛格,不建议使⽤下划线。

1.3 包命名

::: tip 包命名惯例

  • 给包命名的惯例是使用包所在目录的名字。这让用户在导入包的时候,就能清晰地知道包名。
  • 尽量使用简介明了的名字,但要避免冲突
  • 包名一般使用单数的形式,但是避免冲突的用的复数比如bytes,errors,strings等
  • 要避免包名有其他含义。比如 temp这种
  • 命名时考虑包名和成员如何配合,尽量减少包名和成员有重复 :::

1.4 main 包

  • 所有用 Go 语言编译的可执行程序都必须有一个名叫 main 的包。 go语言的编译器会将这种名字的包编译为二进制可执行文件。
  • main包下肯定会有名为main()的函数,main()是程序的入口。
  • 编译完会使用声明 main 包的代码所在的目录的目录名作为二进制可执行文件的文件名

2导包

关键字 Import ,进行导包。未使用的导入包,会编译错误。

2.1 两种方式

import a import b,…多次导入,以及import(a b c) 批量导入,如果导入的包不使用会报错。

import "fmt"
//或者
import(
	"fmt"
    "time"
)

2.2 包的别名

import(
	io "fmt"
)
io.Println("hello world") //别名可以直接用,在包重名时很有用

2.3 简洁模式

import (
	. "fmt"  //但是为了别人好看,一般还是不用这种
)
func main(){
	Println("hello")
}

2.4非导入模式(匿名导入)

即导入一个包并不使用它。如果不加_,就会出现编译错误。 在这里用下划线 _ 重命名导入的包。只导入,不使用。 但是这个包它进行了初始化,一般在init函数调用,这样做的好处是,有些包我们不显示使用它,但是有可能用到它,或者由用户选择使用哪个。比如 对特定图像驱动包的初始化,在我们格式化转换图片用到。还有 database/sql包,可以先都初始化,让用户选择不同的数据库驱动。

import _ "test"     //非导入模式:仅让该包执行初始化函数

2.5 导包的路径

一般情况下是包的相对路径。比如import "learn/test",标准库中的包会在安装 Go 的位置找到,即GOROOT。 Go 开发者创建的包会在 GOPATH 环境变量指定的目录里查找。GOPATH 指定的这些目录就是开发者的个人工作空间。

2.6 远程导入

目前的大势所趋是,使用分布式版本控制系统(Distributed Version Control Systems, DVCS) 来分享代码,如 GitHubLaunchpad 还有 Bitbucket。 Go 语言的工具链本身就支持从这些网站及 类似网站获取源代码。 Go 工具链会使用导入路径确定需要获取的代码在网络的什么地方。

比如:import "github.com/xxxx/xxx",用导入路径编译程序时, go build 命令会使用 GOPATH的设置,在磁盘上搜索这个包。事实上, 这个导入路径代表一个URL,指向 GitHub上的代码库。如果路径包含 URL,可以使用 Go 工具链从 DVCS 获取包,并把包的源代码保存在GOPATH指向的路径里与 URL 匹配的目录里。这个获取过程 使用 go get 命令完成。

go get 将获取任意指定的 URL 的包,或者一个已经导入的包所依赖的其 他包。由于 go get的这种递归特性,这个命令会扫描某个包的源码树,获取能找到的所有依赖包。

3 初始化 init

每个包可以包含任意多个 init 函数,这些函数都会在程序执行开始的时候被调用。所有被编译器发现的 init 函数都会安排在 main 函数之前执行。 init 函数用在设置包、初始化变量或者其他要在程序运行前优先完成的引导工作。举例如下

 package postgres
 import (
	 "database/sql"
 )
 func init() { //初始化函数
     //这里省略。。
	 sql.Register("postgres", new(PostgresDriver))
 }

3.1 init总结

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

4 包管理

4.1 演变过程

  • 2013年:Gedep,社区第一个包管理工具
  • 2015年:vendor,Golang官方(golang1.5)
  • 2016、2017 年:dep、manul、Godep、Govendor、godm (Govendor胜出)
  • go module是Go1.11版本之后官方推出的版本管理工具,并且从Go1.13版本开始,go module将是Go语言默认的依赖管理工具。

4.2 Go Model优点

  • 不必须将项目目录放在GOPATH中
  • 不使用vendor目录,而是统一安装到$GOPATH/pkg/mod/cache
  • build/run时,自动析出项目import的包并安装

4.3 启用go module

要启用go module支持首先要设置环境变量GO111MODULE,通过它可以开启或关闭模块支持,它有三个可选值:off、on、auto,默认值是auto。 设置GO111MODULE=on之后就可以使用go module了,以后就没有必要在GOPATH中创建项目了,并且还能够很好的管理项目依赖的第三方包信息。 使用 go module 管理依赖后会在项目根目录下生成两个文件go.modgo.sum

  • GO111MODULE=off禁用模块支持,编译时会从GOPATHvendor文件夹中查找包。
  • GO111MODULE=on启用模块支持,编译时会忽略GOPATHvendor文件夹,只根据 go.mod下载依赖。
  • GO111MODULE=auto,当项目在$GOPATH/src外且项目根目录有go.mod文件时,开启模块支持。

4.4 GOPROXY

Go1.13之后GOPROXY默认值为proxy.golang.org,在国内是无法访问的,所以十分建议大家设置GOPROXY

5 go mod详解

5.1 go mod命令

常用的go mod命令如下:

go mod命令 描述
go mod download 下载依赖的module到本地cache(默认为$GOPATH/pkg/mod目录)
go mod edit 编辑go.mod文件
go mod graph 打印模块依赖图
go mod init 初始化当前文件夹, 创建go.mod文件
go mod tidy 增加缺少的module,删除无用的module
go mod vendor 将依赖复制到vendor下
go mod verify 校验依赖
go mod why 解释为什么需要依赖

5.2 go.mod说明

go.mod文件记录了项目所有的依赖信息,其结构大致如下:

module github.com/ourlang/studygo/myblog
go 1.13
require (
	github.com/DeanThompson/ginpprof v0.0.0-20190408063150-3be636683586
	github.com/gin-gonic/gin v1.4.0
	github.com/go-sql-driver/mysql v1.4.1
	github.com/jmoiron/sqlx v1.2.0
	github.com/satori/go.uuid v1.2.0
	google.golang.org/appengine v1.6.1 // indirect
)
  • module用来定义包名
  • require用来定义依赖包及版本
  • indirect表示间接引用

5.2.1 依赖的版本

go mod支持语义化版本号,比如go get foo@v1.2.3,也可以跟git的分支或tag,比如go get foo@master,当然也可以跟git提交哈希,比如go get foo@e3702bed2。关于依赖的版本支持以下几种格式:

gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7
gopkg.in/vmihailenco/msgpack.v2 v2.9.1
gopkg.in/yaml.v2 <=v2.2.1
github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e
latest

5.2.2 replace

在国内访问golang.org/x的各个包都需要翻墙,你可以在go.mod中使用replace替换成github上对应的库。

replace (
	golang.org/x/crypto v0.0.0-20180820150726-614d502a4dac => github.com/golang/crypto v0.0.0-20180820150726-614d502a4dac
	golang.org/x/net v0.0.0-20180821023952-922f4815f713 => github.com/golang/net v0.0.0-20180826012351-8a410e7b638d
	golang.org/x/text v0.3.0 => github.com/golang/text v0.3.0
)

5.3 go get

::: tip 在项目中执行go get命令可以下载依赖包,并且还可以指定下载的版本。

  • 运行go get -u将会升级到最新的次要版本或者修订版本(x.y.z, z是修订版本号, y是次要版本号)
  • 运行go get -u=patch将会升级到最新的修订版本
  • 运行go get package@version将会升级到指定的版本号version
  • 如果下载所有依赖可以使用go mod download命令。 :::

5.3.1 整理依赖

我们在代码中删除依赖代码后,相关的依赖库并不会在go.mod文件中自动移除。这种情况下我们可以使用go mod tidy命令更新go.mod中的依赖关系

5.4 go mod edit

5.4.1 格式化

因为我们可以手动修改go.mod文件,所以有些时候需要格式化该文件。Go提供了一下命令:

go mod edit -fmt

5.4.2 添加依赖项

go mod edit -require=golang.org/x/text

5.4.3 移除依赖项

如果只是想修改go.mod文件中的内容,那么可以运行go mod edit -droprequire=package path,比如要在go.mod中移除golang.org/x/text包,可以使用如下命令

go mod edit -droprequire=golang.org/x/text

6 项目中使用go module

6.1 现有项目

如果需要对一个已经存在的项目启用go module,可以按照以下步骤操作:

  • 在项目目录下执行go mod init,生成一个go.mod文件。
  • 执行go get,查找并记录当前项目的依赖,同时生成一个go.sum记录每个依赖库的版本和哈希值

6.2 新项目

对于一个新创建的项目,我们可以在项目文件夹下按照以下步骤操作:

  • 执行go mod init 项目名命令,在当前项目文件夹下创建一个go.mod文件。
  • 手动编辑go.mod中的require依赖项或执行go get自动发现、维护依赖。

以上就是Go语言包和包管理详解的详细内容,更多关于Go语言包及管理的资料请关注我们其它相关文章!

(0)

相关推荐

  • GO语言包管理工具go mod以及包详解

    目录 1.GO中包的定义与介绍 2. 包管理工具 go mod 2.1 自定义包 (可以包含多个go文件) 2.1.1 建立项目并go mod init初始化 2.1.2 自定义一个包(文件夹)并书写方法 2.1.3 引入自定义包,并使用 2.1.4 函数init执行顺序 init函数会自动执行 3. golang中使用第三方包 3.1 查找第三方包 3.2 安装包 3.2.1 go get (全局) 3.2.2 go download (全局) 补充:常用命令 总结 1.GO中包的定义与介绍

  • Go语言包管理工具dep的安装与使用

    什么是dep? dep和go,在一定程度上相当于maven之于Java,composer之于PHP,dep是go语言官方的一个包管理工具. 相比较go get而言,dep可以直接给引入的第三方包一个专门的目录,并且可以专门制定一个配置文件,控制go项目所引入的包,版本以及其他依赖关系. dep这个项目放在golang官方的github中:https://github.com/golang/dep 官方对于dep的解释是:dep is the official experiment, but no

  • Golang中的包及包管理工具go mod详解

    目录 一.包 二.包管理工具go mod 三.init函数 四.使用第三方包 一.包 1.包的种类:系统内置包.自定义包.第三方包. (1)系统内置包:go语言自带包,如str.conv.fmt等 (2)自定义包:开发者自己写的包 (3)第三方包:属于自定义包的一种,需下载到本地才能使用, 如可以从GitHub上下载的第三方包. 2.包是多个go源文件的集合,一个package下可以有多个go文件,归属于同一package 二.包管理工具go mod 1.在go的1.11版本之前如果想自定义包需

  • Go语言包管理工具Godep的用法

    一.为什么要包管理 默认Go的第三方包都是放在Gopath的src目录下,而且这些包都没有版本号的概念,这样的可能会出现一些问题. 举个例子:当A同事将开发完程序之后,此时可能引用了一个第三方的包,过了不久之后,B同事接手了该项目,此时如果B同事通过go get 命令获取了包,而且包的版本进行了升级,恰巧这个包又不兼容以前的版本,这就会导致程序编译错误等问题.或者当这个维护的第三方包删除了,那么B同学则不能下载到该包. 由上面的例子就能知道,为什么需要进行包的依赖管理了. go里面进行包依赖管理

  • Go语言包和包管理详解

    目录 1 包简介 1.1 工作空间 1.2 源文件 1.3 包命名 1.4 main 包 2导包 2.1 两种方式 2.2 包的别名 2.3 简洁模式 2.4非导入模式(匿名导入) 2.5 导包的路径 2.6 远程导入 3 初始化 init 3.1 init总结 4 包管理 4.1 演变过程 4.2 Go Model优点 4.3 启用go module 4.4 GOPROXY 5 go mod详解 5.1 go mod命令 5.2 go.mod说明 5.2.1 依赖的版本 5.2.2 repla

  • 使用go module导入本地包的方法教程详解

    go module 是Go1.11版本之后官方推出的版本管理工具,并且从 Go1.13 版本开始, go module 将是Go语言默认的依赖管理工具.到今天 Go1.14 版本推出之后 Go modules 功能已经被正式推荐在生产环境下使用了. 这几天已经有很多教程讲解如何使用 go module ,以及如何使用 go module 导入gitlab私有仓库,我这里就不再啰嗦了.但是最近我发现很多小伙伴在群里问如何使用 go module 导入本地包,作为初学者大家刚开始接触package的

  • go自动下载所有的依赖包go module使用详解

    今天在学习dubbo-go的时候,下载了dubbo-go的example,依赖的包太多了,之前都是手动下载某个依赖的包,现在手动一个一个 go get 那太麻烦了.因为我是搞java的,刚开始用go的时候感觉有点奇怪,go代码所依赖的所有的第三方库都放在GOPATH这个目录下面,这就导致了同一个库只能保存一个版本的代码.如果不同的项目依赖同一个第三方的库的不同版本,应该怎么解决?总不能改包名吧,看了一下 dubbo-samples/golang/的代码 发现了有个 go.mod文件,百度一下 g

  • Nginx丢弃http包体处理实例详解

    Nginx丢弃http包体处理实例详解 http框架丢弃http请求包体和上一篇文章http框架接收包体, 都是由http框架提供的两个方法,供http各个模块调用,从而决定对包体做什么处理.是选择丢弃还是接收,都是由模块决定的.例如静态资源模块,如果接收到来自浏览器的get请求,请求某个文件时,则直接返回这个文件内容给浏览器就可以了.没有必要再接收包体数据,get请求实际上也不会有包体.因此静态资源模块将调用http框架提供的丢弃包体函数进行丢包处理. 相比接收包体过程, 丢弃包体操作就简单很

  • JVM内存管理之JAVA语言的内存管理详解

    引言 内存管理一直是JAVA语言自豪与骄傲的资本,它让JAVA程序员基本上可以彻底忽略与内存管理相关的细节,只专注于业务逻辑.不过世界上不存在十全十美的好事,在带来了便利的同时,也因此引入了很多令人抓狂的内存溢出和泄露的问题. 可怕的事情还不只如此,有些使用其它语言开发的程序员,给JAVA程序员扣上了一个"不懂内存"的帽子,这着实有点让人难以接受.毕竟JAVA当中没有malloc和delete.没有析构函数.没有指针,刚开始接触JAVA的程序员们又怎么可能接触内存这一部分呢,更何况有不

  • python中seaborn包常用图形使用详解

    seaborn包是对matplotlib的增强版,需要安装matplotlib后才能使用. 所有图形都用plt.show()来显示出来,也可以使用下面的创建画布 fig,ax=plt.subplots() #一个画布 fig,(ax1,ax2) = plt.subplots( ncols=2) #两个画布 1)单个特征统计图countplot sn.countplot(train.mnth)#离散型特征可使用,描述样本点出现的次数. 2)单个特征统计图distplot sn.distplot(t

  • android studio编译jar包或者aar包的方法教程详解

    1. 在原有工程目录右键-> new ->Module->: 2. 选择library: 3. 一路next,最后finish: 4. 在新生成的lib module下的build.gradle中添加如下代码: task makeJar(type: Copy) { //删除存在的 delete 'build/outputs/aar/plugin-release.aar' delete 'libs/' //设置拷贝的文件来源 from('build/outputs/aar/') ////新

  • mysql-connector-java.jar包的下载过程详解

    mysql-connector-java.jar包的下载教程: 1.首先我们打开mysql的官网:https://www.mysql.com/ 2.点击选择DOWNLOADS选项: 3.点击选择Community选项: 4.在左侧选项卡中选择MySQL Connectors选项: 5.单击选择Connector/J选项: 6.在此处下拉选择Platform Independent 选项: 7.选择下载第二个即可: 8.最后选择No thanks,just start my download: 到

  • SpringBoot工程搭建打包、启动jar包和war包的教程图文详解

    工程搭建 1.File->new->project: 2.选择"Spring Initializr",点击next:(jdk1.8默认即可) 3.完善项目信息,组名可不做修改,项目名可做修改:最终建的项目名为:test,src->main->java下包名会是:com->example->test:点击next: 4.Web下勾选Spring Web Start,(网上创建springboot项目多是勾选Web选项,而较高版本的Springboot没

  • Springboot自动扫描包路径来龙去脉示例详解

    我们暂且标注下Springboot启动过程中较为重要的逻辑方法,源码对应的spring-boot-2.2.2.RELEASE版本 public ConfigurableApplicationContext run(String... args) { StopWatch stopWatch = new StopWatch(); stopWatch.start(); ConfigurableApplicationContext context = null; Collection<SpringBoo

随机推荐