Statische Initialisierungsblöcke

Probieren Sie es aus

class ClassWithStaticInitializationBlock {
  static staticProperty1 = "Property 1";
  static staticProperty2;
  static {
    this.staticProperty2 = "Property 2";
  }
}

console.log(ClassWithStaticInitializationBlock.staticProperty1);
// Expected output: "Property 1"
console.log(ClassWithStaticInitializationBlock.staticProperty2);
// Expected output: "Property 2"

Syntax

class ClassWithSIB {
  static {
    // …
  }
}

Beschreibung

Ohne statische Initialisierungsblöcke ließe sich eine komplexe statische Initialisierung durch den Aufruf einer statischen Methode nach der Klassendeklaration erreichen:

class MyClass {
  static init() {
    // Access to private static fields is allowed here
  }
}

MyClass.init();

Dieser Ansatz macht jedoch ein Implementierungsdetail (die Methode init()) für Benutzer der Klasse sichtbar. Initialisierungslogik, die außerhalb der Klasse deklariert wird, hat dagegen keinen Zugriff auf private statische Felder. Mit statischen Initialisierungsblöcken lässt sich beliebige Initialisierungslogik innerhalb der Klasse deklarieren und bei der Auswertung der Klasse ausführen.

Eine class kann in ihrem Klassenkörper beliebig viele static {}-Initialisierungsblöcke enthalten. Diese werden zusammen mit gegebenenfalls dazwischenliegenden Initialisierern statischer Felder in der Reihenfolge ihrer Deklaration ausgewertet. Die statische Initialisierung einer Oberklasse erfolgt immer vor der ihrer Unterklassen.

Der Gültigkeitsbereich von Variablen, die innerhalb eines statischen Blocks deklariert werden, ist auf diesen Block beschränkt. Das gilt für Deklarationen mit var, function, const und let. var-Deklarationen werden nicht aus dem statischen Block herausgehoben.

var y = "Outer y";

class A {
  static field = "Inner y";
  static {
    // var y only hoisted inside block
    console.log(y); // undefined <-- not 'Outer y'

    var y = this.field;
  }
}

// var y defined in static block is not hoisted
// outside the block
console.log(y); // 'Outer y'

this verweist innerhalb eines statischen Blocks auf das Konstruktorobjekt der Klasse. Mit super.property kann auf statische Eigenschaften der Oberklasse zugegriffen werden. Beachten Sie jedoch, dass es ein Syntaxfehler ist, super() in einem statischen Initialisierungsblock einer Klasse aufzurufen oder das Objekt arguments zu verwenden.

Die Anweisungen werden synchron ausgewertet. Sie können await oder yield in diesem Block nicht verwenden. (Stellen Sie sich die Initialisierungsanweisungen so vor, als wären sie implizit in eine Funktion eingeschlossen.)

Der Gültigkeitsbereich des statischen Blocks liegt innerhalb des lexikalischen Gültigkeitsbereichs des Klassenkörpers. Daher kann er auf private Namen zugreifen, die innerhalb der Klasse deklariert sind, ohne einen Syntaxfehler auszulösen.

Initialisierer statischer Felder und statische Initialisierungsblöcke werden nacheinander ausgewertet. Ein Initialisierungsblock kann auf die Werte von Feldern zugreifen, die oberhalb von ihm stehen, nicht aber auf die Werte darunterliegender Felder. Alle statischen Methoden werden zuvor hinzugefügt und können aufgerufen werden. Wenn sie jedoch auf Felder unterhalb des aktuellen Blocks zugreifen, verhalten sie sich möglicherweise nicht wie erwartet.

Ein statischer Initialisierungsblock darf keine Dekoratoren haben (die Klasse selbst hingegen schon).

Beispiele

Mehrere Blöcke

Der folgende Code zeigt eine Klasse mit statischen Initialisierungsblöcken und dazwischenliegenden Initialisierern statischer Felder. Die Ausgabe zeigt, dass die Blöcke und Felder in der Reihenfolge ihrer Ausführung ausgewertet werden.

class MyClass {
  static field1 = console.log("static field1");
  static {
    console.log("static block1");
  }
  static field2 = console.log("static field2");
  static {
    console.log("static block2");
  }
}
// 'static field1'
// 'static block1'
// 'static field2'
// 'static block2'

Beachten Sie, dass die statische Initialisierung einer Oberklasse immer vor der ihrer Unterklassen erfolgt.

Verwendung von this und super

this verweist innerhalb eines statischen Blocks auf das Konstruktorobjekt der Klasse. Dieser Code zeigt, wie auf ein öffentliches statisches Feld zugegriffen wird.

class A {
  static field = "static field";
  static {
    console.log(this.field);
  }
}
// 'static field'

Mit der Syntax super.property kann innerhalb eines static-Blocks auf statische Eigenschaften einer Oberklasse verwiesen werden.

class A {
  static field = "static field";
}

class B extends A {
  static {
    console.log(super.field);
  }
}
// 'static field'

Zugriff auf private Elemente

Das folgende Beispiel zeigt, wie einem Objekt außerhalb einer Klasse Zugriff auf ein privates Instanzfeld dieser Klasse gewährt werden kann (Beispiel aus dem Blog von v8.dev):

let getDPrivateField;

class D {
  #privateField;
  constructor(v) {
    this.#privateField = v;
  }
  static {
    getDPrivateField = (d) => d.#privateField;
  }
}

console.log(getDPrivateField(new D("private"))); // 'private'

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Leitfaden zur Verwendung von Klassen
• Klassen
• static
• class
• Statische Initialisierungsblöcke für Klassen auf v8.dev (2021)
• ES2022-Feature: Statische Initialisierungsblöcke für Klassen von Dr. Axel Rauschmayer (2021)