Java高级编程：打印--学习如何使用打印服务API

作者：Brett Spell

 

翻译：ice_x

版权声明：可以任意转载，转载时请务必以超链接形式标明文章原始出处和作者信息及本声明
英文原文地址:
http://www.javaworld.com/javaworld/jw-07-2005/jw-0725-print.html

中文地址:
http://www.matrix.org.cn/resource/article/43/43658_java_print.html
关键词： Java Programming print PrintJob




摘要
在 这篇文章里，来自Pro Java Programming (Apress, June 2005)专家Brett Spell解释了如何一步一步的定位打印设备，创建打印工程，创建一个Doc文档接口的实例来描述你想要打印的数据并且初始化打印。（4500 字，2005年7月25日）

Java自从问世以来在各方面发展迅速，但是一直以来，打印输出是java最弱的方面。事实 上，java1.0不支持任何打印功能。Java1.1在java.awt包里包含了一个叫做PrintJob的类，但是这个类提供的打印功能十分粗糙和 不可靠。当java1.2问世，它围绕PrinterJob设计了一个完整独立的打印机制（叫做java2D printing API），并且在java.awt.print包里定义了一些新的类和接口。这些使得基于PrintJob打印机制（就是AWT printing）基本荒废，虽然PrintJob从未被抨击而且至少在这篇文章里仍然是一个提供技术的类。

在J2SE1.3里当 PrintJob的功能扩展到可以通过在java.awt包里的JobAttributes 和PageAttributes两个类设定工程和页面的属性时发生了一些额外的改变。随着J2SE1.3的发布，打印功能相应的得到了完善；但是在混合使 用这两种完全不同的打印机制的时候仍然存在一些问题。比如，这两种机制使用java.awt.Graphics这个类的一个接口来展现打印内容，意味着所 有要打印的东西都必须用一张图片表示。另外，完善的PrintJob提供了很有限的工程相关属性的设置；这两种机制都没有办法通过程序来选择目标打印机。

Java 打印最大的改变来自于J2SE的发布带来的Java打印服务API。这个第三代Java打印支持接口突破了先前提到的使用javax.print包的 PrintService和DocPrintJob接口的局限性。因为新的API就是以前两种旧的打印机制定义的功能函数的一个父集，它是目前我们常用的 方法并且是这篇文章的焦点。
更深入来说,以下的步骤包含了怎么使用这个新的Java打印服务API：
1.定义打印机，限制那些返回到提供你要实现功能的函数的列表。打印服务实现了PrintService接口.

2.通过调用接口中定义的createPrintJob()方法创建一个打印事件，作为DocPrintJob的一个实例。

3.创建一个实现Doc接口的类来描述你想要打印的数据 , 你也可以创建一个PrintRequestAttributeSet的实例来定义你想要的打印选项。

4.通过DocPrintJob接口定义的printv()方法来初始化打印，指定你先前创建的Doc，指定PrintRequestAttributeSet或者设为空值。

现在你可以检查每一步并且试着完成它们。

注意

在 这篇文章里，我将交替使用打印机和打印服务，因为在大部分情况下，打印服务不亚于一台真实的打印机。 一般的打印服务反映了理论上可以发送到不仅仅是打印机的的输出。举例来说，打印服务也许根本不能打印东西但是可以往磁盘上的文件写数据。换句话说，所有的 打印机可以看成是特殊的打印服务，但是并不是所有打印服务和打印机有联系。就像你一般把你的文本送到打印机那里一样，我有时候使用更为简便的打印机这个名 词来代替技术上更精确的打印服务。


定义打印服务
你可以使用在PrintServiceLookup类中定义的三种静态方法中的一种来定义。最简单的一种就是lookupDefaultPrintService()，正如它的名字一样，它返回一个你默认的打印机：

PrintService service = PrintServiceLookup.lookupDefaultPrintService(); 

虽 然用这个办法很简单也很方便，用它来选择你的打印机意味着用户的打印机一直都支持你的程序所要精确传输的数据输出。实际上，你真正想要的是那种可以处理你 想要的数据的类型并且可以支持你要的特征例如颜色或者两边打印。为了从列表中中返回你所要求的特殊功能支持的打印机，你可以使用剩下两个方法中的 lookupPrintServices() 或者lookupMultiDocPrintServices()。

lookupPrintServices()方法有两个参数：一个DocFlavor的实例和实现AttributeSet接口的实例。
你 马上将看到，你可以使用两者中任意一个来限制返回的打印机，但是lookupPrintServices()允许你指定这两个参数为空值。如果把两者都设 为空，那么你得到的返回值将是任意一个可用的打印机。在这种情况下，你并不需要查看PrintService中定义的方法，其中一个getName()方 法返回了一个字符串，代表打印机的名字。你可以编译下面的代码来列出你的系统现有的打印机：

