【Java】クラスオブジェクトをセーブデータ化

2017年11月27日2018年3月11日

本稿は自作クラスをそのままファイル化してしまう方法を紹介します。

クラスオブジェクトをセーブデータ化できるとプログラム側での利用が非常に楽になるというメリットがあります。

ただし、セーブされたクラスオブジェクトと復元対象のクラスの情報が違う場合にversionエラーが発生する可能性がある為、その辺を考慮したうえで使用する必要があります。

クラスオブジェクトをファイルに書き込み

クラスオブジェクトをファイル化するにはObjectOutputStreamを使用します。

writeObjectメソッドでオブジェクトデータを指定するだけで書き込みができます。

writeObjectメソッドに指定するオブジェクトはSerializableインターフェースを実装している必要があります。

クラス内に保持されているオブジェクトもそれぞれSerializableインターフェースを実装している必要があります。

試しにキャラクタのステータスをクラスごと書き込みしてみましょう。

import java.io.BufferedOutputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.ObjectOutputStream;
import java.io.Serializable;
 
public class Test {
	public static void main(String[] args) {
		try(FileOutputStream f = new FileOutputStream("status.dat");
			BufferedOutputStream b = new BufferedOutputStream(f);
			ObjectOutputStream out = new ObjectOutputStream(b)){
 
			Status st = new Status("勇者", 100, 30);
 
			out.writeObject(st);
		} catch ( IOException e ) {
			e.printStackTrace();
		}
	}
}
class Status implements Serializable{
	String name;
	int hp;
	int mp;
	Status(String name, int hp, int mp){
		this.name = name;
		this.hp = hp;
		this.mp = mp;
	}
}

実行結果

status.datファイルが作成されました。

status.datファイルは「name=勇者,HP=100,MP=30」を保持するStatusオブジェクトのファイルということになります。

ObjectOutputStreamもいつも通りtry-with-resourceでcloseの自動呼出しの対象にしておきます。

クラスオブジェクトファイルの読み込み

保存したクラスオブジェクトファイルを読み込む場合はObjectInputStreamのreadObjectメソッドを利用します。

保存したクラスオブジェクトファイルを読み込んでステータスを表示してみます。

先ほど作成したstatus.datファイルを読み込んでみましょう。

import java.io.BufferedInputStream;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.Serializable;
 
public class Test {
	public static void main(String[] args) {
		try(FileInputStream f = new FileInputStream("status.dat");
			BufferedInputStream b = new BufferedInputStream(f);
			ObjectInputStream in = new ObjectInputStream(b)){
 
			Status st = (Status) in.readObject();
 
			System.out.println(st.name);
			System.out.println(st.hp);
			System.out.println(st.mp);
		} catch ( IOException e ) {
			e.printStackTrace();
		} catch (ClassNotFoundException e) {
			e.printStackTrace();
		}
	}
}
class Status implements Serializable{
	String name;
	int hp;
	int mp;
	Status(String name, int hp, int mp){
		this.name = name;
		this.hp = hp;
		this.mp = mp;
	}
}

実行結果

勇者
100
30

ちゃんと保存した内容が復元されていますね。

こちらもcloseメソッドはしっかり呼び出されるようにしておいてください。

transient修飾子

transient修飾子を利用すると、変数を保存対象から除外することができます。

まあ使いどころは、ほぼないのですが一応紹介しておきましょう。

Statusクラスのhpとmpの変数にtransient修飾子を付与してみました。

import java.io.BufferedOutputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.ObjectOutputStream;
import java.io.Serializable;
 
public class Test {
	public static void main(String[] args) {
		try(FileOutputStream f = new FileOutputStream("status.dat");
			BufferedOutputStream b = new BufferedOutputStream(f);
			ObjectOutputStream out = new ObjectOutputStream(b)){
 
			Status st = new Status("勇者", 100, 30);
 
			out.writeObject(st);
		} catch ( IOException e ) {
			e.printStackTrace();
		}
	}
}
class Status implements Serializable{
	String name;
	transient int hp;
	transient int mp;
	Status(String name, int hp, int mp){
		this.name = name;
		this.hp = hp;
		this.mp = mp;
	}
}

import java.io.BufferedInputStream;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.Serializable;
 
public class Test {
	public static void main(String[] args) {
		try(FileInputStream f = new FileInputStream("status.dat");
			BufferedInputStream b = new BufferedInputStream(f);
			ObjectInputStream in = new ObjectInputStream(b)){
 
			Status st = (Status) in.readObject();
 
			System.out.println(st.name);
			System.out.println(st.hp);
			System.out.println(st.mp);
		} catch ( IOException e ) {
			e.printStackTrace();
		} catch (ClassNotFoundException e) {
			e.printStackTrace();
		}
	}
}
class Status implements Serializable{
	String name;
	transient int hp;
	transient int mp;
	Status(String name, int hp, int mp){
		this.name = name;
		this.hp = hp;
		this.mp = mp;
	}
}