How to use golang module

With the development of Go language, more and more people are starting to use Go language for development, and as the scale and complexity of projects increase, we need to better organize our code. This is why Go 1.11 and later introduced the concept of modules. This article will introduce how to use Go modules to manage our projects and dependencies.

1. What is a Go module

In the Go language, a package is the basic unit of code organization. Contains a set of related function, variable, or type definitions. In a project, we may use many packages. However, managing the versions and dependencies of these packages is very difficult. The module introduced in Go 1.11 is to solve this problem.

Simply put, a module is a collection of code packages that contains source code, dependencies and version information. A module can reference other modules or other versions of its own module.

2. How to use Go module

1. Create a new module

To create a new Go module project, it needs to be in your working directory Execute the following command:

$ go mod init example.com/hello

This command will create a new module in the current directory and name it example.com/hello. The way Go resolves dependencies is by locating them via URLs, so module names need to be unique.

If your project is already in a directory outside the GOPATH directory, you need to set your environment variable GO111MODULE=on# before executing the above command. ##, as shown below:

$ export GO111MODULE=on

Add dependencies

The way to add dependencies in a module is to run the following command:

$ go get example.com/dependency

This The command will download the latest

dependency package from example.com and add it to your project. If this package depends on other packages, they will also be automatically downloaded.

You can also specify a specific version, as follows:

$ go get example.com/dependency@v1.1.0

This command will download the

dependency package with version v1.1.0.

Modify dependencies

If you need to switch the version of a dependency or modify the code of a dependency, you only need to modify the

go.mod file. Can.

For example, if you want to switch the version of the

dependency package to v1.2.0, you can manually modify it in the go.mod file:

module example.com/hello

require example.com/dependency v1.2.0

Then run the following command to update the dependencies:

$ go mod tidy

This command will automatically update the dependencies and delete no longer used dependencies from the

go.sum file item.

Rebuilding the module

In your code, you can use functions and types from dependencies.

When you make changes to your code, you need to rebuild your modules so that Go can recompile them. Just execute the following command:

$ go build

If your code contains tests, you can run the tests with the following command:

$ go test -v

Publish module

When you are ready to publish your module, you need to give your module a tag. Execute the following command:

$ git tag v1.0.0

Then push the tag to the remote repository:

$ git push --tags

When others want to use your module, they only need to add your module as a dependency:

module example.com/using_hello

require example.com/hello v1.0.0

They can run the

go get command as described in the previous section to download your module.

In short, Go modules provide us with a simple way to manage dependencies and versions. It provides a better structure for our projects and can also help with the reusability and maintainability of our code. If you haven’t tried using Go modules to organize your projects, now is the time to start.

The above is the detailed content of How to use golang module. For more information, please follow other related articles on the PHP Chinese website!