PrintService[] services = PrintServiceLookup.lookupPrintServices(null, null);
for (int i = 0; i < services.length; i++) {
 System.out.println(services[i].getName());
} 

例如你的系统名为PrintServer，下面有Alpha, Beta, 和Gamma 打印机,用以上代码可以得到以下输出:
\\PrintServer\Alpha
\\PrintServer\Beta
\\PrintServer\Gamma

现在查看那些你可以传给lookupPrintServices()方法的参数来看看如何返回拥有特殊功能的打印机。

DocFlavor
第 一个你可以指定的参数是一个DocFlavor类的实例，它描述了将要打印的数据的类型和数据如何存储。在大部分情况下，并不需要去创建一个新的实例因为 Java包含了很多预先定义的实例，使得你可以用它们来传给lookupPrintServices()。然而，我们还是来看一下DocFlavor的结 构和方法来探讨打印服务如何使用这个实例。

创建DocFlavor实例需要的两个参数都是字符串，一个是MIME (Multipurpose Internet Mail Extensions)类型另一个是类的名字。MIME类型被用于描述数据类型。例如，你要打印一个gif文件，你需要使用MIME类型是 image/gif的DocFlavor。相类似，如果你要打印HTML文件里的文本信息要使用MIME类型似text/plain或者text /html。

表现类
MIME类型描述将要打印的数据的类型，表现的类则表示如何让打印服务得到这些数据。DocFlavor包含了几个静态的内部类，每一个相对应一个表现类和如何装载要打印得数据。

表 1中列出了上面提到的内部类和表现类。注意在SERVICE_FORMATTED（一会我会更详细地解释）旁边，每一个和"binary"或者 "character"相对应。事实上，这些差别是人为的，因为"character"数据类型本身就是一种特殊的binary类型。这种情况下，我们说 的二进制（binary）数据包括人们可以看懂的字符和一些格式化的字符比如tabs，换行回车等。当然，这些差别很重要，反映出面向字符的表现类并不适 合存储二进制数据。

例如，你不会用字符队列或者字符串来保存一个gif文件，你也不能通过Reader接口来访问它。另一方面，因为字符也是一种特殊的二进制数据，它完全适合储存文本信息到字节数组里或者通过InputStream或者一个URL来访问它。

Table 1. DocFlavor的表现类


上面定义的任何一个静态内部类相对应一个表现类，但是请记住我说过每一个DocFlavor的实例通过一个表现类和一个MIME来确认要打印的数据的类型。
要 访问这样一个实例，你要通过表1总列出的内部类。例如，我们假设你要打印一个在网上通过URL访问的gif文件，这样的话，就选择表现类是 javav.net.url，对应的在DocFlavor中的静态类就是URL类。如果你打开那个内部类的文档，你会发现其实它定义了一系列静态的内部 类，每一个对应一种打印机支持的MIME类型。表2描述了在DocFlavor.URL里的内部类和MIME

Table 2. The DocFlavor.URL inner classes


因为要通过URL打印gif图片，你可以用一下代码来获得实例

DocFlavor flavor = DocFlavor.URL.GIF; 

这个代码创建了一个DocFlavor实例，代表类是java.net.URL，MIME是image/gif。
表 2列出的了DocFlavor.URL的类，那么其他六个内部类呢？我们等下来讨论一下SERVICE_FORMATTED，这之前，看看与二进制数据联 系的所有三种类型（BYTE_ARRAY, INPUT_STREAM, and URL)相关的内部类。例如，如果你把gif储存到了一个字节数组里，那么你可以用以下代码：

DocFlavor flavor = DocFlavor.BYTE_ARRAY.GIF; 

正如有三个与二进制类型关联的内部类一样，与字符类型相关的另外三个类列在表3里

Table 3. CHAR_ARRAY, READER, and STRING



所以，如果你想打印储存在字符串中的文本数据，用以下代码：

DocFlavor flavor = DocFlavor.STRING.TEXT_PLAIN;

类似，如果文本来自于网页上的HTML文档，用以下代码：

DocFlavor flavor = DocFlavor.STRING.TEXT_HTML;

