>  기사  >  백엔드 개발  >  Go 모듈이란 무엇입니까? 그것을 사용하는 방법? (사용 예 포함)

Go 모듈이란 무엇입니까? 그것을 사용하는 방법? (사용 예 포함)

藏色散人
藏色散人앞으로
2022-01-12 16:02:395394검색

이 글은 golang튜토리얼 칼럼에서 Go 모듈 사용법을 소개하기 위해 쓴 글입니다. 필요한 친구들에게 도움이 되었으면 좋겠습니다!

go 모듈 사용법

go 모듈은 go 1.14 버전 이후에 출시되었습니다

1. Go 모듈 사용법 소개

go 모듈은 Go 1.11 버전 이후에 출시된 공식 버전 관리 도구이며, Go1.13 버전부터 go 모듈이 Go 언어의 기본 종속성 관리 도구가 됩니다. go module是Go1.11版本之后官方推出的版本管理工具,并且从Go1.13版本开始,go module将是Go语言默认的依赖管理工具。

1.1 GO111MODULE

要启用go module支持首先要设置环境变量GO111MODULE,通过它可以开启或关闭模块支持,它有三个可选值:offonauto,默认值是auto

  • GO111MODULE=off禁用模块支持,编译时会从GOPATHvendor文件夹中查找包。

  • GO111MODULE=on启用模块支持,编译时会忽略GOPATHvendor文件夹,只根据 go.mod下载依赖,将依赖下载至%GOPATH%/pkg/mod/ 目录下。

  • GO111MODULE=auto,当项目在$GOPATH/src外且项目根目录有go.mod文件时,开启模块支持。

简单来说,设置GO111MODULE=on之后就可以使用go module了,以后就没有必要在GOPATH中创建项目了,并且还能够很好的管理项目依赖的第三方包信息。

使用 go module 管理依赖后会在项目根目录下生成两个文件go.modgo.sum

1.2 GOPROXY

Go1.11之后设置GOPROXY命令为:

export GOPROXY=https://goproxy.cn

Go1.13之后GOPROXY默认值为https://proxy.golang.org,在国内是无法访问的,所以十分建议大家设置GOPROXY,这里我推荐使用goproxy.cn。

go env -w GOPROXY=https://goproxy.cn,direct

1.3 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         解释为什么需要依赖

1.4 go.mod

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

module github.com/Q1mi/studygo/blogger

go 1.12

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表示间接引用

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

1.4.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
)

1.5 go get

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

  1. 运行go get -u将会升级到最新的次要版本或者修订版本(x.y.z, z是修订版本号, y是次要版本号)
  2. 运行go get -u=patch将会升级到最新的修订版本
  3. 运行go get package@version将会升级到指定的版本号version

如果下载所有依赖可以使用go mod download命令。

1.6 整理依赖

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

1.7 go mod edit

格式化

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

go mod edit -fmt

添加依赖项

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

移除依赖项

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

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

关于go mod edit的更多用法可以通过go help mod edit查看。

1.8 在项目中使用go module

1.8.1 既有项目

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

  1. 在项目目录下执行go mod init,生成一个go.mod文件。
  2. 执行go get,查找并记录当前项目的依赖,同时生成一个go.sum

    1.1 GO111MODULE

  3. go 모듈 지원을 활성화하려면 먼저 환경 변수 GO111MODULE를 설정해야 하며 이를 통해 모듈 지원을 켜거나 끌 수 있습니다. . 세 가지 옵션이 있습니다. 선택 값: off, on, auto, 기본값은 auto입니다.
  • GO111MODULE=off는 모듈 지원을 비활성화하고 GOPATH에서 컴파일합니다. Vendor 폴더에 패키지를 넣으세요.

  • GO111MODULE=on 모듈 지원을 활성화합니다. GOPATHvendor 폴더는 컴파일 시 go .mod%GOPATH%/pkg/mod/ 디렉터리에 종속성을 다운로드합니다. 🎜🎜
  • 🎜GO111MODULE=auto, 프로젝트가 $GOPATH/src 외부에 있고 go.mod 파일이 있는 경우 프로젝트 루트 디렉터리, 모듈 지원을 활성화합니다. 🎜🎜
