1. 引言：ZPL到PDF转换的需求背景
在许多业务场景中，我们可能需要动态生成标签或票据。zpl (zebra programming language) 是一种常用的打印机命令语言，用于描述标签布局。为了在应用程序中预览或保存这些标签，通常需要将其转换为更通用的格式，如pdf。本教程将以labelary api为例，演示如何通过http请求实现zpl到pdf的转换，并特别关注在android开发环境中，如何从java 11 httpclient平稳过渡到okhttp库。
2. Java 11 HttpClient 实现示例
首先，我们回顾一下使用Java 11内置的HttpClient API实现ZPL到PDF转换的典型做法。这种方式简洁高效，但在Android平台上通常不可用。
import java.io.File;
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpRequest.BodyPublishers;
import java.net.http.HttpResponse.BodyHandlers;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
public class ZplToPdfConverter {
public static void main(String[] args) throws IOException, InterruptedException {
// ZPL 字符串示例
var zpl = "^xa^cfa,50^fo100,100^fdHello World^fs^xz";
// Labelary API 端点，指定打印密度、标签尺寸和索引
var uri = URI.create("http://api.labelary.com/v1/printers/8dpmm/labels/4x6/0/");
// 构建 HTTP 请求
var request = HttpRequest.newBuilder(uri)
.header("Accept", "application/pdf") // 明确请求 PDF 格式
.POST(BodyPublishers.ofString(zpl)) // 将 ZPL 字符串作为 POST 请求体发送
.build();
// 创建 HttpClient 实例
var client = HttpClient.newHttpClient();
// 发送请求并获取响应，响应体以字节数组形式处理
var response = client.send(request, BodyHandlers.ofByteArray());
var body = response.body();
// 检查响应状态码
if (response.statusCode() == 200) {
// 成功：将字节数组写入 PDF 文件
var file = new File("label.pdf");
Files.write(file.toPath(), body);
System.out.println("PDF 文件已成功保存到: " + file.getAbsolutePath());
} else {
// 失败：打印错误信息
var errorMessage = new String(body, StandardCharsets.UTF_8);
System.err.println("API 请求失败，错误信息: " + errorMessage);
}
}
}此代码通过POST请求将ZPL字符串发送到Labelary API，并设置Accept头为application/pdf以获取PDF格式的响应。成功后，响应的字节流被直接写入文件。
3. Android 环境下的 OkHttp 迁移与挑战
由于Java 11 HttpClient在Android平台上的兼容性问题，我们通常会选择成熟的第三方库，如Squareup的OkHttp。在迁移过程中，开发者可能会遇到一些挑战，特别是关于如何正确构建请求以获取PDF数据。
3.1 初次尝试：使用 POST 请求发送 ZPL
开发者在迁移时，自然会想到沿用Java 11 HttpClient的POST请求模式，将ZPL字符串作为请求体发送。
import okhttp3.*
import java.io.IOException
import java.io.InputStream
fun fetchPdfWithPost(completion: (InputStream?) -> Unit) {
val url = "https://api.labelary.com/v1/printers/8dpmm/labels/4x6/0/"
val postBody = "^xa^cfa,50^fo100,100^fdHello World^fs^xz"
// 定义请求体类型为 text/plain
val mediaType = MediaType.parse("text/plain;charset=utf-8")
val body = RequestBody.create(mediaType, postBody)
val client = OkHttpClient()
val request = Request.Builder()
.header("Accept", "application/pdf") // 请求 PDF 格式
.url(url)
.post(body) // 使用 POST 方法发送请求体
.build()
client.newCall(request).enqueue(object : Callback {
override fun onFailure(call: Call, e: IOException) {
// 处理网络请求失败
e.printStackTrace()
completion(null)
}
override fun onResponse(call: Call, response: Response) {
if (response.isSuccessful) {
val pdfData = response.body()?.byteStream()
completion(pdfData)
} else {
// 处理非成功响应，例如打印错误信息
println("请求失败: ${response.code()} - ${response.message()}")
response.body()?.close() // 及时关闭响应体
completion(null)
}
}
})
}尽管上述代码看起来逻辑正确，但在实际运行时，可能会遇到java.io.IOException: file not in PDF format or corrupted这样的错误。这通常不是OkHttp本身的问题，而是与特定API（如Labelary）的请求方式有关。Labelary API在某些情况下，特别是对于简单的ZPL字符串，支持通过GET请求将ZPL直接作为URL路径的一部分来发送。
4. 优化方案：使用 GET 请求发送 ZPL
针对Labelary API的特点，一个更简洁且有效的解决方案是将ZPL字符串直接拼接在API的URL路径中，然后使用GET请求。这种方式对于Labelary API是支持的，并且可以避免一些潜在的POST请求体解析问题。
4.1 优化后的 OkHttp 实现
import okhttp3.*
import java.io.IOException
import java.io.InputStream
import java.net.URLEncoder
import java.nio.charset.StandardCharsets
fun fetchPdfWithGet(completion: (InputStream?) -> Unit) {
// 原始 ZPL 字符串
val zpl = "^xa^cfa,50^fo100,100^fdHello World^fs^xz"
// 对 ZPL 字符串进行 URL 编码，以确保特殊字符能正确传递
val encodedZpl = URLEncoder.encode(zpl, StandardCharsets.UTF_8.toString())
// 构建包含 ZPL 的完整 URL
val url = "http://api.labelary.com/v1/printers/8dpmm/labels/4x6/0/$encodedZpl"
val client = OkHttpClient()
val request = Request.Builder()
.header("Accept", "application/pdf") // 明确请求 PDF 格式
.url(url)
.get() // 使用 GET 方法
.build()
client.newCall(request).enqueue(object : Callback {
override fun onFailure(call: Call, e: IOException) {
// 处理网络请求失败
e.printStackTrace()
completion(null)
}
override fun onResponse(call: Call, response: Response) {
if (response.isSuccessful) {
val pdfData = response.body()?.byteStream()
completion(pdfData)
} else {
// 处理非成功响应，例如打印错误信息
val errorBody = response.body()?.string()
println("请求失败: ${response.code()} - ${response.message()}")
println("错误详情: $errorBody")
response.body()?.close() // 及时关闭响应体
completion(null)
}
}
})
}4.2 代码解析与注意事项
- URL 编码 (URLEncoder.encode): 当将ZPL字符串作为URL路径的一部分时，必须对其进行URL编码。这是为了确保ZPL中的特殊字符（如^, ,, /等）不会被误解为URL的组成部分，从而导致请求路径错误或解析失败。
- GET 方法 (.get()): OkHttp默认的Request.Builder()是GET方法，但显式调用.get()可以增加代码可读性。
- 异步请求 (enqueue): enqueue方法是OkHttp进行异步网络请求的标准方式。它会在后台线程执行网络操作，并将结果回调到主线程（或调用enqueue的线程）。这对于Android应用尤其重要，因为它避免了在主线程上执行耗时操作，防止ANR (Application Not Responding) 错误。
-
响应处理 (onResponse):
- response.isSuccessful: 检查HTTP状态码是否在200-299之间。
- response.body()?.byteStream(): 获取原始的字节输入流。对于PDF文件，这是最直接的方式。
- 资源管理: 在处理完响应体后，即使请求失败或不成功，也应该调用response.body()?.close()来关闭底层连接和释放资源。在onResponse方法的两个分支中都应该考虑这一点。
- 错误处理 (onFailure): 处理网络连接问题，如无网络、DNS解析失败、超时等。
5. PDF 数据流的后续处理
当completion回调函数接收到InputStream后，您就可以将其用于显示或保存PDF文件。在Android中，通常会使用第三方PDF查看器库（如Android-Pdf-Viewer、PdfRenderer等）来渲染这个InputStream。
// 示例：如何在 Activity/Fragment 中调用并显示 PDF
// 假设你有一个方法来显示 InputStream 为 PDF
fun displayPdf(inputStream: InputStream) {
// 这里需要集成一个 PDF 渲染库，例如 Android-Pdf-Viewer
// val pdfView = findViewById(R.id.pdfView)
// pdfView.fromStream(inputStream).load()
// 注意：在实际应用中，处理 InputStream 应该在一个后台线程，
// 并且渲染 PDF 的操作也可能需要一定时间。
}
// 在你的 Activity/Fragment 中调用
fun loadAndDisplayPdf() {
fetchPdfWithGet { pdfInputStream ->
if (pdfInputStream != null) {
// 确保在主线程更新 UI
runOnUiThread {
displayPdf(pdfInputStream)
}
} else {
runOnUiThread {
// 显示错误信息
Toast.makeText(this, "无法获取PDF文件", Toast.LENGTH_SHORT).show()
}
}
}
} 6. 总结
本教程详细阐述了在Android平台上，如何通过OkHttp库实现ZPL到PDF的转换。关键在于理解目标API（Labelary）的请求方式，并根据其支持的GET请求模式，将ZPL字符串进行URL编码后拼接在URL中。这种方法比传统的POST请求体方式更适合此特定API，并能有效避免“PDF文件损坏”等问题。在实际开发中，务必注意URL编码、异步处理、错误处理以及响应体资源的正确关闭，以确保应用程序的健壮性和性能。