选择正确的打印机
还 记得我们在开始关于讨论DocFlavor之前关于打印机的那个精确支持你想要打印的数据类型的假设吗？这似乎看起来没有必要。实际上，你会对给你的打印 机所支持的文档类型感到吃惊。例如，刚提到文本类型看起来似乎是最容易支持的，所以，如果你的程序要打印一个普通文本或者HTML文本，你可以随便选择一 个打印服务并把它送到打印机那去。然而大部分打印机不支持基于文本的表现类，如果你试图向打印机发送它不支持的DocFlavor，会产生下面的异常：

Exception in thread "main" sun.print.PrintJobFlavorException: invalid flavor
 at sun.print.Win32PrintJob.print(Win32PrintJob.java:290)
 at PrintTest.main(PrintTest.java:11) 

现 在你已经知道了如何得到一个DocFlavor的引用而且我们也讨论了选择支持这个flavor的打印机重要性，接下来我来告诉你如何确定你使用的打印机 支持它。我先前说过lookupPrintServices()允许你指定一个DocFlavor作为第一个参数，如果你指定的参数非空，那么方法会返回 相应支持这个的打印机的实例。例如以下代码将返回可以通过URL来打印gif文件的打印机的列表：

DocFlavor flavor = DocFlavor.URL.GIF;
PrintService[] services = PrintServiceLookup.lookupPrintServices(flavor, null); 

另外，如果你的程序已经获得了打印服务的实例，而你想知道它是否支持另一种特定的flavor，你可以调用isDocFlavorSupported()方法。在下面的代码里，将得到一个默认打印机的引用，如果不能打印gif就会出现错误信息：

PrintService service = PrintServiceLookup.lookupDefaultPrintService();
DocFlavor flavor = DocFlavor.URL.GIF;
if (!service.isDocFlavorSupported(flavor)) {
 System.err.println("The printer does not support the appropriate DocFlavor");
} 

AttributeSet
正 如你看到的，DocFlavor描述打印数据而且可以用来确定打印服务是否支持这种数据。然而，你的程序需要选择一个基于那些支持的元素的打印机。例如， 你要打印图片用不同的颜色来描述不同的信息，你想知道提供的服务是否支持彩色打印，如果不，那么要么禁止它使用或者要求提供一个黑白图片。

类 似彩色打印，两边打印或者使用不同的定位取决于打印机本身的属性，而javax.print.attribute包包含了许多你可以用于描述这些属性的包 和接口。其中一个接口是前面提到的lookupPrintServices()中第二个参数AttributeSet。正如你愿，它返回属性的集合，在调 用lookupPrintServices()指定一个不为空的值将返回支持这些属性的打印服务。换句话说，如果DocFlavor和 AttributeSet都不为空，那么方法将返回那些这两种属性都支持的打印机

Attribute
AttributeSet 是属性的集合,一个显而易见的问题是如何指定属性的值呢？ javax.print.attribute包里同时含有一个叫Attribute的接口，你马上可以看到通过调用add方法来给 AttributeSet创建一个Attribute实例来获得这个集合。在javax.print.attribute.standard包里定义了大 量你将要用到的接口。在之前，你可以查看javax.print.attribute这个包里的其他接口。

属性模块
目前为止，我们把属性描述成打印服务的功能，而实际上在java支持的属性中算很简单的。对应每个属性，java都有相应的模块。只有遵循这些模块属性才有效。在不同的java打印服务位置使用不同的属性，而不是所有的属性在任何地方都适用。
为了更好的理解这个，来看一下javax.print.attribute.standard 包里定义的
OrientationRequested 和 ColorSupported接口。创建一个新的打印文档时可以指定OrientationRequested属性和用于打印的定位。 ColorSupported在你调用PrintService接口的getAttributes方法时返回。OrientationRequested 是一个你用来传给打印机的属性，而ColorSupported是打印服务用来提供给你关于打印机能力信息的工具。你可以在创建打印文档时把 ColorSupported作为属性指定，因为打印机是否支持彩色打印是你的程序不能控制的。

接口和继承
你第 一次查看javax.print.attribute包里的接口和类时你也许会感到选择那些列表里的接口和类很麻烦。除了Attribute 和AttributeSet和继承AttributeSet的HashAttributeSet，javax.print.attribute包里有4个 子接口和类，列出在表4和图1中。

Table 4. javax.print.attribute 里定义的接口和类



Figure 1. javax.print.attribute 包的一部分类的层次结构.

