メソッド＠Go¶
はじめに¶
本サイトにつきまして、以下をご認識のほど宜しくお願いいたします。
01. 関数の種類¶
実行タイミング¶
import、const、var、init関数の順で実行する。
init関数¶
▼ init関数とは¶
パッケージをimportしたタイミングで実行する。
main.goファイル上で使用すればmain関数より先に、それ以外のパッケージで使用すればそのパッケージ上の関数で一番最初に実行できる。
なお、init関数はinit.goファイルとして切り分けた方が良い。
▼ logパッケージは使用できない¶
仕様上、init関数内でlogパッケージを使用できない。
main関数¶
▼ main関数とは¶
goのエントリーポイントとなる。
goのプログラムが起動した時に、各パッケージのinit関数が実行された後、main関数が実行される。
main関数をビルド対象に指定すると、これを開始点として読み込まれるファイルが枝分かれ状にビルドされていく。
ステータス『0』でプロセスを終了する。
＊実装例＊
package main
import "fmt"
func main() {
log.Printf("%v", "Hello world!")
}
当然、mainパッケージやmain関数が無いと、goのプログラムの起動時にエラーが発生する。
$ go run server.go
go run: cannot run non-main package
$ go run server.go
# command-line-arguments
runtime.main: call to external function main.main
runtime.main: main.main: not defined
runtime.main: undefined: main.main
▼ 処理の終え方¶
panic関数は、プロセスを強制的に終了する。
defer関数があれば、panic関数の前にこれを実行する。
一番強い終了方法であり、基本的にはdefer関数とrecover関数と組み合わせて使用する。
package main
func main() {
...
if err != nil {
panic(err)
}
...
}
Exit関数は、設定した終了コード (0以外) でプロセスを強制的に終了する。
一般的な強制終了方法である。
defer関数があても、これを実行せずにプロセスを終了する。
package main
import "os"
func main() {
...
if err != nil {
os.Exit(1)
}
...
}
Goexit関数は、プロセスを強制的に終了する。
defer関数があれば、panic関数の前にこれを実行する。
また、Goroutineがあればこれを待つ。
main関数では実行しない方が良い。
package main
import "runtime"
func main() {
...
if err != nil {
runtime.Goexit()
}
...
}
- https://blog.logicoffee.tech/posts/programming/golang-exit.html
- https://budougumi0617.github.io/2021/06/30/which_termination_method_should_choose_on_go/#go%E3%81%A7%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%A0%E3%82%92%E7%B5%82%E4%BA%86%E3%81%95%E3%81%9B%E3%82%8B%E6%96%B9%E6%B3%95
- https://qiita.com/nayuneko/items/9534858156dfd50b43fb#panic%E3%82%92%E3%83%AA%E3%82%AB%E3%83%90%E3%83%BC%E3%81%99%E3%82%8Brecoverdefer
- https://qiita.com/nayuneko/items/9534858156dfd50b43fb#panic%E3%82%92%E3%83%AA%E3%82%AB%E3%83%90%E3%83%BC%E3%81%99%E3%82%8Brecoverdefer
自前関数¶
▼ 関数とは¶
構造体に紐付けられていない関数のこと。
＊実装例＊
package main
import "fmt"
// 頭文字を大文字する
func Foo(foo string) {
fmt.Println(foo)
}
func main() {
Foo("Hello world!")
}
▼ 関数名の取得¶
runtime.Caller(1)から、ランタイムの情報を取得できる。
これを使用して、現在実行中の関数名を取得する。
構造体の関数で実行すれば、関数名を取得できる。
package main
import (
"fmt"
"log"
"runtime"
)
// 関数名を取得する
// ここでは構造体がいないため、関数名を取得すると仮定する
func GetCurrentFunctionName() string {
// 他に実行中ファイルや行数も取得できる
// @see https://pkg.go.dev/runtime#Caller
pc, _, _, ok := runtime.Caller(1)
if !ok {
log.Print("Failed to get function name")
return "unknown"
}
fn := runtime.FuncForPC(pc)
if fn == nil {
log.Print("Failed to get function name")
return "unknown"
}
return fn.Name()
}
func foo() {
fmt.Print(GetCurrentFunctionName())
}
func main() {
foo()
}
// main.foo
▼ 現在のモジュール名の取得¶
debug.ReadBuildInfo()を使用して、現在実行中のモジュール名を取得する。
package main
import (
"fmt"
"log"
"runtime/debug"
)
func GetCurrentModuleName() string {
info, ok := debug.ReadBuildInfo()
if !ok {
log.Print("Failed to read build info")
return "unknown"
}
return info.Path
}
func main() {
fmt.Print(GetCurrentModuleName())
}
// 以下のパッケージ名とする
-- go.mod --
module example.com/foo
▼ 引数の型¶
引数の型として、構造体の場合はポインタ型、それ以外のデータの場合はポインタ型以外が推奨される。
▼ クロージャー (無名関数) とは¶
名前のない関数のこと。
▼ 即時関数とは¶
定義したその場でコールされる無名関数のこと。
＊実装例＊
main関数で即時関数を実行する。
package main
import "log"
func main() {
result := func() string {
return "Closure is working!"
}()
log.Printf("%v", result)
}
＊実装例＊
即時関数に引数を設定できる。
その場合、仮引数と引数の両方を設定する必要がある。
package main
import "log"
func main() {
// 仮引数を設定
result := func(x string) string {
return x
}("Closure is working!") // 引数に値を渡す
log.Printf("%v", result)
}
メソッド¶
▼ メソッドとは¶
データ型や型リテラルに紐付けられている関数のこと。
Goは、言語としてオブジェクトという機能を持っていないが、構造体に関数を紐付けることにより、擬似的にオブジェクトを表現できる。
▼ レシーバによる紐付け¶
データ型や型リテラルなどを関数のレシーバとして渡すことによって、それに関数を紐付けられる。
紐付け後、関数はメソッドとも呼ばれるようになる。
メソッド名とフィールド名に同じ名前は使用できない。
＊実装例＊
integer型を値レシーバとして渡し、構造体に関数を紐付ける。
package main
import "log"
type Age int
func (a Age) PrintAge() string {
return fmt.Sprintf("%dです。", a)
}
func main() {
var age Age = 20
log.Printf("%v", age.printAge())
}
＊実装例＊
構造体を値レシーバとして渡し、構造体に関数を紐付ける。
package main
import "log"
// 構造体を定義
type Person struct {
name string
}
// コンストラクタ
func NewPerson(name string) *Person {
return &Person{
name: name,
}
}
// 構造体に関数を紐付ける。
func (p Person) GetName() string {
return p.name
}
// 構造体から関数をコール
func main() {
// 構造体を初期化
person := NewPerson("Hiroki")
log.Printf("%v", person.GetName()) // "Hiroki"
}
▼ 値レシーバ¶
構造体の実体と関数を直接的に紐付ける。
紐付け後、関数はメソッドと呼ばれるようになる。
レシーバとして渡された引数をメソッド内でコピーしてから使用する。
値レシーバによって紐付けられると、そのメソッドは構造体の状態を変えられなくなるため、構造体をイミュータブルにしたい場合は、値レシーバを使用すると良い。
＊実装例＊
構造体を値レシーバとして渡し、構造体に関数を紐付ける。
package main
import "log"
type Person struct {
name string
}
// コンストラクタ
func NewPerson(name string) *Person {
return &Person{
name: name,
}
}
// 値レシーバ
func (p Person) SetName(name string) {
// 引数の構造体をコピーしてから使用
p.name = name
}
func (p Person) GetName() string {
return p.name
}
func main() {
person := NewPerson("Gopher")
person.SetName("Hiroki")
log.Printf("%v", person.GetName()) // "Gopher"
}
▼ ポインタレシーバ¶
構造体のポインタを使用して、関数と構造体の実体を紐付ける。
紐付け後、関数はメソッドと呼ばれるようになる。
レシーバとして渡された引数をメソッド内でそのまま使用する。
ポインタレシーバによって紐付けられると、そのメソッドは構造体の状態を変えられるようになるため、構造体をミュータブルにしたい場合は、ポインタレシーバを使用すると良い。
構造体を初期化する処理を持つコンストラクタ関数のみをポインタレシーバとし、他のメソッドを全て値レシーバとすると、最低限にミュータブルなプログラムを実装できる。
また、構造体はポインタ型として扱った方がメモリを節約できる。
＊実装例＊
package main
import "log"
type Person struct {
Name string
}
// ポインタレシーバ
func (p *Person) SetName(name string) {
// 引数の構造体をそのまま使用
p.Name = name
}
func (p *Person) GetName() string {
return p.Name
}
func main() {
person := Person{Name: "Gopher"}
person.SetName("Hiroki")
log.Printf("%v", person.GetName()) // "Hiroki"
}
defer関数¶
▼ defer関数とは¶
特定の関数の最後に必ず実行される遅延実行関数のこと。
たとえ、ランタイムエラーのように処理が強制的に途中終了しても、その関数の最後に実行される。
▼ 複数のdefer関数¶
deferは複数の関数で宣言できる。
複数宣言した場合、後に宣言されたものから実行される。
＊実装例＊
package main
import "fmt"
func main() {
fmt.Println("Start")
defer fmt.Println("1")
defer fmt.Println("2")
defer fmt.Println("3")
fmt.Println("End")
}
// Start
// 3
// 2
// 1
// End
▼ ロギング処理¶
package main
import (
"fmt"
"log"
)
func main() {
fmt.Println("Start")
// 事後処理
defer func() {
log.Printf("End")
}()
fmt.Println("Processing...")
}
▼ リカバリー処理¶
recover関数を実行すると、panicになったその処理のみを終了し、他の並行処理を実行し続けられる。
即時関数をdefer関数化している。
処理の最後にランタイムエラーが発生したとき、これをrecover関数で吸収できる。
＊実装例＊
package main
import "fmt"
func main() {
fmt.Println("Start")
// 事後処理
defer func() {
// リカバリー処理を実行する
err := recover()
if err != nil {
log.Printf("Failed to run application: %v", err)
}
fmt.Println("End")
}()
// ここで意図的に処理を停止させている。
panic("Runtime error")
}
// Start
// Recover: "Runtime error"
// End
▼ Close処理¶
import¶
▼ 通常のインポート¶
package main
import "<パッケージ名>"
▼ ブランクインポート¶
パッケージ内のinit関数のみを実行したい場合がある。
この場合、パッケージ名を_で宣言する。
package main
import _ "<パッケージ名>" // init関数のみを実行する
01-02. 関数の出入力¶
Variadic Functions (可変個引数関数)¶
要素数が自由なslice型を引数とした場合、可変な引数を定義できる。
関数に渡す場合は、アンパック (...) する。
package main
import (
"fmt"
)
// 可変な引数
func showSlice(args ...int) {
for index, value := range args {
fmt.Printf("s[%d] = %d\n", index, value)
}
}
func main() {
// sliceを定義する
// 要素数はいくつでもよい
val := []int{1, 2, 3, 4, 5}
// 変数をアンパックして渡す
showSlice(val...)
// 個別に渡しても同じ
showSlice(1, 2, 3, 4, 5)
}
引数のデフォルト値¶
▼ Functional Options Pattern¶
Functional Options Patternを使用して、引数のデフォルト値を実現する。
このパターンでは、可変個引数関数の引数に『デフォルト値を設定する関数』を渡す。
package main
// Optionという関数型を定義する
type Option func (*Server)
// デフォルト値を設定する関数を返却する
func Timeout (t int) Option {
// 無名関数
return func (s *Server) {
s.Timeout = time.Duration(t) * time.Second
}
}
func NewServer(addr string, options ...Option) (*Server, error) {
l, err := net.Listen("tcp", addr)
if err != nil {
return nil, err
}
srv := Server{
listener: l,
}
for _, option := range options {
// Server構造体を渡す
// タイムアウト値を設定する
option(&srv)
}
return &srv, nil
}
func main() {
...
srv, err := NewServer(
"localhost",
// Timeout関数を引数に渡す
Timeout(30),
)
...
}
▼ append関数によるマージ¶
可変個引数関数にて、使用側で設定したパラメーターと関数内部で設定したパラメーターをappend関数でマージする。
両方のパラメーターはslice型であるため、append関数でマージできる。
パラメーターとappend関数の返却値の両方のsliceを、アンパック (...) する必要がある。
＊実装例＊
package middleware
import (
"fmt"
"net/http"
"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
"go.opentelemetry.io/otel/trace"
)
func HttpServerMiddleware(next http.Handler, opts ...otelhttp.Option) http.Handler {
return otelhttp.NewHandler(
next,
"foo-service",
append(opts, []otelhttp.Option{
// デフォルト値
filterHealthCheck(),
WithSpanNameFormatter(),
}...)...,
)
}
// ヘルスチェックパスではスパンを作成しない
func filterHealthCheck() otelhttp.Option {
return otelhttp.WithFilter(filters.All(filters.Not(filters.Path("/health"))))
}
// スパン名を作成する関数を設定する
func WithSpanNameFormatter() otelhttp.Option {
return otelhttp.WithSpanNameFormatter(func(operation string, r *http.Request) string {
// URLパスをスパン名とする
spanName := r.URL.Path
if spanName == "" {
spanName = fmt.Sprintf("HTTP %s route not found", r.Method)
}
return spanName
})
}
＊実装例＊
package middleware
import (
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc/filters"
"google.golang.org/grpc"
grpc_recovery "github.com/grpc-ecosystem/go-grpc-middleware/recovery"
)
// リクエストを単位としてスパンを自動的に開始/終了する
func ChainUnaryServerInterceptor(opts ...otelgrpc.Option) grpc.ServerOption {
return grpc.ChainUnaryInterceptor(
grpc_recovery.UnaryServerInterceptor(),
otelgrpc.UnaryServerInterceptor(
append(opts, []otelgrpc.Option{
// デフォルト値
InterceptorFilterHealthCheck(),
}...)...,
),
)
}
// リクエストを単位としてスパンを自動的に開始/終了する
func ChainStreamServerInterceptor(opts ...otelgrpc.Option) grpc.ServerOption {
return grpc.ChainStreamInterceptor(
grpc_recovery.StreamServerInterceptor(),
otelgrpc.StreamServerInterceptor(
append(opts, []otelgrpc.Option{
// デフォルト値
InterceptorFilterHealthCheck(),
}...)...,
),
)
}
// ヘルスチェックパスではスパンを作成しない
func InterceptorFilterHealthCheck() otelgrpc.Option {
return otelgrpc.WithInterceptorFilter(filters.Not(filters.HealthCheck()))
}
返却値¶
▼ 複数の返却値¶
＊実装例＊
package main
import "fmt"
func division(x int, y int) (int, int) {
// 商を計算する。
quotient := x / y
// 余りを計算する。
remainder := x % y
// 商と余りを返却する。
return quotient, remainder
}
func main() {
// 10÷3を計算する。
q, r := division(10, 3)
log.Printf("商=%d、余り=%d", q, r)
}
▼ 返却値の破棄¶
関数から複数の値が返却される時、使用しない値をアンダースコアに代入することにより、これを破棄できる。
＊実装例＊
package main
import (
"fmt"
"os"
)
func main() {
// errorインターフェースを破棄
file, _ := os.Open("filename.txt")
// エラーキャッチする必要がなくなる
log.Printf("%v", file)
}
▼ 関数の返却¶
引数型と返却型を指定して、関数を返却できる。
＊実装例＊
http.Handlerを引数型、http.Handlerを返却型、として設定する。
func FooMiddleware() func(http.Handler) http.Handler {
// Handlerインターフェースを実装する関数を定義する
fn := func(w http.ResponseWriter, r *http.Request) {
// ミドルウェア処理
// そのまま実装すると事前処理になる
// deferを使用すると事後処理になる
// 本来の処理
next.ServeHTTP(w, r)
}
// Handlerインターフェースの実装をHandlerFunc型に変換する
return http.HandlerFunc(fn)
}
01-03. エラー時の事後処理¶
Graceful Shutdown処理¶
▼ Graceful Shutdown処理とは¶
プロセスの終了前に必ず実行したい関数をまとめてコールし、安全にプロセスを終了する仕組みである。
例えば、トランザクション中にエラーが起こった場合に、トランザクションの完了を待ってからプロセスを終了する。
関数の実行時とは逆順で、Graceful Shutdown処理を実行する。
▼ 外部パッケージからコールする¶
多くのパッケージでは、パッケージの処理をGraceful Shutdownするように実装している。
ここでは、github.com/gorilla/muxパッケージのサーバーを使用すると仮定する。
package main
import (
"context"
"log"
"net/http"
"os/signal"
"syscall"
"github.com/gorilla/mux"
)
func main() {
// 割り込み処理を設定する
ctx, stop := signal.NotifyContext(
context.Background(),
// SIGTERMシグナル
syscall.SIGTERM,
// 中断シグナル
os.Interrupt,
// Killシグナル
os.Kill,
)
defer stop()
srv := &http.Server{
Addr: port,
Handler: mux,
}
// Goroutineでサーバーを起動する
go func() {
if err := srv.ListenAndServe(); err != nil {
log.Print(err)
}
}()
// もし割り込み処理が実行されると、Goroutineが終了する
// Done()で、Goroutineの終了を検知する
<-ctx.Done()
// 割り込み処理の実行後から強制終了までの時間を設定する
ctx, cancel := context.WithTimeout(
context.Background(),
5 * time.Second,
)
// タイムアウト時間経過後に処理を中断する
defer cancel()
// Graceful Shutdown処理を実行する
err = srv.Shutdown(ctx)
if err != nil {
return err
}
}
▼ 自前で実装する場合¶
たとえ、ランタイムエラーのように処理が強制的に途中終了しても、全ての関数の最後に実行される。
- 実行したい関数を追加する関数
- 追加した関数を並行的にコールする関数
を用意する必要がある。
＊実装例＊
package main
import (
"shutdown"
)
func main()
shutdown.Add(func(ctx context.Context) {
fmt.Println("start hook1")
time.Sleep(3 * time.Second)
fmt.Println("end hook1")
})
shutdown.Add(func(ctx context.Context) {
fmt.Println("start hook2")
time.Sleep(3 * time.Second)
fmt.Println("end hook2")
})
shutdown.Add(func(ctx context.Context) {
fmt.Println("start hook3")
time.Sleep(5 * time.Second)
fmt.Println("end hook3")
})
// タイムアウト時間を設定し、コンテキストを作成する
ctx, cancel := context.WithTimeout(
context.Background(),
5 * time.Second,
)
// タイムアウト時間経過後に処理を中断する
defer cancel()
shutdown.Invoke(ctx)
}
package shutdown
import (
"context"
"sync"
)
var (
mu sync.Mutex
hooks []func(context.Context)
)
// 実行したい関数を追加する関数
func Add(h func(ctx context.Context)) {
mu.Lock()
defer mu.Unlock()
hooks = append(hooks, h)
}
// 追加した関数を並行的にコールする関数
func Invoke(ctx context.Context) error {
mu.Lock()
defer mu.Unlock()
wg := new(sync.WaitGroup)
wg.Add(len(hooks))
// Goroutineの関数を反復処理する
for i := range hooks {
// Goroutineを宣言して並行化
go func(i int) {
// 時間のかかる処理
defer wg.Done()
hooks[i](ctx)
}(i)
}
// Goroutineを中断するためのdoneチャネルを作成
done := make(chan struct{})
// Goroutineを宣言して並行化
go func() {
// 時間のかかる処理
wg.Wait()
// Goroutineを終了する
close(done)
}()
select {
// close関数が実行された場合
case <-done:
return nil
// cancel関数が実行された場合
case <-ctx.Done():
return ctx.Err()
}
}
＊実装例＊
package main
import (
"shutdown"
)
func init() {
// Goroutineを宣言して並行化
go func() {
// 時間のかかる処理
for {
// 関数を返却する関数
shutdownHook, err := returnFunctions()
if err != nil {
time.Sleep(3 * time.Second)
continue
}
shutdown.AddShutdownHook(shutdownHook)
break
}
}()
}
package shutdown
var hooks = make([]func(), 0)
// プロセスの終了前に実行したい関数を追加する
func AddShutdownHook(hook func()) {
hooks = append(hooks, hook)
}
// プロセスを安全に終了する
func GracefulShutdown() {
hooks := hooks
for _, fun := range hooks {
fun()
}
}
02. 変数¶
定義 (宣言+代入)¶
▼ 明示的な定義¶
＊実装例＊
// 1個の変数を定義 (宣言と代入が同時でない)
var number int
number = 5
// 1個の変数を定義 (宣言と代入が同時)
var number int = 5
// 複数の変数を定義
var foo, bar, baz int
foo, bar, baz = 1, 3, 5
▼ 暗黙的な定義 (型推論)¶
＊実装例＊
// データ型が自動的に認識される
w := 1
x := true
y := 3.14
z := "abc"
var w = 1
var (
foo = true
y = 3.14
z = "abc"
)
package main
import "fmt"
func quotient(x int, y int) int {
// 商を計算する。
quotient := x / y
// を返却する。
return quotient
}
func main() {
fmt.Println(quotient(2, 2))
}
▼ 再宣言¶
基本的には、同じスコープ内で既存の変数を再宣言できない。
ただし、複数の変数を宣言する時に、いずれかに新しい変数の宣言が含まれていれば、既存の変数を宣言したとしても、代入のみが実行される。
＊実装例＊
package main
import "fmt"
func main() {
foo := 1
// 新しい変数の宣言が含まれている
foo, bar := 2, 3
log.Printf("%v", foo) // 2
log.Printf("%v", bar) // 3
}
定義位置の種類¶
▼ グローバル変数¶
関数の外部で定義された変数のこと。
スコープとして、宣言されたパッケージ外部でも使用できる。
＊実装例＊
グローバル変数を宣言し、関数内で値を代入する。
package main
import "fmt"
// グローバル変数
var text string
func main() {
text = "Hello World!"
log.Printf("%v", text)
}
変数に対する代入は関数内でしかできないため、宣言と代入を同時に実行する型推論を使用するとエラーになってしまう。
package main
import "fmt"
// エラーになってしまう。
text := "Hello World!"
func main() {
log.Printf("%v", text)
}
▼ ローカル変数¶
関数の内部で定義された変数のこと。
スコープとして、宣言されたパッケージ内部でしか使用できない。
＊実装例＊
package main
import "fmt"
func main() {
// ローカル変数
text := "Hello World!"
log.Printf("%v", text)
}
03. 環境変数¶
環境変数の出入力¶
▼ init関数による環境変数出力¶
環境変数は、.envファイルを使用する以外に、init関数で出力する方法もある。
▼ アプリ側の環境変数¶
package config
import "os"
// 環境変数名を設定する
const (
FooEnvKey = "FOO"
BarEnvKey = "BAR"
BazEnvKey = "BAZ"
)
func init() {
// 環境変数名を指定して値を格納する
os.Setenv(FooEnvKey, "foo")
os.Setenv(BarEnvKey, "bar")
os.Setenv(BazEnvKey, "baz")
}
▼ パッケージ側の環境変数¶
パッケージ側では、アプリが設定した環境変数を出力できるような処理が必要になる。
この時、フォールバック (変数や定数に値が格納されていない場合に、代わりに使用する処理) で環境変数を取得すると、デフォルト値を設定できる。
環境変数がstring型かfloat64型かに合わせて、関数を定義しておく。
package config
import (
"os"
"strconv"
)
// 環境変数名を設定する
const (
FooEnvKey = "FOO"
BarEnvKey = "BAR"
BazEnvKey = "Baz"
)
var (
Foo string
Bar string
Baz string
)
func init() {
// 環境変数名を指定して値を取得する
foo := getStringEnv(FooEnvKey, "foo")
bar := getStringEnv(BarEnvKey, "bar")
baz := getFloatEnv(BazEnvKey, 1.0)
}
// ゲッター
func GetFoo() string {
return foo
}
func GetBar() string {
return bar
}
func GetBaz() string {
return baz
}
// 環境変数をstring型で取得する
func getStringEnv(key string, fallback string) string {
value := os.Getenv(key)
// マイクロサービス側で値を設定していれば、それを使用する
if len(value) != 0 {
return value
}
// 環境変数の値が空文字だった場合は、fallbackをデフォルト値として返却する
return fallback
}
// 環境変数をfloat64型で取得する
func getFloatEnv(key string, fallback float64) float64 {
value, err := strconv.ParseFloat(getStringEnv(key, "1.0"), 64)
if err != nil {
return fallback
}
return value
}
string型以外の値¶
環境変数は全てstring型で定義する必要がある。
そのため、出入力前にstring型への (からの) 変換が必要になる。
// int型をstring型に変換した上で、環境変数として設定する
os.Setenv("FOO_TIMEOUT", strconv.Itoa(300))
// bool型をstring型に変換した上で、環境変数として設定する
os.Setenv("FOO_ENABLED", strconv.FormatBool(true))
04. スコープ¶
変数、定数¶
▼ パッケージ内外から参照可能¶
変数名または定数名の頭文字を大文字すると、パッケージ内外でこれをコールできるようになる。
＊実装例＊
package foo
// 定数を定義する。
const (
Foo = "foo"
)
package main
import "fmt"
func main() {
log.Printf("%v", Foo) // foo
}
▼ パッケージ内のみ参照可能¶
変数名または定数名の頭文字を小文字すると、パッケージ外でこれをコールできなくなる。
＊実装例＊
package foo
// 定数を定義する。
const (
Bar = "bar"
)
package main
import "fmt"
func main() {
log.Printf("%v", Bar) // コールできずにエラーになる
}
関数¶
▼ パッケージ内外から参照可能¶
関数名の頭文字を大文字すると、パッケージ内外でこれをコールできるようになる。
＊実装例＊
package foo
func Foo() {
// 何らかの処理
}
package main
func main() {
Foo()
}
▼ パッケージ内のみ参照可能¶
関数名の頭文字を小文字すると、パッケージ外でこれをコールできなくなる。
＊実装例＊
package main
func foo() {
// 何らかの処理
}
func main() {
foo()
}
05. 制御文¶
初期化ステートメント¶
以下の二つの実装例は同じである。
package main
import (
"fmt"
"log"
)
func main() {
// 数値を取得する
value := getNum()
// 通常の記法
if value > 20 {
log.Printf("%v: 20より大きいです\n", value)
}
log.Printf("%v: 20より小さいです\n", value)
}
初期化ステートメントでは、条件に処理の結果を使用できる。
なお、処理の結果自体は条件内でしか使用できない。
package main
import (
"fmt"
)
func main() {
// 簡易記法
if value := getNum(); value > 20 {
// value変数は条件内でしか使用できない
log.Printf("%v: 20より大きいです\n", value)
}
log.Printf("%v: 20より小さいです\n", value)
}
func getNum() int {
return 20
}
if-else-ifの代替¶
▼ ifの連続¶
Goにはif-else-ifがあるが、可読性が低い場合は代わりにifを連続させる。
事前にvarで変数を宣言し、各if内で変数に値を格納する。
package main
import (
"fmt"
)
func getFooX() {
return "FooX"
}
func getFooY() {
return "FooY"
}
func getFooZ() {
return "FooZ"
}
func main() {
var foo string
if isX {
foo = getFooX()
}
if isY {
foo = getFooY()
}
if isZ {
foo = getFooZ()
}
fmt.Print(foo)
}
▼ switch-case¶
Goにはif-else-ifがあるが、可読性が低い場合は代わりにswitch-caseを使用する。
事前にvarで変数を宣言し、各switch-case内で変数に値を格納する。
package main
import (
"fmt"
)
func getFooX() {
return "FooX"
}
func getFooY() {
return "FooY"
}
func getFooZ() {
return "FooZ"
}
func main() {
var foo string
switch {
case isX:
foo = getFooX()
case isY:
foo = getFooY()
case isZ:
foo = getFooZ()
}
fmt.Print(foo)
}
配列またはsliceの走査¶
▼ for ... range¶
配列またはsliceを走査する。
PHPのforeachに相当する。
package main
import "fmt"
func main() {
slice := []string{"a", "b", "c"}
for key, value := range slice {
fmt.Println(key, value)
}
}
// 0 a
// 1 b
// 2 c
06. 処理の種類¶
単一処理¶
▼ 単一処理とは¶
特定の処理のみを実行する。
＊実装例＊
package main
import "fmt"
func main() {
fmt.Println("1")
fmt.Println("2")
fmt.Println("3")
}
// 1
// 2
// 3
並行処理¶
▼ Goroutineによる並行処理¶
指定した処理をバラバラに開始し、またそれぞれの処理がバラバラに終了する。
関数でGoroutine (go func()) を宣言すると、その関数の完了を待たずに後続の処理を並行的に実行できる。
結果、完了する順番は順不同になる。
＊実行例＊
package main
import (
"fmt"
)
func main() {
fmt.Println("main")
go func() {
fmt.Println("hoge")
}()
time.Sleep(time.Second)
}
▼ 反復処理や長時間処理と相性がいい¶
反復処理 (for文) や長時間処理 (例：ポーリング) と相性がいい。
package main
import (
"fmt"
)
func main() {
go func() {
// ポーリング処理
// 実装方法を調べて書く
}()
// ポーリングと並行して実行したい処理
}
▼ 返却処理はエラーになる¶
返却処理 (return) は、処理の完了を待つことになるため、Goroutineとは矛盾する。
そのため、Goroutineで実行する関数に返却処理があると、エラーになる。
代わりに、Goroutine間でchannelを介して処理結果を送受信する。
package main
import (
"fmt"
)
func main() {
// "unexpected go" というエラーになる
result := go foo()
fmt.Println(result)
}
func foo() string {
return "foo"
}
▼ Goroutineを入れ子にできる¶
入れ子で実行した場合でも、全く独立してGoroutineを実行する。
Goroutineの親子間に依存関係はない。
package main
import (
"fmt"
)
func main() {
go foo()
// Goroutineを宣言したfoo関数の完了を待たない
fmt.Println("baz")
}
func foo() string {
go func() {
fmt.Println("bar")
}
// Goroutineを宣言した無名関数の完了を待たない
fmt.Println("foo")
}
06-02. Goroutineと合わせて使用する処理¶
channel (チャネル)¶
▼ channelとは¶
異なるGoroutine間で値を送受信するキューとして動作する。
キューに値を送信し、加えてキューから値を受信できる。
package main
import "fmt"
func main() {
// チャネルを作成
channel := make(chan string)
// Goroutineを宣言して並行化
go func() {
// 時間のかかる処理
// チャネルに値を送信する。
channel <- "ping"
}()
// チャネルから値を受信する。
value := <-channel
fmt.Println(value)
}
▼ Goroutine中断方法１ (done channel、close)¶
Goroutineを中断するためのdoneチャネルを作成し、これをclose関数で中断する。
doneチャネルは使い捨てのため、サイズがゼロの空構造体として定義するとよい。
package main
import (
"fmt"
"log"
)
func main() {
// チャネルを作成
channel := make(chan string)
// Goroutineを中断するためのdoneチャネルを作成
// 空構造体はサイズがゼロなため、使い捨てのチャネルと相性がいい
done := make(chan struct{})
// Goroutineを宣言して並行化
go func() {
// 時間のかかる処理
// チャネルに値を送信する。
channel <- "ping"
// Goroutineを中断する
close(done)
}()
for {
select {
// 先に終了したcaseに条件分岐する
// チャネルから値を受信した場合
case value := <-channel:
fmt.Println(value)
// cancel関数が実行された場合
case <-done:
log.Printf("Goroutineが完了しました")
return
}
}
}
- https://zenn.dev/hsaki/books/golang-context/viewer/done#context%E5%B0%8E%E5%85%A5%E5%89%8D---done%E3%83%81%E3%83%A3%E3%83%8D%E3%83%AB%E3%81%AB%E3%82%88%E3%82%8B%E3%82%AD%E3%83%A3%E3%83%B3%E3%82%BB%E3%83%AB%E5%87%A6%E7%90%86
- https://www.reddit.com/r/golang/comments/171i5gv/context_cancel_or_done_channel/
- https://qiita.com/castaneai/items/7815f3563b256ae9b18d#%E9%80%9A%E7%9F%A5%E3%82%92%E9%80%81%E3%82%8B%E9%9A%9B%E3%81%AF-close-%E3%81%A7%E3%82%88%E3%81%84
- https://stackoverflow.com/a/22627240
▼ Goroutine中断方法２ (context.cancel、context.Done)¶
cancel関数のGoroutineの中断を検知する。
sync.WaitGroup.Done関数とは区別する。
package main
import (
"context"
"fmt"
"log"
)
func main() {
// タイムアウト時間を設定し、コンテキストを作成する
ctx, cancel := context.WithTimeout(
context.Background(),
5 * time.Second,
)
// チャネルを作成
channel := make(chan string)
// Goroutineを宣言して並行化
go func() {
// 時間のかかる処理
// チャネルに値を送信する。
channel <- "ping"
// Goroutineを中断する
cancel()
}()
for {
select {
// 先に終了したcaseに条件分岐する
// チャネルから値を受信した場合
case value := <-channel:
fmt.Println(value)
// cancel関数が実行された場合
case <-ctx.Done():
log.Printf("Goroutineが完了しました")
return
}
}
}
▼ select¶
チャネルに対する格納を非同期で待機する。
package main
import (
"fmt"
"time"
)
func main() {
// チャネルを作成する。
channel1 := make(chan string)
channel2 := make(chan string)
// Goroutineを宣言して並行化
go func() {
// 時間のかかる処理
// 完了までに2秒かかるとする。
time.Sleep(2 * time.Second)
// 値を送信する。
channel1 <- "one"
}()
// Goroutineを宣言して並行化
go func() {
// 時間のかかる処理
// 完了までに1秒かかるとする。
time.Sleep(1 * time.Second)
// 値を送信する。
channel2 <- "two"
}()
for i := 0; i < 2; i++ {
select {
// Goroutineの処理の完了タイミングがバラバラになる
// channel1とchannel2の受信を非同期で待機し、受信した順番で処理する。
// channel1 <- "one" を受信したタイミングで出力する
case msg1 := <-channel1:
fmt.Println("received", msg1)
// channel2 <- "two" を受信したタイミングで出力する
case msg2 := <-channel2:
fmt.Println("received", msg2)
// 受信が成功しなければ、defaultで処理する。
default:
fmt.Println("default")
}
}
}
▼ WaitGroupとの使い分け¶
channelを使用すると、異なるGoroutine間で値を送受信できる。
そのため、Goroutineの処理結果を使用したい場合は、WaitGroupではなくchannelを使用する方が良い。
一方で、channelではselect関数が必要になり、処理が複雑になることに注意する。
WaitGroup¶
▼ WaitGroupとは¶
Goroutineを宣言した関数が終了するまで、後続の処理の実行開始を待機する。
sync.WaitGroup.Add関数、sync.WaitGroup.Done関数、sync.WaitGroup.Wait関数、で制御する。
Goroutineの関数の反復処理や異なるGoroutineの関数の並行実行を待機し、その上で後続の処理を実行するような場合に、WaitGroupは役立つ。
単一のGoroutineを待機するのは順次実行と変わらないため、WaitGroupは使用しない。
実行例
実行完了に1秒かかる関数があると仮定する。
反復処理でこの関数をコールする場合、毎回の走査に1秒かかるため、反復の回数だけ秒数が増える。
しかし、各関数をGoroutineとして実行すると、各反復処理を並行実行できる。
そのため、反復回数が何回であっても、およそ1秒で処理が終了する。
package main
import (
"fmt"
"sync"
"time"
)
func main() {
slice := []string{"a", "b", "c"}
wg := &sync.WaitGroup{}
// 処理の開始時刻を取得
start := time.Now()
// Goroutineの関数を反復処理する
// a、b、c、の分だけ反復する
for key, value := range slice {
// インクリメントする
// 完了の待機カウンターを設定する
wg.Add(1)
// Goroutineを宣言して並行化
go func(key int, value string) {
print(key, value)
// デクリメントする
// Wait関数のカウンターを減らす
wg.Done()
}(key, value)
}
// カウンターがゼロになるまで待機する
// 全てのGorourineでDone関数を実行するのを待機する
wg.Wait()
// 開始時刻から経過した秒数を取得する
log.Printf("経過秒数: %s\n", time.Since(start))
}
func print(key int, value string) {
fmt.Println(key, value)
}
// 2 c
// 0 a
// 1 b
// 経過秒数: 1s
▼ channelとの使い分け¶
WaitGroupを使用すると、Add関数、Done関数、Wait関数を使用して、Goroutineを簡単に制御できる。
そのため、Goroutineの処理結果を使用したい場合は、WaitGroupではなくchannelを使用する方が良い。
一方で、WaitGroupではGoroutine間で値の送受信はできないことに注意する。
errgroup¶
エラー処理を含む関数でGoroutineを宣言したい時に使用する。
07. エラーキャッチ、例外スロー¶
Goにおけるエラーキャッチと例外スロー¶
▼ 例外スローのある言語の場合¶
例外スローの意義は、以下の参考にせよ。
▼ Goには例外が無い¶
例えばPHPでは、エラーをキャッチし、ソフトウェア開発者にわかる言葉に変換した例外としてスローする。
Goには例外クラスに相当するものが無い。
その代わり、エラーそのものがerrorインターフェースに保持されており、これを1個の値として扱える。
後続の処理で発生したerrorインターフェースを、そのまま先行の処理に返却する。
エラーキャッチ¶
▼ nilの比較検証¶
関数から返却されたerrインターフェースが、nilでなかった場合、エラーであると見なすようにする。
if err != nil {
// 何らかの処理
}
errorインターフェース¶
▼ 標準エラー¶
Goでは複数の値を返却できるため、多くの関数ではデフォルトで、最後にerrorインターフェースが返却されるようになっている。
errorインターフェースは暗黙的にError関数をコールする。
type error interface {
Error() string
}
＊実装例＊
osパッケージのOpen関数からerrorインターフェースが返却される。
errorインターフェースはError関数を自動的に実行し、標準エラー出力に出力する。
package main
import (
"fmt"
"log"
"os"
)
func main() {
// 処理結果とerrorインターフェースが返却される。
file, err := os.Open("filename.txt")
if err != nil {
// エラーの内容を出力する。
log.Printf("ERROR: %v", err)
return
}
log.Printf("%v", file)
}
▼ New関数による自前エラー¶
errorsパッケージのNew関数にエラーを設定する。
これにより、ユーザー定義のエラーを保持するerrorインターフェースを定義できる。
errorインターフェースはError関数を自動的に実行する。
＊実装例＊
package main
import (
"errors"
"fmt"
"log"
"os"
)
func NewError() error {
return errors.New("<エラーメッセージ>")
}
func main() {
file, err := os.Open("filename.txt")
if err != nil {
// 自前エラーメッセージを設定する。
myErr := NewError()
log.Printf("ERROR: %v", myErr)
return
}
log.Printf("%v", file)
}
▼ fmt.Errorf関数による自前エラー¶
fmtパッケージのErrorf関数で自前エラーを作成できる。
事前に定義したフォーマットを元にエラーを設定する。
これにより、ユーザー定義のエラーを保持するerrorインターフェースを定義できる。
errorインターフェースはError関数を自動的に実行する。
＊実装例＊
package main
import (
"fmt"
"os"
)
func main() {
file, err := os.Open("filename.txt")
if err != nil {
fmt.Errorf("ERROR: %v", err)
return
}
log.Printf("%v", file)
}
▼ 構造体による自前エラー¶
構造体にError関数を定義すると、この構造体にerrorインターフェースが自動的に委譲される。
これにより、ユーザー定義のエラーを保持するerrorインターフェースを定義できる。
errorインターフェースはError関数を自動的に実行する。
＊実装例＊
package main
import (
"fmt"
"os"
)
type Error struct {
Message string
}
func (error *Error) Error() string {
return fmt.Sprintf("ERROR: %v", error.Message)
}
func main() {
file, err := os.Open("filename.txt")
if err != nil {
// 構造体に値を設定する。
myError := &Error{Message: "エラーが発生したため、処理を完了しました。"}
// 構造体をコールするのみで、Error関数が実行される。
log.Printf("%v", myError)
os.Exit(1)
}
log.Printf("%v", file)
}
xerrorsパッケージ¶
▼ xerrorsパッケージとは¶
標準のerrorsパッケージには、エラーにスタックトレース情報が含まれていない。
xerrorsパッケージによって作成されるerrorインターフェースには、errorインターフェースが返却された行数がスタックトレースとして含まれている。
▼ New関数によるトレース付与¶
＊実装例＊
package main
import (
"golang.org/x/xerrors"
"log"
"os"
)
func NewErrorWithTrace() error {
return xerrors.New("<エラーメッセージ>")
}
func main() {
file, err := os.Open("filename.txt")
if err != nil {
// errorインターフェースが返却された行数が付与される。
errWithStack := NewErrorWithTrace()
// %+v\n を使用する。
log.Printf("ERROR: %+v\n", errWithStack)
return
}
log.Printf("%v", file)
}
▼ Errorf関数によるトレース付与¶
package main
import (
"golang.org/x/xerrors"
"log"
"os"
)
func main() {
file, err := os.Open("filename.txt")
if err != nil {
// errorインターフェースが返却された行数が付与される。
errWithStack := xerrors.Errorf("ERROR: %w", err)
// %+v\n を使用する。
log.Printf("ERROR: %+v\n", errWithStack)
return
}
log.Printf("%v", file)
}
08. テンプレート¶
ロジック¶
▼ コメント¶
Goのコメントの前に不要な改行が挿入されないように、{{-とする方が良い。
{{- /* コメント */}}
もしコメントの後にも改行が挿入されてしまう場合は、-}}も付ける。
{{- /* コメント */-}}
*/}}にはスペースを含めずに、一繋ぎで定義する。
▼ 条件分岐¶
{{ if x==100 }}
...
{{ else }}
...
{{ end }}
テンプレート内のエスケープ¶
▼ テンプレート内のエスケープとは¶
Goのテンプレートでは、『{{』と『}}』の記号がロジックで使用される。
これを文字として使用する場合は、ロジックとして認識されないようにエスケープする必要がある。
▼ {{ "<記号>" }}¶
各記号を{{ "<記号>" }}のように挟み、エスケープする。
{{ " {{ " }} foo {{ " }} " }}
▼ {{ <記号を含む文字> }}¶
記号を含む文字ごと{{ `<記号を含む文字列全体>` }}のように挟み、エスケープする。
多くの場合にこの方法で対処できるが、文字列内にバックスラッシュがある場合は対処できない。
{{ `{{ foo }}` }}
09. テスト¶
テストの順番¶
go testコマンドは、テストファイルを並行的に実行する。
そのため、実行の順番は制御できない。
事前/事後処理¶
▼ 環境変数の出入力¶
アプリケーション外 (例：ConfigMap、.envファイルなど) で環境変数を管理している場合、これをテスト時に事前に出入力する必要がある。
package test
import "os"
func setup() func() {
// 環境変数を設定する
os.Setenv("FOO_TIMEOUT", "300")
os.Setenv("FOO_ENABLED", "false")
return func() {
// 事後処理
os.Unsetenv("FOO_TIMEOUT")
os.Unsetenv("FOO_ENABLED", "false")
}
}
func TestServer(t *testing.T) {
t.Helper()
teardown := setup()
defer teardown()
...
}
package test
import (
"net/http"
"testing"
)
// setup ユニットテストの前処理の結果と，後処理の関数を返却する
func setup() (*http.Client, func()) {
// クライアントを作成する
client := &http.Client{}
return client, func() {
// 事後処理
}
}
// TestIntegration 統合テストを実行する
func TestIntegration(t *testing.T) {
t.Helper()
client, teardown := setup()
defer teardown()
...
}