سرفصل‌ها درس 67 از 148 · رابط‌های برنامه‌نویسی که هیچ‌کس نمی‌تواند از آن‌ها سوءاستفاده کند
رابط‌های برنامه‌نویسی که هیچ‌کس نمی‌تواند از آن‌ها سوءاستفاده کند

سوءاستفاده از روی طراحی

چرا اهمیت دارد بیشتر باگ‌ها در مرز یک API در خود API نیستند. آن‌ها در فراخوانی‌کننده‌ای هستند که آن را طوری استفاده کرده که ظاهراً درست به نظر می‌رسید اما بی‌صدا کار اشتباه انجام می‌داد. شما نمی‌توانید همه فراخوانی‌کننده‌ها را اصلاح کنید؛ می‌توانید استفاده نادرست را غیرممکن یا پرصدا کنید.

یک دستیار که در حال نوشتن یک API است، معمولاً کمک‌کننده است: اگر قبل از اتصال ارسال کنید، آن برای شما متصل می‌کند؛ اگر رشته‌ای را جایی که بایت انتظار می‌رفت ارسال کنید، آن را رمزگذاری می‌کند؛ اگر گزینه‌ای را فراموش کنید، یک مقدار پیش‌فرض وجود دارد. هر یک از این مهربانی‌ها یک اشتباه را تا زمانی که در جایی دور ظاهر نشود، پنهان می‌کند.

در همان ابتدا و با صدای بلند خطا بدهید: در همان فراخوانی اشتباه، پیش از آنکه چیزی تغییر کند، یک خطا را با پیامی که بیانگر انتظارهاست، گزارش کنید.

چهار ابزار

  • بیانی صریح: ابجکتی که می‌داند آیا جدید، باز یا بسته است و درخواست‌هایی را که مناسب نیستند رد می‌کند.
  • گزینه‌های نام‌گذاری‌شده، بدون بولین: mode="dry_run" نمی‌تواند به طور تصادفی با پرچم دیگری جابجا شود؛ copy(a, b, True, False) می‌تواند.
  • برای انتخاب‌هایی که اشتباه کردن در آن‌ها خطرناک است، هیچ پیش‌فرض خاموشی وجود ندارد: بگذارید فراخواننده آن را مشخص کند.
  • نوع‌هایی که معنا را حمل می‌کنند: پولی که واحد پولی خود را می‌شناسد را نمی‌توان به پولی با واحد دیگر افزود.

در این ماژول، اسکریپت‌های سوءاستفاده مخفی، API شما را به اشتباه فراخوانی می‌کنند و انتظار خطا در فراخوانی اشتباه را دارند، بدون اینکه هیچ تغییری ایجاد شود. اسکریپت‌های استفاده صحیح انتظار دارند که به سادگی کار کند. هر مشکل، سوءاستفاده‌هایی را که باید در برابرشان احتیاط کرد، فهرست می‌کند.

خلاصه: حدس‌های مفید باگ‌ها را پنهان می‌کنند. استفاده نادرست را در همان فراخوانی اشتباه رد کنید، پیش از هرگونه تأثیر.

مشکلی در این درس دیدید؟ گزارشش کنید · دربارهٔ این درس بپرسید

این تمرین به‌زودی باز می‌شود

درس پیش از آن را تمام کنید تا این یکی باز شود. کل دوره رایگان است، حساب کاربری لازم نیست، و می‌توانید همین الان این درس را بخوانید.