Java spi机制 面向接口的编程
最近看到公司的一些框架和之前看到的开源的一些框架的一些服务发现和接入都采用了java的spi机制。
所以简单的总结下java spi机制的思想。
SPI的全名为Service Provider Interface.普通开发人员可能不熟悉，因为这个是针对厂商或者插件的。在java.util.ServiceLoader的文档里有比较详细的介绍。究其思想，其实是和"Callback"差不多。“Callback”的思想是在我们调用API的时候，我们可以自己写一段逻辑代码，传入到API里面，API内部在合适的时候会调用它，从而实现某种程度的“定制”。
我们系统里抽象的各个模块，往往有很多不同的实现方案，比如日志模块的方案，xml解析模块、jdbc模块的方案等。面向的对象的设计里，我们一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。
为了实现在模块装配的时候能不在程序里动态指明，这就需要一种服务发现机制。java spi就是提供这样的一个机制：为某个接口寻找服务实现的机制。有点类似IOC的思想，就是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要。
java spi的具体约定如下 ：
当服务的提供者，提供了服务接口的一种实现之后，在jar包的META-INF/services/目录里同时创建一个以服务接口命名的文件。该文件里就是实现该服务接口的具体实现类。而当外部程序装配这个模块的时候，就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名，并装载实例化，完成模块的注入。
基于这样一个约定就能很好的找到服务接口的实现类，而不需要再代码里制定。
jdk提供服务实现查找的一个工具类：java.util.ServiceLoader
例子
1.common-logging
apache最早提供的日志的门面接口。只有接口，没有实现。具体方案由各提供商实现，发现日志提供商是通过扫描 META-INF/services/org.apache.commons.logging.LogFactory配置文件，通过读取该文件的内容找到日志提工商实现类。只要我们的日志实现里包含了这个文件，并在文件里制定 LogFactory工厂接口的实现类即可。
2.jdbc
jdbc4.0以前，开发人员还需要基于Class.forName("xxx")的方式来装载驱动，jdbc4也基于spi的机制来发现驱动提供商了，可以通过META-INF/services/java.sql.Driver文件里指定实现类的方式来暴露驱动提供者。
典型的是Collections.sort（List<T> list,Comparator<? super T> c）这个方法，它的第二个参数是一个实现Comparator接口的实例。我们可以根据自己的排序规则写一个类，实现此接口，传入此方法，那么这个方法就会根据我们的规则对list进行排序。
把这个思想扩展开来，我们用SPI来重新实现上面的例子。客户把自己的排序规则写成一个类，并且打包成Jar文件，这个Jar文件里面必须有META-INF目录，其下又有services目录，其下有一个文本文件，文件名即为接口的全名：
java.util.Comparator
--META-INF
--services
--java.util.Comparator
文件内容只有一行：
com.company1.ComparatorProvider这一行是你实现了Comparator接口的类的全名，它的代码如下：
package com.company1;
import java.util.Comparator;
import com.mycompany.myapp.MyItem;
public class ComparatorProvider implements Comparator<MyItem>{
@Override
public int compare(MyItem o1, MyItem o2) {
//依据name排序
return o1.getName().compareTo(o2.getName());
}
}
编译打包后，把它放到你的主程序的class path里。下面是你的主程序：
//从class path中所有Jar的META-INF目录中搜索，找到合适的类并加载。
private static ServiceLoader<Comparator> serviceLoader
= ServiceLoader.load(Comparator.class);
public static void main(String[] args)
{
List<MyItem> myList = new ArrayList<MyItem>();
myList.add(new MyItem(2,"c","hhh"));
myList.add(new MyItem(3,"k","ooo"));
myList.add(new MyItem(4,"d","ppp"));
myList.add(new MyItem(5,"b","ggg"));
showList(myList);
Collections.sort(myList,getCompartor());
showList(myList);
}
@SuppressWarnings("unchecked")
private static Comparator<MyItem> getCompartor() {
for(Comparator service : serviceLoader)
{
return (Comparator<MyItem>)service;
}
return null;
}
要注意的是serviceLoader开始只是加载类，实例化要到第一次用的时候。类MyItem和方法showList并不重要，所以你不必在意。你可以按照这个规则，写另外一个排序规则的Jar,随时可以更换你的排序规则.
这篇文章写在我研究J2SE、J2EE近三年后。前3年我研究了J2SE的Swing、Applet、Net、RMI、Collections、 IO、JNI……研究了J2EE的JDBC、Sevlet、JSP、JNDI…..不久我发现这些好像太浮浅了：首先，我发现自己知道的仅仅是java提 供的大量的API，根本不能很好地使用它; 其次，我根本就没有学到任何有助于写程序的知识，此时我也只不过能写个几页的小程序。出于这个幼稚的想法我研究了JDK中Collections、 Logger、IO…..的源代码，发现这个世界真的很神奇，竟然有如此的高手――利用java语言最最基本的语法，创造了这些优秀的 Framework。
从此一发不可收拾，我继续研究了J2EE的部分，又发现这是一个我根本不能理解的方向(曾经有半年停滞不前)，为什么只有接口没有实现啊!后来由于 一直使用Tomcat、Derby等软件突然发现：哦!原来J2EE仅仅是一个标准，只是一个架构。真正的实现是不同提供商提供的。
接着我研究了MOM4J、OpenJMS、Mocki、HSQLD……发现这些就是J2EE的实现啊!原来软件竟会如此复杂，竟会如此做….规范和 实现又是如何成为一体的呢?通过上面的研究发现：原来J2EE后面竟然有太多太多理念、太多太多的相似!这些相似就是其背后的理念――设计模式!(很幸 运，在我学java的时候，我一般学java的一个方向就会读一些关于设计模式的书!很幸运，到能领略一点的时候能真正知道这是为什么!)其实模式就是一 种思维方式、就是一种理念……模式是要运用到程序中的，只有从真正的项目中才能领会模式的含义……
学得越多，发现懂得越少!在学习过程中发现一些很有用，很值得学习的开源项目，今天在此推荐给大家。
一、JavaServlet和JSP方向
很多人都是从Servlet和JSP步入J2EE的。它就是J2EE的表现层，用于向客户呈现服务器上的内容。J2EE很重要的方面。不罗嗦了!大 家都知道的!下面就开始推荐吧!
1. Jakarta Tomcat
Apache基金会提供的免费的开源的Serlvet容器，它是的Jakarta项目中的一个核心项目，由Apache、Sun和其它一些公司(都 是IT界的大鳄哦)及个人共同开发而成，全世界绝大部分Servlet和Jsp的容器都是使用它哦!由于Sun的参与和支持，最新的Servlet和 Jsp规范总能在Tomcat中得到体现。
不过它是一个非常非常全的Serlvet容器，全部源码可能有4000页，对于初学者或者一般的老手可能还是比较大了!在你有能力时推荐研究!下载 地址：http://jakarta.apache.org/tomcat/index.html
下面推荐两个小一点的吧!
2. Jetty
Jetty是一个开放源码的HTTP服务器和Java serverlet容器。源代码只有1000页左右，很值得研究。有兴趣可以去http://jetty.mortbay.com/下载看看。我曾经翻了 一下，只是目前没有时间。(都化在博客上了，等博客基本定型，且内容完整了，再干我热衷的事件吧!)
3. Jigsaw
Jigsaw是W3C开发的HTTP，基于Java 的服务器，提供了未来 Web 技术发展的蓝图。W3C知道吧!(太有名气了，很多标准都是它制订的!有空经常去看看吧!)下载网址：http://www.w3.org/Jigsaw 代码仅仅1000页左右。
4. Jo!
Jo!是一个纯Java的实现了Servlet API 2.2, JSP 1.1, 和HTTP/1.1的Web服务器。它的特性包括支持servlet tag,支持SSI，高级线程管理，虚拟主机，数据缓存，自动压缩text或HTML文件进行传输，国际化支持，自动重新加载Servlet、Jsp，自 动重新加载web工程文件(WARs)，支持WAR热部署和一个Swing控制台。jo!可以被用做jboss和jakarta avalon-phoenix的web容器。下载地址http://www.tagtraum.com/ 。我极力推荐大家在研究Tomcat之前研究该软件，主要是其比Tomcat小多了，且开发者提供比较全的手册。该方向研究这两个也就可以了!
二、JDBC方向
很多人都喜欢JDBC，数据库吗!很深奥的东西，一听就可以糊弄人。其实等你真正研究了数据库的实现后发现，接口其实真的太简单，太完美了!要想设 计如此优秀的框架还是需要学习的。下面就推荐几个数据库的实现吧!
1. Hypersonic SQL
Hypersonic SQL开源数据库方向比较流行的纯Java开发的关系型数据库。好像不是JDBC兼容的，JDBC的很多高级的特性都没有支持，不过幸好支持ANSI- 92 标准 SQL语法。我推荐它主要是它的代码比较少1600页左右，如此小的数据库值得研究，而且他占的空间很小，大约只有160K，拥有快速的数据库引擎。推荐 你的第一个开源数据库。下载地址：http://hsqldb.sourceforge.net/。
2. Mckoi DataBase
McKoiDB 和Hypersonic SQL差不多，它是GPL 的license的纯Java开发的数据库。他的 JDBC Driver 是使用 JDBC version 3 的 Specifaction。 他也是遵循 SQL-92 的标准，也尽量支持新的 SQL 特色, 并且支持 Transaction 的功能。两个可以选一个吧!下载地址：http://mckoi.com/database/。
3. Apache Derby
学Java的数据库我建议使用Apache Derby ，研究数据库想成为一个数据库的高手我建议你先研究Apache Derby。Apache Derby是一个高质量的、纯 Java开发的嵌入式关系数据库引擎，IBM® 将其捐献给Apache开放源码社区，同时IBM的产品CloudSpace是它对应的产品。Derby是基于文件系统，具有高度的可移植性，并且是轻量 级的，这使得它非常便于发布。主要是没有商业用户的很好的界面，没有其太多的功能。不过对于我们使用数据库、研究数据库还是极其有用的。对于中小型的企业 说老实话你也不要用什么Oracle、SqlServer了，用Derby就可以了，何况是开源的呢!只要能发挥其长处也不容易啊!下载地 址：http://incubator.apache.org/derby。
不过在没有足够的能力前，不要试图读懂它!注释和源代码15000页左右，我一年的阅读量!能读下来并且能真正领会它，绝对高手!你能读完 Derby的源代码只有两种可能：1.你成为顶尖的高手――至少是数据库这部分; 2.你疯了。选择吧!!!!作为我自己我先选择Hypersonic SQL这样的数据库先研究，能过这一关，再继续研究Derby!不就是一年的阅读量吗!我可以化3年去研究如何做一个数据库其实还是很值得的!有的人搞 IT一辈子自己什么都没有做，也根本没有研究别人的东西!
作为一个IT落后于别国若干年的、从事IT的下游产业“外包”的国家的IT从业人员，我认为还是先研究别人的优秀的东西比较好!可以先研究别人的， 然后消化，学为己用!一心闭门造车实在遗憾!
三、JMS方向
JMS可能对大家来说是一个比较陌生的方向!其实JMS是一个比较容易理解，容易上手的方向。主要是Java消息服务，API也是相当简单的。不过 在企业应用中相当广泛。下面就介绍几个吧!
1. MOM4J
MOM4J是一个完全实现JMS1.1规范的消息中间件并且向下兼容JMS1.0与1.02。它提供了自己的消息处理存储使它独立于关系数据与语 言，它的客户端可以用任何语言开发。它可以算是一个小麻雀，很全实现也比较简单!它包含一个命名服务器，一个消息服务器，同时提供自己的持续层。设计也相 当的巧妙，完全利用操作系统中文件系统设计的观念。代码也很少，250页左右，最近我在写该实现的源代码阅读方面的书，希望明年年中能与大家见面!下载地 址：http://mom4j.sourceforge.net/index.html。
2. OpenJMS
OpenJMS是一个开源的Java Message Service API 1.0.2 规范的实现，它包含有以下特性：
1. 它既支持点到点(point-to-point)(PTP)模型和发布/订阅(Pub/Sub)模型。
2. 支持同步与异步消息发送 。
3. JDBC持久性管理使用数据库表来存储消息 。
4. 可视化管理界面。
5. Applet支持。
6. 能够与Jakarta Tomcat这样的Servlet容器结合。
7. 支持RMI, TCP, HTTP 与SSL协议。
8. 客户端验证 。
9. 提供可靠消息传输、事务和消息过滤。
很好的JMS方向的开源项目!我目前也在研究它的源代码!学习它可以顺便研究JNDI的实现、以及网络通信的细节。这是我JMS方向研究的第二个开 源项目。代码量1600页左右吧!下载地址：http://openjms.sourceforge.net/index.html
3. ActiveMQ
ActiveMQ是一个开放源码基于Apache 2.0 licenced 发布并实现了JMS 1.1。它能够与Geronimo，轻量级容器和任Java应用程序无缝的给合。主要是Apache的可以任意的使用和发布哦!个人比较喜欢Apache 的源代码!下载地址：http://activemq.codehaus.org/
4. JORAM
JORAM一个类似于openJMS分布在ObjectWeb之下的JMS消息中间件。ObjectWeb的产品也是非常值得研究的!下面我还会给 大家另外一个ObjectWeb的产品。下载地址：http://joram.objectweb.org/
我个人推荐：OpenJMS和ActiveMQ!
四、EJB方向
EJB一个比较“高级”的方向。Sun公司曾经以此在分布式计算领域重拳出击。不过自从出现了Spring、Hibernation……后似乎没落 了!这个方向单独开源的也比较少，主要EJB是和JNDI、JDBC、JMS、JTS、JTA结合在一起的是以很少有单独的。下面推荐两个不过好像也要下 载其它类库。
1. EasyBeans
ObjectWeb的一个新的项目，一个轻量级的EJB3容器，虽然还没有正式发布，但是已经可以从它们的subversion仓库中检出代码。代 码量比较小600页左右，熟读它可以对网络编程、架构、RMI、容器的状态设计比较了解了!即学会EJB又能学习其它设计方法何乐而不为哦!下载地 址：http://easybeans.objectweb.org/
2. OpenEJB
OpenEJB是一个预生成的、自包含的、可移植的EJB容器系统，可以被插入到任意的服务器环境，包括应用程序服务器，Web服务器，J2EE平 台， CORBA ORB和数据库等等。OpenEJB 被用于 Apple的WebObjects。听起来很好，我目前没有研究过。不知道我就不推荐了。下载地址：http://www.openejb.org/
五、J2EE容器
上面谈了这么多，都是J2EE的各个方向的。其实J2EE是一个规范，J2EE的产品一般要求专业提供商必须提供它们的实现。这些实现本身就是 J2EE容器。市场上流行的J2EE容器很多，在开源领域流行的只有很少，很少。其中最著名的是JBoss。
1. JBoss
在J2EE应用服务器领域，Jboss是发展最为迅速的应用服务器。由于Jboss遵循商业友好的LGPL授权分发，并且由开源社区开发，这使得 Jboss广为流行。另外，Jboss应用服务器还具有许多优秀的特质。
其一，它将具有革命性的JMX微内核服务作为其总线结构;
其二，它本身就是面向服务的架构(Service-Oriented Architecture，SOA);
其三，它还具有统一的类装载器，从而能够实现应用的热部署和热卸载能力。因此，它是高度模块化的和松耦合的。Jboss用户的积极反馈告诉我 们，Jboss应用服务器是健壮的、高质量的，而且还具有良好的性能。为满足企业级市场日益增长的需求，Jboss公司从2003年开始就推出了 24*7、专业级产品支持服务。同时，为拓展Jboss的企业级市场，Jboss公司还签订了许多渠道合作伙伴。比如，Jboss公司同HP、 Novell、Computer Associates、Unisys等都是合作伙伴。
在2004年6月，Jboss公司宣布，Jboss应用服务器通过了Sun公司的J2EE认证。这是Jboss应用服务器发展史上至今为止最重要的 里程碑。与此同时，Jboss一直在紧跟最新的J2EE规范，而且在某些技术领域引领J2EE规范的开发。因此，无论在商业领域，还是在开源社 区，Jboss成为了第一个通过J2EE 1.4认证的主流应用服务器。现在，Jboss应用服务器已经真正发展成具有企业强度(即，支持关键级任务的应用)的应用服务器。
Jboss 4.0作为J2EE认证的重要成果之一，已经于2004年9月顺利发布了。同时，Jboss 4.0还提供了Jboss AOP(Aspect-Oriented Programming，面向方面编程)组件。近来，AOP吸引了大量开发者的关注。它提供的新的编程模式使得用户能够将方面(比如，事务)从底层业务逻 辑中分离出来，从而能够缩短软件开发周期。用户能够单独使用Jboss AOP，即能够在Jboss应用服务器外部使用它。或者，用户也可以在应用服务器环境中使用它。Jboss AOP 1.0已经在2004年10月发布了。 很有名吧!可以下载一个用一下，下载地址：http://www.jboss.org/
关于JBoss的使用资料也非常多，甚至比商业软件的还多。有机会研究吧!
2. JOnAS
JOnAS是一个开放源代码的J2EE实现，在ObjectWeb协会中开发。整合了Tomcat或Jetty成为它的Web容器，以确保符合 Servlet 2.3和JSP 1.2规范。JOnAS服务器依赖或实现以下的Java API：JCA、JDBC、JTA 、JMS、JMX、JNDI、JAAS、JavaMail 。下载地址：http://jonas.objectweb.org/
3.Apache Geronimo
Apache Geronimo 是 Apache 软件基金会的开放源码J2EE服务器，它集成了众多先进技术和设计理念。 这些技术和理念大多源自独立的项目，配置和部署模型也各不相同。 Geronimo能将这些项目和方法的配置及部署完全整合到一个统一、易用的模型中。作为符合J2EE标准的服务器，Geronimo提供了丰富的功能集 和无责任 Apache 许可，具备“立即部署”式J2EE 1.4容器的各种优点，其中包括：
1. 符合J2EE1.4标准的服务器 。
2. 预集成的开放源码项目 。
3. 统一的集成模型 。
4. 可伸缩性、可管理性和配置管理功能。
我一直比较推荐Apache的产品。主要是可以任意自由地使用。下载地址：http://incubator.apache.org /projects/geronimo/
六、其它
讲了这么多大家可能很厌烦了!是不是很多很多啊!其实不然，我们不会的太多太多了!不会的太多太多了。不管你是不是J2EE高手，还是J2SE高 手，有些东西你要绝对很精明的。例如：1.Java的Collections Framework就是java的数据结构了，不仅要吃透它，还要能按照需要扩展它，利用其思想创建一个自己的数据结构。2.网络编程肯定要会吧，现在以 及以后很多程序都是不在同一台机器上的，不会网络怎么行哦!3.IO肯定要会的吧!你的程序难道不用输入输出数据啊!整个IO包加NIO也有600多页的 源代码哦!4.JDBC你要会吧!数据库都不会，在你的企业应用中你的数据又保存到哪里啊!文件中――太落后了吧!典型的没有学过J2EE。尽管数据库背 后也是采用文件保存的。5.Serverlet、JSp你要是做网页做网站，肯定要做到。问你一个简单的问题，网页中如何实现分页啊!有具体方法的就在本 文章后发言吧!6. Ant要会吧!java语言中发布的工具，类似与c中的make工具。7.JUnit用过吧!单元测试软件。你不要啊!你的软件就没有bug!你牛!(建 议大家研究研究其源代码，很有用的框架，包含大量的设计模式，源代码不到100页!看了只能感叹――高手就是高手)细心的朋友可以看到在你使用的很多 IDE工具中都有JUnit哦!就是它。
一切的一切才刚刚开始!有兴趣，有需要你可以研究数据库连接池的框架，如：C3P0、Jakarta DBCP、 DBPool….可以研究J2EE框架Spring……. Web框架Struts……持久层框架Hibernate…..甚至开发工具Eclipse…..Sun领导的点对点通信的JXTA…..报表工具 JFreeChart、JasperReports…..分布式网络编程的CORBA、网络通信的JGROUPS、XML解析的xerces…..(在不 经意间开源已经步入你的电脑，不信啊!你JDK的安装目录jdk1.6.0 src com sun org apache就是Xerces，一个XML解析的著名的开源 项目)
不管怎么样我还是建议从基本的做起，学精J2SE，熟读它的源码，准确了解其设计理念，然后分头击破J2EE――一口吃不成一个胖子!不要贪多贪 广!脚踏实地就可以了!
一、什么是面向接口编程
要正确地使用Java语言进行面向对象的编程，从而提高程序的复用性，增加程序的可维护性、可扩展性，就必须是面向接口的编程。面向接口的编程就意味着：开发系统时，主体构架使用接口，接口构成系统的骨架。这样就可以通过更换实现接口的类来更换系统的实现。
例如：在上节示例中，Java接口Introduceable就是系统骨架的一个重要组成部分，这个Java接口定义了一个方法：detailo中心类和教员类分别实现了Java接口Introduceable，因此具有了不同的detail方法实现。在School2类中，print方法接收的参数类型是Introduceable，这样，就可以向print方法传递任意一个Introduceable接口的实现类，在运行时，Java虚拟机会根据实际创建的对象类型调用不同的方法实现。这就意味着：可以通过更换实现接口的类来更换系统的实现。
二、面向接口编程的示例
接下来通过一个示例详细讲解面向接口编程的实现过程。
案例需求的效果图如图1所示。
升级系统，要求如下：
★ 打印机有多种类型，比如：黑白打印机、彩色打印机等。
★ 中心可能配备其中任意一款打印机，负责打印教员或者中心的详细信息。
★ 系统要具备良好的可扩展性与可维护性。
采用面向接口编程的方式实现可以分为3个步骤。
1．抽象出Java接口
分析：由于黑白、彩色打印机都存在一个共同的方法特征：print，而且黑白、彩色打印机对print方法有各自不同的实现，因此可以抽象出一个Java接口PrinterFace（代表打印机），在其中定义print方法。
具体实现代码如下：
package Java.sg.ch03;
public interface PrinterFace {
//定义打印方法
public voicl print (String content);
}
2．实现Java接口
分析：在第一步中已经抽象出Java接口PrinterFace，并在其中定义了print方法。由于黑白、彩色打印机对print方法有各自不同的实现，因此在第2步中，要让黑白、彩色打印机实现PrinterFace接口，各自实现print方法。
彩色打印机代码实现如下：
package Java.sg.ch03;
public class ColorPrinter implements
PrinterFace {
/**
* 打印方法
*/
public void print(String content) {
System.out.println("彩色打印 ：");
System.out.println(content);
}
}
黑白打印机代码实现如下：
package Java.sg.ch03;
public class BlackPrinter implements
PrinterFace {
/**
* 打印方法
*/
public void print(String content) {
System.out.println("黑白打印 ：");
System.out.println(content);
}
}
3．使用Java接口
经验：现在，Java接口及其实现类都已经创建完毕，接着，我们就要使用面向接口编程的原则，让接口构成系统的骨架，以便达到更换实现接口的类就可以更换系统的实现的目的。
中心类负责对外提供打印功能，要求可以随时更换打印机类型。代码实现如下：
package Java.sg.ch03;
public class School3 implements Introduceable{
private PrinterFace printer; //打印机
// 输出中心的详细信息
public String detail() {
return "这里是中心";
}
// 使用中心打印机打印信息
public void print(Introduceable intro){
printer.print(intro.detail());
}
//设置打印机
public void setPrinter(PrinterFace p) {
this.printer = p;
}
}
测试类提供main方法进行单元测试。代码实现如下：
package Java.sg.ch03;
public class Test {
public static void main(String[] args) {
//创建中心实例
School3 school = new School3();
//为该中心配备黑白打印机
school.setPrinter(new BlackPrinter());
school.print(school);
//为该中心配备彩色打印机
school.setPrinter(new ColorPrinter());
school.print(school);
}
}
经验：面向接口编程可以实现接口和实现的分离，这样做的最大好处就是能够在客户端未知的情况下修改实现代码。那么什么时候应该抽象出Java接口呢？一种是用在层和层之问的调用。层和层之间是最忌讳耦合度过高或是改变过于频繁。设计优秀的接口能够解决这个问题。另一种是用在那些不稳定的部分上。如果某些需求的变化性很大，那么定义接口也是一种解决之道。设计良好的接口就像是我们日常使用的万用插座一样，不论插头如何变化，都可以使用。
最后强调一点，良好的接口定义一定是来自于需求的，它绝对不是程序员绞尽脑汁想出来的。