🎜간단히 GO111MODULE=on을 설정한 후 go 모듈을 사용할 수 있으며, 앞으로는 GOPATH에서 프로젝트를 생성할 필요가 없습니다. 또한 프로젝트가 의존하는 타사 패키지 정보를 잘 관리할 수 있습니다. 🎜🎜go 모듈을 사용하여 종속성을 관리하면 프로젝트 루트 디렉터리에 go.modgo.sum 두 파일이 생성됩니다. 🎜

1.2 GOPROXY

🎜Go1.11 이후에는 GOPROXY 명령을 다음과 같이 설정합니다. 🎜
moduledemo
├── go.mod
├── main.go
└── mypackage
    └── mypackage.go  // package mp 定义包名为 mp
🎜Go1.13 이후에는 GOPROXY의 기본값은 https://입니다. Proxy.golang.org 는 중국에서 접속이 불가능하므로 GOPROXY를 설정하시는 것을 적극 권장합니다. 여기서는 goproxy.cn을 사용하는 것을 권장합니다. 🎜
module moduledemo  // 设定 moduledemo 为包根目录名,可以随意改变该名字,只需要导入时一致就好
go 1.14  // 表明版本

1.3 go mod 명령

🎜일반적으로 사용되는 go mod 명령은 다음과 같습니다. 🎜
import "moduledemo/mypackage"  // 这里是导入包目录下的包文件名

1.4 go.mod

