okuzawatsの日記

Android / Kotlin / GitHub Actions Enthusiast 🤖

[Kotlin] nullオブジェクトパターン

profile

書いている人 モバイルアプリケーションアーキテクト(Android)として働いています。モバイルアプリケーションのアーキテクチャ、自動テスト、CI/CDに興味があります。もっと詳しく

Kotlinでnullオブジェクトパターンを実装する例です。こんな感じのinterfaceを考えます。

interface AwesomeRunnable {
  fun runSomething()
}

nullオブジェクトパターンを使わない場合

nullオブジェクトパターンを使わない場合は、こんな感じのifチェックを呼び出し側で毎回書かないといけません。対象の変数がnullなのかどうかということに興味がある場合は毎回nullチェックをするのもやぶさかではありません。

fun main() {
  val awesomeRunnable: AwesomeRunnable? = null
  if (awesomeRunnable != null) {
    awesomeRunnable.runSomething()
  }
}

nullオブジェクトパターンを使う場合

対象の変数がnullなのかどうかということに興味がない場合もあります。こういう場合はnullオブジェクトパターンの使用に一考の価値があります。

以下のコードは「何かを行う」関数を呼び出しています。

fun main() {
  val doSomethingRunnable: AwesomeRunnable = object : AwesomeRunnable {
    override fun runSomething() {
      println("do something")
    }
  }

  doSomethingRunnable.runSomething()
}

これに対して、以下のコードはnullオブジェクトパターンを用いた「何もしない」関数を呼び出しています。この場合は、インスタンスに対して runSomething 関数を呼び出しても、実際には何の処理も行われません12

fun main(args: Array<String>) {
  val doNothingRunnable: AwesomeRunnable = object : AwesomeRunnable {
    override fun runSomething() {
      // NOP
    }
  }

  doNothingRunnable.runSomething()
}

nullオブジェクトパターンを用いたことで、「何かを行う」場合も「何もしない」場合も、処理を呼び出す側ではnullチェックが不要となっています。このように、オブジェクトがnullかどうかということには関心を持ちたくないが、実際には処理を呼び出した時に何もしないで欲しいことがある、という場合にnullオブジェクトパターンが使えることがあります。

上記の例ではオブジェクト式を用いた無名クラスでnullオブジェクトを作成していますが、以下のようにnullオブジェクトをひとつだけ定義しておけば、コードの重複を防ぐことができます3

object NullRunnable : AwesomeRunnable {
  override fun runSomething() {
    // NOP
  }
}

  1. Unit を返す、という処理は行われます。 ↩︎

  2. Kotlinの object キーワードを用いていますが、nullオブジェクトの「オブジェクト」とはあまり関係がありません。 ↩︎

  3. この例でもKotlinの object キーワードを用いていますが、こちらもnullオブジェクトの「オブジェクト」とはあまり関係がありません。 ↩︎

Related