自從Adobe公司1993年第一次發(fā)布公共PDF參考以來(lái),支持各種語(yǔ)言和平臺的PDF工具和類(lèi)庫就如雨后春筍般涌現。然而,Java應用開(kāi)發(fā)中Adobe技術(shù)的支持相對滯后了。這是個(gè)奇怪的現象,因為PDF文檔是企業(yè)信息系統存儲和交換信息的大勢所趨,而Java技術(shù)特別適合這種應用。然而,Java開(kāi)發(fā)人員似乎直到最近才獲得成熟可用的PDF支持。
PDFBox(一個(gè)BSD許可下的源碼開(kāi)放項目)是一個(gè)為開(kāi)發(fā)人員讀取和創(chuàng )建PDF文檔而準備的純Java類(lèi)庫。它提供如下特性:
- 提取文本,包括Unicode字符。
- 和Jakarta Lucene等文本搜索引擎的整合過(guò)程十分簡(jiǎn)單。
- 加密/解密PDF文檔。
- 從PDF和XFDF格式中導入或導出表單數據。
- 向已有PDF文檔中追加內容。
- 將一個(gè)PDF文檔切分為多個(gè)文檔。
- 覆蓋PDF文檔。
PDFBox API
PDFBox設計時(shí)采用面向對象的方式來(lái)描述PDF文檔。PDF文檔的數據是一系列基本對象的集合:數組,布爾型,字典,數字,字符串和二進(jìn)制流。PDFBox在org.pdfbox.cos包(COS模型)中定義這些基本對象類(lèi)型。你可以使用這些對象與PDF文檔進(jìn)行任何交互,但你應該先對PDF文檔內部結構以及高層概念作一些深入的了解。例如,頁(yè)面和字體都是帶有特殊屬性的字典對象;PDF參考手冊提供這些特殊屬性的含義和類(lèi)型的說(shuō)明,但這是一個(gè)枯燥的文檔查閱過(guò)程。
于是,org.pdfbox.pdfmodel包(PD模型)應運而生,它的基礎是COS模型,但提供了以一種熟悉的方式訪(fǎng)問(wèn)PDF文檔對象的高層API(如圖1)。對底層COS模型進(jìn)行了封裝的PDPage和PDFont等類(lèi)就在這個(gè)包中。
注意,雖然PD模型提供了一些優(yōu)秀的功能,但它依然是一個(gè)開(kāi)發(fā)中的模型。在有些實(shí)例中,你可能需要借助于COS模型才能訪(fǎng)問(wèn)PDF的特定功能性。所有的PD模型對象都提供返回相應的COS模型對象的方法。所以,在一般情況下,你都會(huì )使用PD模型,但PD模型鞭長(cháng)莫及時(shí)你可以直接操作底層的COS模型。
上文對PDFBox作了大體上的介紹,現在是舉一些例子的時(shí)候了。我們從如何讀已存在的PDF文檔開(kāi)始:
- PDDocument document =
- PDDocument.load( "./test.pdf" );
上面的語(yǔ)句解析指定的PDF文件并在內存中創(chuàng )建其文檔對象??紤]到處理大文檔時(shí)的效率問(wèn)題,PDFBox只在內存中存儲文檔結構,圖像、內嵌字體和頁(yè)面內容等對象將被緩存在一個(gè)臨時(shí)文件中。
注意:PDDocument對象使用完畢時(shí)需要調用其close()方法來(lái)釋放創(chuàng )建時(shí)使用的資源。
文本提取和Lucene整合
這是一個(gè)信息展現時(shí)代(an information retrieval age),不管信息存放在哪種媒體中,應用程序都應該支持檢索和索引。對信息進(jìn)行組織和分類(lèi)從而形成可檢索的格式是很關(guān)鍵的。這對于文本文檔和HTML文檔來(lái)說(shuō)是很簡(jiǎn)單的,但PDF文檔包含大量的結構和元信息,提取文檔內容決不是一件簡(jiǎn)單的事情。PDF語(yǔ)言和Postscript相似,二者中的對象都是作為矢量繪制在頁(yè)面的某些位置。例如:
- /Helv 12 Tf
- 0 13.0847 Td
- (Hello World) Tj
上面的指令將字體設為12號的Helvetica,移到下一行然后打印“Hello World”。這些命令流通常是經(jīng)過(guò)壓縮的,文字在屏幕上的顯示順序并不一定是文件中的字符出現順序。因此,你有時(shí)無(wú)法直接從原始PDF文檔中提取字符串。然而,PDFBox成熟的文本提取算法使得開(kāi)發(fā)人員可以提取文檔內容,就像在閱讀器中呈現的那樣。
Lucene是Apache Jakarta項目的子項目,它是一個(gè)流行的源代碼開(kāi)放的搜索引擎庫。開(kāi)發(fā)人員可以使用Lucene來(lái)創(chuàng )建索引,并基于該索引對大量的文本內容進(jìn)行復雜的檢索。Lucene只支持文本內容的檢索,所以開(kāi)發(fā)人員需要將其他形式的數據轉換為文本形式才能使用Lucene。例如,Microsoft Word和StarOffice文檔都必須先轉換為文本形式才能添加到Lucene索引中。
PDF文件也不例外,但PDFBox提供一個(gè)特殊的整合對象,這讓在Lucene索引中包含PDF文檔變得非常容易。將一個(gè)基本PDF文檔轉換為L(cháng)ucene文檔只需要一條語(yǔ)句:
- Document doc = LucenePDFDocument.getDocument( file );
這條語(yǔ)句解析指定的PDF文檔,提取其內容并創(chuàng )建一個(gè)Lucene文檔對象。然后你就可以將該對象添加到Lucene索引中了。如上文所述,PDF文檔中也包含作者信息和關(guān)鍵詞等元數據,在索引PDF文檔時(shí)對這些元數據進(jìn)行跟蹤時(shí)很重要的。表1列出了創(chuàng )建Lucene文檔時(shí)PDFBox將填寫(xiě)(populate)的字段。
這種整合使得開(kāi)發(fā)人員可以輕松地使用Lucene來(lái)支持PDF文檔的檢索和索引。當然,有些應用程序要求更成熟的文本提取方法。此時(shí)可以直接使用PDFTextStripper類(lèi),或繼承該類(lèi)來(lái)滿(mǎn)足這種復雜的需求。
通過(guò)繼承PDFTextStripper并覆蓋showCharacter()方法,你可以從許多方面對文本提取進(jìn)行控制。例如,使用x、y位置信息進(jìn)行限制以提取特定文本塊。你可以有效地忽略所有的y坐標大于某個(gè)值的文本,這樣文檔頭部?jì)热菥蜁?huì )被排除。
另一個(gè)例子。常常有這種情況:從表單創(chuàng )建了一組PDF文檔,但這些原始數據被丟失了。也就是說(shuō),這些文檔都包含一些你感興趣的文本,而且這些文本都在相似的位置上,但填充文檔的表單數據丟失了。例如,你有一些信封,在相同的位置上都有名字和地址信息。這時(shí),你就可以使用PDFTextStripper的派生類(lèi)來(lái)提取期望的字段,這個(gè)類(lèi)就像一種截取屏幕區域的設備。
加密/解密
PDF的一個(gè)流行特性是允許對文檔內容進(jìn)行加密、對訪(fǎng)問(wèn)進(jìn)行控制,限制只能閱讀未加密文檔。PDF文檔加密時(shí)采用一個(gè)主密碼和一個(gè)可選的用戶(hù)密碼。如果設定了用戶(hù)密碼,那么PDF閱讀器(如Acrobat)將在顯示文檔之前提示輸入密碼。而主密碼則用于授權修改文檔內容。
PDF規范允許PDF文檔的創(chuàng )建者對用戶(hù)使用Acrobat閱讀器查看文檔時(shí)的某些操作進(jìn)行限制。這些限制包括:
PDF文檔安全的討論不在本文范疇之內,有興趣的讀者可以參考PDF規范的相關(guān)部分。PDF文檔的安全模型是可插拔式的(pluggable),你可以在加密文檔時(shí)使用不同的安全處理器(security handler)。對本文而言,PDFBox支持標準的安全處理器,它是大多數PDF文檔所使用的。
加密文檔時(shí)必須先指定一個(gè)安全處理器,然后使用一個(gè)主密碼和用戶(hù)密碼進(jìn)行加密。在下面的代碼中,文檔被加密,用戶(hù)不需要敲入就可以在A(yíng)crobat中打開(kāi)它(沒(méi)有設置用戶(hù)密碼),但是該文檔不可被打印。
- //load the document
- PDDocument pdf =
- PDDocument.load( "test.pdf" );
- //create the encryption options
- PDStandardEncryption encryptionOptions =
- new PDStandardEncryption();
- encryptionOptions.setCanPrint( false );
- pdf.setEncryptionDictionary(
- encryptionOptions );
- //encrypt the document
- pdf.encrypt( "master", null );
- //save the encrypted document
- //to the file system
- pdf.save( "test-output.pdf");
更詳細的示例參見(jiàn)PDFBox發(fā)布版中包含的加密工具類(lèi)源代碼:org.pdfbox.Encrypt。
許多應用程序可以生成PDF文檔,但不支持控制文檔的安全選項。這時(shí)PDFBox就可以用來(lái)在發(fā)送給用戶(hù)之前截獲并加密PDF文檔。
表單整合
當應用程序的輸出是一系列表單域的值時(shí),提供將表單保存成文件的功能是很必要的。這時(shí)PDF技術(shù)將是一個(gè)很好的選擇。開(kāi)發(fā)人員可以手動(dòng)編寫(xiě)PDF指令來(lái)繪制圖形、表格和文本?;蛘邔祿娉蒟ML形式并使用XSL-FO模版來(lái)創(chuàng )建PDF文檔。然而,這些辦法都是比較耗時(shí),容易出錯,而且靈活性也比較差。對于簡(jiǎn)單的表單而言,一個(gè)更好的辦法是創(chuàng )建模版,然后將給定的輸入數據填入該模版,從而生成文檔。
Employment Eligibility Verification是一個(gè)大多數人都熟悉的表單,它又叫做“I-9表單”,參見(jiàn):
http://uscis.gov/graphics/formsfee/forms/files/i-9.pdf 你可以使用PDFBox發(fā)布版中的一個(gè)示例程序列出表單域名單:
- java org.pdfbox.examples.fdf.PrintFields i-9.pdf
還有一個(gè)示例程序用于向指定的域中插入文本形式的數據:
- java org.pdfbox.examples.fdf.SetField i-9.pdf NAME1 Smith
在A(yíng)crobat中打開(kāi)這個(gè)PDF文檔你就會(huì )看到"Last Name"域已被填寫(xiě)了。你也可以使用以下代碼來(lái)完成相同的操作:
- PDDocument pdf =
- PDDocument.load( "i-9.pdf" );
- PDDocumentCatalog docCatalog =
- pdf.getDocumentCatalog();
- PDAcroForm acroForm =
- docCatalog.getAcroForm();
- PDField field =
- acroForm.getField( "NAME1" );
- field.setValue( "Smith" );
- pdf.save( "i-9-copy.pdf" );
下面的代碼可用于提取剛才填寫(xiě)的表單域的值:
- PDField field =
- acroForm.getField( "NAME1" );
- System.out.println(
- "First Name=" + field.getValue() );
Acrobat支持將表單數據導入或導出到一個(gè)特定的文件格式“表單數據格式”(Forms Data Format)。這種文件有兩類(lèi):FDF和XFDF。FDF文件存放表單數據的格式與PDF相同,而XFDF則以XML格式存放表單數據。PDFBox在一個(gè)類(lèi)中處理FDF和XFDF:FDFDocument。下面的代碼片斷演示了如何從上面的I-9表單導出FDF數據:
- PDDocument pdf =
- PDDocument.load( "i-9.pdf" );
- PDDocumentCatalog docCatalog =
- pdf.getDocumentCatalog();
- PDAcroForm acroForm =
- docCatalog.getAcroForm();
- FDFDocument fdf = acroForm.exportFDF();
- fdf.save( "exportedData.fdf" );
PDFBox表單整合步驟:
- 使用Acrobat或其他可視化工具創(chuàng )建PDF表單模版
- 記下每個(gè)需要的(desirable)表單域的名稱(chēng)
- 將模版存放在應用程序可以訪(fǎng)問(wèn)到的地方
- 當PDF被請求時(shí),使用PDFBox解析PDF模版
- 填充指定的表單域
- 將填充結果(PDF)返回給用戶(hù)
工具
除了上文介紹的API之外,PDFBox還提供一系列命令行工具。表2列出了這些工具類(lèi)并作簡(jiǎn)短介紹。
備注
PDF規范共有1172頁(yè)之多,其實(shí)現的確是一浩大工程。同樣,PDFBox發(fā)布版中說(shuō)它“正在進(jìn)行中”,新的功能會(huì )慢慢地添加上去。它的主要弱點(diǎn)是從零開(kāi)始創(chuàng )建PDF文檔。然而,有一些源碼開(kāi)放的Java項目可用于填補這個(gè)缺口。例如,Apache FOP項目支持從特殊的XML文檔生成PDF,這個(gè)XML文檔描述了要生成的PDF文檔。此外,iText提供一個(gè)高層API用于創(chuàng )建表格和列表。
PDFBox的下一個(gè)版本將支持新的PDF 1.5 對象流和交叉引用流。然后將提供內嵌字體和圖像的支持。在PDFBox的努力下,Java應用程序中的PDF技術(shù)有望得到充分的支持。
參考資源
PDFBox:
www.pdfbox.org Apache FOP:
http://xml.apache.org/fop/ iText:
www.lowagie.com/iText/ PDF Reference:
http://partners.adobe.com/asn/tech/pdf/specifications.jsp Jakarta Lucene:
http://jakarta.spache.org/lucene/ 關(guān)于作者
Ben Litchfield是一位擁有LPA Systems開(kāi)發(fā)和整合經(jīng)驗的商業(yè)系統顧問(wèn)。在過(guò)去的兩年中,他領(lǐng)導著(zhù)PDFBox開(kāi)發(fā)組。Ben擁有Rochester技術(shù)研究院的軟件工程方面的學(xué)士學(xué)位。在過(guò)去的5年中,他一直在提供企業(yè)應用程序的解決方案。(
更多)
(譯注:原文中沒(méi)有下圖的說(shuō)明,但給出其鏈接)
附件:i-9.pdf(245K)