MyBatis 源码解读（三）指定VFS 的实现

loadCustomVfs 指定VFS 的实现

解析配置的文件加载系统
loadCustomVfs(settings);

VFS

VFS ：虚拟文件系统，主要是通过程序能够方便读取本地文件系统中的文件资源，通过该配置可以加载自定义的虚拟文件系统应用程序，VFS详细解释参见《百度百科-VFS》

private void loadCustomVfs(Properties props) throws ClassNotFoundException {
	// 拿到自定义的文件加载系统实现，实现可以是多个用 "," 分隔，优先使用得放在最前面
	String value = props.getProperty("vfsImpl");
	if (value != null) {
		String[] clazzes = value.split(",");
		for (String clazz : clazzes) {
			if (!clazz.isEmpty()) {
				// 通过反射加载虚拟文件系统的操作实现类，自定义的文件加载应当继承自 VFS
				@SuppressWarnings("unchecked")
				Class<? extends VFS> vfsImpl = (Class<? extends VFS>) Resources.classForName(clazz);
				// 设置用户自定义的文件加载系统实现
				configuration.setVfsImpl(vfsImpl);
			}
		}
	}
}

通过代码（Class<? extends VFS> vfsImpl = (Class<? extends VFS>) Resources.classForName(clazz);）可以看出自定的文件加载系统的实现应当为 VFS 的子类，

MyBatis 内置了两种VFS的实现（JBoss6VFS.class 和 DefaultVFS.class），一般情况下已经足够我们使用，由名字可以看出，第一种是为 JBoss 定制的功能，其他情况下都会使用默认实现，在VFS的源码中，可以看到该类使用静态内部类的方式实现了 单例模式 进行初始化进行初始化。

以下是主要代码部分：

// 内建文件加载系统实现
public static final Class<?>[] IMPLEMENTATIONS = { JBoss6VFS.class, DefaultVFS.class };
// 用户自定义文件系统实现
public static final List<Class<? extends VFS>> USER_IMPLEMENTATIONS = new ArrayList<>();

// 基于静态内部类实现的单例模式
private static class VFSHolder {
    static final VFS INSTANCE = createVFS();

    static VFS createVFS() {
        // 优先使用用户自定义实现，如果用户未定义则使用内建实现
        List<Class<? extends VFS>> impls = new ArrayList<>();
        impls.addAll(USER_IMPLEMENTATIONS);
        impls.addAll(Arrays.asList((Class<? extends VFS>[]) IMPLEMENTATIONS));

        VFS vfs = null;
        for (int i = 0; vfs == null || !vfs.isValid(); i++) {
            Class<? extends VFS> impl = impls.get(i);
            try {
                vfs = impl.getDeclaredConstructor().newInstance();
            } catch (Exception e) {
                log.error("Failed to instantiate " + impl, e);
                return null;
            }
        }
        if (log.isDebugEnabled()) {
            log.debug("Using VFS adapter " + vfs.getClass().getName());
        }
        return vfs;
    }
}

// 返回适合当前运行环境的 VFS的实现
public static VFS getInstance() {
    return VFSHolder.INSTANCE;
}

VFS 是个抽象接口，方法指定了两个抽象方法

public abstract boolean isValid();
protected abstract List<String> list(URL url, String forPath) throws IOException;

第一个方法用来判定适不适合当前运行环境，第二个方法递归检索指定位置下的子路径。

如果用户自定义 VFS ，则使用户的自定义，否则使用默认值。调用 VFS.addImplClass(Class<? extends VFS> clazz) 方法可以添加用户实现。

	public static void addImplClass(Class<? extends VFS> clazz) {
		if (clazz != null) {
			USER_IMPLEMENTATIONS.add(clazz);
		}
	}

单元测试

@Test
public void testVfs() throws Exception {
    VFS vfs = VFS.getInstance();
    List<String> paths = vfs.list("com/tky/perperties");
    assertTrue(paths.contains("com/tky/perperties/system.properties"));
    logger.info("testVfs : {} .", paths);
}

测试结果

CustomVfsLoadTest - testVfs : [com/tky/perperties/mybatis-config.xml, com/tky/perperties/system.properties] .