Scala実践「Either型を使ってimmutable（不変）なコードを書こう！」

2018/12/13 - プログラミング手法, プログラム言語 java, sbt, Scala

はじめに

みなさんこんにちは、プロダクト開発本部の亀梨です。
普段はXmediaOneというメディアプランニング・広告運用管理・トラッキング・マーケティング分析を行う
統合プラットフォームの開発を担当しています。

Scalaでイケてるコードを書きたい！

背景

わたくしはDACに入社してからScalaを書くことになりました。それまでは以前の会社で3年ほどPHPを書いてきて他のサーバーサイド言語は知らなかったので、
スクリプト言語からコンパイル言語への移行には最初は非常に苦労しました。…いや、今でも苦労しています（笑）。

さて今回はScalaのEither型を取り上げます。基本的な使い方と具体的な例を挙げて実践に活用出来るヒントになればと思います。
ちなみに過去にScala関連で書いた記事は以下となります。参考まで。

イケてるコードの定義

Scalaの特徴の一つとして「immutable（不変）」なコードが簡潔かつ副作用が無いと推奨されています。
そして今回のケースとしては、いかにimmutableにコードを書けるかがイケてるかどうかの定義とします。
このあたりはScalaビギナーが通る最初の関門ではないでしょうか。

Either型とは

それでははじめにEither型について触れておきましょう。
Either型はその名の通り「2つのうちどちらか一方」という値を表します。この特徴のため、主にエラー処理で「成功時の値or失敗時の値」として扱われることが多いです。EitherはRightとLeftという2つの値を持ちます。REPLでコードを書いてみましょう。

scala> val right: Either[String, Int] = Right(123)
v1: Either[String,Int] = Right(123)

scala> val left: Either[String, Int] = Left("abc")
v2: Either[String,Int] = Left(abc)

scala> val right: Either[String, Int] = Right(123)

v1: Either[String,Int] = Right(123)

scala> val left: Either[String, Int] = Left("abc")

v2: Either[String,Int] = Left(abc)

一般的にEitherを使う場合、Left値をエラー値、Right値を正常な値とみなすことが多いです。
英語の”right”が正しいという意味なので、それにかけているという説があります。

イケてるコード具体例

それではEither型の基本に触れた上で早速コードの具体例を書いていきます。
前提として、

とある商品IDリストを格納している配列がある
この商品ID一つ一つを元にDBにクエリを投げて、この商品が有効であるかを確認→有効であれば商品情報を取得する
商品情報を改めて配列に格納する
有効な商品に対してなんらかの処理を行う

という処理を行うこととします。

【びふぉー】mutable（可変）でイケてないコード

まずはEither型を使わない場合のコードです。

　import scala.collection.mutable.ListBuffer
  type itemId
  case class ItemFindForm(itemId: itemId)
  object ItemService {
    def find(itemFindForm: itemFindForm): List[item] = ???
  }
  def itemIds: List[itemId]

  /** 
   * Beforeここから
   */
  val itemList = new ListBuffer[Message]
  itemIds.foreach(itemId => {
    val targetItem = ItemService.find(MessageFindForm(itemId))
    if (targetItem.isEmpty) {
      // エラー処理
    } else {
      itemList += targetItem.head
    }
  })
  
  itemList...// 何らかの処理

　import scala.collection.mutable.ListBuffer

type itemId

case class ItemFindForm(itemId: itemId)

object ItemService {

def find(itemFindForm: itemFindForm): List[item] = ???

}

def itemIds: List[itemId]

/**

* Beforeここから

val itemList = new ListBuffer[Message]

itemIds.foreach(itemId => {

val targetItem = ItemService.find(MessageFindForm(itemId))

if (targetItem.isEmpty) {

// エラー処理

} else {

itemList += targetItem.head

}

})

itemList...// 何らかの処理

はい、こんな感じです。このコードだと予め作成しておいた空の配列に有効な商品情報を次々と追加していく形になるので、
itemListがmutable（可変）となり副作用を伴います。。。
まぁこの書き方でも悪くはないと思うのですが、せっかくScalaで書くならその特徴を生かしたいですよね。

【あふたー】immutable（不変）でイケてるコード

では次にEither型を使ってリファクタリングしたコードです。

　import scala.collection.mutable.ListBuffer
  type itemId
  case class ItemFindForm(itemId: itemId)
  object ItemService {
    def find(itemFindForm: itemFindForm): List[item] = ???
  }
  def itemIds: List[itemId]

  /** 
   * Afterここから
   */
  val result: Seq[Either[String, Message]] = itemIds.map(itemId => {
    val targetItem = ItemService.find(ItemFindForm(itemId))
    targetItem.headOption.toRight(s"$itemId not found.")
  })
  val itemList: Seq[Item] = result.collect { case Right(item) => item }
  if (itemIds.length != itemList.length) {
    // エラー処理
  } else {
    // 何らかの処理
  }

　import scala.collection.mutable.ListBuffer

type itemId

case class ItemFindForm(itemId: itemId)

object ItemService {

def find(itemFindForm: itemFindForm): List[item] = ???

}

