只今、クラウド基盤「Google App Engine(以下、GAE)」の連載しています。
本日から「初級実装編」と称しまして、実際にモノを作っている真っ最中です。
前回でクライアントからGAEにリクエストを送信する機能を作りましたので、今回はGAEからクライアントにレスポンスする機能を作りましょう。
懐かしのFORM作戦
さて、今回のGAEではWebAPIの形式を取っており、レスポンスにはJSON文字列を返却します。JSON文字列の作成は主導ではなく、「JavaのクラスをJSONに変換するライブラリ」を使用しますので、JSONに変換する専用の型を用意しようと思います。
Struts1で言う所のFORMクラスです。
このFORMという設計発想は、私はちょっと冗長な部分があると考えています。
それは、ＤＢから取得したエンティティを、一回FORMに置き換えなければいけないからです。
図でご説明しましょう。
通常のWebシステムにおいて、最も望ましいのはＤＢをそのまま画面に表示するような正規化された画面設計です。
DBから取り出した方は、DBと1:1で対応するモデル型に格納して、そのまま画面に出力します。
これが最も合理的でして、この思想が最も活かされているのは、あの有名なRuby On Railsです。
対して、FORM設計というのは、モデル型から一回置き換えを行わなければなりません。
そして、「モデル型」と「FORM型」は形がそっくりなケースが多いんですよね。
冗長なのです。
また、画面に１コずつFORMがあるので、画面に表示するテキストボックスが１コだけなのにわざわざFORMを作ってFORMが溢れかえっていくFORM爆発という事象が発生したり。
このように、FORMを採用したクラス設計は、ソースを汚くする罠が仕込まれていると考えるべきです。
だから、本来はRORのように、DBと画面の両側面を擦り合わせる設計をすべきというのが最も理想的。
しかしですね、GAEの場合は、あえてFORM作戦を採用する必要があると私は考えました。
と言うのもですね、作っているとどうしても不純物が混ざり込んで来るんです。
例えば、GAEは標準では「yyyy-MM-dd」形式ですが、画面には「yyyy/MM/dd」で表示したい、とか。
ＤＢのレコードだけではなくて、WebAPIとして使い易い様に追加でレスポンスコードを出力したい、とか。
ちょこちょこちょこちょこ不純物のような要件が混ざり込んできて、とてもモデル型そのままでの出力は出来ないのですよ。
だから、その不純物を吸収するステップであるFORM型が必要になってきます。
GAEは多少泥臭い設計で丁度良い。
これ、凄く大事な概念です。
GAEは通常開発には無い制約がありますので、その制約をJavaコーディングで自力解決する必要が出て来ます。
そういったイレギュラーパターンに対応する為に、あえて冗長化したクラス設計を行う。
ベストの追求よりもリスク回避。
クラス設計担当者の匙加減が要求される部分です。
やっぱりGAEは通常開発より難しい印象ですね。
名付けてJET
しかし、StrutsのFORMというのは、HTMLのFORMタグと同一という意味を込めたネーミングです。GAEのWebAPIは別にFORMに限ったことではないので、クラスにFORMと命名するのは本来の趣旨から外れてしまいますね。
役割はFORMと同じですが、ネーミングは変えた方が良いと思いました。
所謂、DTOシリーズの新型の登場です。
DTOというのは、「Data Transfer Object」という意味で、単純にデータを持っているだけの型ということです。
これを機能毎にネーミングを変えるというのが良くあるパターンです。
- Struts1で画面とマッピングするDTO：FORM
- DBから取得したレコードとマッピングするDTO：MODEL or entity
- 実装の都合で用意する便利クラス：DTO
こんな感じです。
全部DTOに過ぎないのですが、用途に応じてネーミングを分けることで可読性を高める。
これもクラス設計には大事な要件です。
さて、今回作成するDTOは「JSONレスポンスに対応するDTO」という明確な役割付けがありますので、それに相応しいネーミングをしようと思います。
名付けて、「Json Engine Transfer Object」
Jet型です。
このJet型にセットしたJava型をJSON文字列に変換してレスポンスする。
このクラス設計で行きます！！
終わりに
これでかなり手堅い設計になったと思います。
後はJET型が増えすぎてJET爆発が起きないようにコントロールする必要がありますが、ここはちゃんと良く見るしか無いですね。
昔のStruts1の時代は、まだ開発セオリーが未熟だったこともあってFORM爆発が頻発していましたが、
今の時代のエンジニアならばそういうことが起きないように十分コントロールしていくことが出来ると思います。
次回は、上記の図にある「変換ライブラリで自動変換」
このライブラリの使い方についてご紹介します。