那 么有了Attribute, AttributeSet, 和 HashAttributeSet为什么需要使用这些不同的接口和继承类呢？是因为这些特殊的类是为那些特殊的属性量身定做的。比方说，我提到过当你创建 打印文档的时候有个地方可以使用的属性例如ColorSupported在那里不能使用。当创建这样的文档，你可以使用DocAttributeSet接 口（或者更专业一点，HashDocAttributeSet这个继承的类），这个继承类只允许你添加继承DocAttribute这个接口的属性。这四 种不同的模块如下：
 Doc: 在创建文档时指 定如何打印文档
 PrintJob: 打印任务的属性描述任务的状态
 PrintRequest: 初始化打印时传给任务的请求
 PrintService:由打印服 务返回来描述打印机的功能

要 知道如何工作，我们来创建一个DocAttributeSet的实例然后为AttributeSet设置DocAttributeSet和 OrientationRequested属性。HashDocAttributeSet定义了很好的结构，所有你可以很简便的如下创建实例：

DocAttributeSet attrs = new HashDocAttributeSet(); 

现 在你已经创建了AttributeSet，你可以调用add方法并把它传给Attribute的继承实例去。如果你看了 OrientationRequested这个类的文档，你会发现它包含了一系列静态的OrientationRequest实例，每一个对应一种文档定 位方式。要指定你想要的类型，你所要做的只是按下面的方法传给add方法一个静态的实例的引用：

DocAttributeSet attrs = new HashDocAttributeSet();
attrs.add(OrientationRequested.PORTRAIT); 

ColorSupported类有一点不同但一样很简单，它定义了两种静态实例:一个表示支持彩色打印另一个不是。你可以试着增加一个ColorSupported属性到DocAttributeSet去，代码如下：

DocAttributeSet attrs = new HashDocAttributeSet();
attrs.add(OrientationRequested.PORTRAIT);
attrs.add(ColorSupported.SUPPORTED); 

早先提过，去指定是否支持彩色打印不恰当因为这不是程序所能控制的内容。换句话说，ColorSupported这个属性放到一系列文档属性中并不合适，所以，运行先前的代码当添加ColorSupported属性时会抛出一个ClassCastException异常。

要学习怎么运行，记住每一个AttributeSet子接口都有一个相应Attribute子接口和继承子类。当添加一个属性时，继承的子类试图把Attribute作为参数给相应的子接口，这样来确保只有当前适当的属性会成功添加。

这 样的话，HashDocAttributeSet 的add方法第一次和OrientationRequested的一个实例一起调用，并成功的把它作为一个object传给DocAttribute。因 为如图2所示，OrientationRequested继承了那个接口。与之相对应，传ColorSupported实例的时候因为没有继承 DocAttribute所以失败了。


Figure 2. javax.print.attribute 包的一部分类的层次结构

这 个例子举例说明，表4里的四个接口和类组来保证使用正确的属性。注意模块和不同的属性之间有大量的交互，所以很多属性与不止一个模块关联。例如，许多属性 继承了PrintJobAttribute 和 PrintRequestAttribute因为大部分是通过一个相关的打印任务获得提供给你的。你可以在初始化时指定它们。举个例子，你可以把它加到 PrintRequestAttributeSet中去来指定任务名，并且在打印的时候通过PrintJobAttributeSet来返回它。因 此，JobName属性类同时继承
PrintRequestAttribute 和 PrintJobAttribute。
AttributeSet and HashAttributeSet

你 已经知道了为什么会有四个子类，但是AttributeSet接口和HashAttributeSet父类又是什么 呢？AttributeSet/HashAttributeSet在你不能确定要存储在这个集合中的那些仅仅和一个模块相关的属性时使用。记得我以前提到 的lookupPrintServices()方法允许你指定AttributeSet参数来限制返回的打印服务。表面上看来最好指定 PrintServiceAttributeSet的实例，但是很多你可能用到的属性并不继承PrintServiceAttribute。

我 们假设你想要让lookupPrintServices()方法返回支持彩色打印和风景画打印的打印机。这些属性与ColorSupported和 OrientationRequested属性关联，但是请注意这些类并不共享模块，前者是一个PrintServiceAttribute而 OrientationRequested与另外三个模块(Doc, PrintRequest,和 PrintJob)关联。这意味着不存在单个的AttributeSet接口或类来同时包含ColorSupported和Sides属性。

创建AttributeSet的方法使用一个HashAttributeSet实例同时包含一个OrientationRequested 和 ColorSupported太简单了。不像它的子类，它并不限制你往上加特殊的属性，所以可以用以下代码成功执行：

AttributeSet attrs = new HashAttributeSet();
attrs.add(ColorSupported.SUPPORTED);
attrs.add(OrientationRequested.LANDSCAPE);
PrintService[] services = PrintServiceLookup.lookupPrintServices(null, attrs); 

