google-gson でシリアライズ・デシリアライズしたサンプル

公開日: : 最終更新日:2014/01/26 Java , ,

これまで Java で JSON を扱うときは JSONIC を使っていたが、google-gson の存在を知ったのでシリアライズ・デシリアライズのサンプルを試してみた。

作成したサンプルプログラム

サンプルは Github に登録済み。

ファイル構成

動作確認を行うテストケースが1つ。

  • src/test/java/net/tomoyamkung/GsonTest.java

シリアライズ・デシリアライズに使用するクラスが4つ。

  • src/main/java/net/tomoyamkung/BaseJson.java
  • src/main/java/net/tomoyamkung/Friend.java
  • src/main/java/net/tomoyamkung/JsonException.java
  • src/main/java/net/tomoyamkung/JsonFriend.java

わざわざ図にまでもないが、クラス図的にはこんな感じ。

2013-06-02-google-gson-class

動作確認方法

プロジェクトは Maven で作成したので、ビルド → テストは次のコマンドを実行すればOK。

$ cd $PROJECT_HOME
$ mvn eclipse:eclipse -DdownloadSources=true # Eclipse のプロジェクトにしたい場合に実行する
$ mvn clean package

mvn コマンドを実行するとちょこちょこ WARNING が出てくるが、ビルドもテストも通るのでとりあえず放置している。

使用したソフトウェアのバージョン

ちなみに、Java や Maven のバージョンは次の通り。

$ java -version
java version "1.7.0_11"
Java(TM) SE Runtime Environment (build 1.7.0_11-b21)
Java HotSpot(TM) 64-Bit Server VM (build 23.6-b04, mixed mode)
$ mvn -v
Apache Maven 3.0.4 (r1232337; 2012-01-17 17:44:56+0900)
Maven home: C:\XXX\maven-3.0.4
Java version: 1.7.0_11, vendor: Oracle Corporation
Java home: C:\Program Files\Java\jdk1.7.0_11\jre
Default locale: ja_JP, platform encoding: MS932
OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

google-gson のバージョンは pom.xml にも書いてあるが、次のものを使用。

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.2.4</version>
    <scope>compile</scope>
</dependency>

サンプルで使用したアノテーション

@Expose

明示的にシリアライズ・デシリアライズの対象としたい場合に、このアノテーションを付与する。

javadoc にもあるように、「シリアライズのときはこのフィールドを対象外にしたい」といったことができるようだ。
次の User クラスをシリアライズした場合、lastName, emailAddress, password はその対象外になる。

public class User {
    @Expose private String firstName;
    @Expose(serialize = false) private String lastName;
    @Expose (serialize = false, deserialize = false) private String emailAddress;
    private String password;
}

シリアライズするコードは次の通り。

new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create().toJson(this);

@SerializedName

デフォルトだとシリアライズする際の「キー」はフィールド名と同じになるが、このアノテーションを付与すると「キー」を任意のものに変更することができる。

これも javadoc が参考になる。
次の SomeClassWithFields のフィールド someField は @SeriallizedName が設定されているため、"someField" ではなく "name" とシリアライズされている。

public class SomeClassWithFields {
    @SerializedName("name") private final String someField;
    private final String someOtherField;

    public SomeClassWithFields(String a, String b) {
        this.someField = a;
        this.someOtherField = b;
    }
}

検証コードは次の通り。

SomeClassWithFields objectToSerialize = new SomeClassWithFields("a", "b");
Gson gson = new Gson();
String jsonRepresentation = gson.toJson(objectToSerialize);
System.out.println(jsonRepresentation);

// ===== OUTPUT =====
// {"name":"a","someOtherField":"b"}

シリアライズ・デシリアライズ方法

上記の javadoc でも触れているが、シリアライズ・デシリアライズのコードを載せておく。コードは GitHub に上げてある次のクラスからの抜粋。

シリアライズ

