按值渲染Forms

本文档中的示例和示例仅适用于AEM Forms on JEE环境。

通常，在Designer中创建的表单设计会通过引用Forms服务进行传递。 窗体设计可以很大，因此，通过引用传递它们更有效，从而不必按值封送窗体设计字节。 Forms服务还可以缓存表单设计，以便在缓存表单设计时，它不必持续读取表单设计。

如果表单设计包含UUID属性，则将其缓存。 UUID值对于所有表单设计都是唯一的，可用于唯一标识表单。 按值呈现表单时，应仅在表单重复使用时缓存表单。 但是，如果表单未重复使用并且必须是唯一的，则可以避免使用使用AEM Forms API设置的缓存选项来缓存表单。

Forms服务还可以解析链接内容在表单设计中的位置。 例如，从表单设计内引用的链接图像是相对URL。 始终假定链接的内容相对于窗体设计位置。 因此，解析链接内容是通过将相对路径应用于绝对窗体设计位置来确定其位置的问题。

您可以按值传递表单设计，而不是通过引用传递表单设计。 在动态创建表单设计时，即客户端应用程序在运行时生成用于创建表单设计的XML时，按值传递表单设计是非常有效的。 在这种情况下，表单设计不会存储在物理存储库中，因为它存储在内存中。 在运行时动态创建表单设计并按值传递时，可以缓存表单并提高Forms服务的性能。

按值传递表单的限制

当表单设计按值传递时，以下限制适用：

• 表单设计中不能有相对链接的内容。 所有图像和片段都必须嵌入到窗体设计中，或绝对参照。
• 渲染表单后无法执行服务器端计算。 如果将表单提交回Forms服务，则会提取并返回数据，而无需任何服务器端计算。
• 由于HTML只能在运行时使用链接的图像，因此无法生成包含嵌入图像的HTML。 这是因为Forms服务通过从引用的表单设计中检索图像来支持带有HTML的嵌入式图像。 由于按值传递的表单设计没有引用的位置，因此显示“HTML”页面时无法提取嵌入的图像。 因此，图像引用必须是绝对路径，才能在HTML中渲染。

步骤摘要

要按值呈现表单，请执行以下步骤：

1. 包括项目文件。
2. 创建Forms客户端API对象。
3. 参考窗体设计。
4. 按值渲染表单。
5. 将表单数据流写入客户端Web浏览器。

包括项目文件

在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序，则包含必要的JAR文件。 如果您使用的是Web服务，请确保包含代理文件。

创建Forms客户端API对象

您必须先创建数据集成服务客户端，然后才能以编程方式将数据从客户端API导入PDF。 创建服务客户端时，您可以定义调用服务所需的连接设置。

参考表单设计

按值呈现表单时，必须创建 com.adobe.idp.Document 包含要呈现的表单设计的对象。 您可以引用现有的XDP文件，也可以在运行时动态创建表单设计并填充 com.adobe.idp.Document 用那些数据。

按值渲染表单

要按值呈现表单，请传递 com.adobe.idp.Document 包含窗体设计到渲染方法的实例 inDataDoc 参数(可以是任意 FormsServiceClient 对象的渲染方法，例如 renderPDFForm， (Deprecated) renderHTMLForm，等等)。 此参数值通常保留给与表单合并的数据。 同样，将空字符串值传递给 formQuery 参数。 通常，此参数需要指定表单设计名称的字符串值。

将表单数据流写入客户端Web浏览器

当Forms服务按值呈现表单时，它会返回一个您必须写入客户端Web浏览器的表单数据流。 在写入客户端Web浏览器时，该表单对用户可见。

另请参阅

使用Java API按值渲染表单

使用Web服务API按值渲染表单

包括AEM Forms Java库文件

设置连接属性

Forms服务API快速启动

将文档传递到Forms服务

创建渲染Forms的Web应用程序

使用Java API按值渲染表单

使用Forms API (Java)按值渲染表单：

1. 包括项目文件

   在Java项目的类路径中包含客户端JAR文件，如adobe-forms-client.jar。

2. 创建Forms客户端API对象

   • 创建 ServiceClientFactory 包含连接属性的对象。
   • 创建 FormsServiceClient 对象，使用它的构造函数传递 ServiceClientFactory 对象。

3. 参考表单设计

   • 创建 java.io.FileInputStream 表示要渲染的表单设计的对象，方法是使用其构造函数并传递一个指定XDP文件位置的字符串值。
   • 创建 com.adobe.idp.Document 对象，使用它的构造函数传递 java.io.FileInputStream 对象。

