Smart-Doc یک ابزار قدرتمند تولید اسناد است که به توسعه دهندگان کمک می کند تا به راحتی اسناد API واضح و دقیق را برای پروژه های جاوا ایجاد کنند. با افزایش محبوبیت WebSocket فناوری، Smart-Doc پشتیبانی از آن را اضافه کرده است WebSocket رابط های شروع از نسخه 3.0.7. در این مقاله نحوه استفاده از Smart-Doc برای تولید اسناد رابط Java WebSocket و ارائه یک نمونه کامل از سرور WebSocket توضیح داده شده است.
مروری بر فناوری WebSocket
ابتدا اجازه دهید به طور خلاصه فناوری WebSocket را درک کنیم. پروتکل WebSocket یک کانال ارتباطی تمام دوبلکس را فراهم می کند و تبادل داده بین مشتری و سرور را ساده تر و کارآمدتر می کند. در جاوا، توسعه دهندگان می توانند به راحتی سرورها و کلاینت های WebSocket را با استفاده از آن پیاده سازی کنند JSR 356: Java API for WebSocket.
مروری بر حاشیه نویسی WebSocket
در Java WebSocket، @ServerEndpoint حاشیه نویسی برای تعریف کلاس POJO به عنوان نقطه پایانی سرور WebSocket استفاده می شود. هنگامی که رویدادهای WebSocket (مانند برقراری اتصال، دریافت پیام و غیره) رخ می دهد، می توان روش های علامت گذاری شده با این حاشیه نویسی را به طور خودکار فراخوانی کرد. علاوه بر این @ServerEndpoint، چندین حاشیه نویسی مرتبط با WebSocket وجود دارد:
@OnOpen: این روش زمانی فعال می شود که یک کلاینت یک اتصال WebSocket با سرور برقرار کند. معمولا برای مقداردهی اولیه استفاده می شود…