نحوه مدیریت خطاهای Java Callout

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

«تماس با Java» چیست؟

اگر با «تماس‌های خروجی Java» آشنایی ندارید، توصیه می‌کنیم با نحوه ایجاد تماس خروجی Java شروع کنید.

مدیریت خطاها در یک فراخوانی Java

وقتی «تماس با Java» می‌نویسید، ممکن است بخواهید در کد Java خود مدیریت خطای سفارشی انجام دهید. برای مثال، ممکن است بخواهید پیام‌های خطا و سرایندهای سفارشی را برگردانید و/یا متغیرهای جاری‌سازی را با اطلاعات خطا در جاری‌سازی پراکسی در Edge تنظیم کنید.

بیایید یک مثال ساده از «فراخوانی Java» را بررسی کنیم که الگوهای پایه مدیریت خطای سفارشی را نشان می‌دهد. وقتی استثنایی رخ می‌دهد، نمونه پیام خطای سفارشی برمی‌گرداند. همچنین پشته ردیابی خطا را در متغیر جاری‌سازی قرار می‌دهد که می‌تواند تکنیک مفیدی برای اشکال‌زدایی باشد.

بارگیری پروژه

برای ساده‌تر کردن کار، می‌توانید این پروژه را از مخزن api-platform-samples در GitHub بارگیری کنید.

  1. api-platform-samples را در سیستم خود بارگیری یا شبیه‌سازی کنید.
  2. در پایانه یا ویرایشگر کد انتخابی‌تان، به api-platform-samples/doc-samples/java-error پروژه بروید.

کد نمونه Java

الگوهای مدیریت خطا سرراست هستند. می‌توانید متغیرهای جاری را در بافت جاری جریان Edge با روش messageContext.setVariable() تنظیم کنید. برای برگرداندن اطلاعات خطای سفارشی، نمونه ExecutionResult را بسازید و روش‌هایی را در آن فراخوانی کنید تا پاسخ خطا و سرایندها را تنظیم کنید.

package com.apigeesample;

import com.apigee.flow.execution.ExecutionContext;
import com.apigee.flow.execution.ExecutionResult;
import com.apigee.flow.execution.spi.Execution;
import com.apigee.flow.message.MessageContext;
import com.apigee.flow.execution.Action;

import org.apache.commons.lang.exception.ExceptionUtils;


public class JavaError implements Execution {
    public ExecutionResult execute(MessageContext messageContext, ExecutionContext executionContext) {

        try {

                String name = messageContext.getMessage().getHeader("username");

                if (name != null && name.length()>0) {
                        messageContext.getMessage().setContent("Hello, " + name + "!");
                        messageContext.getMessage().removeHeader("username");

                } else {
                        throw new RuntimeException("Please specify a name parameter!");
                }

                return ExecutionResult.SUCCESS;

        } catch (RuntimeException ex) {

            ExecutionResult executionResult = new ExecutionResult(false, Action.ABORT);

            //--Returns custom error message and header
            executionResult.setErrorResponse(ex.getMessage());
            executionResult.addErrorResponseHeader("ExceptionClass", ex.getClass().getName());

            //--Set flow variables -- may be useful for debugging.
            messageContext.setVariable("JAVA_ERROR", ex.getMessage());
            messageContext.setVariable("JAVA_STACKTRACE", ExceptionUtils.getStackTrace(ex));
            return executionResult;
        }
    }
}


ترجمه کردن کد با Maven

پروژه طوری تنظیم شده است که بتوانید با Maven آن را گردآوری کنید. اگر می‌خواهید از javac استفاده کنید، نمونه‌ای هم اضافه می‌کنیم.

  1. مطمئن شوید که Maven را نصب کرده‌اید:
    mvn -version
  2. دستورگان java-error/buildsetup.sh را اجرا کن. این دستورگان وابستگی‌های JAR موردنیاز را در مخزن محلی Maven نصب می‌کند.
  3. به فهرست راهنمای java-error/callout بروید.
  4. اجرای Maven:
    mvn clean package
  5. درصورت تمایل، تأیید کنید که فایل JAR edge-custom-policy-java-error.jar به java-error/apiproxy/resources/java کپی شده است. این مکان موردنیاز برای فایل‌های JAR است که می‌خواهید با پراکسی مستقر کنید.

ترجمه کردن با javac

اگر می‌خواهید از javac برای گردآوری کد استفاده کنید، می‌توانید کاری مشابه با مورد زیر انجام دهید (از دایرکتوری java-error). فایل‌های JAR موردنیاز در دایرکتوری java-error/lib برای شما ارائه شده است.

  1. به api-platform-samples/doc-samples/java-error بروید.
  2. مطمئن شوید که javac در مسیر شما باشد.

    javac -version
  3. فرمان javac زیر را اجرا کنید:

    javac -d . -classpath ./lib/expressions-1.0.0.jar:./lib/message-flow-1.0.0.jar:. callout/src/main/java/JavaProperties.java
  4. فایل JAR را در دایرکتوری apiproxy/resources/java کپی کنید. این مکان موردنیاز برای فایل‌های JAR است که می‌خواهید با پراکسی مستقر کنید.

    cp com/apigeesample/JavaProperties.class apiproxy/resources/java

استقرار و فراخوانی پراکسی

یک متن استقرار در دایرکتوری ./java-error ارائه شده است. اما قبل‌از اجرای آن، باید راه‌اندازی سریعی انجام دهید.

  1. رفتن به api-platform-samples/doc-samples/java-error
  2. اگر قبلاً این کار را نکرده‌اید، فایل ../../setup/setenv.sh را باز کنید و آن را همان‌طور که با اطلاعات حساب Apigee شما نشان داده شده است ویرایش کنید: نام کاربری شما (آدرس ایمیل منسوب به حسابتان)، نام سازمانتان، و دامنه‌ای که برای برقراری تماس‌های مدیریت API استفاده می‌کنید. برای مثال، برای ابر Edge، دامنه https://api.enterprise.apigee.com است؛ بااین‌حال، اگر از «ابر خصوصی Edge» استفاده می‌کنید، دامنه شما ممکن است متفاوت باشد.
  3. فایل setenv.sh را ذخیره کنید.
  4. اجرای دستورگان استقرار:
    ./deploy.sh
  5. اگر استقرار موفقیت‌آمیز بود، دستورگان فراخوانی را اجرا کنید:
    ./invoke.sh

    نوشتار فراخوانی فرمان cURL را فرا می‌خواند که به این شکل است:

    curl  http://$org-$env.$api_domain/java-error

    چون تماس شامل پارامتر پُرسمان «نام» نیست، کد جاوا خطای زمان اجرا برمی‌گرداند. کارگزار پراکسی این پیام و سرایند را برمی‌گرداند:

  • پیام خطا: Please specify a name parameter!
  • سرایند: ExceptionClass: java.lang.RuntimeException