این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

جریان درخواست ها و پاسخ ها

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

آنچه در این مبحث خواهید آموخت

بعد از خواندن این تاپیک خواهید دانست:

استریم درخواست و پاسخ در Apigee Edge چیست؟
چه زمانی از جریان درخواست و پاسخ استفاده کنیم
نحوه فعال کردن جریان درخواست و پاسخ

جریان درخواست و پاسخ چیست؟

به طور پیش‌فرض، جریان HTTP غیرفعال است و بارهای درخواست و پاسخ HTTP قبل از پردازش توسط خط لوله پروکسی API، در یک بافر در حافظه نوشته می‌شوند. شما می‌توانید این رفتار را با فعال کردن جریان تغییر دهید. با فعال کردن جریان، بارهای درخواست و پاسخ بدون تغییر به برنامه کلاینت (برای پاسخ‌ها) و نقطه پایانی هدف (برای درخواست‌ها) جریان می‌یابند.

چه زمانی باید استریمینگ را فعال کنم؟

اگر پروکسی API شما درخواست‌ها و/یا پاسخ‌های بسیار بزرگی را مدیریت می‌کند (برای محدودیت‌های اندازه، به موارد دیگری که باید در مورد استریمینگ بدانم در زیر مراجعه کنید)، ممکن است بخواهید استریمینگ را فعال کنید.

توجه: اگر API شما حجم زیادی از داده‌ها را درخواست یا بازگرداند، ممکن است این خطای HTTP را مشاهده کنید:

{"fault":"{\"detail\":{\"errorcode\":\"protocol.http.TooBigBody\"},\"faultstring\":\"Body buffer overflow\"}"}

اگر این خطا را مشاهده کردید، توصیه می‌کنیم که پخش جریانی را فعال کنید. اگر پس از فعال کردن پخش جریانی همچنان این خطا را مشاهده کردید، حذف هرگونه سیاستی را که نیاز به دسترسی به بار داده درخواست یا پاسخ دارد، در نظر بگیرید. برای اطلاعات بیشتر، به بخش «اندازه بار داده پیام» در بهترین شیوه‌ها برای طراحی و توسعه پروکسی API مراجعه کنید.

چه چیز دیگری باید در مورد استریمینگ بدانم؟

اندازه بار پیام در Edge Cloud و Private Cloud، حتی با فعال بودن قابلیت پخش، به 10 مگابایت محدود شده است. در درخواست‌ها و پاسخ‌های غیر پخش، تجاوز از این اندازه منجر به خطای protocol.http.TooBigBody می‌شود.

اگرچه استریمینگ می‌تواند به شما کمک کند تا محدودیت اندازه درخواست/پاسخ ۱۰ مگابایتی اعمال شده توسط محصول را دور بزنید، اما Apigee تجاوز از این محدودیت را هنگام استریمینگ توصیه نمی‌کند و نمی‌تواند از مشکلاتی که در نتیجه تجاوز از آن محدودیت ایجاد می‌شوند، مانند مشکلات عملکرد، وقفه‌های زمانی و غیره، پشتیبانی کند. اگر خطای وقفه زمانی یا خطای دروازه دریافت کردید، برای مراحل عیب‌یابی احتمالی به مرجع پیام خطا مراجعه کنید.

برای بارهای داده بزرگتر از ۱۰ مگابایت، Apigee استفاده از الگوی URLهای امضا شده در Apigee JavaCallout را توصیه می‌کند، که توسط مثال Edge Callout: Signed URL Generator در GitHub نشان داده شده است.

در پیاده‌سازی‌های Edge برای ابر خصوصی، می‌توانید محدودیت اندازه درخواست/پاسخ غیر استریم‌شده را تغییر دهید. حتماً قبل از اعمال تغییر در محیط عملیاتی، آن را آزمایش کنید.

برای نسخه‌های Edge for Private Cloud قبل از ۴.۱۶.۰۱:

