Go構造体の扱い方(DBからデータ取得時)

Question

Golangにおいて，DBから取得したデータを構造体に格納してその構造体を返す関数を作成することを考えた場合，

type User struct {
    Name string
    Age  int
}

type UserDB struct {
    db *sql.DB
}

func (u UserDB) FindUserByName(name string) (*User, error){
...
}

となると思うのですが，
構造体を変更することがない場合，
戻り値はUser構造体のポインタの方が良いのでしょうか．
それともそのまま構造体を返した方が良いのでしょうか．

またその理由を教えていただきたいです．

Answer 1

質問への回答としては nobonobo さんのが適切として、僕は Go のポインタと実体をどう使い分けるかの話を。簡略化して例えば以下の様な処理を例にします。

package main

import (
	"fmt"
)

type User struct {
	name string
}

func NewUser(name string) User {
	return User{name: name}
}

func (u User) Name() string {
	return u.name
}

func main() {
	fmt.Println(NewUser("bob").Name())
}

このコードは現状は正しく動きます。これに対して今度は name を変更出来るメソッド SetName を足します。

package main

import (
	"fmt"
)

type User struct {
	name string
}

func NewUser(name string) User {
	return User{name: name}
}

func (u User) Name() string {
	return u.name
}

func (u User) SetName(newname string) {
	u.name = newname
}

func main() {
	u := NewUser("bob")
	u.SetName("john")
	fmt.Println(u.Name())
}

このコードは期待通りには動きません。なぜなら Go の実体に宣言されたメソッドは呼び出し時にレシーバの値のコピーが作成されるからです。よってこのコードは bob が表示されます。nobonobo さんが仰る様に、コピーにコストがかかるのでプリミティブ(boolやintやstring)でない形のレシーバに対するメソッド宣言は一般的にポインタで作られる事が多いです。(特に理由が無ければ)

ただし以下のコードを見て下さい。以下のコードはコンパイルエラーになります。

package main

import (
	"fmt"
)

type User struct {
	name string
}

func NewUser(name string) User {
	return User{name: name}
}

func (u *User) Name() string {
	return u.name
}

func (u *User) SetName(newname string) {
	u.name = newname
}

func main() {
	fmt.Println(NewUser("bob").Name())
}

これは NewUser が返す実体がまだどの変数にも割り当てられていないのでアドレスが取れなず、ポインタをレシーバにした Name が呼び出せないのです。アドレスを得る為には以下の様に修正する必要があります。

func main() {
	u := NewUser("bob") // 変数に割り当てる
	fmt.Println(u.Name())
}

ただこうすると NewUser、Name の呼び出しでそれぞれでコピーが発生してしまいますね。となると結局はコピーを避ける為に以下の様にするのがコピーのコストが低い事が分かります。

package main

import (
	"fmt"
)

type User struct {
	name string
}

func NewUser(name string) *User {
	return &User{name: name}
}

func (u *User) Name() string {
	return u.name
}

func (u *User) SetName(newname string) {
	u.name = newname
}

func main() {
	fmt.Println(NewUser("bob").Name())
}

例としてはフィールドが name だけですが、もっとフィールド数が多い struct で想像して貰えるとなぜコピーを避けるべきかご理解いただけると思います。

Comments

[RyomaK]

ポインタと実体の使い分け，とても為になりました！ありがとうございます！

Answer 2

見つからなかったことを上位に伝える方法はいくつかパターンがあります。

errorで見つからなかったことを返す場合、errorの分岐が必要になる場合があります。
ポインタ型は空を表現できる利点があります。（例えば該当ユーザーが見つからなかったときの値をnilで返す
）
なので「return nil, nil」を返せば、滞りなくDBアクセスは完了し、ユーザーが見つからなかったことを上位に伝えられます。

Userを非ポインタでこのFindUserByNameの戻りを提供する場合、
見つからなかったとしても何らかのUser値を返す必要があります。

また、処理コスト面だけを解説すると、

• 戻り値がポインタの場合値の格納にヒープメモリを利用します（ポインタはスタック）。
• 戻り値が非ポインタの場合スタックを利用します。

スタックメモリ操作よりもヒープメモリ操作の方が処理コストが大きいので
質問の例ならベンチマークをとってみればわかりますが、
非ポインタのほうが早い結果になると思います。

ただし、戻り値を受け取る際に代入が発生します。

戻そうとする構造体のメモリ使用量が大きくなると
代入における値のコピーコストが
ポインタ型よりも非ポインタ型のほうが大きくなっていきます。

結論としては、
硬く変更しないような小さな値セットであれば非ポインタ型で、それ以外はポインタ型にしておくことをお勧めします。

硬く変更しないような小さな値セットの例としては

要素も増える見込みのないような以下のようなものですね。

type Vec2 struct {
    X int
    Y int
}

フィールドに変更が発生する可能性があればポインタ型で。

Comments

[RyomaK]

わかりやすい説明ありがとうございます！