コンストラクタ

目次 keyboard_arrow_down keyboard_arrow_up

コンストラクタの種類
インスタンス変数の初期化
コンストラクタの継承
- デフォルト以外のスーパークラスコンストラクタ
- スーパパラメータ

more_horiz

コンストラクタは、クラスのインスタンスを作成する特別な関数です。

Dartは多くの種類のコンストラクタを実装しています。デフォルトコンストラクタを除き、これらの関数はクラスと同じ名前を使用します。

生成コンストラクタ：新しいインスタンスを作成し、インスタンス変数を初期化します。
デフォルトコンストラクタ：コンストラクタが指定されていない場合に新しいインスタンスを作成するために使用されます。引数を取らず、名前もありません。
名前付きコンストラクタ：コンストラクタの目的を明確にするか、同じクラスに対して複数のコンストラクタの作成を可能にします。
定数コンストラクタ：コンパイル時定数としてインスタンスを作成します。
ファクトリコンストラクタ：サブタイプの新しいインスタンスを作成するか、キャッシュから既存のインスタンスを返します。
リダイレクトコンストラクタ：同じクラス内の別のコンストラクタへの呼び出しを転送します。

クラスをインスタンス化するには、生成コンストラクタを使用します。

dartclass Point {
  // Initializer list of variables and values
  double x = 2.0;
  double y = 2.0;

  // Generative constructor with initializing formal parameters:
  Point(this.x, this.y);
}

コンストラクタを宣言しない場合、Dartはデフォルトコンストラクタを使用します。デフォルトコンストラクタは、引数も名前も持たない生成コンストラクタです。

クラスに対して複数のコンストラクタを実装する場合、または明確にするために、名前付きコンストラクタを使用します。

dartconst double xOrigin = 0;
const double yOrigin = 0;

class Point {
  final double x;
  final double y;

  // Sets the x and y instance variables
  // before the constructor body runs.
  Point(this.x, this.y);

  // Named constructor
  Point.origin()
      : x = xOrigin,
        y = yOrigin;
}

サブクラスは、スーパークラスの名前付きコンストラクタを継承しません。スーパークラスで定義された名前付きコンストラクタを持つサブクラスを作成するには、サブクラスでそのコンストラクタを実装します。

クラスが不変のオブジェクトを生成する場合は、これらのオブジェクトをコンパイル時定数にします。オブジェクトをコンパイル時定数にするには、すべてのインスタンス変数を`final`として設定した`const`コンストラクタを定義します。

dartclass ImmutablePoint {
  static const ImmutablePoint origin = ImmutablePoint(0, 0);

  final double x, y;

  const ImmutablePoint(this.x, this.y);
}

定数コンストラクタが常に定数を作成するとは限りません。`const`ではないコンテキストで呼び出される可能性があります。詳細については、コンストラクタの使用に関するセクションを参照してください。

コンストラクタは、同じクラス内の別のコンストラクタにリダイレクトされる場合があります。リダイレクトコンストラクタには空の本体があります。コンストラクタはコロン（:）の後にクラス名ではなく`this`を使用します。

dartclass Point {
  double x, y;

  // The main constructor for this class.
  Point(this.x, this.y);

  // Delegates to the main constructor.
  Point.alongXAxis(double x) : this(x, 0);
}

コンストラクタの実装において以下の2つのケースのいずれかに遭遇した場合、`factory`キーワードを使用します。

コンストラクタが常にクラスの新しいインスタンスを作成するとは限りません。ファクトリコンストラクタは`null`を返すことはできませんが、以下を返す可能性があります。
- 新しいインスタンスを作成する代わりに、キャッシュから既存のインスタンスを返す
- サブタイプの新しいインスタンスを返す
インスタンスを作成する前に、重要な処理を実行する必要があります。これには、引数の確認や、初期化リストでは処理できないその他の処理が含まれる場合があります。

次の例には、2つのファクトリコンストラクタが含まれています。

`Logger`ファクトリコンストラクタは、キャッシュからオブジェクトを返します。
`Logger.fromJson`ファクトリコンストラクタは、JSONオブジェクトからfinal変数を初期化します。

dartclass Logger {
  final String name;
  bool mute = false;

  // _cache is library-private, thanks to
  // the _ in front of its name.
  static final Map<String, Logger> _cache = <String, Logger>{};

  factory Logger(String name) {
    return _cache.putIfAbsent(name, () => Logger._internal(name));
  }

  factory Logger.fromJson(Map<String, Object> json) {
    return Logger(json['name'].toString());
  }

  Logger._internal(this.name);

  void log(String msg) {
    if (!mute) print(msg);
  }
}

ファクトリコンストラクタは他のコンストラクタと同様に使用します。

dartvar logger = Logger('UI');
logger.log('Button clicked');

var logMap = {'name': 'UI'};
var loggerJson = Logger.fromJson(logMap);

リダイレクトファクトリコンストラクタは、リダイレクトコンストラクタが呼び出されたときに使用する別のクラスのコンストラクタへの呼び出しを指定します。

dart

factory Listenable.merge(List<Listenable> listenables) = _MergingListenable

