Ferdinand Malcher
 

Typisierte Reactive Forms – neu ab Angular 14

19.05.2022

Mit Version 14 von Angular erscheint ein lang erwartetes Feature: stark typisierte Formulare! Bisher waren die Datenmodelle für Reactive Forms stets lose mit any typisiert – das ändert sich nun. In diesem Blogartikel stellen wir kurz die wichtigsten Eckpunkte vor.

Untypisierte Formulare

Reactive Forms sind ein mächtiger Ansatz, um Formulare in Angular zu bauen. In der Komponentenklasse bauen wir dazu ein Formularmodell aus den Bausteinen FormControl, FormGroup und FormArray auf. Dieses Modell wird dann mithilfe von Direktiven mit dem Template verknüpft.

Ein Formularmodell kann zum Beispiel so definiert werden:

bookForm = new FormGroup({
  isbn: new FormControl(''),
  title: new FormControl(''),
  author: new FormControl('')
});

Über das Property value bzw. die Methode getRawValue() können wir den Wert des Formulars auslesen, um damit weiterzuarbeiten. Das Problem: Bis Angular 13 ist dieser Wert mit any typisiert!

this.bookForm.value // any
this.bookForm.getRawValue() // any

Dadurch kann es schnell passieren, dass Fehler in den erfassten Daten erst zur Laufzeit auffallen. Das Angular-Team hat sich dieses Problems nun angenommen: Ab Angular 14 kann das Formularmodell mit konkreten Typen behandelt werden.

Typed Forms

Seit Angular 14 verwenden alle Bausteine von Reactive Forms die korrekten Typinformationen. Der Typ wird anhand des Startwerts ermittelt, den wir im Konstruktor von FormControl angeben:

new FormControl('') // FormControl<string | null>
new FormControl(5) // FormControl<number | null>

Dabei ist immer auch der Typ null inkludiert. Der Hintergrund: Controls können mit der Methode reset() zurückgesetzt werden. Gibt man dabei keinen neuen Startwert an, wird der Wert standardmäßig auf null gesetzt. Damit für dieses bestehende Verhalten kein Breaking Change entsteht, ist null standardmäßig im Typ enthalten.

In vielen Fällen wird dies nicht mit dem benötigten Datenmodell übereinstimmen. Daher können wir das Standardverhalten ändern: Bei der Initialisierung von FormControl setzen wir dazu die neue Option nonNullable und ändern so das Reset-Verhalten: Beim Zurücksetzen wird nicht null verwendet, sondern der ursprünglich definierte Startwert. Damit entfällt der Typ null und das FormControl besitzt nur noch den Typ string:

new FormControl('', { nonNullable: true }) // FormControl<string>

⚠️ ACHTUNG: In der ersten Umsetzung war die Option unter dem Namen initialValueIsDefault verfügbar. Mit dem finalen Release von Angular 14.0.0 wurde der Name in nonNullable umbenannt.

Üblicherweise werden im zweiten Argument von FormControl die Validatoren notiert. Möchte man die neue Option und Validatoren setzen, müssen diese mit in das Optionsobjekt aufgenommen werden. Das gilt auch für asynchrone Validatoren:

new FormControl('', {
  validators: [
    Validators.required,
    Validators.maxLength(15)
  ],
  asyncValidators: [checkISBNValidator],
  nonNullable: true
})

Falls der Typ eines einzelnen FormControls nicht automatisch inferiert werden kann, weil der Startwert auf null gesetzt wird, können wir mithilfe des generischen Typparameters nachhelfen:

new FormControl<string | null>(null) // FormControl<string | null>

Es ist zu erwarten, dass die Option nonNullable in einer späteren Version von Angular per Default auf true gesetzt wird, sodass für alle Controls standardmäßig der Startwert zum Reset verwendet wird (und nicht null). Da es sich dabei allerdings um einen Breaking Change handelt, wird das Angular-Team eine solche Änderung mit großer Vorsicht und einer Übergangsfrist durchführen müssen.

Entwickeln Sie ein Formular "auf der grünen Wiese", empfehlen wir Ihnen, die Option nonNullable für jedes Control auf true zu setzen. Das vereinfacht die Arbeit mit den erzeugten Daten, weil die Typen den tatsächlichen Eingabewert widerspiegeln. Ein normales Input-Feld erzeugt zum Beispiel stets einen leeren String bzw. einen String mit Werten. Der Wert null beschäftigt uns hier tatsächlich nur beim Zurücksetzen des Formulars.

FormGroup und FormArray

Kombinieren wir mehrere Controls in einer FormGroup oder in einem FormArray, wird der zusammengesetzte Typ automatisch inferiert. Die Methode getRawValue() liefert also ein Objekt mit dem erwarteten Typ:

bookForm = new FormGroup({
  isbn: new FormControl('', {
    nonNullable: true
  }),
  title: new FormControl(''),
  author: new FormControl('')
});

// Typ von bookForm.getRawValue()
{
  isbn: string;
  title: string | null;
  author: string | null;
}

Hier ist eine Einschränkung zu beachten: Das Property value und das Observable valueChanges geben nur die Werte der aktivierten Controls aus. Wurde ein Control über disable() deaktiviert, so wird es komplett ignoriert – sogar die Validatoren werden nicht mehr berücksichtigt. Da das Typsystem nicht bestimmen kann, ob ein Control aktiviert ist oder nicht, ist der Typ hier stets mit Partial definiert. Das bedeutet, dass alle Felder optional sind, also auch undefined beinhalten können:

// Typ von bookForm.value
Partial<{
  isbn: string;
  title: string | null;
  author: string | null;
}>

