此页面由 Cloud Translation API 翻译。

如何创建 JavaCallout

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。信息

什么是 JavaCallout？

Apigee Edge 提供一系列政策来满足常见的 API 管理要求，如安全性、数据转换、流量管理等。

但在某些情况下，您的 API 需要标准政策中未实现的自定义行为。在这些情况下，Apigee 提供了多种选项，使您能够编写脚本或代码来自定义 API 行为。一种方法是使用 Java 实现所需的行为。

如需了解受支持的 Java 版本，请参阅支持的软件和支持的版本。

如何在代理中使用 Java 代码？

通过 JavaCallout 政策，您可以在执行代理流内调用 Java 代码。您的 Java 代码需要实现某些特定于 Edge 的 Java 接口，以允许代码与执行代理进行交互。例如，存在用于获取和设置标头、查询参数、流变量以及代理当前流上下文中的其他实体的 Java 方法。

何时应使用 JavaCallout？

我们来了解一下 JavaCallout 非常有用以及您应该考虑使用其他方法的情况。

首先考虑替代方法

在使用 JavaCallout 之前，请注意，也可以改用备用方法。例如：

对于轻量级操作（例如对远程服务的 HTTP API 调用），请考虑使用 ServiceCallout 政策。请参阅服务标注政策。
如需对消息内容进行相对简单的交互（例如修改或提取 HTTP 标头、参数或消息内容），可以使用 JavaScript 或 Python 语言。

可以在 Java 代码中执行的操作

JavaCallout 支持以下基本操作：

检查或处理请求或响应消息
获取和设置流变量。您可以使用 Java 方法访问 Edge 流变量。如果您想要访问键值对映射 (KVM) 信息，请使用 KVM 政策，将 KVM 值分配给流变量，然后就可以从 Java Callout 中访问流变量了。
调用外部服务
引发错误
处理错误消息和状态代码

无法在 Java 代码中执行的操作

大多数系统调用都是不允许的。无法执行以下操作：

进行内部文件系统读取或写入。这意味着您无法使用任何 Java 包来读入内部文件系统；但是，您可以执行外部远程调用。
获取机器上当前进程、进程列表或 CPU/内存利用率的信息。
访问 expressions-1.0.0.jar 和 message-flow-1.0.0.jar 中的源代码。

虽然此类调用可能会正常工作，但不受支持，并且可能随时会被主动停用。不要在您的代码中进行此类调用。

请勿使用或依赖 Apigee Edge 随附的 Java 库。这些库仅用于 Edge 产品功能，我们无法保证各个版本都会提供相应的库。如果您使用此类库，请仅在非生产的演示中使用它们。

Hello Java callout

我们来看一个基本的 hello world Java callout 示例。在本示例中，我们通过一个返回“hello world”响应的 Java callout 创建一个简单的代理。该代理可能会返回两个可能的响应之一：

如果您传入带有“name”值的“username”标头，代理会返回：
```
Hello, <name>!
```
如果省略该标头，代理将仅返回：
```
"Hello, Guest!"
```

下载入门级项目

为简单起见，我们在 GitHub 上的 Apigee api-platform-samples 代码库中准备了一个基本项目。

将 api-platform-samples 下载或克隆到您的系统中。
在您选择的终端或代码编辑器中，转到 api-platform-samples/doc-samples/java-hello 项目。

编写 Java 代码

打开 Java 源文件：java-hello/callout/src/main/java/HelloJava.java。此文件是我们将实现的主 Java 类的框架版本。Edge 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;


public class HelloJava implements Execution {

        public ExecutionResult execute(MessageContext messageContext, ExecutionContext executionContext) {
                
                try {

                        // Your code here.
            
            return ExecutionResult.SUCCESS;

                } catch (Exception e) {
                        return ExecutionResult.ABORT;
                }
        }

}

将注释行 // Your code here 替换为以下代码：
```
String name = messageContext.getMessage().getHeader("username");

if (name != null && name.length()>0) {
        messageContext.getMessage().setContent("Hello, " + name + "!");
        messageContext.getMessage().removeHeader("username");
} else {
        messageContext.getMessage().setContent("Hello, Guest!");
}
```
注意：注意：通过 MessageContext 对象，您可以访问执行 Java 调用程序政策的数据流内的实体。假设 Java Callout 政策已附加到代理端点响应流。上面列出的代码获取了该流上下文的 HTTP Message 对象。反过来，您可以通过 Message 对象访问标头、查询参数、正文内容和流变量。
保存文件。

使用 Maven 编译代码

项目设置完毕，可以使用 Maven 进行编译。如果您想要使用 javac，我们在 Maven 示例后面包括了一个示例。