通常のファクトリコンストラクタは、他のクラスのインスタンスを作成して返すことができるように見えるかもしれません。これにより、リダイレクトファクトリは不要になります。リダイレクトファクトリにはいくつかの利点があります。

抽象クラスは、別のクラスの定数コンストラクタを使用する定数コンストラクタを提供できます。
リダイレクトファクトリコンストラクタは、フォワーダが形式パラメータとそのデフォルト値を繰り返す必要性を回避します。

Dartでは、コンストラクタを呼び出さずにパラメータとして提供できます。*ティアオフ*（括弧を*引き剥がす*ため）と呼ばれ、同じパラメータでコンストラクタを呼び出すクロージャとして機能します。

ティアオフが、メソッドが受け入れるシグネチャと戻り値の型が同じコンストラクタである場合、ティアオフをパラメータまたは変数として使用できます。

ティアオフは、ラムダ式や無名関数とは異なります。ラムダ式はコンストラクタのラッパーとして機能するのに対し、ティアオフはコンストラクタそのものです。

ティアオフを使用する

gooddart// Use a tear-off for a named constructor: 
var strings = charCodes.map(String.fromCharCode);  

// Use a tear-off for an unnamed constructor: 
var buffers = charCodes.map(StringBuffer.new);

ラムダ式ではない

baddart// Instead of a lambda for a named constructor:
var strings = charCodes.map((code) => String.fromCharCode(code));

// Instead of a lambda for an unnamed constructor:
var buffers = charCodes.map((code) => StringBuffer(code));

詳細については、このDecoding Flutterビデオのティアオフに関する説明をご覧ください。

Dart Tear-offs | Decoding Flutter

Dartは3つの方法で変数を初期化できます。

変数を宣言する際にインスタンス変数を初期化します。

dartclass PointA {
  double x = 1.0;
  double y = 2.0;

  // The implicit default constructor sets these variables to (1.0,2.0)
  // PointA();

  @override
  String toString() {
    return 'PointA($x,$y)';
  }
}

コンストラクタ引数をインスタンス変数に代入するという一般的なパターンを簡素化するために、Dartには*初期化形式パラメータ*があります。

コンストラクタ宣言で`this.<propertyName>`を含め、本体を省略します。`this`キーワードは現在のインスタンスを参照します。

名前の競合が存在する場合は`this`を使用します。それ以外の場合は、Dartのスタイルでは`this`を省略します。生成コンストラクタでは、初期化形式パラメータ名を`this`で接頭辞を付ける必要があるという例外があります。

このガイドの前の方で述べたように、特定のコンストラクタとコンストラクタの一部はthisにアクセスできません。これらには以下が含まれます。

ファクトリコンストラクタ
初期化リストの右辺
スーパークラスコンストラクタへの引数

初期化形式パラメータを使用すると、null 非許容またはfinalインスタンス変数を初期化することもできます。これら2種類の変数には、初期化またはデフォルト値が必要です。

dartclass PointB {
  final double x;
  final double y;

  // Sets the x and y instance variables
  // before the constructor body runs.
  PointB(this.x, this.y);

  // Initializing formal parameters can also be optional.
  PointB.optional([this.x = 0.0, this.y = 0.0]);
}

プライベートフィールドは、名前付き初期化形式パラメータとして使用できません。

dartclass PointB {
// ...

  PointB.namedPrivate({required double x, required double y})
      : _x = x,
        _y = y;

// ...
}

これは名前付き変数でも機能します。

dartclass PointC {
  double x; // must be set in constructor
  double y; // must be set in constructor

  // Generative constructor with initializing formal parameters
  // with default values
  PointC.named({this.x = 1.0, this.y = 1.0});

  @override
  String toString() {
    return 'PointC.named($x,$y)';
  }
}

// Constructor using named variables.
final pointC = PointC.named(x: 2.0, y: 2.0);

初期化形式パラメータから導入されたすべての変数は、finalであり、初期化された変数のスコープ内でのみ有効です。

初期化リストでは表現できないロジックを実行するには、ファクトリコンストラクタまたは静的メソッドを作成してそのロジックを実装します。その後、計算された値を通常のコンストラクタに渡すことができます。

コンストラクタパラメータはnull許容として設定でき、初期化されません。

dartclass PointD {
  double? x; // null if not set in constructor
  double? y; // null if not set in constructor

  // Generative constructor with initializing formal parameters
  PointD(this.x, this.y);

  @override
  String toString() {
    return 'PointD($x,$y)';
  }
}

コンストラクタ本体が実行される前に、インスタンス変数を初期化できます。初期化子はコンマで区切ります。

dart// Initializer list sets instance variables before
// the constructor body runs.
Point.fromJson(Map<String, double> json)
    : x = json['x']!,
      y = json['y']! {
  print('In Point.fromJson(): ($x, $y)');
}

開発中の入力の検証には、初期化リスト内でassertを使用します。

dartPoint.withAssert(this.x, this.y) : assert(x >= 0) {
  print('In Point.withAssert(): ($x, $y)');
}

初期化リストは、finalフィールドの設定に役立ちます。

