シラバス レッスン 148 中 67 · 誰も誤用できない API
誰も誤用できない API

設計による誤用

なぜ大切か API の境界でのバグのほとんどは、API の中にはありません。問題なさそうに見えて、こっそり間違ったことをするやり方で使った呼び出し側にあります。すべての呼び出し側を直すことはできませんが、間違った使い方を不可能に、あるいは大きな声にすることはできます。

API を書くアシスタントは親切になりがちです。接続する前に送れば接続してくれ、バイト列が期待されるところに文字列を渡せばエンコードしてくれ、選択肢を忘れれば既定値があります。どの親切も、遠いどこかで表に出るまで間違いを隠します。

早く失敗し、大きな声で失敗する:何かが変わる前に、まさに間違った呼び出しで、何が期待されていたかを言うメッセージ付きのエラーを出すことです。

4 つの道具

  • 明示的な状態:自分が新しいか、開いているか、閉じているかを知っていて、合わない呼び出しを拒むオブジェクト。
  • 名前付きの選択肢、真偽値なし:mode="dry_run" はうっかりほかのフラグと入れ替わることがありません。copy(a, b, True, False) はありえます。
  • 間違えると危険な選択には こっそりした既定値なし:呼び出し側に言わせます。
  • 意味を運ぶ型:通貨を知っているお金は、別の通貨のお金に足せません。

このモジュールでは、隠れた誤用の台本があなたの API を間違って呼び、間違った呼び出しで、何も変わらないままエラーが出ることを期待します。正しい使い方の台本は、ただ動くことを期待します。どの問題も、防ぐべき誤用を挙げています。

まとめ 親切な推測はバグを隠します。間違った使い方は、どんな効果よりも前に、間違った呼び出しで拒みましょう。

このレッスンに問題を見つけましたか?報告する · このレッスンについて質問する

この演習はまもなく開きます

その前のレッスンを終えると、このレッスンが解放されます。コース全体が無料でアカウントも不要、このレッスンは今すぐ読めます。