通过用户界面的打印机选择
就此观点而言，我认为使用的打印机应该由应用程序计划选择。但操作过程中，打印输出内容时往往会显示一个对话框让用户选择。幸运的是，Java通过使用ServiceUI类（在javax.print包中定义）中的静态printDialog()方法使得这些操作简单化。
在显示的对话框旁边，仅在调用printDialog()时必须指定的参数值如下：
用户可选用的PrintService实例数组。
默认的PrintService。
PrintRequestAttributeSet实例。这用来弹出显示的对话框，并在对话框消失之前返回用户所作的任何更改。
要解释这些如何运作，可使用下列简单的代码段来显示打印对话：

PrintService[] services = PrintServiceLookup.lookupPrintServices(null, null);
PrintService svc = PrintServiceLookup.lookupDefaultPrintService();
PrintRequestAttributeSet attrs = new HashPrintRequestAttributeSet();
PrintService selection = ServiceUI.printDialog(
 null, 100, 100, services, svc, null, attrs); 

运行时，代码产生如图例3中所示的对话框


Figure 3. The printer dialog

随 着代码的说明，从printDialog()方法返回的值是一个PrintService实例，识别用户所选的打印机，或在用户取消打印机对话时识别为 空。此外，PrintRequestAttributeSet已更新到可通过对话框来反映用户作出的更改，比如要打印的份数。
通过使用printDialog()方法，可让用户选择其输出要发往的打印机，提供用户对于专业应用程序的期望功能。

创建打印任务
这是打印中的一个简单步骤；因为一旦获得PrintService的一个参考，你需要做的就是调用createPrintJob()方法，如：

PrintService service;
.
.
.
DocPrintJob job = service.createPrintJob(); 

代 码中显示，从createPrintJob()返回的值是一个DocPrintJob实例，可让您控制并监控打印操作的状态。要启动打印，您会调用 DocPrintJob对象的print()方法，但是，这之前，您需要定义待打印的文档或选用PrintRequestAttributeSe。您已经 知道如何构造并弹出AttributeSet，这个步骤不再重复，接下来，您将了解定义待打印的文档。

定义要打印的文档
接下来这一步是定义要打印的文档，用一个在javax.print包里的Doc的接口实例来创建。每一个Doc的实例有两个必须定义的属性和一个可选择的属性：
 Object 代表要打印的内容
 DocFlavor的一个实例描述数据类型
 可选的DocAttributeSet 包含打印时的属性

复 习Doc接口的文档可以看出javax.print包里包含了一个叫SimpleDoc 的接口的继承，它的构造函数包含了上面三个参数。要知道如何构建SimpleDoc 的实例，我们假设你要打印两份存在http://www.apress.com/ApressCorporate/supplement/1/421 /bcm.gif的gif文件拷贝。
我们要做的就是构建一个SimpleDoc实例来描述这个文档创建了一个URL来指向图片，并且引用了DocFlavor，并把这两个传给SimpleDoc构造函数：

URL url = new URL(
 "http://www.apress.com/ApressCorporate/supplement/1/421/bcm.gif");
DocFlavor flavor = DocFlavor.URL.GIF;
SimpleDoc doc = new SimpleDoc(url, flavor, null); 

启动打印
打 印的最后一个步骤就是调用DocPrintJob的 print()方法，传递待打印数据的Doc对象，或选用PrintRequestAttributeSet实例。为简单起见，假设默认打印机支持你所需 要的flavor和属性，在此情况下要使用下列代码将上一个例子提及的gif文件打印两份：

PrintService service = PrintServiceLookup.lookupDefaultPrintService();
DocPrintJob job = service.createPrintJob();
URL url = new URL(
 "http://www.apress.com/ApressCorporate/supplement/1/421/bcm.gif ");
DocFlavor flavor = DocFlavor.URL.GIF;
Doc doc = new SimpleDoc(url, flavor, null);
PrintRequestAttributeSet attrs = new HashPrintRequestAttributeSet();
attrs.add(new Copies(2));
job.print(doc, attrs)

;
注意，一些情况下，打印不同步执行，这可能会在实际打印完成之前返回对print()的调用。

关于作者
Brett Spell是一个Frito-Lay的高级程序开发者并写了Pro Java Programming 的初始版本。
资源
这 是Pro Java Programming, Second Edition, Brett Spell (Apress, June 2005; ISBN: 1590594746):第十章“打印”的一部分 http://www.apress.com/book/bookDisplay.html?bID=421
要得到更多关于java API的文章，点击以下链接
http://www.javaworld.com/channel_content/jw-apis-index.shtml