Why Am I Getting the 'package XXX is not in GOROOT' Error in My Go Project?

"package XXX is not in GOROOT" Error in Go Projects

This error often occurs when trying to build or run a Go project and encounters the following scenario:

• The project is structured as follows:

  src/
  |--project
     |--game
         |--entity
             |--whatever.go
         |--game_stuff.go
     |--server

• GOROOT is set to the correct path (e.g., C:Go).

Cause

In recent versions of Go (post 1.13), setting environment variables like GOPATH and GOBIN is no longer necessary. Instead, the project should contain a go.mod file at its root, which denotes it as a Go module.

Resolution

To resolve this issue, follow these steps:

1. Create a go.mod file: In the project root directory, run go mod init [remote-repo.com/username/repository].
2. Define the main package: Within the go.mod file, specify the package path of the main package (e.g., github.com/yourname/calculatorv3) and its main file (e.g., main.go).
3. Remove obsolete environment variables: If you had previously set GOPATH and GOBIN, delete or comment out those lines from your environment configuration.
4. Rebuild or run the project: Rerun the go build or go run command, which will now correctly recognize the project's structure and build or run the appropriate package.

Example

For the sample project structure provided:

1. Create a go.mod file in the project root directory and include the following:

   module github.com/myorg/myproject
   
   go 1.17
   
   require (
    github.com/myorg/gameutils v1.2.3
   )

2. Ensure that main.go is located in the project/server directory.

3. Remove or comment out obsolete environment variables:

   # GOPATH=$HOME/go  # Assuming previous GOPATH setting

4. Rerun go build -o server project/server to build the project.

Additional Notes

• If the project uses external packages, make sure they are installed using go get or go mod tidy.
• If the error still persists, try clearing the Go cache using go clean -modcache.

The above is the detailed content of Why Am I Getting the 'package XXX is not in GOROOT' Error in My Go Project?. For more information, please follow other related articles on the PHP Chinese website!