</>مدرسه زیب‌موجیاد بگیر، تمرین کن، بساز
مدرسهPHPدرس 43
درس 43 از 80 · ۶۵ دقیقه

ساخت پکیج PHP، API عمومی و نسخه‌گذاری

پکیج خوب مسئله‌ای مشخص حل می‌کند، API عمومی کوچک دارد و تغییر ناسازگار را با نسخه major اعلام می‌کند. جزئیات داخلی نباید ناخواسته به قرارداد عمومی تبدیل شوند.

۰امتیاز شما
نقشه این درس

بعد از این درس دقیقاً چه بلدی؟

  • موضوع «Public API» را با زبان ساده برای فرد دیگری توضیح می‌دهی.
  • مثال همین درس را خط‌به‌خط می‌خوانی و خروجی آن را پیش‌بینی می‌کنی.
  • کد را تغییر می‌دهی، نتیجه یا ساختار آن را بررسی می‌کنی و خطا را مرحله‌ای اصلاح می‌کنی.
به زبان زندگی واقعی

محصول در جعبه

کاربر دکمه‌ها و راهنمای روی جعبه را می‌بیند؛ پیچ‌های داخلی قرارداد استفاده نیستند. API عمومی همان بخش قابل اتکا است.

نکته مهم برای شروع PHP

پکیج خوب مسئله‌ای مشخص حل می‌کند، API عمومی کوچک دارد و تغییر ناسازگار را با نسخه major اعلام می‌کند. جزئیات داخلی نباید ناخواسته به قرارداد عمومی تبدیل شوند.

چرا مهم است؟ این مفهوم یکی از آجرهای مسیر حرفه‌ای PHP است. فعلاً لازم نیست همه جزئیات را حفظ کنی؛ باید دلیل استفاده و اثر هر خط را بفهمی.

اولین تمرین تو: یک Value Object و Validator کوچک ارائه می‌شود، آزمون‌ها رفتار مرزی را ثبت و README شیوه استفاده را نشان می‌دهد.

مفهوم‌های اصلی

اول بفهم، بعد کد بنویس

Public API

بخش مستند و متعهد پکیج برای مصرف‌کننده است.

BC break

تغییری است که کد معتبر نسخه قبلی را می‌شکند.

Changelog

تغییرها، مهاجرت و اثر آن‌ها را برای کاربر توضیح می‌دهد.

سناریوی واقعی

کتابخانه اعتبارسنجی شماره موبایل

یک Value Object و Validator کوچک ارائه می‌شود، آزمون‌ها رفتار مرزی را ثبت و README شیوه استفاده را نشان می‌دهد.

ورودی روشنقانون قابل توضیحخروجی قابل بررسی
بازی ساختن کد

قطعه‌ها را به ترتیب درست بچین

روی هر قطعه بزن تا وارد پاسخ شود؛ برای برگرداندن دوباره روی آن بزن. با دکمه‌های جابه‌جایی هم می‌توانی بدون کشیدن و رهاکردن ترتیب را اصلاح کنی.