次の例では、初期化リストで3つのfinalフィールドを初期化しています。コードを実行するには、**実行**をクリックしてください。

import 'dart:math';

class Point {
  final double x;
  final double y;
  final double distanceFromOrigin;

  Point(double x, double y)
      : x = x,
        y = y,
        distanceFromOrigin = sqrt(x * x + y * y);
}

void main() {
  var p = Point(2, 3);
  print(p.distanceFromOrigin);
}

サブクラス（または子クラス）は、スーパークラス（または直接の親クラス）からコンストラクタを継承しません。クラスがコンストラクタを宣言していない場合、デフォルトコンストラクタのみを使用できます。

クラスは、スーパークラスのパラメータを継承できます。これらはスーパーパラメータと呼ばれます。

コンストラクタは、一連の静的メソッドの呼び出しとほぼ同様の方法で動作します。各サブクラスは、スーパークラスのコンストラクタを呼び出してインスタンスを初期化できます。これは、サブクラスがスーパークラスの静的メソッドを呼び出すことができるのと同様です。このプロセスでは、コンストラクタの本体やシグネチャは「継承」されません。

Dartは、コンストラクタを以下の順序で実行します。

初期化リスト
スーパークラスの無名引数なしコンストラクタ
メインクラスの引数なしコンストラクタ

スーパークラスに無名引数なしコンストラクタがない場合は、スーパークラスのコンストラクタのいずれかを呼び出します。コンストラクタ本体（存在する場合）の前に、コロン（:）の後にスーパークラスコンストラクタを指定します。

次の例では、Employeeクラスのコンストラクタは、スーパークラスPersonの名前付きコンストラクタを呼び出しています。次のコードを実行するには、**実行**をクリックしてください。

class Person {
  String? firstName;

  Person.fromJson(Map data) {
    print('in Person');
  }
}

class Employee extends Person {
  // Person does not have a default constructor;
  // you must call super.fromJson().
  Employee.fromJson(Map data) : super.fromJson(data) {
    print('in Employee');
  }
}

void main() {
  var employee = Employee.fromJson({});
  print(employee);
  // Prints:
  // in Person
  // in Employee
  // Instance of 'Employee'
}

Dartはスーパークラスコンストラクタへの引数をコンストラクタを呼び出す前に評価するため、引数は関数呼び出しのような式にすることができます。

dartclass Employee extends Person {
  Employee() : super.fromJson(fetchDefaultData());
  // ···
}

コンストラクタのスーパー呼び出しに各パラメータを渡すのを避けるには、スーパーイニシャライザパラメータを使用して、指定されたまたはデフォルトのスーパークラスコンストラクタにパラメータを転送します。この機能はリダイレクトコンストラクタでは使用できません。スーパーイニシャライザパラメータは、初期化形式パラメータと同様の構文とセマンティクスを持っています。

スーパークラスコンストラクタ呼び出しに位置引数が含まれている場合、スーパーイニシャライザパラメータは位置指定できません。

dartclass Vector2d {
  final double x;
  final double y;

  Vector2d(this.x, this.y);
}

class Vector3d extends Vector2d {
  final double z;

  // Forward the x and y parameters to the default super constructor like:
  // Vector3d(final double x, final double y, this.z) : super(x, y);
  Vector3d(super.x, super.y, this.z);
}

さらに説明するために、次の例を考えてみましょう。

dart  // If you invoke the super constructor (`super(0)`) with any
  // positional arguments, using a super parameter (`super.x`)
  // results in an error.
  Vector3d.xAxisError(super.x): z = 0, super(0); // BAD

この名前付きコンストラクタは、x値を2回設定しようとします。1回はスーパークラスコンストラクタで、もう1回は位置指定スーパーパラメータとして。どちらもx位置パラメータを指定しているため、エラーになります。

スーパークラスコンストラクタに名前付き引数がある場合、それらを名前付きスーパーパラメータ（次の例ではsuper.y）とスーパークラスコンストラクタ呼び出しへの名前付き引数（super.named(x: 0)）に分割できます。

dartclass Vector2d {
  // ...
  Vector2d.named({required this.x, required this.y});
}

class Vector3d extends Vector2d {
  final double z;

  // Forward the y parameter to the named super constructor like:
  // Vector3d.yzPlane({required double y, required this.z})
  //       : super.named(x: 0, y: y);
  Vector3d.yzPlane({required super.y, required this.z}) : super.named(x: 0);
}

特に明記されていない限り、このサイトのドキュメントはDart 3.5.3を反映しています。ページの最終更新日：2024年8月4日。ソースを表示または問題を報告する.

コンストラクタ

コンストラクタの種類

生成コンストラクタ

デフォルトコンストラクタ

名前付きコンストラクタ

定数コンストラクタ

リダイレクトコンストラクタ

ファクトリコンストラクタ

リダイレクトファクトリコンストラクタ

コンストラクタティアオフ

インスタンス変数の初期化

宣言時にインスタンス変数を初期化する

初期化形式パラメータを使用する

初期化リストを使用する

コンストラクタの継承

デフォルト以外のスーパークラスコンストラクタ

スーパパラメータ