/**
 * JsonFriend オブジェクトにデシリアライズする。
 * 
 * @param json デシリアライズする JSON
 * @return JsonFriend オブジェクト
 * @throws JsonException デシリアライズに失敗した場合
 */
public static JsonFriend fromJson(String json) throws JsonException {
    JsonFriend fromJson = new Gson().fromJson(json, JsonFriend.class);
    if(!fromJson.isSuccess()) {
        throw new JsonException(fromJson.message);
    }

    return fromJson;
}

デシリアライズ

/**
 * JsonFriend オブジェクトをシリアライズする。
 * 
 * @return シリアライズした文字列
 */
public String toJson() {
    return new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create().toJson(this);
}

Googleアドセンス用(PC)

  • このエントリーをはてなブックマークに追加
  • follow us in feedly

関連記事

icatch-thumbnail

レスポンスにサムネイル画像を返す API のサンプル

今回は直接 ImageMagick は関係ありませんが、また画像ネタです。この辺りのことを仕事で扱っ

記事を読む

GradleLogoReg

SDKMAN!(GVM) を使って Mac に Gradle をインストールする

長らく Java のアプリ開発には Maven を使ってきたが、時代に取り残されている感じがするので

記事を読む

medium_182531101

ClassLoader を使って getResourceAsStream で取得したファイルを UTF-8 で読み込む

よく使う割には覚えられず毎回調べている気がするので備忘録としてメモしておきます。 文字コードを指定し

記事を読む

no image

Stream#filter()で絞り込みmap()で処理するコードスニペット

Java8 から導入された Stream API も少しずつ慣れてきて、「そういえばこういうパターン

記事を読む

icatch_2185253176-resized

Java8 の Optional 型を返す Generics を使ったメソッドを定義する

Java8 の Optional とガード節 に続いて Java8 の Optional ネタ。今回

記事を読む

no image

プロセスの起動を確認するプログラム

プロセスが起動しているかを確認するプログラムを Java で書いてみました。Excel のプロセス確

記事を読む

no image

サーブレットでクラスパス上にあるプロパティファイルを参照するスニペット

よく使うわりにはいつも調べているのでいい加減メモすることにした。 "app.proper

記事を読む

no image

Spark を使って JSON を返すシンプルな API を書いてみた

必要に迫られてモックの API を作成することになった。 大した工数を割けないので使ったことのある

記事を読む

icatch-10139609144_5bc33706f9_z-resized

保存ダイアログを表示させてファイルをダウンロードさせる方法

例えば、ブラウザに表示している画像は右クリックを使ってダウンロードできますが、左クリックから保存ダイ

記事を読む

no image

ファイルの拡張子が JPG であるかを問い合わせるスニペット

特に目新しいこともないが、同じようなことをする機会があるかもしれないのでメモ。Gist にも登録済み

記事を読む

Googleアドセンス用(PC)

Message

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です


3 × 五 =

次のHTML タグと属性が使えます: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

Googleアドセンス用(PC)

icatch-jersey_multi_pathparams
Jerseyの@PathParamはスラッシュの間に複数指定できる

http://hoge-api/user/{id}.{format}

icatch-vagrant_box_customize
VagrantのBoxファイルをカスタマイズして独自のBoxファイルを作成する

配布されている Vagrant の Box ファイルを使って検証環境を

icatch-2015-006-1
バリデーションチェックにJava8のOptionalを使ってスマートに書く(自分比)

Web アプリのバリデーションチェックにアノテーションを使うことが増え

icatch-2015-005-1
ユニットテストの偏りを防ぐ命名規則の付け方

ユニットテスト名に以下の命名規則を付けるようにして二ヶ月ぐらい経った。

icatch-2015-004-1
Vagrantで起動したCentOS上のOctopressをホストOSから確認する設定

タイトルの通りだが、Vagrant を使って起動した CentOS に

→もっと見る

PAGE TOP ↑