com.github.zhangxd1989.basetool.convert.AbstractConverter Maven / Gradle / Ivy
package com.github.zhangxd1989.basetool.convert;
import com.github.zhangxd1989.basetool.util.ArrayUtil;
import com.github.zhangxd1989.basetool.util.CharUtil;
import com.github.zhangxd1989.basetool.util.ClassUtil;
import com.github.zhangxd1989.basetool.util.StrUtil;
import java.util.Map;
/**
* 抽象转换器，提供通用的转换逻辑，同时通过convertInternal实现对应类型的专属逻辑
* 转换器不会抛出转换异常，转换失败时会返回{@code null}
*
* @author sheldon
*/
public abstract class AbstractConverter implements Converter {
/**
* 不抛异常转换
* 当转换失败时返回默认值
*
* @param value 被转换的值
* @param defaultValue 默认值
* @return 转换后的值
*/
public T convertQuietly(Object value, T defaultValue) {
try {
return convert(value, defaultValue);
} catch (Exception e) {
return defaultValue;
}
}
@Override
@SuppressWarnings("unchecked")
public T convert(Object value, T defaultValue) {
Class targetType = getTargetType();
if (null == targetType && null == defaultValue) {
throw new NullPointerException(StrUtil.format("[type] and [defaultValue] are both null for Converter [{}], we can not know what type to convert !", this.getClass().getName()));
}
if (null == targetType) {
// 目标类型不确定时使用默认值的类型
targetType = (Class) defaultValue.getClass();
}
if (null == value) {
return defaultValue;
}
if (null == defaultValue || targetType.isInstance(defaultValue)) {
if (targetType.isInstance(value) && !Map.class.isAssignableFrom(targetType)) {
// 除Map外，已经是目标类型，不需要转换（Map类型涉及参数类型，需要单独转换）
return targetType.cast(value);
}
T result = convertInternal(value);
return ((null == result) ? defaultValue : result);
} else {
throw new IllegalArgumentException(StrUtil.format("Default value [{}] is not the instance of [{}]", defaultValue, targetType));
}
}
/**
* 内部转换器，被 {@link AbstractConverter#convert(Object, Object)} 调用，实现基本转换逻辑
* 内部转换器转换后如果转换失败可以做如下操作，处理结果都为返回默认值：
*
* 1、返回{@code null}
* 2、抛出一个{@link RuntimeException}异常
*
*
* @param value 值
* @return 转换后的类型
*/
protected abstract T convertInternal(Object value);
/**
* 值转为String，用于内部转换中需要使用String中转的情况
* 转换规则为：
*
* 1、字符串类型将被强转
* 2、数组将被转换为逗号分隔的字符串
* 3、其它类型将调用默认的toString()方法
*
*
* @param value 值
* @return String
*/
protected String convertToStr(Object value) {
if (null == value) {
return null;
}
if (value instanceof CharSequence) {
return value.toString();
} else if (ArrayUtil.isArray(value)) {
return ArrayUtil.toString(value);
} else if (CharUtil.isChar(value)) {
//对于ASCII字符使用缓存加速转换，减少空间创建
return CharUtil.toString((char) value);
}
return value.toString();
}
/**
* 获得此类实现类的泛型类型
*
* @return 此类的泛型类型，可能为{@code null}
*/
@SuppressWarnings("unchecked")
public Class getTargetType() {
return (Class) ClassUtil.getTypeArgument(getClass());
}
}