确保您已安装 Maven：
```
mvn -version
```
执行脚本 java-hello/buildsetup.sh。此脚本会在本地 Maven 代码库中安装所需的 JAR 依赖项。
使用 cd 命令转到 java-hello/callout 目录。
执行 Maven：
```
mvn clean package
```
注意：如果您遇到 Maven 错误，请确保您位于 java-hello/callout 目录中。
如果需要，请验证 JAR 文件 edge-custom-policy-java-hello.jar 是否已复制到 java-hello/apiproxy/resources/java。要使用代理部署的 JAR 文件必须存放在该位置。

使用 javac 编译（可选）

在上一部分中，您使用 Maven 命令自动生成所需的 Java JAR 文件。或者，如果您要使用 javac 编译代码，可以从 java-hello 目录执行类似如下的操作。java-hello/lib 目录中提供了所需的 JAR 文件。

使用 cd 命令转到 api-platform-samples/doc-samples/java-hello。
确保您的路径中包含 javac。
```
javac -version
```

执行以下 javac 命令：

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

此操作会创建 com/apigeesample/HelloJava.class。

在 apiproxy/resources/java 目录中创建一个包含已编译类的 JAR 文件。要使用代理部署的 JAR 文件必须存放在该位置。为此，您可以在 java-hello 目录中运行以下命令（注意末尾处的句点）。
```
jar cvf apiproxy/resources/java/edge-custom-policy-java-hello.jar -C com .
```

部署和调用代理

./java-hello 目录中提供了部署脚本。但在运行前，您需要进行快速设置。

使用 cd 命令转到 api-platform-samples/doc-samples/java-hello
打开文件 ../../setup/setenv.sh，然后按照 Apigee 帐号信息的指示进行修改：您的用户名（与您的帐号关联的电子邮件地址）、您的组织名称，以及您用于进行 API 管理调用的网域。例如，对于 Edge Cloud，网域为 https://api.enterprise.apigee.com；但是，如果您使用的是 Edge Private Cloud，则您的网域可能会有所不同。
保存 setenv.sh 文件。
执行部署脚本：
```
./deploy.sh
```
如果部署成功，请执行调用脚本：
```
./invoke.sh
```
调用脚本会调用如下所示的 c网址命令：
```
curl  http://$org-$env.$api_domain/java-hello -H "username:Will"
```
此操作会返回“Hello, Will!

您可以修改 invoke.sh 脚本以更改名称，或者如果您更改 c网址调用以移除标头，则该命令会返回“Hello, Guest!”

代理简介

让我们快速检查此代理中使用的政策。注意代理在代理流中的放置位置及原因。

“分配消息”政策

“分配消息”政策附加到 ProxyEndpoint 请求流。它从请求中复制 username 标头，并将其分配给响应。此操作允许附加到响应流的 Java Callout 政策访问 username 标头，并使用该标头的值构建自定义响应正文。

<AssignMessage async="false" continueOnError="false" enabled="true" name="CopyHeader">     
    <DisplayName>CopyHeader</DisplayName>     
    <Copy source="request">         
        <Headers>             
          <Header name="username"/>         
        </Headers>     
    </Copy>     
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>     
    <AssignTo createNew="false" transport="http" type="response"/> 
</AssignMessage>

Java callout 政策

Java callout 政策附加到响应流中。这是因为自定义 Java 代码会更改响应标头和消息。政策的 ClassName 元素指定了由政策执行的主类。ResourceURL 元素是您构建的 JAR 文件的名称，并添加到代理的 resources/java 目录中。

<JavaCallout name="hello-java">         
    <ClassName>com.apigeesample.HelloJava</ClassName>         
    <ResourceURL>java://edge-custom-policy-java-hello.jar</ResourceURL> 
</JavaCallout>

关于 Java callout 的须知事项

有关实现 Java callout 的重要注意事项：

从 com.apigee.flow.execution 和 com.apigee.flow.message 包中导入类。这些包必须包含在打包和部署的 JAR 文件中。您可以通过管理界面代理编辑器上传 Java JAR，也可以在本地开发的 API 代理中将其包含在 /resources/java 目录中。
实现 Execution 接口。在 API 代理中执行的任何 Java 代码都必须实现 Execution。
Java Callout 政策不包含实际代码。相反，Java Callout 政策引用 Java“资源”（您必须将该资源打包在一个 JAR 中）。
应避免的软件包名称：请勿在 Java Callout 中使用 io.apigee 或 com.apigee。这些名称由其他 Apigee 模块预留和使用。
如果您的 Java 标注依赖于打包为独立 JAR 文件的其他第三方库，则将这些 JAR 文件也放在 /resources/java 目录中，以确保在运行时正确加载它们。
如果有多个 JAR，只需将它们添加为其他资源。您无需修改政策配置来引用其他 JAR 文件。将其放入 /resources/java 即可。
如需详细了解如何上传 Java JAR，请参阅资源文件。