HOWTO · React

React Proptype Array mit Shape

Erfahren Sie, wie Sie das React PropTypes Array mit Shape verwenden, um die Datenvalidierung in Ihren Anwendungen zu verbessern. Dieses Tutorial erklärt die Vorteile von PropTypes, liefert Codebeispiele und führt Sie durch die Implementierung von PropTypes.shape() für eine bessere Fehlererkennung. Entdecken Sie, wie Sie Fehler frühzeitig erkennen und Ihre Codequalität noch heute verbessern können.

Auf dieser Seite

PropTypes.arrayOf(PropTypes.shape(...)) beschreibt ein Array, dessen Elemente Objekte mit festgelegten Feldern sind. Das Paket prop-types prüft diesen Komponentenvertrag während der Entwicklung und kann warnen, wenn übergebene Props nicht dazu passen.

Was PropTypes überprüft

PropTypes legt fest, welche Typen und Objektstruktur eine Komponente erwartet. Das macht die Komponentenschnittstelle verständlicher und kann beim Entwickeln auf Abweichungen hinweisen. Die Prüfungen geben Warnungen in der Konsole aus; sie verhindern weder das Rendern einer Komponente noch ersetzen sie eine Datenvalidierung in der Produktionsumgebung.

Ein Array von Objekten mit PropTypes validieren

Installiere das Paket prop-types in deinem React-Projekt. Importiere es im Komponentenmodul mit import PropTypes from 'prop-types' und deklariere items: PropTypes.arrayOf(PropTypes.shape({ name: PropTypes.string.isRequired, value: PropTypes.number.isRequired })).isRequired. Damit wird die Objektstruktur auf jedes Array-Element angewendet. Das kurze JavaScript-Beispiel unten zeigt, wie dieselben Daten durch eine Listenkomponente fließen; es ist eigenständig ausführbar, während die PropTypes-Deklaration ins React-Komponentenmodul gehört.

const items = [
  { name: 'Ada', value: 7 },
  { name: 'Lin', value: 9 },
];

function renderItems(items) {
  return `<ul>${items.map((item) => `<li>${item.name}: ${item.value}</li>`).join('')}</ul>`;
}

console.log(renderItems(items));
<ul><li>Ada: 7</li><li>Lin: 9</li></ul>

Verwende in der React-Komponente den items-Prop mit demselben Array und rendere jeden Eintrag mit items.map(...). Gib jedem gerenderten Element einen stabilen key. Die Beispielwerte entsprechen den deklarierten Feldern und zeigen so den erwarteten Listeninhalt.

Felder als erforderlich festlegen und Warnungen verstehen

.isRequired bei items bedeutet, dass der Prop übergeben werden muss. Derselbe Zusatz bei name und value bedeutet, dass jedes Objekt diese Felder mit den deklarierten Typen enthalten soll. Entferne .isRequired bei einem Feld, wenn es fehlen darf; die übrigen deklarierten Felder werden weiterhin geprüft. Ein Objekt mit value: '7' statt einer Zahl entspricht nicht der festgelegten Struktur. Deshalb geben Reacts Entwicklungsprüfungen eine Warnung in der Konsole aus. Die Warnung wandelt den String nicht um, weist den Prop nicht zurück und verhindert das Rendern nicht. Wenn deine Anwendung auf externe Daten oder Produktionsdaten angewiesen ist, validiere diese zusätzlich.

Häufig gestellte Fragen

Überprüft PropTypes jedes Element eines Arrays?

Ja. PropTypes.arrayOf wendet den Validator auf jedes Element an. In Verbindung mit PropTypes.shape werden die festgelegten Felder jedes Objekts geprüft.

Validiert PropTypes.shape allein ein Array?

Nein. PropTypes.shape beschreibt die Felder eines einzelnen Objekts. Für ein Array aus Objekten verwendest du PropTypes.arrayOf(PropTypes.shape(...)).

Ist PropTypes in React erforderlich?

Nein. PropTypes ist eine optionale Laufzeitprüfung, die Props dokumentieren und während der Entwicklung Warnungen ausgeben kann. Sie ersetzt weder statische Typisierung noch die Validierung von Daten an den Grenzen der Anwendung.