Jakarta Commons 巧用类和组件.docx

1、Jakarta Commons 巧用类和组件Jakarta Commons:巧用类和组件Jakarta Commons是Jakarta的子项目，它创建和维护着许多独立软件包，这些包一般与其他框架或产品无关，其中收集了大量小型、实用的组件，大部分面向服务器端编程。 Commons的包分成两部分：Sandbox，Commons代码库。Sandbox是一个测试平台，用来检验各种设想、计划。本文介绍的组件属于Commons代码库，文章将展示各个组件的功能、适用场合，并通过简单的例子介绍其用法。 一、概述 可重用性是Jakarta Commons项目的灵魂所在。这些包在设计阶段就已经考虑了可重用性问题。

2、其中一些包，例如Commons里面用来记录日志的Logging包，最初是为其他项目设计的，例如Jakarta Struts项目，当人们发现这些包对于其他项目也非常有用，能够极大地帮助其他项目的开发，他们决定为这些包构造一个公共的存放位置，这就是Jakarta Commons项目。 为了真正提高可重用性，每一个包都必须不依赖于其他大型的框架或项目。因此，Commons项目的包基本上都是独立的，不仅是相对于其他项目的独立，而且相对于Commons内部的大部分其他包独立。虽然存在一些例外的情况，例如Betwixt包要用到XML API，但绝大部分只使用最基本的API，其主要目的就是要能够通过简单的接

3、口方便地调用。 不过由于崇尚简洁，许多包的文档变得过于简陋，缺乏维护和支持，甚至有一部分还有错误的链接，文档也少得可怜。大部分的包需要我们自己去找出其用法，甚至有时还需要我们自己去分析其适用场合。本文将逐一介绍这些包，希望能够帮助你迅速掌握这一积累了许多人心血的免费代码库。 说明：Jakarta Commons和Apache Commons是不同的，后者是Apache Software Foundation的一个顶层项目，前者则是Jakarta项目的一个子项目，同是也是本文要讨论的主角。本文后面凡是提到Commons的地方都是指Jakarta的Commons。 为了便于说明，本文把Common

4、s项目十八个成品级的组件（排除了EL、Latka和Jexl）分成5类，如下表所示。 必须指出的是，这种分类只是为了方便文章说明，Commons项目里面实际上并不存在这种分类，同时这些分类的边界有时也存在一定的重叠。 本文首先介绍Web相关类和其他类里面的组件，下一篇文章将涉及XML相关、包装这两类，最后一篇文章专门介绍属于工具类的包。 二、其他类 CLI、Discovery、Lang和Collections包归入其他类，这是因为它们都各自针对某个明确、实用的小目标，可谓专而精。 2.1 CLI 概况：CLI即Command Line Interface，也就是命令行接口，它为Java程序访问和

5、解析命令行参数提供了一种统一的接口。 官方资源：主页，二进制，源代码 何时适用：当你需要以一种一致的、统一的方式访问命令行参数之时。 示例应用：CLIDemo.java。CLASSPATH中必须包含commons-cli-1.0.jar。 说明： 有多少次你不得不为一个新的应用程序重新设计新的命令行参数处理方式？如果能够只用某个单一的接口，统一完成诸如定义输入参数（是否为强制参数，数值还是字符串，等等）、根据一系列规则分析参数、确定应用要采用的路径等任务，那该多好！答案就在CLI。 在CLI中，每一个想要在命令中指定的参数都是一个Option对象。首先创建一个Options对象，将各个Opti

6、on对象加入Options对象，然后利用CLI提供的方法来解析用户的输入参数。Option对象可以要求用户必须输入某个参数，例如必须在命令行提供文件名字。如果某个参数是必须的，创建Option对象的时候就要显式地指定。 下面是使用CLI的步骤。 / / 创建一个Options：Options options = new Options();options.addOption(t, false, current time);/ / 创建一个解析器，分析输入：CommandLineParser parser = new BasicParser();CommandLine cmd;try . cmd