مرحله ۲ از ۳ · مرتب‌کردن کد
بانک قطعه‌هاقطعه مناسب را انتخاب کن
ترتیب پاسخ تواز بالا به پایین اجرا می‌شود

    هنوز پاسخی بررسی نشده است.

    کارگاه تعاملی

    کد را کامل کن و ساختار آن را بررسی کن

    این درس وارد قابلیت‌های سروری یا حرفه‌ای شده است. برای امنیت سایت، کد دلخواه روی سرور اجرا نمی‌شود؛ بررسی‌گر، وجود اجزای ضروری و منطق مورد انتظار را کنترل می‌کند و راهنمای اصلاح می‌دهد.

    lesson-43.php
    گزارش بررسیبررسی‌گر ساختار آماده است
    کد را کامل کن و «بررسی ساختار» را بزن.
    در مثال‌های پیشرفته، اجرای ناامن سروری نداریم؛ اجزای ضروری کد بررسی می‌شوند.
    کدخوانی استاد

    این مثال خط‌به‌خط چه می‌گوید؟

    فعلاً حفظ نکن؛ هر خط را به یک جمله ساده تبدیل کن.

    1. 1<?php

      از اینجا مفسر PHP شروع به خواندن کد می‌کند.

    2. 2namespace Zibmoj\Mobile;

      این خط بخشی از منطق اصلی مثال است؛ نام‌ها و علامت‌ها را از راست به چپ، بخش‌به‌بخش بخوان.

    3. 3final readonly class IranianMobile {

      این خط بخشی از منطق اصلی مثال است؛ نام‌ها و علامت‌ها را از راست به چپ، بخش‌به‌بخش بخوان.

    4. 4public function __construct(public string $value) {

      یک کار نام‌گذاری‌شده تعریف می‌شود تا منطق آن قابل استفاده دوباره و قابل آزمون باشد.

    5. 5if (! preg_match("/^09\d{9}$/", $value)) {

      یک پرسش درست/نادرست بررسی می‌شود و مسیر اجرای بعدی را تعیین می‌کند.

    6. 6throw new InvalidArgumentException("شماره معتبر نیست");

      این خط بخشی از منطق اصلی مثال است؛ نام‌ها و علامت‌ها را از راست به چپ، بخش‌به‌بخش بخوان.

    7. 7}

      مرز یک بلوک یا فراخوانی در اینجا باز یا بسته می‌شود.

    8. 8}

      مرز یک بلوک یا فراخوانی در اینجا باز یا بسته می‌شود.

    9. 9}

      مرز یک بلوک یا فراخوانی در اینجا باز یا بسته می‌شود.

    منبع رسمی همین درسمستندات اصلی PHP را ببین ←برای عمیق‌ترشدن؛ لازم نیست در شروع همه آن را بخوانی.
    حالا نوبت توست

    README کوتاه، سه آزمون مرزی و سیاست نسخه‌گذاری پکیج را بنویس.

    تمرین پلکانی

    از ساده به چالشی، بدون پرش

    ۱ · گرم‌کردن

    یکی از مقدارهای مثال را عوض کن، خروجی را روی کاغذ حدس بزن و سپس بررسی کن.

    ۲ · تثبیت

    README کوتاه، سه آزمون مرزی و سیاست نسخه‌گذاری پکیج را بنویس.

    ۳ · ساختن

    سناریوی «کتابخانه اعتبارسنجی شماره موبایل» را با نام‌های واضح‌تر و یک حالت تازه گسترش بده.

    دام‌های رایج

    این سه اشتباه را انجام نده

    1

    انتشار کلاس‌های داخلی به‌عنوان API ناخواسته

    2

    تغییر ناسازگار در نسخه minor

    3

    نداشتن آزمون برای نسخه‌های PHP پشتیبانی‌شده

    آزمون پایان درس

    5 پرسش کوتاه؛ مطمئن شو واقعاً یاد گرفته‌ای

    برای هر پرسش یک پاسخ انتخاب کن. بعد از هر انتخاب، دلیل پاسخ را همان‌جا می‌بینی.

    پرسش 1 از 5

    تغییر ناسازگار معمولاً کدام نسخه را افزایش می‌دهد؟

    پرسش 2 از 5

    کدام توضیح، «Public API» را دقیق‌تر بیان می‌کند؟

    پرسش 3 از 5

    بهترین قدم بعد از خواندن مثال این درس چیست؟

    پرسش 4 از 5

    کدام روش نشان می‌دهد این درس را واقعاً فهمیده‌ای؟

    پرسش 5 از 5

    کدام رفتار احتمال خطا را در همین موضوع بیشتر می‌کند؟

    پایان درس 43

    درس را فقط وقتی تمام کن که کد را تغییر داده‌ای

    دیدن آموزش کافی نیست؛ یک مقدار را تغییر بده، خروجی را پیش‌بینی کن و بعد اجرا بزن.