Dart言語で型安全で使いやすい擬似的なUnion型を実装する方法

どうも、Shinyaです。

この記事では、Dart言語で型安全で使いやすい擬似的なUnion型を実装する方法について書いていこうと思います。

// 文字列または数値を受け取る型
type StringOrNumber = string | number;

// Union型の関数
function printValue(value: StringOrNumber) {
    console.log(value);
}

// 使用例
printValue("Hello");  // 文字列OK
printValue(42);       // 数値もOK

事前準備

この記事に書いていく内容を実践するためには、まずDart言語のインストールが必須となります。そのため、Dart言語をまだインストールしていない方は、以下の記事を参考にDart言語をインストールしてください。

Homebrewを使用してFlutterとDartを簡単にインストールする方法

この記事はこんな人にオススメクロスプラットフォーム開発に興味のある人FlutterとDartを使用した開発に興味のある人Flutterを簡単に導入する方法を知りたい人どうも、Shinyaです。この記事では、Homebrewを使用してFlut...

shinyakato.dev

2025.08.16

Dart言語で擬似的なUnion型を実装していく

それでは、早速Dart言語でUnion型を実装していきましょう。Dart言語でUnion型を実装する主な方法は次の通りです。

• sealedクラスを使用する
• freezedパッケージを使用する

sealedクラスを使用してUnion型を実装する

例えば、次のように実装できます。

/// 支払方法に関するUnion型
sealed class Payment {
  const factory Payment.credit(final String cardNumber) = Credit;
  const factory Payment.payPal(final String email) = PayPal;
  const factory Payment.bank(final String accountNumber) = Bank;
}

/// クレジットカード
final class Credit implements Payment {
  /// カード番号
  final String cardNumber;

  const Credit(this.cardNumber);
}

/// PayPal
final class PayPal implements Payment {
  /// メールアドレス
  final String email;

  const PayPal(this.email);
}

/// 銀行
final class Bank implements Payment {
  /// 顧客番号
  final String accountNumber;

  const Bank(this.accountNumber);
}

上記で実装したPaymentオブジェクトの使い方は次の通りです。Dartのパターンマッチング構文を使用して簡単にそれぞれの型を判別することができます。

import 'package:dart_union/dart_sealed_union.dart';

void main(List<String> arguments) {
  final payments = <Payment>[
    const Payment.credit('123-4567-890'),
    const Payment.payPal('xyz@example.com'),
    const Payment.bank('xxxx-yyyy-zzzz'),
  ];

  for (final payment in payments) {
    switch (payment) {
      case Credit():
        print('Credit: ${payment.cardNumber}');
      case PayPal():
        print('PayPal: ${payment.email}');
      case Bank():
        print('Bank: ${payment.accountNumber}');
    }
  }
}

上記の検証用のmain関数を実行すると、次のようにsealedクラスで実装したUnion型がパターン毎に振り分けられることを確認できます。

Credit: 123-4567-890
PayPal: xyz@example.com
Bank: xxxx-yyyy-zzzz

freezedパッケージを使用してUnion型を実装する

例えば、次のように実装できます。

name: dart_union
environment:
  sdk: ^3.9.0

dependencies:
  freezed_annotation: ^3.1.0

dev_dependencies:
  freezed: ^3.2.0
  build_runner: ^2.7.0

import 'package:freezed_annotation/freezed_annotation.dart';

part 'dart_freezed_union.freezed.dart';

/// 支払方法に関するUnion型
@freezed
abstract class Payment with _$Payment {
  const factory Payment.credit({required Credit data}) = PaymentCredit;
  const factory Payment.payPal({required PayPal data}) = PaymentPayPal;
  const factory Payment.bank({required Bank data}) = PaymentBank;
}

/// クレジットカード
final class Credit {
  final String cardNumber;

  const Credit(this.cardNumber);
}

/// PayPal
final class PayPal {
  final String email;

  const PayPal(this.email);
}

/// 銀行
final class Bank {
  final String accountNumber;

  const Bank(this.accountNumber);
}

freezedはbuild_runnerを使用したコード生成が必須なので、コマンドプロンプトで次のコマンドを実行してください。

dart run build_runner build --delete-conflicting-outputs

上記のコマンドを実行すると、次の画像のようにfreezedが実行に必要なコードを自動生成したことを確認できます。

上記で実装したPaymentオブジェクトの使い方は次の通りです。sealedクラスを使用して実装した場合と同様に、Dartのパターンマッチング構文を使用して簡単にそれぞれの型を判別することができます。

import 'package:dart_union/dart_freezed_union.dart';

void main(List<String> arguments) {
  final payments = <Payment>[
    const Payment.credit(data: Credit('123-4567-890')),
    const Payment.payPal(data: PayPal('xyz@example.com')),
    const Payment.bank(data: Bank('xxxx-yyyy-zzzz')),
  ];

  for (final payment in payments) {
    switch (payment) {
      case PaymentCredit():
        print('Credit: ${payment.data.cardNumber}');
      case PaymentPayPal():
        print('PayPal: ${payment.data.email}');
      case PaymentBank():
        print('Bank: ${payment.data.accountNumber}');
    }
  }
}

また、freezedを使用した場合には、デフォルトで次の例のように.whenや.whenOrNullといった便利なユーティリティが利用できます。

import 'package:dart_union/dart_freezed_union.dart';

void main(List<String> arguments) {
  final payments = <Payment>[
    const Payment.credit(data: Credit('123-4567-890')),
    const Payment.payPal(data: PayPal('xyz@example.com')),
    const Payment.bank(data: Bank('xxxx-yyyy-zzzz')),
  ];

  for (final payment in payments) {
    payment.when(
      credit: (data) => print('Credit: ${data.cardNumber}'),
      payPal: (data) => print('PayPal: ${data.email}'),
      bank: (data) => print('Bank: ${data.accountNumber}'),
    );
  }
}