Trang này được dịch bởi Cloud Translation API.

Cách xử lý lỗi Chú thích Java

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X. thông tin

Chú thích Java là gì?

Nếu chưa quen với chú thích Java, bạn nên bắt đầu với Cách tạo chú thích Java.

Xử lý lỗi trong Chú thích Java

Khi viết Chú thích Java, bạn có thể muốn xử lý lỗi tuỳ chỉnh trong mã Java. Ví dụ: bạn có thể muốn trả về các thông báo lỗi và tiêu đề tuỳ chỉnh và/hoặc đặt các biến luồng có thông tin lỗi trong luồng proxy trên Edge.

Hãy cùng tìm hiểu ví dụ về Chú thích Java đơn giản minh hoạ các mẫu xử lý lỗi tuỳ chỉnh cơ bản. Mẫu này sẽ trả về thông báo lỗi tuỳ chỉnh khi xảy ra ngoại lệ. Thao tác này cũng đặt dấu vết ngăn xếp lỗi vào một biến luồng. Đây có thể là một kỹ thuật gỡ lỗi tiện dụng.

Tải dự án xuống

Để đơn giản hoá mọi thứ, bạn có thể tải dự án này xuống qua kho lưu trữ api-platform-samples của Apigee trên GitHub.

Tải hoặc sao chép api-platform-samples vào hệ thống của bạn.
Trong một thiết bị đầu cuối hoặc trình soạn thảo mã mà bạn chọn, hãy chuyển đến dự án api-platform-samples/doc-samples/java-error.

Mã Java mẫu

Các mẫu xử lý lỗi rất đơn giản. Bạn có thể đặt các biến luồng trong ngữ cảnh luồng Edge hiện tại bằng phương thức messageContext.setVariable(). Để trả về thông tin lỗi tuỳ chỉnh, hãy tạo một thực thể ExecutionResult và các phương thức gọi trên thực thể đó để đặt phản hồi lỗi và tiêu đề.

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;
        }
    }
}

Biên dịch mã bằng Maven

Dự án được thiết lập để bạn có thể biên dịch bằng Maven. Nếu bạn muốn sử dụng javac, chúng tôi cũng đưa ra một ví dụ.

Hãy đảm bảo rằng bạn đã cài đặt Maven:
```
mvn -version
```
Thực thi tập lệnh java-error/buildsetup.sh. Tập lệnh này sẽ cài đặt các phần phụ thuộc JAR bắt buộc trong kho lưu trữ Maven cục bộ.
cd vào thư mục java-error/callout.
Thực thi Maven:
```
mvn clean package
```
Lưu ý: Nếu gặp lỗi Maven, hãy đảm bảo rằng bạn đang ở trong thư mục java-error/callout.
Nếu muốn, hãy xác minh rằng tệp JAR edge-custom-policy-java-error.jar đã được sao chép vào java-error/apiproxy/resources/java. Đây là vị trí bắt buộc cho các tệp JAR mà bạn muốn triển khai bằng proxy.

Biên dịch bằng javac

Nếu muốn sử dụng javac để biên dịch mã, bạn có thể làm tương tự như sau (trong thư mục java-error). Các tệp JAR bắt buộc sẽ được cung cấp cho bạn trong thư mục java-error/lib.

cd sang api-platform-samples/doc-samples/java-error.
Hãy đảm bảo bạn có javac trong đường dẫn của mình.
```
javac -version
```

Thực thi lệnh javac sau đây:

javac -d . -classpath ./lib/expressions-1.0.0.jar:./lib/message-flow-1.0.0.jar:. callout/src/main/java/JavaProperties.java

Sao chép tệp JAR vào thư mục apiproxy/resources/java. Đây là vị trí bắt buộc cho các tệp JAR mà bạn muốn triển khai bằng proxy.
```
cp com/apigeesample/JavaProperties.class apiproxy/resources/java
```

Triển khai và gọi proxy

Tập lệnh triển khai được cung cấp trong thư mục ./java-error. Tuy nhiên, trước khi chạy, bạn cần thiết lập nhanh.

cd sang api-platform-samples/doc-samples/java-error
Nếu bạn chưa làm việc này, hãy mở tệp ../../setup/setenv.sh và chỉnh sửa tệp như được nêu trong thông tin tài khoản Apigee của bạn: tên người dùng (địa chỉ email liên kết với tài khoản của bạn), tên tổ chức và miền mà bạn dùng để thực hiện lệnh gọi quản lý API. Ví dụ: đối với đám mây ở Edge, miền là https://api.enterprise.apigee.com. Tuy nhiên, miền của bạn có thể khác nếu bạn sử dụng Edge Private Cloud.
Lưu tệp setenv.sh.
Thực thi tập lệnh triển khai:
```
./deploy.sh
```
Nếu triển khai thành công, hãy thực thi tập lệnh gọi:
```
./invoke.sh
```
Tập lệnh gọi sẽ gọi một lệnh cURL có dạng như sau:
```
curl  http://$org-$env.$api_domain/java-error
```
Do lệnh gọi không bao gồm tham số truy vấn "name" nên mã Java sẽ gửi ra lỗi thời gian chạy. Proxy sẽ trả về thông báo và tiêu đề này:

Thông báo lỗi: Please specify a name parameter!
Tiêu đề: ExceptionClass: java.lang.RuntimeException