🎜go.mod 파일은 모든 것을 기록합니다. 프로젝트 정보 패키지 및 버전 🎜
  • indirect의 종속성 정보는 간접 참조를 의미합니다. 🎜🎜1.4.1 종속 버전 🎜🎜go mod는 와 같은 의미 체계 버전 번호를 지원합니다. go get foo@v1.3, go get foo@master와 같은 git 브랜치나 태그를 따를 수도 있습니다. 물론 foo@e3702bed2로 이동하세요. 종속 버전과 관련하여 다음 형식이 지원됩니다. 🎜
    mp.MyPackage()  // 使用包中的 MyPackage() 函数
    🎜1.4.2 교체🎜🎜중국에서 golang.org/x에 액세스하는 각 패키지를 우회해야 합니다. go.mod에서 교체를 사용하여 해당 패키지로 교체할 수 있습니다. 깃허브. 🎜
    ├── moduledemo
    │   ├── go.mod
    │   └── main.go
    └── mypackage
        ├── go.mod
        └── mypackage.go  // package mp 定义包名为 mp

    1.5 go get

    🎜프로젝트에서 go get 명령을 실행하여 종속성 패키지를 다운로드할 수 있으며, 다운로드한 버전을 지정할 수도 있습니다. 🎜
    1. go get -u를 실행하면 최신 마이너 버전 또는 개정판으로 업그레이드됩니다(x.y.z, z는 개정 번호, y는 마이너 버전 번호)🎜
    2. 실행 중 go get -u=patch는 최신 버전으로 업그레이드됩니다🎜
    3. go get package@version을 실행하면 지정된 버전 번호로 업그레이드됩니다🎜 🎜🎜다운로드하려면 모든 종속성이 있는 경우 go mod download 명령을 사용할 수 있습니다. 🎜

      1.6 종속성 구성

      🎜코드에서 종속 코드를 삭제한 후에도 관련 종속 라이브러리는 go.mod 파일에서 자동으로 제거되지 않습니다. 이 경우 go mod tidy 명령을 사용하여 go.mod의 종속성을 업데이트할 수 있습니다. 🎜

      1.7 go mod 편집

      🎜Formatting🎜🎜go.mod 파일을 수동으로 수정할 수 있기 때문에 때로는 파일 포맷이 필요할 때가 있습니다. Go는 다음 명령을 제공합니다. 🎜
      module mypackage
      
      go 1.14
      🎜종속성 추가🎜
      module moduledemo
      
      go 1.14
      
      
      require mypackage v0.0.0  // 这个会在你执行 go build 之后自动在该文件添加
      replace mypackage => ../mypackage  // 指定需要的包目录去后面这个路径中寻找
      🎜종속성 제거🎜🎜go.mod 파일의 내용만 수정하려면 go mod edit를 실행할 수 있습니다. droprequire=패키지 경로, 예를 들어 go.mod에서 golang.org/x/text 패키지를 제거하려면 다음 명령을 사용할 수 있습니다. 🎜
      import "mypackage"  // 因为该包目录本身就是包文件所以无需添加下一级路径
      
      mp.MyPackage()  // 使用包中的 MyPackage() 函数
      🎜정보 go mod edit의 더 많은 사용법은 go help mod edit를 통해 확인할 수 있습니다. 🎜

      1.8 프로젝트에서 go 모듈 사용

      🎜1.8.1 기존 프로젝트🎜🎜기존 프로젝트에 대해 go 모듈을 활성화해야 하는 경우 다음 단계를 따르세요. 🎜
    4. 프로젝트 디렉터리에서 go mod init를 실행하여 go.mod 파일을 생성합니다. 🎜
    5. go get을 실행하여 현재 프로젝트의 종속성을 찾아 기록하고 go.sum을 생성하여 각 종속 라이브러리의 버전과 해시 값을 기록합니다. 🎜🎜🎜1.8.2 새 프로젝트🎜🎜새로 생성된 프로젝트의 경우 프로젝트 폴더 아래에서 다음 단계를 수행할 수 있습니다.🎜
      1. 执行go mod init 项目名命令,在当前项目文件夹下创建一个go.mod文件。
      2. 手动编辑go.mod中的require依赖项或执行go get自动发现、维护依赖。

      二、包和调用文件在同一项目下

      例如:

      moduledemo
      ├── go.mod
      ├── main.go
      └── mypackage
          └── mypackage.go  // package mp 定义包名为 mp

      步骤:

      1.在项目下创建一个 go.mod 文件,文件名只能为这个。

      2.在 go.mod 文件中添加以下代码

      module moduledemo  // 设定 moduledemo 为包根目录名,可以随意改变该名字,只需要导入时一致就好
      go 1.14  // 表明版本

      3.导入想要的包文件

      import "moduledemo/mypackage"  // 这里是导入包目录下的包文件名

      4.使用包文件

      mp.MyPackage()  // 使用包中的 MyPackage() 函数

      三、包和被调用文件不在同一个项目下

      例如:

      ├── moduledemo
      │   ├── go.mod
      │   └── main.go
      └── mypackage
          ├── go.mod
          └── mypackage.go  // package mp 定义包名为 mp

      步骤

      1.在 mypackage 下面创建 go.mod 文件,并添加以下代码

      module mypackage
      
      go 1.14

      2.在 moduledemo 下面创建 go.mod 文件,并添加以下代码

      module moduledemo
      
      go 1.14
      
      
      require mypackage v0.0.0  // 这个会在你执行 go build 之后自动在该文件添加
      replace mypackage => ../mypackage  // 指定需要的包目录去后面这个路径中寻找

      3.导入和使用

      import "mypackage"  // 因为该包目录本身就是包文件所以无需添加下一级路径
      
      mp.MyPackage()  // 使用包中的 MyPackage() 函数
  • 위 내용은 Go 모듈이란 무엇입니까? 그것을 사용하는 방법? (사용 예 포함)의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

    성명:
    이 기사는 segmentfault.com에서 복제됩니다. 침해가 있는 경우 admin@php.cn으로 문의하시기 바랍니다. 삭제