Programma Lezione 67 di 148 · API che nessuno può usare male
API che nessuno può usare male

Uso sbagliato per progetto

Perché è importante La maggior parte dei bug al confine di un'API non sta nell'API. Sta in un chiamante che l'ha usata in un modo che sembrava a posto e in silenzio ha fatto la cosa sbagliata. Non puoi correggere ogni chiamante; puoi rendere impossibile l'uso sbagliato, o rumoroso.

Un assistente che scrive un'API tende a essere disponibile: se invii prima di connetterti, si connette per te; se passi una stringa dove servivano dei byte, la codifica; se dimentichi un'opzione, c'è un valore predefinito. Ogni gentilezza nasconde un errore finché non emerge da qualche parte lontano.

Fallisci presto, fallisci in modo evidente: solleva un errore nella chiamata esatta che è sbagliata, prima che qualcosa sia cambiato, con un messaggio che dice che cosa ci si aspettava.

Quattro strumenti

  • Stati espliciti: un oggetto che sa se è nuovo, aperto o chiuso, e rifiuta le chiamate che non vanno bene.
  • Opzioni con nome, niente booleani: mode="dry_run" non si può scambiare per sbaglio con un altro flag; copy(a, b, True, False) sì.
  • Niente valori predefiniti silenziosi per le scelte pericolose da sbagliare: fai in modo che sia il chiamante a dirlo.
  • Tipi che portano significato: del denaro che conosce la propria valuta non si può sommare a denaro in un'altra.

In questo modulo, script nascosti di uso sbagliato chiamano la tua API in modo sbagliato e si aspettano un errore nella chiamata sbagliata, senza che niente sia cambiato. Gli script di uso corretto si aspettano che funzioni e basta. Ogni problema elenca gli usi sbagliati da cui proteggersi.

Riepilogo Le ipotesi disponibili nascondono i bug. Rifiuta l'uso sbagliato nella chiamata che è sbagliata, prima di qualsiasi effetto.

Hai notato un problema in questa lezione? Segnalalo · Chiedi qualcosa su questa lezione

Questo esercizio si apre presto

Finisci la lezione precedente e questa si sblocca. L'intero corso è gratuito, senza account, e puoi leggere questa lezione subito.