2.0以降のPlay JavaでパワーアップしたPlayのOptionをつかう


この記事は、Play or Scala Advent Calendar 2012の23日目の記事です。

Playには、昔からF.javaという怪しげなライブラリ群があり、関数型プログラミングっぽい記述の手伝いをして、フレームワークを支えてきました。 その中でも今回は、PlayにおけるOptionの話を書こうと思います。Play Javaな人向けの記事です。PlayのOptionについては、ScalaのOptionの簡易版のようなものと想像してもらうといいかもしれません。

PlayのOptionのつかいかた

PlayのOptionは、play.libs以下にある、F.javaをインポートすることで使えます。 実際には下記のようにコントローラーなどでimport文を書きます。

import play.libs.F;

F.javaにはOption以外にも、ScalaでおなじみのTuple、Either、Promise、そしてコールバックや関数渡し用のCallbackやFunctionといった型が定義されています。

ちなみにPlay 2.0.4におけるOptionの定義は、こんな感じになっています(インターフェース的に抜粋)。Scalaにある定義に似ていますね。

public static abstract class Option<T> implements Iterable<T> {
    public abstract boolean isDefined();
    public abstract T get();
    public static <T> None<T> None();
    public static <T> Some<T> Some(T value);
    public T getOrElse(T defaultValue);
    public <A> Option<A> map(Function<T,A> function);
}

Optionを継承したクラスとして、おなじくおなじみのSomeとNoneが存在します。 isDefinedというのは、値があるかどうかを示すブール値で、Someの場合はtrue、Noneの場合はfalseになります。 また、getメソッドを使うと、Someの場合は値の取得、Noneの場合はIllegalStateExceptionが発生します。 Play 1.2.xからの大きな進歩として、getOrElseメソッドの実装が挙げられます。これにより、Optionらしい使い方が可能になりました。 mapメソッドは、Function型を使って、フィルターのように処理を適用させた値を取り出すことが出来ます。

Option.applyの実装

ただし、ScalaのようにOption(オブジェクト)でくるむと自動でSomeやNoneを返すなんていう仕様にはなっていませんので、そこは自力で作ることになります。 例えばこんな具合のユーティリティクラスを作るとかどうでしょうか。

package libs;
import play.libs.F;
public class OptionUtil {
    static public <A> F.Option<A> apply(A value) {
        if(value != null) {
            return F.Option.Some(value);
        } else {
            return F.Option.None();
        }
    }
}

これは、いたってシンプルなもので、値があればSome、なければNoneを返すというだけのものです。 しかし、ScalaのOption.applyメソッドの実装をみてみると、だいたいそんな感じなのがわかります。

Option.scala

def apply[A](x: A): Option[A] = if (x == null) None else Some(x)

さて、これを使ってみましょう。 まず、インポート文を宣言します。

import libs.OptionUtil;

続いて、てきとうなアクション内にこんな感じで書いてみます。 まずは、文字列がある場合の処理。getOrElseメソッドも使ってみます。

String testString = "文字列です";
F.Option<String> testStringOption = OptionUtil.apply(testString);
System.out.println("testStringOption is :" + testStringOption);
System.out.println("testStringOption getOrElse is :" + testStringOption.getOrElse("文字列ではありません"));

すると、

testStringOption is :Some(文字列です)
testStringOption getOrElse is :文字列です

このように出ます。 続いて、nullの場合を見てみましょう。

String testNullString = null;
F.Option<String> testNullStringOption = OptionUtil.apply(testNullString);
System.out.println("testNullStringOption is :" + testNullStringOption);
System.out.println("testNullStringOption getOrElse is :" + testNullStringOption.getOrElse("文字列ではありません"));

この結果は、こんな風に出ます。

testNullStringOption is :None
testNullStringOption getOrElse is :文字列ではありません

おお、という感じで実行が出来ました。

ScalaのOptionをつかってみる?

さて、ここまで見てきて、そもそも何故Playには、Optionが別途実装されているのかと思われる方もいるでしょう。 実はこのOptionは、PlayがJavaベースだった頃から使われてきたもので、その頃に多く使われていたものでした。今、Scalaがベースになり、大部分のコアコードがScalaで書かれている現在、そこまで活用されているものではないのでしょう。

Play 2.0とScalaは切っても切りはなせないものです。Javaで書く事になろうともです。 それで、Javaで書いたとしてもScalaのお世話にはなるのですが、当然、ScalaのライブラリなどもPlayで何かアプリケーションを作る場合は素で使えます。 つまり、Java版からScalaのOptionを使う事も可能なわけです。

こんな風に、scala.Optionとscala.Option$をまずは、インポートします。

import scala.Option$;
import scala.Option;

最後に$とついているのは、ScalaのObjectを利用するためにこういった表記になりますが詳しくは割愛します。 すると、こういう風に書く事で、ScalaのOptionとして定義ができます。

Option<String> testStringScalaOption = Option$.MODULE$.apply(testString);
System.out.println("testStringScalaOption is :" + testStringScalaOption);

nullの場合も、

Option<String> testNullStringScalaOption = Option$.MODULE$.apply(testNullString);
System.out.println("testNullStringScalaOption is :" + testNullStringScalaOption);

となります。Scalaで書くより煩雑ですが、まあ書けます。 が、問題はここからで、一見、testStringScalaOption.getOrElse(“hoge”)などと書けば値を取得出来そうに見えますが、できません。

ScalaのOptionのgetOrElseは、

final def getOrElse[B >: A](default: => B): B =
    if (isEmpty) default else this.get

こういった実装になっており、これをJavaから定義しようとすると、えと関数をごにょごにょしないとだめぽくねいですかね?ってなって面倒そうに思えるのでやめる感じになります。

ということで、素直にPlayが用意しているOptionを使うというのがよい気もします。

ビュー側での使い方

では、話をビュー側に移します。

Scalaテンプレートでは、Scala版であろうが、Java版であろうがテンプレートエンジン自体は変わらないため、下記のようにJava版であろうと、Scalaライクに記述ができます。

@Option(testString).map { s => @s }

デフォルト値を決めるなら、OptionでおなじみのgetOrElseを使ってこんな風に書けます。

@Option(testString).getOrElse("文字列ではありません")

Play内蔵のOptionを使った場合も同様に、このようにして、nullの場合(つまり、Noneの場合)のデフォルト値を設定しつつ値を取得することが可能です。

@testStringOption.getOrElse("文字列ではありません")

ということで、楽しいplay.libs.F.Optionライフを送りましょう!

Comments are closed.