Scalaプログラミングのはまりポイントとして頻出頻度が高く影響も甚大なのは、＝＝メソッドとcontainsメソッドの型チェックだと思います。
この2つのメソッドは(多分Javaとの互換性の問題で)、引数に定義されている型がAnyであるため事実上型チェックが効かない仕様になっています。
具体的には以下のような処理がコンパイルエラーにならず通ってしまうという問題です。
scala> "1" == 1
"1" == 1
res112: Boolean = false
scala> List(1, 2, 3).contains("1")
List(1, 2, 3).contains("1")
res113: Boolean = falseいずれの場合も、常に判定結果はfalseになり、意図した処理でないことは明らかですがScalaコンパイラはエラーとして弾いてくれません。
Scalaは型チェックが厳しいので、きちんとプログラミングしていればケアレスミス的なバグはほとんどでないのですが、逆に出る場合は＝＝メソッドとcontainsメソッドのあたりに集中するというのがボクの実感です。
例題
＝＝メソッドとcontainsメソッドの問題がよく発生する例として、クラスで保持しているプロパティの型がOptionのケースがあります。
以下の例ではcityの型がOption[String]となっています。
case class Person(name: String, city: Option[String])
特によくバグになるパターンとしては最初に:
case class Person(name: String, city: String)
として(Optionなしの)String型で定義していたものを、機能追加などでOption[String]に変更した場合です。このような場合には、コンパイルエラーで影響箇所が検出されることを期待しているわけですが、＝＝メソッドとcontainsメソッドを使っている場所はエラーにならず、ロジック的に常にfalseとなるため、即バグになってしまいます。
準備
説明では以下のクラスとデータを使用します。
case class Person(name: String, city: Option[String])
val cities = Vector("Yokohama", "Kawasaki", "Kamakura")
val person = Person("Taro", Some("Yokohama"))
val persons = Vector(
Person("Taro", Some("Yokohama")),
Person("Jiro", Some("Kawasaki")))ScalazとScalactic
＝＝メソッドとcontainsメソッドの問題に対応するための機能を提供するライブラリとしてScalazとScalacticを使ってみます。
ScalazはMonadicプログラミング向けのライブラリの1機能(型クラスEqual)として＝＝メソッド問題の解を提供しています。
一方Scalacticは、Scalatestのスピンオフ機能で＝＝メソッド問題を中心にオブジェクト操作の便利機能を提供するライブラリです。
ダメロジック
ダメロジックとして＝＝メソッドとcontainsメソッドの例を順にみていきます。
＝＝メソッド
Personのcityプロパティの方はOption[String]なのでStringと比較しても意味がないのですが、以下のように＝＝メソッドでは比較できてしまいます。
person.city == "Yokohama"
コンパイルは通りますが、実行結果は必ずfalseになってしまいます。
containsメソッド
Personの集まりからcitiesに登録された市に所属する人を抽出する処理です。
persons.filter(x => cities.contains(x.city))
本来比較できないPersonのcityプロパティのOption[String]と、citiesに入っているStringを比較していますが、コンパイルエラーになりません。
しかし、containsメソッドの結果は必ずfalseになるため、全体の実行結果は必ず空の集まりが返ってきてしまいます。
Scalazによる解
まずScalazの提供する機能を使ってみます。
準備として以下のimportを行います。
import scalaz._, Scalaz._
＝＝メソッド
Scalazでは、型チェックあり版の＝＝メソッドとして＝＝＝メソッドを提供しています。
エラー検出
オブジェクトの同定比較として＝＝メソッドの代わりに＝＝＝メソッドを用いると型チェックしてエラー検出するようになります。
person.city === "Yokohama"
[error] .../src/main/scala/sample/Main.scala:66: type mismatch;
[error] found : String("Yokohama")
[error] required: Option[String]
[error] person.city === "Yokohama"
[error] ^簡単に使えて効果抜群です。
対応
コンパイルエラーに対する対応は、比較の型を合わせる修正です。
person.city === Some("Yokohama")containsメソッド
Scalazでは、型チェックあり版のcontainsメソッドとしてelementメソッドを提供しています。
エラー検出
オブジェクトの集まりでの存在確認にcontainsメソッドの代わりにelementメソッドを用いると型チェックしてエラー検出するようになります。
persons.filter(x => cities.element(x.city))
[error] .../src/main/scala/sample/Main.scala:67: type mismatch; [error] found : Option[String] [error] required: String [error] persons.filter(x => cities.element(x.city)) [error] ^
こちらも簡単に使えて効果抜群です。
対応
コンパイルエラーに対する対応は、比較の型を合わせる修正です。以下の例では、Optionのfoldメソッドを使ってみました。
persons.filter(_.city.fold(false)(cities.element))
Scalacticによる解
Scalacticで同定比較によるコンパイラエラー抽出を行うためには以下のimportを行います。
import scalactic._ import TypeCheckedTripleEquals._
「import TypeCheckedTripleEquals._」を他のものに変えると、同定比較の方式を変更することができます。
＝＝メソッド
ScalacticではScalazと同様に同定比較によるコンパイラエラー抽出用に型チェックあり版の＝＝メソッドとして＝＝＝メソッドを提供しています。
エラー検出
オブジェクトの同定比較として＝＝メソッドの代わりに＝＝＝メソッドを用いると型チェックしてエラー検出するようになります。
person.city === "Yokohama"
[error] .../src/main/scala/sample/Main.scala:28: types Option[String] and String do not adhere to the type constraint selected for the === and !== operators; the missing implicit parameter is of type org.scalactic.CanEqual[Option[String],String] [error] person.city === "Yokohama" [error] ^
こちらも簡単に使えて効果抜群です。
対応
コンパイルエラーに対する対応は、比較の型を合わせる修正です。
person.city === Some("Yokohama")containsメソッド
ScalacticではScalazのelementメソッドに相当する機能はないようなので＝＝＝メソッドを使って対応してみます。
エラー検出
containsメソッドの代わりにexistsメソッドを使い、同定比較に＝＝＝メソッドを使ってみました。
persons.filter(x => cities.exists(_ === x.city))
[error] .../src/main/scala/sample/Main.scala:29: types String and Option[String] do not adhere to the type constraint selected for the === and !== operators; the missing implicit parameter is of type org.scalactic.CanEqual[String,Option[String]] [error] persons.filter(x => cities.exists(_ === x.city)) [error] ^
containsメソッドを使うより若干ロジックが入りますが、気になるほどではないと思います。
対応
コンパイルエラーに対する対応は、比較の型を合わせる修正です。
persons.filter(x => cities.exists(y => x.city === Some(y)))
ScalazとScalacticの使い分け
型安全な同定比較機能としてScalazとScalacticで同等の使い勝手の機能が提供されていることが確認できました。
Scalazは汎用のMonadicプログラミング向けライブラリなので、Scalazを使用している場合はありがたく＝＝＝メソッド、elementメソッドを使用するのがよいと思います。
Scalacticは同定比較機能として以下の機能を提供しています。
- Torerance (値の誤差範囲を考慮した比較)
- 同定比較方法のカスタマイズ (大文字小文字の区別の有無など)
また以下のユーティリティ機能も提供しています。
- Or/Every (Validation結果の格納)
- 事前条件の文字列補完
- スナップショット用の文字列補完
こういったユーティリティ機能を使う場合にはScalacticが選択肢になります。
＝＝＝メソッドだけ欲しい場合は、どちらを選んでもよいですが暗黙定義の影響範囲が少なそうなScalaticの方が若干使い勝手がよさそうです。
まとめ
地味な話題ですが結構開発工数に影響する＝＝メソッドとcontainsメソッドの問題と、その解決策についてご紹介しました。
防御的プログラミングを心がけるなら＝＝メソッドとcontainsメソッドは使わないぐらいの心持ちでもよいと思います。
Scalazは＝＝＝メソッドだけのために採用するのは心理的障壁が高そうですが、その場合はScalacticを選ぶとよいでしょう。
Scalacticは、事前条件の文字列補完、スナップショット用の文字列補完の機能が地味に便利なので、そういう意味でも使い出があると思います。
諸元
- Java 1.7.0_75
- Scala 2.11.7
- Scalaz 7.2.0
- Scalactic 3.0.0-M15
投稿