7、 = parser.parse(options, args); catch (ParseException pe) . usage(options); return;/ / 最后就可以根据用户的输入，采取相应的操作：if (cmd.hasOption(n) . System.err.println(Nice to meet you: + cmd.getOptionValue(n); 这就是使用CLI的完整过程了。当然，CLI还提供了其他高级选项，例如控制格式和解析过程等，但基本的使用思路仍是一致的。请参见本文最后提供的示例程序。 2.2 Discovery 概况：Discovery组件是发现模

8、式（Discovery Pattern）的一个实现，它的目标是按照一种统一的方式定位和实例化类以及其他资源。 官方资源：主页，二进制，源代码。 何时适用：当你想用最佳的算法在Java程序中查找Java接口的各种实现之时。 应用实例：DiscoveryDemo.java，MyInterface.java，MyImpl1.java，MyImpl2.java，MyInterface。要求CLASSPATH中必须包含commons-discovery.jar和commons-logging.jar。 说明： Discovery的意思就是发现，它试图用最佳的算法查找某个接口的所有已知的实现。在使用服务的

9、场合，当我们想要查找某个服务的所有已知的提供者时，Discovery组件尤其有用。 考虑一下这种情形：我们为某个特别复杂的任务编写了一个接口，所有该接口的实现都用各不相同的方式来完成这个复杂任务，最终用户可以根据需要来选择完成任务的具体方式。那么，在这种情形下，最终用户应该用什么办法来找出接口的所有可用实现（即可能的完成任务的方式）呢？ 上面描述的情形就是所谓的服务-服务提供者体系。服务的功能由接口描述，服务提供者则提供具体的实现。现在的问题是最终用户要用某种办法来寻找系统中已经安装了哪些服务提供者。在这种情形下，Discovery组件就很有用了，它不仅可以用来查找那些实现了特定接口的类，而且

10、还可以用来查找资源，例如图片或其他文件等。在执行这些操作时，Discovery遵从Sun的服务提供者体系所定义的规则。 由于这个原因，使用Discovery组件确实带来许多方便。请读者参阅本文后面示例程序中的接口MyInterface.java和两个实现类MyImpl1.java、MyImple2.java，了解下面例子的细节。在使用Discovery的时候要提供MyInterface文件，把它放入META-INF/services目录，注意该文件的名字对应接口的完整限定名称（Fully Qualified Name），如果接口属于某个包，该文件的名字也必须相应地改变。 / / 创建一个类装入

11、器的实例。ClassLoaders loaders = ClassLoaders.getAppLoaders(MyInterface.class, getClass(), false);/ / 用DiscoverClass的实例来查找实现类。DiscoverClass discover = new DiscoverClass(loaders);/ / 查找实现了指定接口的类：Class implClass = discover.find(MyInterface.class);System.err.println(Implementing Provider: + implClass.getNam

12、e(); 运行上面的代码，就可以得到在MyInterface文件中注册的类。再次提醒，如果你的实现是封装在包里面的，在这里注册的名字也应该作相应地修改，如果该文件没有放在正确的位置，或者指定名字的实现类不能找到或实例化，程序将抛出DiscoverException，表示找不到符合条件的实现。下面是MyInterface文件内容的一个例子：MyImpl2 # Implementation 2。 当然，实现类的注册办法并非只有这么一种，否则的话Discovery的实用性就要大打折扣了！实际上，按照Discovery内部的类查找机制，按照这种方法注册的类将是Discovery最后找到的类。另一种常用

13、的注册方法是通过系统属性或用户定义的属性来传递实现类的名字，例如，放弃META-INF/services目录下的文件，改为执行java -DMyInterface=MyImpl1 DiscoveryDemo命令来运行示例程序，这里的系统属性是接口的名字，值是该接口的提供者，运行的结果是完全一样的。 Discovery还可以用来创建服务提供者的(singleton)实例并调用其方法，语法如下：(MyInterface)discover.newInstance(MyInterface.class).myMethod();。注意在这个例子中，我们并不知道到底哪一个服务提供者实现了myMethod，甚

14、至我们根本不必关心这一点。具体的情形与运行这段代码的方式以及运行环境中已经注册了什么服务提供者有关，在不同的环境下运行，实际得到的服务提供者可能不同。 2.3 Lang 概况：Lang是java.lang的一个扩展包，增加了许多操作String的功能，另外还支持C风格的枚举量。 官方资源：主页，二进制，源代码。 何时适用：当java.lang包提供的方法未能满足需要，想要更多的功能来处理String、数值和System属性时；还有，当你想要使用C风格的枚举量时。 示例应用：LangDemo.java，Mortgage.java，OnTV.java。CLASSPATH中必须包含commons-l

15、ang.jar。 说明： 这个包提供了许多出于方便目的而提供的方法，它们中的大多数是静态的，简化了日常编码工作。StringUtils类是其中的一个代表，它使得开发者能够超越标准的java.lang.String包来处理字符串。使用这些方法很简单，通常只要在调用静态方法时提供适当的参数就可以了。例如，如果要将某个单词的首字符改为大写，只需调用：StringUtils.capitalise(name)，调用的输出结果是Name。请浏览StringUtils API文档了解其他静态方法，也许你会找到一些可以直接拿来使用的代码。本文提供的示例程序示范了其中一些方法的使用。 另一个值得注意的类是Ran

16、domStringUtils，它提供了生成随机字符串的方法，用来创建随机密码实在太方便了。 NumberUtils类提供了处理数值数据的方法，许多方法值得一用，例如寻找最大、最小数的方法，将String转换成数值的方法，等等。NumberRange和CharRange类分别提供了创建和操作数值范围、字符范围的方法。 Builder包里的类提供了一些特殊的方法，可用来构造类的toString、hashCode、compareTo和equals方法，其基本思路就是构造出类的高质量的toString、hashCode、compareTo和equals方法，从而免去了用户自己定义这些方法之劳，只要调用

17、一下Builder包里面的方法就可以了。例如，我们可以用ToStringBuilder来构造出类的toString描述，如下例所示： public class Mortgage . private float rate; private int years; . public String toString() . return new ToStringBuilder(this). append(rate, this.rate). append(years, this.years). toString(); 使用这类方法有什么好处呢？显然，它使得我们有可能通过一种统一的方式处理所有数据类型。所

18、有Builder方法的用法都和上例相似。 Java没有C风格的枚举量，为此，lang包提供了一个类型安全的Enum类型，填补了空白。Enum类是抽象的，如果你要创建枚举量，就要扩展Enum类。下面的例子清楚地说明了Enum的用法。 import mons.lang.enum.Enum;import java.util.Map;import java.util.List;import java.util.Iterator; public final class OnTV extends Enum . public static final OnTV IDOL= new OnTV(Idol); p

19、ublic static final OnTV SURVIVOR = new OnTV(Survivor); public static final OnTV SEINFELD = new OnTV(Seinfeld); private OnTV(String show) . super(show); public static OnTV getEnum(String show). return (OnTV) getEnum(OnTV.class, show); public static Map getEnumMap() . return getEnumMap(OnTV.class); pu

20、blic static List getEnumList() . return getEnumList(OnTV.class); public static Iterator iterator() . return iterator(OnTV.class); 以后我们就可以按照下面的方式使用枚举变量：OnTV.getEnum(Idol)。该调用从前面创建的枚举数据类型返回Idol。这个例子比较简单，实际上Enum类还提供了许多有用的方法，请参见本文后面提供的完整实例。 2.4 Collections 概况：扩展了Java Collection框架，增添了新的数据结构、迭代机制和比较操作符。 官

21、方资源：主页，二进制，源代码。 何时适用：几乎所有需要操作数据结构的重要Java开发项目都可以使用Collections API。和Java的标准实现相比，Collections API有着诸多优势。 示例应用：CollectionsDemo.java。要求CLASSPATH中包含commons-collections.jar。 说明： 要在有限的文章篇幅之内详尽地介绍 Collections API实在是太困难了，不过这里仍将涵盖大多数最重要的类，希望能够引起你的兴趣，认真了解一下其余的类。Collections本身的文档也提供了许多资料并解释了每一个类的用法。 Bag接口扩展标准的Java

22、 Collection，允许生成计数器来跟踪Bag里面的所有元素。当你想要跟踪进出某个集合的元素的总数时，Bag是非常有用的。由于Bag本身是一个接口，所以实际使用的应该是实现了该接口的类，例如HashBag或TreeBag-从这些类的名字也可以看出，HashBag实现的是一个HashMap的Bag，而TreeBag实现的是TreeMap的Bag。Bag接口中两个最重要的方法是：getCount(Object o)，用来返回Bag里面特定对象的出现次数；uniqueSet()，返回所有唯一元素。 Buffer接口允许按照预定义的次序删除集合中的对象，删除次序可以是LIFO（Last In Fi

23、rst Out，后进先出），或FIFO（First In First Out，先进先出），另外还可以是自定义的次序。下面来看看如何实现一个Buffer，按照自然次序删除元素。 BinaryHeap类实现了Buffer接口，能够按照自然次序删除元素。如果要颠倒次序，则必须传入一个false，告诉Heap采用自然次序的逆序。 BinaryHeap heap = new BinaryHeap();/ / 将元素加入该Heapheap.add(new Integer(-1);heap.add(new Integer(-10);heap.add(new Integer(0);heap.add(new I

24、nteger(-3);heap.add(new Integer(5);/ 删除一个元素heap.remove(); 调用该Heap的remove，按照自然次序，元素集合中的-10将被删除。如果我们要求按照逆序排序，则被删除的将是5。 FastArrayList、FastHashMap和FastTreeMap类能够按照两种模式操作，超越了与它们对应的标准Collection。第一种模式是慢模式，类的修改操作（添加、删除元素）是同步的。与此相对，另一种模式是快模式，对这些类的访问假定为只读操作，因此不需要同步，速度较快。在快模式中，结构性的改动通过下列方式完成：首先克隆现有的类，修改克隆得到的类，

25、最后用克隆得到的类替换原有的类。FastArrayList、FastHashMap和FastTreeMap类特别适合于那种初始化之后大部分操作都是只读操作的多线程环境。 iterators包为各种集合和对象提供标准Java Collection包没有提供的迭代器。本文的示例应用示范了ArrayIterator，通过迭代方式访问Array的内容。iterators包里面各种迭代器的用法基本上与标准Java迭代器一样。 最后，comparators包提供了一些实用的比较符。所谓比较符其实也是一个类，它定义的是如何比较两个属于同一类的对象，决定它们的排序次序。例如，在前面提到的Buffer类中，我们

26、可以定义自己的比较符，用自定义的比较符来决定元素的排序次序，而不是采用元素的自然排序次序。下面来看看具体的实现经过。 / / 创建一个BinaryHeap类，但这一次参数中/ 指定NullComparator。NullComparator比较/ null与其他对象，根据nullsAreHigh标记来/ 判断null值比其他对象大还是小：如果/ nullsAreHigh的值是false，则认为null要比/ 其他对象小。BinaryHeap heap2 = new BinaryHeap (new NullComparator(false);/ / 将一些数据（包括几个null值）加入heap：h

27、eap2.add(null);heap2.add(new Integer(6);heap2.add(new Integer(-6);heap2.add(null);/ / 最后删除一个元素，Bag包含的null将减少/ 一个，因为null要比其他对象小。heap2.remove();有关其他类Commons组件的介绍就到这里结束。如果你想了解更多细节信息，请参见API文档，最好再看看这些包的源代码。 三、Web类 Web类的组件用来执行与Web相关的任务。 3.1 FileUpload 概况：一个可以直接使用的文件上载组件。 官方资源：主页。由于这个组件尚未正式发布，今年二月发布的Beta版又

28、有许多BUG，所以建议从nightly builds下载最新的版本。 何时适用：当你想要在Java服务器环境中加入一个易用、高性能的文件上载组件之时。 示例应用：fileuploaddemo.jsp，fileuploaddemo.htm，和msg.jsp。要求服务器端应用目录的WEB-INF/lib下面有commons-fileupload-1.0-dev.jar。 说明： FileUpload组件解决了常见的文件上载问题。它提供了一个易用的接口来管理上载到服务器的文件，可用于JSP和Servlet之中。FileUpload组件遵从RFC1867，它分析输入请求，向应用程序提供一系列上载到服务

29、器的文件。上载的文件可以保留在内存中，也可以放入一个临时位置（允许配置一个表示文件大小的参数，如果上载的文件超过了该参数指定的大小，则把文件写入一个临时位置）。另外还有一些参数可供配置，包括可接受的最大文件、临时文件的位置等。 下面介绍一下使用FileUpload组件的步骤。 首先创建一个HTML页面。注意，凡是要上载文件的表单都必须设置enctype属性，且属性的值必须是multipart/form-data，同时请求方法必须是POST。下面的表单除了上载两个文件，另外还有一个普通的文本输入框： 输入你的名字: 图形: 文件: 接下来创建JSP页面。/ / 检查输入请求是否为multipart的表单数据。boolean isMultipart = FileUpload. isMultipartContent(request);/ / 为该请求创建一个句柄，通过它来解析请求。执行/ 解析后，所有的表单项目都保存在一个List中。DiskFileUpload upload = new DiskFileUpload();/ 通过句柄解析请求，解析得到的项目保存在一个List中List items = upload.parseRequest(request);/ /