// das entspricht:
{
  isbn?: string;
  titl?: string | null;
  author?: string | null;
}

Es ist übrigens empfehlenswert, die FormGroup immer direkt bei der Deklaration des Komponenten-Propertys zu initialisieren. Ansonsten müssten wir den vollständigen Typ manuell hinter dem Property notieren.

Controls abrufen mit .get()

Mit der Methode get() können wir in eine FormGroup "hinabsteigen" und ein Control abrufen. Das funktioniert selbst mit zusammengesetzten Pfaden hervorragend – it's magic!

const form = new FormGroup({
  title: new FormControl('', { nonNullable: true }),
  authors: new FormArray([
    new FormGroup({
      firstname: new FormControl(''),
      lastname: new FormControl(''),
    })
  ])
});
form.get('title')
// AbstractControl<string, string> | null

form.get('authors.0.firstname')
// AbstractControl<string | null, string | null> | null

NonNullableFormBuilder verwenden

Wenn wir in einem komplexen Formular jedes Control mit der Option nonNullable versehen, wächst das Formularmodell stark an und wird unübersichtlich.

Um ohne viel Tipparbeit ein FormControl zu erzeugen, können wir deshalb den FormBuilder nutzen. Diese Klasse bietet verschiedene Methoden an, um Formularmodelle schnell und kurz zu erzeugen. Ab Angular 14 existiert eine zweite Variante: der NonNullableFormBuilder.

Damit können wir typisierte Controls erzeugen, in denen die Option nonNullable sofort auf true gesetzt ist. Selbstverständlich können wir den FormBuilder und die selbst erzeugten Klasseninstanzen in unserem Formularmodell kombinieren:

import { NonNullableFormBuilder } from '@angular/forms';

bookForm = new FormGroup({
  isbn: this.nnfb.control('', [
    Validators.required,
    Validators.maxLength(15)
  ]),
  title: this.nnfb.control(''),
  author: this.nnfb.control('')
});

constructor(private nnfb: NonNullableFormBuilder) {}

Grenzen der Typisierung

Grundsätzlich gilt: In TypeScript können nur die Dinge typisiert werden, die zur Kompilierungszeit sicher bekannt sind. Wenn wir ein dynamisches Formular entwickeln, dessen Struktur zur Laufzeit geändert wird, können wir uns nicht auf die Typisierung verlassen.

Die FormGroup ist daher in der neuen Variante strikt typisiert. Wir können zur Laufzeit keine weiteren Controls hinzufügen oder durch andere Controls mit einem anderen Typ ersetzen:

bookForm = new FormGroup({
  isbn: new FormControl('')
});

bookForm.addControl('title', new FormControl('')) // ❌ FEHLER!
bookForm.setControl('isbn', new FormControl(5)) // ❌ FEHLER!

In diesem Fall müssen wir auf die untypisierte Variante UntypedFormControl (siehe unten) oder auf den neuen FormRecord zurückgreifen.

Der neue Baustein FormRecord

Um das Laufzeitproblem mit addControl() in einer FormGroup zu lösen, wurde ein neuer Baustein eingeführt: FormRecord. Prinzipiell funktioniert dieses Objekt wie eine FormGroup, alle darüber eingebundenen Controls müssen aber denselben Typ besitzen. Das ist besonders dann sinnvoll, wenn Controls zur Laufzeit hinzugefügt oder entfernt werden sollen:

const checkboxGroup = new FormRecord({
  acceptAGB: new FormControl(false),
  acceptDSGVO: new FormControl(false)
});

checkboxGroup.addControl('subscribeNewsletter', new FormControl(false)); // ✅

Bei der Typisierung des Values kommt TypeScript allerdings wieder an seine Grenzen: Die Namen/Keys der Felder können nicht statisch ermittelt werden und sind deshalb generisch mit string definiert:

{ [key: string]: boolean | null; }

Rufen wir also z. B. mit get() ein Control ab, kann der eingegebene Key nicht von TypeScript geprüft werden.

Migration

Der Umstieg mit einem existierenden Formular auf die neue typisierte Variante ist unter Umständen nicht ganz trivial. Deshalb werden alle Bausteine von Reactive Forms auch weiterhin mit ihrer alten, untypisierten Schnittstelle angeboten.

Wenn wir die Anwendung mithilfe von ng update auf Angular 14 migrieren, werden die Klassennamen automatisch ersetzt:

  • FormControl => UntypedFormControl
  • FormGroup => UntypedFormGroup
  • FormArray => UntypedFormArray

So kann die Migration auf typisierte Formulare schrittweise durchgeführt werden. Komplexe Formulare mit dynamischen Strukturen können ggf. sogar gar nicht von der Typisierung profitieren und müssen mit den Untyped-Varianten bestehen bleiben.

Möchten Sie die einzelne Migration der Controls manuell anstoßen, können Sie den folgenden Befehl nutzen:

ng update @angular/core --migrate-only=migration-v14-typed-forms

Fazit

Das Angular-Team hat einige lang ersehnte Wünsche der Community berücksichtigt und hat viel Zeit und Energie in neue Features investiert. Die neuen typisierten Bausteine für Reactive Forms bringen ein neues Level an Typsicherheit in die Anwendung. Aufwendige Prüfungen der Formularwerte zur Laufzeit können damit entfallen, und der Komfort bei der Entwicklung steigt. Wir freuen uns schon auf den baldigen Einsatz von Angular 14, bei dem die stark typisierten Formulare endlich bereitstehen!


Titelbild: Photo by Ivan Bandura on Unsplash (edited)

Zurück | Back
Suggestions? Feedback? Bugs? Please fork/edit this page on Github .