0
Help us understand the problem. What are the problem?

posted at

updated at

Organization

【Golang】PHP の serialize のようにオブジェクトを保存可能なデータにしたい【gob】

Go でオブジェクトをシリアライズ(シリアル化)したい

Go 言語(以下 Golang)で、オブジェクトを保存 & 読み込みできるようにシリアライズしたい。

JSON 文字列に変換してもいいのですが、json.Marshalerjson.Unmarshaler インターフェースを実装しないといけないものだと面倒です。

特に、ユーザーが保存データを直接編集する必要もないし、他のプログラム言語とのやりとりもない場合に、PHP の serialize くらい簡単に保存可能な値に変換できないものか悩みます。

「"golang" phpのserializeみたいなもの」でググってもドンピシャの記事が出てこなかったので、自分のググラビリティとして。

TL; DR (今北産業)

  1. Golang には gob という自己表記型のデータ形式がある。(Go v1 から実装済み)
  2. encoding/gob パッケージの Encode でシリアル化、Decode で復元できる。
  3. Golang 同士でしか使えないが、バイト・データなのでサイズは小さく済む。

TS; DR (マスター、動くものをくれ)

main.go
package main

import (
	"bytes"
	"encoding/gob"
	"fmt"
	"log"
)

// ----------------------------------------------------------------------------
//  Main
// ----------------------------------------------------------------------------

func main() {
	// 保存したいオブジェクトの作成
	apple1 := Fruit{
		Name:  "apple",
		Color: Red,
	}
	fmt.Println(apple1)

	// オブジェクトを保存可能なバイト・データに変換
	buf := bytes.NewBuffer(nil)
	err := gob.NewEncoder(buf).Encode(&apple1)
	ExitOnError(err)

	dataToSave := buf.Bytes() // 保存するバイト・データ

	fmt.Println("Saved data:", dataToSave)

	// 保存されたバイトデータからオブジェクトを復元
	var apple2 Fruit // 復元先の空のオブジェクト

	buf = bytes.NewBuffer(dataToSave)
	err = gob.NewDecoder(buf).Decode(&apple2)
	ExitOnError(err)

	fmt.Println(apple2)

	// Output:
	// Before: I am apple. My color is red.
	// Saved data: [38 255 129 3 1 1 5 70 114 117 105 116 1 255 130 0 1 2 1 4 78 97 109 101 1 12 0 1 5 67 111 108 111 114 1 4 0 0 0 12 255 130 1 5 97 112 112 108 101 1 2 0]
	// After: I am apple. My color is red.
}

// ----------------------------------------------------------------------------
//  Type: Color
// ----------------------------------------------------------------------------

// Color は色情報を保持する enum 用の型です。
type Color int

const (
	Unknown Color = iota // Unknown は不明な色を表す enum 定数です。
	Red                  // Red は赤色を表す enum 定数です。
	Green                // Green は緑色を表す enum 定数です。
	Yellow               // Yellow は黄色を表す enum 定数です。
)

// String は fmt.Stringer インターフェースの実装です。自身の色を示す文字列を返します。
func (c Color) String() string {
	switch c {
	case Red:
		return "red"
	case Green:
		return "green"
	case Yellow:
		return "yellow"
	}

	return "unknown"
}

// ----------------------------------------------------------------------------
//  Type: Fruit
// ----------------------------------------------------------------------------

// Fruit はフルーツの情報を保持する型です。
type Fruit struct {
	Name  string
	Color Color
}

// String は fmt.Stringer インターフェースの実装です。自身を示す文字列を返します。
func (f Fruit) String() string {
	return fmt.Sprintf("I am %s. My color is %s.", f.Name, f.Color)
}

// ----------------------------------------------------------------------------
//  Functions
// ----------------------------------------------------------------------------

// ExitOnError は err が nil でない場合に、エラーで終了します。
func ExitOnError(err error) {
	if err != nil {
		log.Fatal(err)
	}
}

Register as a new user and use Qiita more conveniently

  1. You can follow users and tags
  2. you can stock useful information
  3. You can make editorial suggestions for articles
What you can do with signing up
0
Help us understand the problem. What are the problem?