در تمام پردازنده‌های پیام، فایل http.properties را ویرایش کنید تا محدودیت موجود در پارامتر HTTPResponse.body.buffer.limit افزایش یابد و سپس پردازنده پیام را مجدداً راه‌اندازی کنید.
برای Edge برای Private Cloud نسخه ۴.۱۶.۰۱ و بالاتر:
1. فایل /<inst_root>/apigee/customer/application/message-processor.properties را ویرایش کنید. اگر این فایل وجود ندارد، آن را ایجاد کنید.
2. ویژگی conf_http_HTTPResponse.body.buffer.limit را در فایل message-processor.properties تنظیم کنید. برای مثال:
  conf_http_HTTPResponse.body.buffer.limit=5m
3. پردازشگر پیام را مجدداً راه‌اندازی کنید:
  /<inst_root>/apigee/apigee-service/bin/apigee-service edge-message-processor راه‌اندازی مجدد
4. این کار را برای همه پردازنده‌های پیام تکرار کنید.

با فعال بودن قابلیت استریمینگ، شرکت Apigee اکیداً توصیه می‌کند که سیاست‌هایی را که نیاز به دسترسی به بار داده درخواست یا پاسخ دارند، پیوست نکنید . این نوع سیاست‌ها یا باعث ایجاد خطا می‌شوند یا باعث بافر شدن در پروکسی API می‌شوند که اندازه بار داده را به اعداد ذکر شده در بالا محدود می‌کند و هدف فعال کردن استریمینگ برای مدیریت بارهای داده بزرگ را نقض می‌کند. می‌توانید سیاست‌هایی را پیوست کنید که با بدنه درخواست/پاسخ تعامل ندارند، مانند سیاست‌های احراز هویت یا ثبت پیام.

نحوه فعال کردن جریان درخواست و پاسخ

برای فعال کردن استریمینگ درخواست، باید ویژگی request.streaming.enabled را به تعاریف ProxyEndpoint و TargetEndpoint در بسته پروکسی اضافه کنید و آن را روی true تنظیم کنید. به طور مشابه، ویژگی response.streaming.enabled را برای فعال کردن استریمینگ پاسخ تنظیم کنید.

می‌توانید این فایل‌های پیکربندی را در رابط کاربری مدیریت در نمای توسعه برای پروکسی خود پیدا کنید. اگر به صورت محلی در حال توسعه هستید، این فایل‌های تعریف در apiproxy/proxies و apiproxy/targets قرار دارند.

این نمونه نحوه فعال کردن هر دو جریان درخواست و پاسخ را در تعریف TargetEndpoint نشان می‌دهد.

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
    <Properties>
      <Property name="response.streaming.enabled">true</Property>
      <Property name="request.streaming.enabled">true</Property>
      <Property name="supports.http10">true</Property>
      <Property name="request.retain.headers">User-Agent,Referer,Accept-Language</Property>
      <Property name="retain.queryparams">apikey</Property>
    </Properties>
  </HTTPTargetConnection>
</TargetEndpoint>

این مثال نحوه فعال‌سازی پخش پاسخ و درخواست را در تعریف ProxyEndpoint نشان می‌دهد:

<ProxyEndpoint name="default">
  <HTTPProxyConnection>
    <BasePath>/v1/weather</BasePath>
    <Properties>
      <Property name="allow.http10">true</Property>
      <Property name="response.streaming.enabled">true</Property>
      <Property name="request.streaming.enabled">true</Property>
    </Properties>
  </HTTPProxyConnection>
</ProxyEndpoint>

برای اطلاعات بیشتر در مورد پیکربندی تعاریف نقطه پایانی، به مرجع ویژگی‌های نقطه پایانی مراجعه کنید.

نمونه‌های کد مرتبط

نمونه‌های پروکسی API در GitHub به راحتی قابل دانلود و استفاده هستند. برای اطلاعات بیشتر در مورد دانلود و استفاده از نمونه‌ها ، به بخش «استفاده از نمونه پروکسی‌های API» مراجعه کنید.

نمونه پروکسی‌هایی که قابلیت پخش جریانی دارند عبارتند از:

streaming - یک پروکسی API پیکربندی شده برای پخش HTTP را نشان می‌دهد.
Edge Callout: تولیدکننده URL امضا شده - بهترین روش تولید URL امضا شده برای دسترسی به فایل‌های بزرگ به جای تلاش برای پخش آنها در یک درخواست/پاسخ را نشان می‌دهد.