کتابخانه
protobufjs یه کتابخانه جاوااسکریپت و تایپ اسکریپتی برای کار با Protocol Buffers هست. باهاش می تونی فایل های proto رو بخونی، پیام ها رو به قالب باینری فشرده تبدیل کنی و دوباره از باینری به شیء جاوااسکریپت برگردونی. هم توی مرورگر کار می کنه، هم توی Node.js و برای تبادل داده سبک بین سرویس ها به کار میاد.
نسخه رسمی و بدون تغییر، از منبع رسمی با مجوز BSD-3-Clause؛ هش هر فایل با منبع بررسی شده است.
۱٫۵ مگابایت· ۷۱ فایل· انتشار
SHA-256: fd5370f90ad4a0d5a573a047763a94c8115e2f326c4fe69f3b6b96b2ed96f023
Protocol Buffers قالبیه که گوگل برای ذخیره و ارسال داده ساخته. توی JSON کلیدها به شکل متن توی هر پیام تکرار می شن. اینجا ساختار داده رو یه بار توی فایلی با پسوند proto تعریف می کنی و بعدش پیام ها به شکل باینری فشرده رد و بدل می شن. protobufjs همون چیزیه که این کار رو برای جاوااسکریپت و تایپ اسکریپت ممکن می کنه.
باهاش می تونی فایل proto رو موقع اجرا بارگذاری کنی و از روی تعریفش پیام بسازی، بررسی کنی، به باینری ببری و دوباره بخونی. راه دیگه اینه که از فایل proto کد جاوااسکریپت ثابت (static) تولید کنی و اون رو توی پروژه بذاری. این حالت معمولاً سریع تر بالا میاد و برای پروژه هایی که حجم فایل براشون مهمه بهتره. تعریف نوع های تایپ اسکریپت هم هست، پس لازم نیست با نوع ها دستی کلنجار بری. کتابخانه نسخه های سبک تر هم داره که فقط بخش لازم رو شامل می شن.
اگه با سرویس های gRPC یا هر API مبتنی بر protobuf کار می کنی، بین چند سرویس Node پیام باینری رد و بدل می کنی، یا توی وب سوکت و اپلیکیشن های وب داده کم حجم می خوای، این کتابخانه به کارت میاد. وقتی پهنای باند بین الملل محدوده یا کاربرها با اینترنت موبایل ضعیف وصل می شن، کم شدن حجم پیام ها واقعاً حس می شه. ولی اگه سایت وردپرسیت فقط چند تا درخواست ساده Ajax یا REST می زنه، JSON کافیه و protobuf فقط پیچیدگی اضافه می کنه. چون باینریه، دیباگش هم مثل JSON با چشم و مرورگر راحت نیست.
موقع انتخاب و استفاده سه چیز رو یادت باشه. اول، دو طرف ارتباط باید از یه تعریف proto مشترک استفاده کنن. دوم، شماره فیلدها بعد از انتشار نباید عوض بشن، وگرنه داده های قدیمی اشتباه خونده می شن. سوم، باید بین بارگذاری پویا و کد تولیدشده یکی رو انتخاب کنی و حجم و سرعت پروژه ات توی این انتخاب مهمه. نسخه های رسمی و بدون تغییر protobufjs توی مخزن داخلی ما هم هست، پس اگه دسترسی به منبع اصلی قطع یا کند بود، می تونی از همین جا برداری.
راه استفاده بسته به پروژه ات فرق می کنه. اگه توی Node.js یا پروژه ای با ابزار بیلد کار می کنی، بسته رو با npm نصب کن و توی کدت import کن. اگه می خوای مستقیم توی یه صفحه وب ازش استفاده کنی، کد آماده پایین همین صفحه رو به صفحه اضافه کن تا کتابخانه بارگذاری بشه.
مسیر کلی کار اینه:
اگه تایپ اسکریپت استفاده می کنی، از ابزار تولید کد و تعریف نوع ها کمک بگیر تا ادیتورت خودش فیلدها رو پیشنهاد بده. قبل از انتشار روی سرور واقعی هم یه بار رفت و برگشت کامل (encode و decode) رو روی داده نمونه تست کن و ببین نتیجه عین ورودیه یا نه.
یه کتابخانه جاوااسکریپت و تایپ اسکریپت برای Protocol Buffers هست. ساختار داده رو توی فایل proto تعریف می کنی و کتابخانه پیام ها رو به باینری فشرده تبدیل می کنه و دوباره می خونه. بیشتر برای ارتباط بین سرویس ها، gRPC و انتقال داده کم حجم استفاده می شه.
JSON متنیه و با چشم خونده می شه، ولی کلیدها رو توی هر پیام تکرار می کنه. protobuf باینریه و بر اساس یه تعریف مشترک کار می کنه، برای همین معمولاً جمع و جورتره. برای API ساده و دیباگ راحت، JSON مناسب تره. برای حجم زیاد پیام یا ارتباط بین سرویس های داخلی، protobuf گزینه بهتریه.
هر دو محیط رو پشتیبانی می کنه. توی Node.js با npm نصبش می کنی و توی مرورگر می تونی از نسخه آماده یا خروجی ابزار بیلد استفاده کنی. اگه حجم فایل برات مهمه، نسخه سبک تر و کد تولیدشده رو در نظر بگیر.
نه، اجباری نیست. می تونی فایل proto رو موقع اجرا بارگذاری کنی که برای شروع و تست ساده تره. توی پروژه های جدی تر، تولید کد ثابت معمولاً سریع تر بالا میاد و برای تایپ اسکریپت هم تعریف نوع می ده.
مجوزش BSD-3-Clause هست که یکی از مجوزهای آزاد و منعطفه و معمولاً استفاده تجاری رو اجازه می ده. فقط باید اطلاعیه کپی رایت و متن مجوز رو همراه کد نگه داری. اگه پروژه ات مهمه، متن کامل مجوز رو خودت یه بار بخون.
نام کتابخانه، افزونه یا قالب را بفرستید؛ پس از بررسی، نسخه‌های رسمی آن به مخزن اضافه می‌شود.