add FieldInvoker

This commit is contained in:
Looly 2024-09-10 12:13:47 +08:00
parent 024c236fac
commit 264d24b54c
2 changed files with 177 additions and 30 deletions

View File

@ -0,0 +1,166 @@
/*
* Copyright (c) 2024 Hutool Team and hutool.cn
*
* 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 org.dromara.hutool.core.reflect;
import org.dromara.hutool.core.array.ArrayUtil;
import org.dromara.hutool.core.convert.Converter;
import org.dromara.hutool.core.exception.HutoolException;
import org.dromara.hutool.core.lang.Assert;
import java.lang.reflect.Field;
/**
* 字段调用器<br>
* 通过反射读取或赋值字段<br>
* 读取字段值
* <pre>{@code
* FieldInvoker.of(Field).invoke(obj);
* }</pre>
*
* 赋值字段值
* <pre>{@code
* FieldInvoker.of(Field).invoke(obj, value);
* }</pre>
*
* @author looly
* @since 6.0.0
*/
public class FieldInvoker implements Invoker {
/**
* 创建字段调用器
*
* @param field 字段
* @return {@code FieldInvoker}
*/
public static FieldInvoker of(final Field field) {
return new FieldInvoker(field);
}
private final Field field;
private Converter converter;
/**
* 构造
*
* @param field 字段
*/
public FieldInvoker(final Field field) {
this.field = Assert.notNull(field);;
}
/**
* 设置字段值转换器
*
* @param converter 转换器{@code null}表示不转换
* @return this
*/
public FieldInvoker setConverter(final Converter converter) {
this.converter = converter;
return this;
}
@SuppressWarnings("unchecked")
@Override
public <T> T invoke(final Object target, final Object... args) {
if(ArrayUtil.isEmpty(args)){
// 默认取值
return (T) invokeGet(target);
} else if(args.length == 1){
invokeSet(target, args[0]);
return null;
}
throw new HutoolException("Field [{}] cannot be set with [{}] args", field.getName(), args.length);
}
/**
* 获取字段值
*
* @param obj 对象static字段则此字段为null
* @return 字段值
* @throws HutoolException 包装IllegalAccessException异常
*/
public Object invokeGet(Object obj) throws HutoolException {
if (null == field) {
return null;
}
if (obj instanceof Class) {
// 静态字段获取时对象为null
obj = null;
}
ReflectUtil.setAccessible(field);
final Object result;
try {
result = field.get(obj);
} catch (final IllegalAccessException e) {
throw new HutoolException(e, "IllegalAccess for {}.{}", field.getDeclaringClass(), field.getName());
}
return result;
}
/**
* 设置字段值传入的字段值必须和字段类型一致否则抛出异常
*
* @param obj 对象如果是static字段此参数为null
* @param value 值类型必须与字段类型匹配
* @throws HutoolException UtilException 包装IllegalAccessException异常
*/
public void invokeSet(final Object obj, final Object value) throws HutoolException {
ReflectUtil.setAccessible(field);
try {
field.set(obj instanceof Class ? null : obj, convertValue(value));
} catch (final IllegalAccessException e) {
throw new HutoolException(e, "IllegalAccess for [{}.{}]", null == obj ? field.getDeclaringClass() : obj, field.getName());
}
}
@Override
public Class<?> getType() {
return field.getType();
}
/**
* 转换值类型
*
* @param value
* @return 转换后的值
*/
private Object convertValue(final Object value){
if(null == converter){
return value;
}
// 值类型检查和转换
final Class<?> fieldType = field.getType();
if (null != value) {
if (!fieldType.isAssignableFrom(value.getClass())) {
//对于类型不同的字段尝试转换转换失败则使用原对象类型
final Object targetValue = converter.convert(fieldType, value);
if (null != targetValue) {
return targetValue;
}
}
} else {
// 获取null对应默认值防止原始类型造成空指针问题
return ClassUtil.getDefaultValue(fieldType);
}
return value;
}
}

View File

@ -18,7 +18,8 @@ package org.dromara.hutool.core.reflect;
import org.dromara.hutool.core.annotation.Alias;
import org.dromara.hutool.core.array.ArrayUtil;
import org.dromara.hutool.core.convert.ConvertUtil;
import org.dromara.hutool.core.convert.CompositeConverter;
import org.dromara.hutool.core.convert.Converter;
import org.dromara.hutool.core.exception.HutoolException;
import org.dromara.hutool.core.lang.Assert;
import org.dromara.hutool.core.map.MapUtil;
@ -333,43 +334,23 @@ public class FieldUtil {
* @param value 类型不匹配会自动转换对象类型
* @throws HutoolException UtilException 包装IllegalAccessException异常
*/
public static void setFieldValue(final Object obj, final Field field, Object value) throws HutoolException {
Assert.notNull(field, "Field in [{}] not exist !", obj);
// 值类型检查和转换
final Class<?> fieldType = field.getType();
if (null != value) {
if (!fieldType.isAssignableFrom(value.getClass())) {
//对于类型不同的字段尝试转换转换失败则使用原对象类型
final Object targetValue = ConvertUtil.convert(fieldType, value);
if (null != targetValue) {
value = targetValue;
}
}
} else {
// 获取null对应默认值防止原始类型造成空指针问题
value = ClassUtil.getDefaultValue(fieldType);
}
setFieldValueExact(obj, field, value);
public static void setFieldValue(final Object obj, final Field field, final Object value) throws HutoolException {
setFieldValue(obj, field, value, CompositeConverter.getInstance());
}
/**
* 设置字段值传入的字段值必须和字段类型一致否则抛出异常
* 设置字段值如果值类型必须与字段类型匹配会自动转换对象类型
*
* @param obj 对象如果是static字段此参数为null
* @param field 字段
* @param value 值类型必须与字段类型匹配
* @param value 类型不匹配会自动转换对象类型
* @param converter 转换器用于转换给定value为字段类型{@code null}表示不转换
* @throws HutoolException UtilException 包装IllegalAccessException异常
*/
public static void setFieldValueExact(final Object obj, final Field field, final Object value) throws HutoolException {
ReflectUtil.setAccessible(field);
try {
field.set(obj instanceof Class ? null : obj, value);
} catch (final IllegalAccessException e) {
throw new HutoolException(e, "IllegalAccess for [{}.{}]", null == obj ? field.getDeclaringClass() : obj, field.getName());
}
}
public static void setFieldValue(final Object obj, final Field field, final Object value, final Converter converter) throws HutoolException {
Assert.notNull(field, "Field in [{}] not exist !", obj);
FieldInvoker.of(field).setConverter(converter).invokeSet(obj, value);
}
// endregion
}