您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
什麼是 Java 呼叫?
如果您是第一次使用 Java 呼叫,建議您先閱讀「如何建立 Java 呼叫」一文。
在 Java 呼叫中使用屬性
屬性可讓您在 Java 呼叫政策中指定名稱/值組合,在執行階段中可以透過 Java 程式碼存取這些組合。您必須為每個屬性指定常值字串值;您無法在這個元素中參照流程變數。
以下逐步說明使用屬性的簡易 Java 呼叫範例。在這個範例中,我們會建立內含 Java 呼叫政策的 Proxy。這項政策會使用 <Properties>
元素指定名稱/值組合。在 Java 程式碼中,我們會擷取該值,並使用該值設定回應標頭。
下載專案
為簡化流程,您可以從 GitHub 的 Apigee api-platform-samples 存放區下載這項專案。
- 將 api-platform-samples 下載或複製到您的系統。
- 使用您選擇的終端機或程式碼編輯器,前往
api-platform-samples/doc-samples/java-properties
專案。
Java 呼叫政策
這項政策會使用 <Properties>
元素。這個元素可讓您指定名稱/值組合。在執行階段,您的 Java 程式碼可以存取政策中指定的屬性值,稍後會如此。
<JavaCallout name="java-callout"> <ClassName>com.apigeesample.JavaProperties</ClassName> <ResourceURL>java://edge-custom-policy-java-properties.jar</ResourceURL> <Properties> <Property name="prop">WORLD!</Property> </Properties> </JavaCallout>
Java 程式碼範例
這個範例的 Java 程式碼顯示如何擷取 Java 呼叫政策中指定的屬性。在範例專案中,您可以在 java-properties/callout/src/main/java/JavaProperties.java
中找到原始碼。本主題的後續部分將逐一說明編譯及部署程式碼的步驟。
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 java.util.Map; public class JavaProperties implements Execution { private Map <String,String> properties; // read-only public JavaProperties(Map <String,String> properties) { this.properties = properties; } public ExecutionResult execute(MessageContext messageContext, ExecutionContext executionContext) { try { messageContext.getMessage().setHeader("X-PROPERTY-HELLO", this.properties.get("prop")); return ExecutionResult.SUCCESS; } catch (Exception e) { return ExecutionResult.ABORT; } } }
使用 Maven 編譯程式碼
專案設定完畢,方便您使用 Maven 進行編譯。如果您想使用 javac
,我們也會加入範例。
- 確認已安裝 Maven:
mvn -version
- 執行
java-properties/buildsetup.sh
指令碼。這個指令碼會在本機 Maven 存放區中安裝必要的 JAR 依附元件。 - cd 寫入
java-properties/callout
目錄。 - 執行 Maven:
mvn clean package
- 您可以視需求確認 JAR 檔案
edge-custom-policy-java-properties.jar
已複製到java-properties/apiproxy/resources/java
。這是您要透過 Proxy 部署的 JAR 檔案必要位置。
透過 Javac 編譯 (選用)
如果您想使用 javac
編譯程式碼,可以執行類似下方的操作 (從 java-properties
目錄)。java-properties/lib
目錄中會為您提供所需的 JAR 檔案。
- cd 重新命名為
api-platform-samples/doc-samples/java-properties
。 - 請確認路徑中有 Javac。
javac -version
- 執行下列 javac 指令:
javac -d . -classpath ./lib/expressions-1.0.0.jar:./lib/message-flow-1.0.0.jar:. callout/src/main/java/JavaProperties.java
- 建立 JAR 檔案:
jar -cvf edge-custom-policy-java-properties.jar ./com/apigeesample/JavaProperties.class
- 將 JAR 檔案複製到 apiproxy/resources/java 目錄。這是您要透過 Proxy 部署的 JAR 檔案必要位置。
cp edge-custom-policy-java-properties.jar apiproxy/resources/java
部署及呼叫 Proxy
./java-properties
目錄中會提供部署指令碼。但在執行前,您必須先快速設定。
- CD 至
api-platform-samples/doc-samples/java-properties
- 如果尚未開啟檔案
../../setup/setenv.sh
,請先開啟檔案,然後依照 Apigee 帳戶資訊 (與帳戶相關聯的電子郵件地址)、貴機構的名稱,以及用於執行 API 管理呼叫的網域來編輯該檔案。舉例來說,若為 Edge Cloud,網域為https://api.enterprise.apigee.com
;不過,如果您使用的是 Edge Private Cloud,網域可能會不同。 - 儲存
setenv.sh
檔案。 - 執行部署指令碼:
./deploy.sh
- 如果部署成功,請執行叫用指令碼:
./invoke.sh
叫用指令碼呼叫的 cURL 指令如下所示:
curl http://$org-$env.$api_domain/java-properties
Proxy 會傳回標頭:
X-PROPERTY-HELLO: WORLD!
。請注意,我們在政策中新增了屬性名稱/值組合"prop/WORLD!"
。Java 呼叫會擷取"WORLD!"
值,並將其設為在名為X-PROPERTY-HELLO
的標頭中:messageContext.getMessage().setHeader("X-PROPERTY-HELLO", this.properties.get("prop"));