【Golang】ローカル自作パッケージを使おうとすると「package XXX/ZZZZ is not in std」になる

はじまり#

リサちゃん

ちょっと、全然パッケージを使えないんですが・・・

135ml

新しいプログラミング言語の使い始めあるあるだな。

※当ページはアフィリエイト広告を利用しています。

想定する読者#

Go 言語を始めたての初心者

まず、何が起きてるんだ#

最近まで、 Python を書いていましたが、処理速度とメモリ節約に関する冒険がしたくなり、 Go を使い始めました。

そこで、自分で書いたローカルパッケージをmain.goなどで使おうとした時の話です。

話題のランタイム環境は、 Go 1.22.2 です。

はい、まずは憎きこのエラー文からです。

1
main.go:9:3: package mymodule/mypkg is not in std (/usr/local/go/src/mymodule/mypkg)

もしくは、 VSCode 上で表示されるこのエラー文。

1
could not import mymodule/mypkg (no required module provides package "mymodule/mypkg")

コイツらを乗り越えて、 Go を実行したい！

まずは結論から。#

結論としては、以下のディレクトリ構成で以下のようにファイルを設定すれば出来ました。

ディレクトリ構成:

1
mymodule
2
|--go.mod
3
|--go.sum
4
|--main.go
5
|--mypkg
6
|  |--tools.go

1
module mymodule
2

3
go 1.22.2
4

5
require (
6
  github.com/google/go-github v17.0.0+incompatible
7
  golang.org/x/oauth2 v0.19.0
8
)
9

10
require github.com/google/go-querystring v1.1.0 // indirect

1
package main
2

3
import (
4
    "fmt"
5

6
    "mymodule/mypkg"
7

8
    "github.com/google/go-github/github"
9
  "golang.org/x/oauth2"
10
)
11

12
// ...略
13

14
func main() {
15
    fmt.Println(mypkg.Hello())
16
}

1
package my
2

3
// ...略
4

5
func Hello() string {
6
    return "Hello, world!"
7
}

そして、内部パッケージを導入する際には、以下の4点に気を付ければ良いのかなと思いました。

• 自作パッケージの中のファイル名は何でも良い: mypkgディレクトリ内にあるファイル名はtools.goですし、そのファイルのpackage文にmypkgは書いてありません。しかし、プログラムとしては問題なく動きます。ビルドしても動きます。
• 自作パッケージの中にgo.modは不要である: 自作パッケージのディレクトリにgo.modが無ければ、親ディレクトリを見に行きます。モジュール全体で必要な外部パッケージが分からなくなるので、go.modはルートディレクトリだけに置かれるのが良さそうだと思いました。
• go.mod内のmoduleの値が重要である: ここのモジュール名から、直下のサブディレクトリを参照していきます。
• main.goのimport文にはディレクトリ名を書く: 僕の場合はファイル名を書いていて沼りました。

自作パッケージを使用するまでの手順#

それでは、細かいところを手順立てていきましょう。

1
package my
2

3
// ...略
4

5
func Hello() string {
6
    return "Hello, world!"
7
}

1
package main
2

3
import (
4
    "fmt"
5

6
    "mymodule/mypkg"
7

8
    "github.com/google/go-github/github"
9
  "golang.org/x/oauth2"
10
)
11

12
// ...略
13

14
func main() {
15
    fmt.Println(mypkg.Hello())
16
}

1
go: cannot determine module path for source directory /home/username/mymodule (outside GOPATH, module path must be specified)
2

3
Example usage:
4
    'go mod init example.com/m' to initialize a v0 or v1 module
5
    'go mod init example.com/m/v2' to initialize a v2 module
6

7
Run 'go help mod init' for more information.

1
go mod init mymodule

1
go: creating new go.mod: module mymodule
2
go: to add module requirements and sums:
3
    go mod tidy

1
go mod tidy

1
module mymodule
2

3
go 1.22.2
4

5
require (
6
  github.com/google/go-github v17.0.0+incompatible
7
  golang.org/x/oauth2 v0.19.0
8
)
9

10
require github.com/google/go-querystring v1.1.0 // indirect

まとめ#

Go 言語でローカルの自作パッケージをインポートする方法を紹介しました。以下にポイントをまとめます。

• 自作パッケージの中のファイル名とpackage名は、適当に付けても動くことは動く。
• 自作パッケージの中にgo.modは不要である
• go.mod内のmoduleの値およびgo mod initの引数が重要である。
• main.goのimport文にはディレクトリ名を書く。

この内部パッケージのインポートの作業でかなり時間を無駄にしたので、同じように無駄にする人が一人でも減れば嬉しいですね・・・！

プログラミングのお供に#

おしまい#

リサちゃん

いっつもこういう所に詰まるんだよなあ～！！

135ml

動かせてしまえればコッチのもの。

以上になります！