4. 按值渲染表单

   调用 FormsServiceClient 对象的 renderPDFForm 方法，并传递以下值：

   • 空字符串值。 （通常，此参数需要指定表单设计名称的字符串值。）
   • A com.adobe.idp.Document 包含窗体设计的对象。 通常，此参数值会保留给与表单合并的数据。
   • A PDFFormRenderSpec 存储运行时选项的对象。 这是一个可选参数，您可以指定 null 如果您不想指定运行时选项。
   • A URLSpec 包含Forms服务所需的URI值的对象。
   • A java.util.HashMap 存储文件附件的对象。 这是一个可选参数，您可以指定 null 如果您不想将文件附加到表单。

   此 renderPDFForm 方法返回 FormsResult 包含可写入客户端Web浏览器的表单数据流的对象。

5. 将表单数据流写入客户端Web浏览器

   • 创建 com.adobe.idp.Document 对象 FormsResult 对象 getOutputContent 方法。
   • 获取的内容类型 com.adobe.idp.Document 对象，调用其 getContentType 方法。
   • 设置 javax.servlet.http.HttpServletResponse 对象的内容类型(通过调用其 setContentType 方法和传递的内容类型 com.adobe.idp.Document 对象。
   • 创建 javax.servlet.ServletOutputStream 用于通过调用 javax.servlet.http.HttpServletResponse 对象的 getOutputStream 方法。
   • 创建 java.io.InputStream 对象 com.adobe.idp.Document 对象的 getInputStream 方法。
   • 创建字节数组并分配 InputStream 对象。 调用 InputStream 对象的 available 用于获取 InputStream 对象。
   • 通过调用 InputStream 对象的 read方法，并将字节数组作为参数传递。
   • 调用 javax.servlet.ServletOutputStream 对象的 write 方法将表单数据流发送到客户端Web浏览器。 将字节数组传递到 write 方法。

另请参阅

按值渲染Forms

快速入门（SOAP模式）：使用Java API按值渲染

包括AEM Forms Java库文件

设置连接属性

使用Web服务API按值渲染表单

使用Forms API（Web服务）按值渲染表单：

1. 包括项目文件

   • 创建使用Forms服务WSDL的Java代理类。
   • 将Java代理类包含在类路径中。

2. 创建Forms客户端API对象

   创建 FormsService 对象并设置身份验证值。

3. 参考表单设计

   • 创建 java.io.FileInputStream 对象。 传递一个指定XDP文件位置的字符串值。
   • 创建 BLOB 对象。 此 BLOB 对象用于存储已用密码加密的PDF文档。
   • 创建一个字节数组，用于存储 java.io.FileInputStream 对象。 您可以通过获取 java.io.FileInputStream 对象大小(使用其 available 方法。
   • 通过调用 java.io.FileInputStream 对象的 read 方法和传递字节数组。
   • 填充 BLOB 对象，调用其 setBinaryData 方法和传递字节数组。

4. 按值渲染表单

   调用 FormsService 对象的 renderPDFForm 方法，并传递以下值：

   • 空字符串值。 （通常，此参数需要指定表单设计名称的字符串值。）
   • A BLOB 包含窗体设计的对象。 通常，此参数值会保留给与表单合并的数据。
   • A PDFFormRenderSpec 存储运行时选项的对象。 这是一个可选参数，您可以指定 null 如果您不想指定运行时选项。
   • A URLSpec 包含Forms服务所需的URI值的对象。
   • A java.util.HashMap 存储文件附件的对象。 这是一个可选参数，您可以指定 null 如果您不想将文件附加到表单。
   • 空 com.adobe.idp.services.holders.BLOBHolder 由方法填充的对象。 用于存储渲染的PDF表单。
   • 空 javax.xml.rpc.holders.LongHolder 由方法填充的对象。 （此参数会存储表单中的页数。）
   • 空 javax.xml.rpc.holders.StringHolder 由方法填充的对象。 （此参数存储区域设置值。）
   • 空 com.adobe.idp.services.holders.FormsResultHolder 将包含此操作结果的对象。

   此 renderPDFForm 方法填充 com.adobe.idp.services.holders.FormsResultHolder 作为最后一个参数值（具有必须写入客户端Web浏览器的表单数据流）传递的对象。

5. 将表单数据流写入客户端Web浏览器

   • 创建 FormResult 对象，方法是获取 com.adobe.idp.services.holders.FormsResultHolder 对象的 value 数据成员。
   • 创建 BLOB 通过调用 FormsResult 对象的 getOutputContent 方法。
   • 获取的内容类型 BLOB 对象，调用其 getContentType 方法。
   • 设置 javax.servlet.http.HttpServletResponse 对象的内容类型(通过调用其 setContentType 方法和传递的内容类型 BLOB 对象。
   • 创建 javax.servlet.ServletOutputStream 用于通过调用 javax.servlet.http.HttpServletResponse 对象的 getOutputStream 方法。
   • 创建一个字节数组，并通过调用 BLOB 对象的 getBinaryData 方法。 此任务分配 FormsResult 对象。
   • 调用 javax.servlet.http.HttpServletResponse 对象的 write 方法将表单数据流发送到客户端Web浏览器。 将字节数组传递到 write 方法。

另请参阅

按值渲染Forms

使用Base64编码调用AEM Forms