Java中的HR文档工作流
许多企业需要新员工的相关文档，如在家办公员工的工作场所协议。 传统上，企业将这些文档以难以管理和存储的形式进行物理管理。 当切换到电子文档时，PDF文件是理想选择，因为它们比其他文件类型更安全，更不可修改。 此外，它们还支持数字签名。
您可以学到的内容
在本实际操作教程中，了解如何实施基于Web的HR表单，该表单保存了工作区协议，以便在简单的Java Spring MVCPDF中通过签署来进行。
相关的API和资源
生成API凭据
首先注册Adobe PDF Services API免费试用版。 转到Adobe 网站，然后单击 创建新凭据 下的 开始使用 按钮。 免费试用版提供了1,000个文档事务，可在六个月内使用。 在下一页（请参阅下文）上，选择服务(PDF服务API)，设置凭据名称（例如，HRDocumentWFCredentials），然后输入说明。
选择语言（本示例为Java）并选中 创建个性化代码示例。 最后一步确保代码示例已包含预填充的pdftools-api-credentials.json文件，以及用于在API中对应用程序进行身份验证的私钥。
最后，单击 创建凭据 按钮。 这将生成凭据，并自动开始下载示例。
为确保凭据有效，请打开下载的示例。 您正在使用IntelliJ IDEA。 打开源代码时，集成开发环境(IDE)会要求生成引擎。 此示例中使用了Maven，但您也可以根据自己的喜好使用Gradle。
接下来，执行mvn clean install Maven目标以生成jar文件。
最后，运行CombinePDF示例，如下所示。 代码在输出文件夹中生成PDF。
创建Spring MVC应用程序
根据凭据，您即可创建应用程序。 本示例使用Spring Initializer。
首先，配置项目设置以使用Java 8语言和Jar打包（请参见下面的屏幕截图）。
其次，添加Spring Web（来自Web）和Thymeleaf（来自模板引擎）：
创建项目后，转到pom.xml文件，然后使用pdftools-sdk和log4j-slf4j-impl补充依赖关系部分：
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
然后，使用示例代码将下载的两个文件补充到项目的根文件夹中：
-
pdftools-api-credentials.json
-
private.key
渲染Web表单
要渲染Web表单，请修改包含渲染个人数据表单的控制器的应用程序，然后处理表单的发布。 因此，首先使用PersonForm模型类修改应用程序：
package com.hr.docsigning;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
public class PersonForm {
@NotNull
@Size(min=2, max=30)
private String firstName;
@NotNull
@Size(min=2, max=30)
private String lastName;
public String getFirstName() {
return this.firstName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
}
public String getLastName() {
return this.lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public String GetFullName() {
return this.firstName + " " + this.lastName;
}
}
此类包含两个属性： firstName和lastName。 此外，使用此简单验证可检查字符数是否介于2到30个字符之间。
给定模型类，您可以创建控制器（请参阅伴随代码中的PersonController.java）：
package com.hr.docsigning;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import javax.validation.Valid;
@Controller
public class PersonController {
@GetMapping("/")
public String showForm(PersonForm personForm) {
return "form";
}
}
控制器只有一种方法：showForm。 它负责使用位于resources/templates/form.html中的HTML模板呈现表单：
<html>
<head>
<link rel="stylesheet" href="https://www.w3schools.com/w3css/4/w3.css">
</head>
<body>
<div class="w3-container">
<h1>HR Department</h1>
</div>
<form class="w3-panel w3-card-4" action="#" th:action="@{/}"
th:object="${personForm}" method="post">
<h2>Personal data</h2>
<table>
<tr>
<td>First Name:</td>
<td><input type="text" class="w3-input"
placeholder="First name" th:field="*{firstName}" /></td>
<td class="w3-text-red" th:if="${#fields.hasErrors('firstName')}"
th:errors="*{firstName}"></td>
</tr>
<tr>
<td>Last Name:</td>
<td><input type="text" class="w3-input"
placeholder="Last name" th:field="*{lastName}" /></td>
<td class="w3-text-red" th:if="${#fields.hasErrors('lastName')}"
th:errors="*{lastName}"></td>
</tr>
<tr>
<td><button class="w3-button w3-black" type="submit">Submit</button></td>
</tr>
</table>
</form>
</body>
</html>
为了渲染动态内容，采用Thymeleaf模板渲染引擎。 因此，在运行应用程序后，您应该会看到以下内容：
生成具有动态内容的PDF
现在，在呈现个人数据表单后，通过动态填充选定字段来生成包含虚拟合同的PDF文档。 具体来说，您必须在预先创建的合同中填充人员数据。
为简单起见，此处您只有一个标题、一个子标题和一个字符串常量，内容为：“此合同是为<人员的全名>准备的”。
为了实现此目标，请从Adobe的从动态HTML创建PDF示例开始。 通过分析示例代码，可以看到动态HTML字段填充的过程如下。
首先，您必须准备包含静态和动态内容的HTML页。 使用JavaScript更新动态部件。 即，PDF服务API会将JSON对象注入您的HTML。
然后，使用加载HTML文档时调用的JavaScript函数获取JSON属性。 此JavaScript函数更新选定的DOM元素。 以下是填充范围元素的示例，其中保存了人员的数据(请参阅伴随代码的src\main\resources\contract\index.html)：
<html>
<head>
<link rel="stylesheet" href="https://www.w3schools.com/w3css/4/w3.css">
</head>
<body onload="updateFullName()">
<script src="./json.js"></script>
<script type="text/javascript">
function updateFullName()
{
var document = window.document;
document.getElementById("personFullName").innerHTML = String(
window.json.personFullName);
}
</script>
<div class="w3-container ">
<h1>HR Department</h1>
<h2>Contract details</h2>
<p>This contract was prepared for:
<strong><span id="personFullName"></span></strong>
</p>
</div>
</body>
</html>
然后，您必须将HTML与所有依赖的JavaScript和CSS文件一起压缩。 PDF服务API不接受HTML文件。 相反，它需要zip文件作为输入。 在本例中，您将压缩文件存储在src\main\resources\contract\index.zip中。
然后，您可以使用处理POST请求的另一个方法补充PersonController：
@PostMapping("/")
public String checkPersonInfo(@Valid PersonForm personForm,
BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
return "form";
}
CreateContract(personForm);
return "contract-actions";
}
上述方法使用提供的个人数据创建PDF合同并呈现合同 — 操作视图。 后者提供指向所生成PDF的链接和用于签署PDF。
现在，让我们看看CreateContract方法的工作方式（下面是完整列表）。 该方法依赖于两个字段：
-
LOGGER，从log4j调试有关任何异常的信息 -
contractFilePath，包含所生成PDF的文件路径
CreateContract方法设置凭据并从HTML创建PDF。 要在合同中传递和填充人员的数据，请使用setCustomOptionsAndPersonData帮助程序。 此方法从表单中检索人员数据，然后通过上述JSON对象将其发送到生成的PDF。
此外，setCustomOptionsAndPersonData还显示如何通过禁用页眉和页脚来控制PDF外观。 完成这些步骤后，将PDF文件保存到output/contract.pdf，并最终删除以前生成的文件。
private static final Logger LOGGER = LoggerFactory.getLogger(PersonController.class);
private String contractFilePath = "output/contract.pdf";
private void CreateContract(PersonForm personForm) {
try {
// Initial setup, create credentials instance.
Credentials credentials = Credentials.serviceAccountCredentialsBuilder()
.fromFile("pdftools-api-credentials.json")
.build();
//Create an ExecutionContext using credentials
//and create a new operation instance.
ExecutionContext executionContext = ExecutionContext.create(credentials);
CreatePDFOperation htmlToPDFOperation = CreatePDFOperation.createNew();
// Set operation input from a source file.
FileRef source = FileRef.createFromLocalFile(
"src/main/resources/contract/index.zip");
htmlToPDFOperation.setInput(source);
// Provide any custom configuration options for the operation
// You pass person data here to dynamically fill out the HTML
setCustomOptionsAndPersonData(htmlToPDFOperation, personForm);
// Execute the operation.
FileRef result = htmlToPDFOperation.execute(executionContext);
// Save the result to the specified location. Delete previous file if exists
File file = new File(contractFilePath);
Files.deleteIfExists(file.toPath());
result.saveAs(file.getPath());
} catch (ServiceApiException | IOException |
SdkException | ServiceUsageException ex) {
LOGGER.error("Exception encountered while executing operation", ex);
}
}
private static void setCustomOptionsAndPersonData(
CreatePDFOperation htmlToPDFOperation, PersonForm personForm) {
//Set the dataToMerge field that needs to be populated
//in the HTML before its conversion
JSONObject dataToMerge = new JSONObject();
dataToMerge.put("personFullName", personForm.GetFullName());
// Set the desired HTML-to-PDF conversion options.
CreatePDFOptions htmlToPdfOptions = CreatePDFOptions.htmlOptionsBuilder()
.includeHeaderFooter(false)
.withDataToMerge(dataToMerge)
.build();
htmlToPDFOperation.setOptions(htmlToPdfOptions);
}
在生成合同时，您还可以将特定于人员的动态数据与固定合同条款合并。 为此，请遵循从静态HTML创建PDF示例。 或者，您可以合并两个PDF。
正在演示要下载的PDF文件
现在，您可以显示所生成PDF的链接以供用户下载。 为此，请首先创建contract-actions.html文件（请参阅伴随代码的resources/templates contract-actions.html）：
<html>
<head>
<link rel="stylesheet" href="https://www.w3schools.com/w3css/4/w3.css">
</head>
<div class="w3-container ">
<h1>HR Department</h1>
<h2>Contract file</h2>
<p>Click <a href="/pdf">here</a> to download your contract</p>
</div>
</body>
</html>
然后，在PersonController类中实现downloadContract方法，如下所示：
@RequestMapping("/pdf")
public void downloadContract(HttpServletResponse response)
{
Path file = Paths.get(contractFilePath);
response.setContentType("application/pdf");
response.addHeader(
"Content-Disposition", "attachment; filename=contract.pdf");
try
{
Files.copy(file, response.getOutputStream());
response.getOutputStream().flush();
}
catch (IOException ex)
{
ex.printStackTrace();
}
}
运行应用程序后，您将获得以下流程。 第一个屏幕显示个人数据表单。 要进行测试，请用介于2到30个字符之间的任何值填充它：
单击“提交”按钮后，表单将验证，并且PDF将根据HTML(resources/contract/index.html)生成。 应用产品将显示另一个视图（合同详细信息），您可以在其中下载PDF：
在Web浏览器中渲染后，PDF如下所示。 即，您输入的个人数据将传播到PDF：
启用签名和安全性
当协议准备就绪时，Adobe Sign可以添加表示批准的数字签名。 Adobe Sign身份验证的工作方式与OAuth稍有不同。 现在，让我们了解如何将该应用程序与Adobe Sign集成。 为此，您必须为应用程序准备访问令牌。 然后，使用Adobe Sign Java SDK编写客户端代码。
要获取授权令牌，您必须执行若干步骤：
首先，注册开发人员帐户。
在Adobe Sign门户中创建CLIENT应用程序。
按照此处和此处所述为应用程序配置OAuth。 请注意您的客户端标识符和客户端密钥。 然后，您可以使用https://www.google.com作为重定向URI和以下作用域：
-
user_login： self
-
agreement_read：帐户
-
agreement_write：帐户
-
agreement_send：帐户
按如下所述使用客户端ID代替<CLIENT_ID>准备URL：
https://secure.eu1.adobesign.com/public/oauth?redirect_uri=https://www.google.com
&response_type=code
&client_id=<CLIENT_ID>
&scope=user_login:self+agreement_read:account+agreement_write:account+agreement_send:account
在Web浏览器中键入上述URL。 您将被重定向到google.com，并且代码在地址栏中显示为code=<YOUR_CODE>，用于
示例：
https://www.google.com/?code=<YOUR_CODE>&api_access_point=https://api.eu1.adobesign.com/&web_access_point=https://secure.eu1.adobesign.com%2F
请注意为<YOUR_CODE>和api_access_point提供的值。
要发送提供访问令牌的HTTPPOST请求，请使用客户端ID、<YOUR_CODE>和api_access_point值。 您可以使用Postman或cURL：
curl --location --request POST "https://**api.eu1.adobesign.com**/oauth/token"
\\
\--data-urlencode "client_secret=**\<CLIENT_SECRET\>**" \\
\--data-urlencode "client_id=**\<CLIENT_ID\>**" \\
\--data-urlencode "code=**\<YOUR_CODE\>**" \\
\--data-urlencode "redirect_uri=**https://www.google.com**" \\
\--data-urlencode "grant_type=authorization_code"
示例响应如下所示：
{
"access_token":"3AAABLblqZhByhLuqlb-…",
"refresh_token":"3AAABLblqZhC_nJCT7n…",
"token_type":"Bearer",
"expires_in":3600
}
记下您的access_token。 你需要它来授权你的客户端代码。
使用Adobe Sign Java SDK
获取访问令牌后，您可以将REST API调用发送到Adobe Sign。 要简化此过程，请使用Adobe Sign Java SDK。 源代码在Adobe的GitHub存储库中可用。
要将此包与应用程序集成，必须克隆代码。 然后，创建Maven包（mvn包），并将以下文件安装到项目中（您可以在adobe-sign-sdk文件夹的伴随代码中找到它们）：
-
target/swagger-java-client-1.0.0.jar
-
target/lib/gson-2.8.1.jar
-
target/lib/gson-fire-1.8.0.jar
-
target/lib/hamcrest-core-1.3.jar
-
target/lib/junit-4.12.jar
-
target/lib/logging-interceptor-2.7.5.jar
-
target/lib/okhttp-2.7.5.jar
-
target/lib/okio-1.6.0.jar
-
target/lib/swagger-annotations-1.5.15.jar
在IntelliJ IDEA中，您可以使用 项目结构（文件/项目结构）将这些文件添加为依赖项。
发送PDF以供签名
您现在可以发送协议以供签名。 为此，请首先将contract-details.html补充为发送请求的另一个超链接：
<html>
<head>
<link rel="stylesheet" href="https://www.w3schools.com/w3css/4/w3.css">
</head>
<div class="w3-container ">
<h1>HR Department</h1>
<h2>Contract file</h2>
<p>Click <a href="/pdf"> here</a> to download your contract</p>
</div>
</body>
</html>
然后，添加另一个控制器AdobeSignController，在其中实现sendContractMethod（请参见伴随代码）。 该方法的工作原理如下：
首先，它使用ApiClient获取API终结点。
ApiClient apiClient = new ApiClient();
//Default baseUrl to make GET /baseUris API call.
String baseUrl = "https://api.echosign.com/";
String endpointUrl = "/api/rest/v6";
apiClient.setBasePath(baseUrl + endpointUrl);
// Provide an OAuth Access Token as "Bearer access token" in authorization
String authorization = "Bearer ";
// Get the baseUris for the user and set it in apiClient.
BaseUrisApi baseUrisApi = new BaseUrisApi(apiClient);
BaseUriInfo baseUriInfo = baseUrisApi.getBaseUris(authorization);
apiClient.setBasePath(baseUriInfo.getApiAccessPoint() + endpointUrl);
然后，该方法使用contract.pdf文件创建临时文档：
// Get PDF file
String filePath = "output/";
String fileName = "contract.pdf";
File file = new File(filePath + fileName);
String mimeType = "application/pdf";
//Get the id of the transient document.
TransientDocumentsApi transientDocumentsApi =
new TransientDocumentsApi(apiClient);
TransientDocumentResponse response = transientDocumentsApi.createTransientDocument(authorization,
file, null, null, fileName, mimeType);
String transientDocumentId = response.getTransientDocumentId();
接下来，您必须创建一个协议。 为此，请使用contract.pdf文件并将协议状态设置为IN_PROCESS以立即发送文件。 此外，您可以选择电子签名：
// Create AgreementCreationInfo
AgreementCreationInfo agreementCreationInfo = new AgreementCreationInfo();
// Add file
FileInfo fileInfo = new FileInfo();
fileInfo.setTransientDocumentId(transientDocumentId);
agreementCreationInfo.addFileInfosItem(fileInfo);
// Set state to IN_PROCESS, so the agreement is be sent immediately
agreementCreationInfo.setState(AgreementCreationInfo.StateEnum.IN_PROCESS);
agreementCreationInfo.setName("Contract");
agreementCreationInfo.setSignatureType(AgreementCreationInfo.SignatureTypeEnum.ESIGN);
接下来，您可以按如下方式添加协议收件人。 您要添加两个收件人（请参阅“员工”和“经理”部分）：
// Provide emails of recipients to whom agreement is be sent
// Employee
ParticipantSetInfo participantSetInfo = new ParticipantSetInfo();
ParticipantSetMemberInfo participantSetMemberInfo = new ParticipantSetMemberInfo();
participantSetMemberInfo.setEmail("");
participantSetInfo.addMemberInfosItem(participantSetMemberInfo);
participantSetInfo.setOrder(1);
participantSetInfo.setRole(ParticipantSetInfo.RoleEnum.SIGNER);
agreementCreationInfo.addParticipantSetsInfoItem(participantSetInfo);
// Manager
participantSetInfo = new ParticipantSetInfo();
participantSetMemberInfo = new ParticipantSetMemberInfo();
participantSetMemberInfo.setEmail("");
participantSetInfo.addMemberInfosItem(participantSetMemberInfo);
participantSetInfo.setOrder(2);
participantSetInfo.setRole(ParticipantSetInfo.RoleEnum.SIGNER);
agreementCreationInfo.addParticipantSetsInfoItem(participantSetInfo);
最后，使用createAgreement方法从Adobe Sign Java SDK发送协议：
// Create agreement using the transient document.
AgreementsApi agreementsApi = new AgreementsApi(apiClient);
AgreementCreationResponse agreementCreationResponse = agreementsApi.createAgreement(
authorization, agreementCreationInfo, null, null);
System.out.println("Agreement sent, ID: " + agreementCreationResponse.getId());
运行此代码后，您会收到一封包含协议签名请求的电子邮件（发送到代码中指定为<email_address>)的地址）。 电子邮件包含超链接，该链接会将收件人引导至Adobe Sign门户以执行签名。 您会在Adobe Sign开发人员门户中看到此文档（请参阅下图），并且还可以使用getAgreementInfo方法以编程方式跟踪签名过程。
最后，您还可以使用PDF服务API对PDF进行密码保护，如以下示例所示。
后续步骤
如您所见，通过利用快速启动，您可以实施一个简单的Web表单，使用Adobe PDF Services API在Java中创建经过审批的PDF。 Adobe PDF API可无缝集成到现有客户端应用程序中。
再进一步了解一下，您可以创建表单，方便收件人远程安全地签名。 当您需要多个签名时，您甚至可以自动将表单发送给工作流程中的一系列人员。 您的员工入职培训已得到改进，并且人力资源部会喜欢您。
请查看Adobe Acrobat Services，以立即为您的应用程序添加多种PDF功能。