def itemIds: List[itemId]

/**

* Afterここから

val result: Seq[Either[String, Message]] = itemIds.map(itemId => {

val targetItem = ItemService.find(ItemFindForm(itemId))

targetItem.headOption.toRight(s"$itemId not found.")

})

val itemList: Seq[Item] = result.collect { case Right(item) => item }

if (itemIds.length != itemList.length) {

// エラー処理

} else {

// 何らかの処理

}

はい、これでEither型で関数型を使ったコードとなります。
有効な商品情報と無効な商品を一度に配列に格納でき後から追加ができないようになるため、
immutable（不変）で副作用のないコードとなります。あと最後のif文でエラー処理か正常の処理かを分岐しているため可読性も増しているかと思います。

あと個人的にimmutableなコードが書けたときになんとも言えない高揚感と興奮を覚えます（笑）。

まとめ

というわけで簡単ではありますがEither型の具体例を紹介いたしました。
わたくしもまだまだScalaは勉強中でビギナー感が抜けない状態ではありますが、だからこそ気づきも多いかと思うので
またなにか良い具体例があればここで共有できればと思います。

それではまた！

: GoogleスプレッドシートからTreasureDataへデータを取り込む

AudienceOneの開発を担当しています。skryoです。またまたTreasureDataネタですが、今回はGoogleスプレッドシートからGoogleAppsScriptを使ってTreasureDataへデータを取り込む手順を紹介したいと思います。なぜ？ Googleスプレッドシート上でマ …

: 読み方がわからない技術用語 2015

英語圏での読み方を基本的には参考にしています。英語圏でも複数の読み方をしているケースもあるようなので、あくまでも参考程度。2015と書きながら、古い言葉も混じってますが。 async – えーしんく Alt – おると ASUS – えいすーす bower &#8 …

: D3.jsとその活用事例について

D3.jsとは？ D3とは「Data Driven Document」の略で、データに基づいてドキュメントを操作するための JavaScript ライブラリです。ご存知の方も多いと思いますが、ちょっとだけD3.jsの基本的な使い方、そして弊社プラットフォームでの利用についてご紹介したいと思います。 …

: Scala入門基礎編「Scalaの書き方を理解しよう」 – PHP使いからScala使いへ転身！

はじめにみなさんこんにちは、プロダクト開発本部の亀梨です。普段はXmediaOneというメディアプランニング・広告運用管理・トラッキング・マーケティング分析を行う統合プラットフォームの開発を担当しています。さて、今回はScala入門第二弾として、Scalaの書き方を紹介する基礎編をお送りしま …

: Railsたった14行でアドサーバーAPIができた話

こんにちは。駆け出しエンジニアの近江です。最近Railsにハマっているので、私が2年間担当しているアドサーバの、簡易版をRailsで作ってみました。広告やキャンペーンを登録する管理画面はある前提で、ここからたった14行追加するだけでアドサーバーのHTTP APIを作りたいと思います。ついでに配信 …

: 【未経験からのRuby on Rails – 第3回】変数と定数

こんにちは。新卒1年目のmatsuariです。今回はRubyに限らずプログラミングを学ぶ上で非常に重要となる「変数と定数」について、ご紹介していきます。変数とは・・・オブジェクトを一時的に格納しておく箱で、オブジェクトを識別するために利用します。言葉だけでは理解が難しいかと思いますので、まず …

: ナイーブベイズで羽生さんと羽生くんを分類してみた

はじめにこんにちは。システム開発部の中村です。機械学習についての理解を促進するため、データから分類モデルを自動で構築する古典的な方法である、ナイーブベイズ分類器を実装してみました。最近はCloudVisionAPIなど専ら画像解析が流行っていますが、自分のような初学者には敷居が高そうだっ …

: AWSにRailsアプリをデプロイする(準備編)

今回は、せっかくRailsで開発したアプリをAWS上に公開してみたいのでその構築方法をまとめていきたいと思います。 (前回の記事：初心者がRailsで開発 – deviseでユーザー認証設定 ) AWSの設定はすでに社内で使用できるようになっていたので割愛します。 ★やりたいこと Gitlabでコ …

: PyStanによるはじめてのマルコフ連鎖モンテカルロ法

はじめにこんにちは。システム開発部の中村です。社内で行っている『データ解析のための統計モデリング入門』(所謂緑本)の輪読会に参加した所、大変わかりやすい本だったものの、Macユーザには悲しい事に実装サンプルがWinBUGSだったため、 9章の一般化線形モデルのベイズ推定によるアプローチをPyt …

: Selenium × PHP でテスト自動化！【環境構築編】

はじめにみなさんこんにちは、プロダクト開発本部の亀梨です。普段はXmediaOneというメディアプランニング・広告運用管理・トラッキング・マーケティング分析を行う統合プラットフォームの開発を担当しています。テスト自動化の背景わたくしが担当するXmediaOneでは品質担保のために①コードベ …

PREV: 最強のSQLクライアント（GUIツール）「TeamSQL」を使ってみた！
NEXT: Scala番外編「Boxに保存したファイルをBox APIを使ってダウンロードしよう！」