commons-configuration2.1:不支持java.net.URI的原因分析及解决办法

版权声明：本文为博主原创文章，转载请注明源地址。 https://cloud.tencent.com/developer/article/1433448

org.apache.commons.configuration2.AbstractConfiguration有get系列方法get(Class<T> cls, String key),get(Class<T> cls, String key, T defaultValue),允许直接将key指定的值转为指定的类(cls).

这个方法在使用时很方便，不需要自己获取字符串再转为对应的Class。

可以认为getInteger,getLong,getBoolean这些方法是这个方法的特例化实现。

但是最在使用commons-configuration2时发现一个问题，get(Class<T> cls, String key)方法不支持java.net.URI类型(cls为URI.class时会抛出ConversionException异常)。

The value ‘redis://localhost:6379/0’ (java.lang.String) can’t be converted to a java.net.URI object

准确的说是2.1.1 这个版本不支持java.net.URI类型，再往后的版本(2.2,2.3,2.4…)都是可以支持URI的。但是我的项目要求JDK 1.7编译，而2.1.1是支持JDK 1.7最后一版本。我必须使用这个版本。怎么办？

于是我开始分析关于类型转部分的源码。

实现String到指定数据类型转的代码根源在这个方法：

org.apache.commons.configuration2.convert.PropertyConverter.to(Class<?> cls, Object value, DefaultConversionHandler convHandler) ,因为在2.1版本这个方法中没有针对URI类型的处理，所以不能支持。

这个方法又是被org.apache.commons.configuration2.convert.DefaultConversionHandler.convertValue(Object src, Class<T> targetCls, ConfigurationInterpolator ci)方法调用的。

而在org.apache.commons.configuration2.AbstractConfiguration类中可以通过setConversionHandler(ConversionHandler conversionHandler)方法指定ConversionHandler实例(默认实例是DefaultConversionHandler)。

于是我就有了解决办法：

重写DefaultConversionHandler类的convertValue(Object src, Class<T> targetCls, ConfigurationInterpolator ci)方法

首先，创建一个继承于DefaultConversionHandler的类重写 convertValue(Object src, Class<T> targetCls, ConfigurationInterpolator ci)方法，在这个方法中检查输入的targetCls参数是否为java.net.URI.class如果是则以String创建一个URI的实例返回。否则调用父类的方法。如下是具体实现：

CustomConversionHandler.java

package net.gdface.facelog;

import java.net.URI;
import java.net.URISyntaxException;

import org.apache.commons.configuration2.convert.DefaultConversionHandler;
import org.apache.commons.configuration2.ex.ConversionException;
import org.apache.commons.configuration2.interpol.ConfigurationInterpolator;

/**
 * 增加对{@link URI}类型的转换支持
 * @author guyadong
 *
 */
public class CustomConversionHandler extends DefaultConversionHandler {
	public static final CustomConversionHandler INSTANCE = new CustomConversionHandler();

	@SuppressWarnings("unchecked")
	@Override
	protected <T> T convertValue(Object src, Class<T> targetCls, ConfigurationInterpolator ci) {
        if (src == null)
        {
            return null;
        }
        if (targetCls.isInstance(src))
        {
            return (T) src; // no conversion needed
        }
		if(src instanceof String && URI.class.equals(targetCls)){
			try {
				return (T) new URI((String) src);
			} catch (URISyntaxException e) {
		        throw new ConversionException("The value '" + src + "' (" + src.getClass() + ")"
		                + " can't be converted to a " + targetCls.getName() + " object"); 
			}
		}
		return super.convertValue(src, targetCls, ci);
	}
}

有了上面这个类，在使用org.apache.commons.configuration2.AbstractConfiguration的相关子类实例时只要调用setConversionHandler(ConversionHandler conversionHandler)方法指定CustomConversionHandler为执行类型转换实例就可以了。示例如下：

	CombinedConfiguration config;
	// ...
	// 设置自定义handler
	config.setConversionHandler(CustomConversionHandler.INSTANCE);
	// 获取URI类型的参数值
	config.get(URI.class,"mykey")