com.feilong.core.lang.reflect.ConstructorUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
/*
* Copyright (C) 2008 feilong
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.feilong.core.lang.reflect;
import java.lang.reflect.Constructor;
import com.feilong.core.lang.ClassUtil;
import com.feilong.core.Validate;
import com.feilong.lib.lang3.reflect.ConstructorUtils;
import com.feilong.tools.slf4j.Slf4jUtil;
/**
* 使用反射方法请求构造函数创建新实例的工具类,可以简化程序中使用反射方式创建对象的代码,focused on constructors.
*
* 方法介绍:
*
*
*
* - {@link #newInstance(Class, Object...)} 获得实例
* - {@link #newInstance(Class, Object[], Class[])} 获得实例
*
*
* 上面三个方法,底层均调用了 {@link ConstructorUtils#invokeConstructor(Class, Object[], Class[])} ,此方法 会
* {@link ConstructorUtils#getMatchingAccessibleConstructor(Class, Class...)} 自动根据类型活动最匹配的构造函数,并且将异常转成了 {@link ReflectException} 以便调用的时候使用
*
*
* 因此,不用担心 int{@code -->}Integer 原始类型参数和包装类型参数,以及父类/子类 这样的参数不匹配带来的问题
*
*
*
*
* 如果不想使用自动匹配的特性
*
*
*
*
* 您可以使用原生方法,下面两个是 获得精准的构造函数并实例,如果参数类型不匹配,那么就会抛异常
*
*
*
* - {@link ConstructorUtils#invokeExactConstructor(Class, Object...)} 获得实例
* - {@link ConstructorUtils#invokeExactConstructor(Class, Object[], Class[])} 获得实例
*
*
* 下面还有三个方法是,获得构造函数而不实例
*
* - {@link ConstructorUtils#getAccessibleConstructor(Constructor)}
* - {@link ConstructorUtils#getAccessibleConstructor(Class, Class...)}
* - {@link ConstructorUtils#getMatchingAccessibleConstructor(Class, Class...)}
*
*
*
*
* @author feilong
* @see com.feilong.lib.lang3.reflect.ConstructorUtils
* @see "org.springframework.beans.BeanUtils.instantiateClass"
* @since 1.0.7
*/
public final class ConstructorUtil{
/** Don't let anyone instantiate this class. */
private ConstructorUtil(){
//AssertionError不是必须的. 但它可以避免不小心在类的内部调用构造器. 保证该类在任何情况下都不会被实例化.
//see 《Effective Java》 2nd
throw new AssertionError("No " + getClass().getName() + " instances for you!");
}
//---------------------------------------------------------------
// [start] newInstance
/**
* 新建实例,返回指定类型 klass 的实例,使用正确的构造函数使用参数类型parameterValues.
*
* 示例:
*
*
*
*
* User user = ConstructorUtil.newInstance(User.class)
*
*
* 调用无参的构造函数,返回User对象,你还可以:
*
*
*
* User user1 = ConstructorUtil.newInstance(User.class, 100L);
*
*
* 返回 id 是100的user对象构造函数
*
*
* @param
* the generic type
* @param klass
* 类
* @param parameterValues
* 构造函数的参数值, 比如100L
* @return 如果 klass 是null,抛出 {@link NullPointerException}
* 有任何异常(比如 NoSuchMethodException 找不到相关参数的构造函数),将抛出 {@link ReflectException}
* @see com.feilong.core.lang.ClassUtil#toClass(Object...)
* @see java.lang.Class#getConstructor(Class...)
* @see java.lang.reflect.Constructor#newInstance(Object...)
* @see com.feilong.lib.lang3.reflect.ConstructorUtils#invokeConstructor(Class, Object...)
* @see "org.springframework.beans.BeanUtils.instantiateClass(Constructor, Object...)"
*/
public static T newInstance(Class klass,Object...parameterValues){
Validate.notNull(klass, "klass can't be null!");
Class[] parameterTypes = ClassUtil.toClass(parameterValues);
return newInstance(klass, parameterValues, parameterTypes);
}
//---------------------------------------------------------------
/**
* 返回指定类型 klass,指定参数 parameterValues 和指定参数类型 parameterTypes的构造函数示例.
*
* 说明:
*
*
* - 定位并调用一个构造函数。构造函数的签名必须与赋值兼容的参数类型相匹配。
* - 和 {@link #newInstance(Class, Object...)}的区别, 在于 如果一个类有些重载的构造函数,并且参数类型相似, 此时使用这个方法可以精准定位到需要的构造函数
*
*
*
* 示例:
*
*
*
*
* User user = ConstructorUtil.newInstance(User.class,null,null)
*
*
* 调用无参的构造函数,返回User对象,你还可以:
*
*
*
* User user1 = ConstructorUtil.newInstance(User.class, toArray(100L), toArray(Long.class));
*
*
* 返回 id 是100的user对象构造函数
*
*
* @param
* the generic type
* @param klass
* the class to be constructed, not {@code null}
* @param parameterValues
* the array of arguments, {@code null} treated as empty
* @param parameterTypes
* the array of parameter types, {@code null} treated as empty
* @return 如果 klass 是null,抛出 {@link NullPointerException}
* 有任何异常(比如 NoSuchMethodException 找不到相关参数的构造函数),将抛出 {@link ReflectException}
* @see com.feilong.lib.lang3.reflect.ConstructorUtils#invokeConstructor(Class, Object[], Class[])
* @see "org.springframework.beans.BeanUtils.instantiateClass(Constructor, Object...)"
*/
public static T newInstance(Class klass,Object[] parameterValues,Class[] parameterTypes){
Validate.notNull(klass, "klass can't be null!");
//---------------------------------------------------------------
try{
return ConstructorUtils.invokeConstructor(klass, parameterValues, parameterTypes);
}catch (Exception e){
String pattern = "invokeConstructor exception,class:[{}].args:[{}],parameterTypes:[{}]";
String message = Slf4jUtil.format(pattern, klass, parameterValues, parameterTypes);
throw new ReflectException(message, e);
}
}
}