caseクラスの抽出

ディレクティブ によって実行される値の抽出は、適切な型安全性とエラー処理を備えた興味深いリクエストプロパティをルートロジックに提供するうえで便利です。 しかし、場合によってはより多くのことを望むかもしれません。 この例を考えてみましょう。

case class Color(red: Int, green: Int, blue: Int)

val route =
  path("color") {
    parameters('red.as[Int], 'green.as[Int], 'blue.as[Int]) { (red, green, blue) =>
      val color = Color(red, green, blue)
      // ... route working with the `color` instance
    }
  }

ここでは、-parameters-scala-`ディレクティブを使用して3つの ` Int``値を抽出し、 `` Color``のcaseクラスのインスタンスを構築します。 ここまでは順調ですね。 しかし、モデルクラスがいくつかのパラメータを持っているときに、モデルクラスのコンストラクタに引数を与えるためだけに引数をキャプチャーすることによってオーバーヘッドが導入されると、ルート定義がいくらか乱雑になる可能性があります。

モデルクラスがcaseクラスである場合、この例のように、Akka HTTPはさらに短くて簡潔な構文をサポートしています。 上記の例を次のように書くこともできます：

case class Color(red: Int, green: Int, blue: Int)

val route =
  path("color") {
    parameters('red.as[Int], 'green.as[Int], 'blue.as[Int]).as(Color) { color =>
      // ... route working with the `color` instance
    }
  }

任意のディレクティブを ``as(...)``で抽出して後置することができます。 モデルcaseクラスのコンパニオンオブジェクトを単に ``as``修飾子メソッドに渡すだけで、基礎となるディレクティブは、モデルクラスの型の1つの値だけを抽出する同等のものに変換されます。 リフレクションは必要ありませんし、caseクラスに特別なインターフェイスを実装する必要もありません。 唯一の要件は、 ``as``呼び出しをつけるディレクティブが適切な型と適切な順序で正しい数の抽出を生成することです。

*いくつかの*ディレクティブによって生成された抽出からcaseクラスのインスタンスを構築したい場合は、 ``as``呼び出しを使用する前にまずディレクティブを ``&``演算子で結合することができます:

case class Color(name: String, red: Int, green: Int, blue: Int)

val route =
  (path("color" / Segment) & parameters('r.as[Int], 'g.as[Int], 'b.as[Int]))
    .as(Color) { color =>
      // ... route working with the `color` instance
    }

ここで `` Color``クラスは、パラメータではなくパス要素として提供される ``name``という別のメンバを取得しました。 ``path``と ``parameters``ディレクティブを &``で結合することで、 ` Color``のクラスのメンバーリストに直接適合する4つの値を抽出するディレクティブを作成します。 したがって、 `` as``修飾子を使用して、ディレクティブを1つの `` Color``インスタンスのみを抽出するものに変換することができます。

一般に、3つ以上の抽出とともに動作するルートがある場合は、これらのcaseクラスを導入して、caseクラス抽出に頼るのが良い考えです。 特に、それはもう一つの素晴らしい機能をサポートしています：検証。

case class Color(name: String, red: Int, green: Int, blue: Int) {
  require(!name.isEmpty, "color name must not be empty")
  require(0 <= red && red <= 255, "red color component must be between 0 and 255")
  require(0 <= green && green <= 255, "green color component must be between 0 and 255")
  require(0 <= blue && blue <= 255, "blue color component must be between 0 and 255")
}