java.util.ServiceLoader使用

今天在看Hadoop源代的时候发现，在FileSystem中用到了Java.util.ServiceLoader这个类来从配置文件中加载子类或者接口的实现类。以前从来没有使用过这个类，进去大概看了一下具体的实现。主要是从META-INF/services这个目录下的配置文件加载给定接口或者基类的实现，ServiceLoader会根据给定的类的full name来在META-INF/services下面找对应的文件，在这个文件中定义了所有这个类的子类或者接口的实现类，返回一个实例。

下面以一个具体的例子来说明一下ServiceLoader的具体使用，类似Hadoop FileSystem中的实现。

首先定义一个接口，具体如下：

[java] view plain copy

1. public interface IService {  
2.     public String sayHello();  
3.       
4.     public String getScheme();  
5. }  

该接口有两个子类，分别为HDFSService和LocalService：

[java] view plain copy

1. public class HDFSService implements IService {  
2.   
3.     @Override  
4.     public String sayHello() {  
5.         return "Hello HDFS!!";  
6.     }  
7.   
8.     @Override  
9.     public String getScheme() {  
10.         return "hdfs";  
11.     }  
12. }  

[java] view plain copy

1. public class LocalService implements IService {  
2.   
3.     @Override  
4.     public String sayHello() {  
5.         return "Hello Local!!";  
6.     }  
7.   
8.     @Override  
9.     public String getScheme() {  
10.         return "local";  
11.     }  
12.   
13. }  

需要在META-INF/services下以IService这个类的全名来新建立一个文件，文件中的内容为两个实现类的全名，如下：

[java] view plain copy

1. org.hadoop.java.HDFSService  
2. org.hadoop.java.LocalService  

所有的实现和配置都已经完成，下面写一个测试类来看一下结果:

[java] view plain copy

1. public class ServiceLoaderTest {  
2.   
3.     /** 
4.      * @param args 
5.      */  
6.     public static void main(String[] args) {  
7.         //need to define related class full name in /META-INF/services/....  
8.         ServiceLoader<IService> serviceLoader = ServiceLoader  
9.                 .load(IService.class);  
10.         for (IService service : serviceLoader) {  
11.             System.out.println(service.getScheme()+"="+service.sayHello());  
12.         }  
13.     }  
14.   
15. }  

具体的输出来如下：

[plain] view plain copy

1. hdfs=Hello HDFS!!  
2. local=Hello Local!!  

可以看到ServiceLoader可以根据IService把定义的两个实现类找出来，返回一个ServiceLoader的实现，而ServiceLoader实现了Iterable接口，所以可以通过ServiceLoader来遍历所有在配置文件中定义的类的实例。Hadoop FileSystem就是通过这个机制来根据不同文件的scheme来返回不同的FileSystem。

FileSystem中的相关实例如下：

[java] view plain copy

1. private static void loadFileSystems() {  
2.   synchronized (FileSystem.class) {  
3.     if (!FILE_SYSTEMS_LOADED) {  
4.       ServiceLoader<FileSystem> serviceLoader = ServiceLoader.load(FileSystem.class);  
5.       for (FileSystem fs : serviceLoader) {  
6.         SERVICE_FILE_SYSTEMS.put(fs.getScheme(), fs.getClass());  
7.       }  
8.       FILE_SYSTEMS_LOADED = true;  
9.     }  
10.   }  
11. }  

FileSystem对应的配置如下：

[java] view plain copy

1. org.apache.hadoop.fs.LocalFileSystem  
2. org.apache.hadoop.fs.viewfs.ViewFileSystem  
3. org.apache.hadoop.fs.s3.S3FileSystem  
4. org.apache.hadoop.fs.s3native.NativeS3FileSystem  
5. org.apache.hadoop.fs.kfs.KosmosFileSystem  
6. org.apache.hadoop.fs.ftp.FTPFileSystem  
7. org.apache.hadoop.fs.HarFileSystem  

通过之前的测试类输出对应的scheme和class如下：

[plain] view plain copy

1. file=class org.apache.hadoop.fs.LocalFileSystem  
2. viewfs=class org.apache.hadoop.fs.viewfs.ViewFileSystem  
3. s3=class org.apache.hadoop.fs.s3.S3FileSystem  
4. s3n=class org.apache.hadoop.fs.s3native.NativeS3FileSystem  
5. kfs=class org.apache.hadoop.fs.kfs.KosmosFileSystem  
6. ftp=class org.apache.hadoop.fs.ftp.FTPFileSystem  
7. har=class org.apache.hadoop.fs.HarFileSystem  
8. hdfs=class org.apache.hadoop.hdfs.DistributedFileSystem  
9. hftp=class org.apache.hadoop.hdfs.HftpFileSystem  
10. hsftp=class org.apache.hadoop.hdfs.HsftpFileSystem  
11. webhdfs=class org.apache.hadoop.hdfs.web.WebHdfsFileSystem  

可以看到FileSystem会把所有的FileSystem的实现都以scheme和class来cache，之后就从这个cache中取相应的值。

因此，以后可以通过ServiceLoader来实现一些类似的功能。而不用依赖像Spring这样的第三方框架。