درخواست‌ها و پاسخ‌های جاری‌سازی

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

آنچه در این موضوع خواهید آموخت

پس‌از خواندن این موضوع، با این موارد آشنا خواهید شد:

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

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

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

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

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

چه چیز دیگری باید درباره جاری‌سازی بدانم؟

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

در استقرار Edge for Private Cloud، می‌توانید محدودیت اندازه درخواست/پاسخ غیر جاری‌سازی‌شده را تغییر دهید. حتماً قبل‌از استقرار تغییر در تولید، آن را آزمایش کنید.

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

    در همه «پردازشگرهای پیام»، فایل http.properties را ویرایش کنید تا حد مجاز در پارامتر HTTPResponse.body.buffer.limit را افزایش دهید و سپس «پردازشگر پیام» را بازراه‌اندازی کنید.
  • برای Edge for 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 restart

    4. این کار را برای همه «پردازشگرهای پیام» تکرار کنید.

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

برای فعال کردن جاری‌سازی درخواست، باید دارایی 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 به‌راحتی قابل بارگیری و استفاده هستند. برای کسب اطلاعات درباره بارگیری و استفاده از نمونه‌ها، به استفاده از پراکسی‌های نمونه میانای برنامه‌سازی کاربردی مراجعه کنید.

پراکسی‌های نمونه‌ای که دارای ویژگی جاری‌سازی هستند عبارت‌اند از: