Lehrplan Lektion 67 von 148 · APIs, die niemand missbrauchen kann
APIs, die niemand missbrauchen kann

Absichtliche Fehlbedienung

Warum das wichtig ist Die meisten Bugs an einer API-Grenze liegen nicht in der API. Sie liegen in einem Caller, der sie auf eine Weise verwendet hat, die gut aussah und stillschweigend das Falsche tat. Du kannst nicht jeden Caller reparieren; du kannst eine falsche Verwendung unmöglich oder laut machen.

Ein Assistent, der eine API schreibt, neigt dazu, hilfreich zu sein: Wenn du sendest, bevor du verbindest, verbindet er für dich; wenn du einen string übergibst, wo bytes erwartet wurden, kodiert er ihn; wenn du eine Option vergisst, gibt es einen Standardwert. Jede Freundlichkeit verbirgt einen Fehler, bis er irgendwo weit weg auftaucht.

Früh fehlschlagen, laut fehlschlagen: einen Fehler genau bei dem Aufruf auslösen, der falsch ist, bevor sich etwas geändert hat, mit einer Nachricht, die sagt, was erwartet wurde.

Vier Werkzeuge

  • Explizite Zustände: ein Objekt, das weiß, ob es neu, offen oder geschlossen ist, und Aufrufe ablehnt, die nicht passen.
  • Benannte Optionen, keine Booleans: mode="dry_run" kann nicht versehentlich mit einer anderen Flag vertauscht werden; copy(a, b, True, False) kann.
  • Keine stillen Standardwerte für Entscheidungen, die gefährlich falsch sein können: lass den Aufrufer es sagen.
  • Typen, die eine Bedeutung tragen: Geld, das seine Währung kennt, kann nicht zu Geld in einer anderen Währung addiert werden.

In diesem Modul rufen versteckte Missbrauchsskripte deine API falsch auf und erwarten einen Fehler beim falschen Aufruf, ohne dass sich etwas ändert. Skripte für die korrekte Nutzung erwarten, dass es einfach funktioniert. Jedes Problem listet die Missbräuche auf, vor denen man schützen muss.

Zusammenfassung Hilfreiche Vermutungen verbergen Fehler. Lehne die falsche Verwendung am Aufruf ab, der falsch ist, bevor eine Wirkung eintritt.

Ein Problem in dieser Lektion entdeckt? Melde es · Frage zu dieser Lektion

Diese Übung öffnet bald

Beende die vorherige Lektion, damit diese freigeschaltet wird. Der ganze Kurs ist kostenlos, kein Konto erforderlich, und du kannst diese Lektion jetzt direkt lesen.