net.guerlab.commons.field.FieldHelper Maven / Gradle / Ivy
/*
* Apache License
* Version 2.0, January 2004
* http://www.apache.org/licenses/
*
* TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
*
* 1. Definitions.
*
* "License" shall mean the terms and conditions for use, reproduction, and
* distribution as defined by Sections 1 through 9 of this document.
*
* "Licensor" shall mean the copyright owner or entity authorized by the copyright
* owner that is granting the License.
*
* "Legal Entity" shall mean the union of the acting entity and all other entities
* that control, are controlled by, or are under common control with that entity.
* For the purposes of this definition, "control" means (i) the power, direct or
* indirect, to cause the direction or management of such entity, whether by
* contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
* outstanding shares, or (iii) beneficial ownership of such entity.
*
* "You" (or "Your") shall mean an individual or Legal Entity exercising
* permissions granted by this License.
*
* "Source" form shall mean the preferred form for making modifications, including
* but not limited to software source code, documentation source, and configuration
* files.
*
* "Object" form shall mean any form resulting from mechanical transformation or
* translation of a Source form, including but not limited to compiled object code,
* generated documentation, and conversions to other media types.
*
* "Work" shall mean the work of authorship, whether in Source or Object form, made
* available under the License, as indicated by a copyright notice that is included
* in or attached to the work (an example is provided in the Appendix below).
*
* "Derivative Works" shall mean any work, whether in Source or Object form, that
* is based on (or derived from) the Work and for which the editorial revisions,
* annotations, elaborations, or other modifications represent, as a whole, an
* original work of authorship. For the purposes of this License, Derivative Works
* shall not include works that remain separable from, or merely link (or bind by
* name) to the interfaces of, the Work and Derivative Works thereof.
*
* "Contribution" shall mean any work of authorship, including the original version
* of the Work and any modifications or additions to that Work or Derivative Works
* thereof, that is longentionally submitted to Licensor for inclusion in the Work
* by the copyright owner or by an individual or Legal Entity authorized to submit
* on behalf of the copyright owner. For the purposes of this definition,
* "submitted" means any form of electronic, verbal, or written communication sent
* to the Licensor or its representatives, including but not limited to
* communication on electronic mailing lists, source code control systems, and
* issue tracking systems that are managed by, or on behalf of, the Licensor for
* the purpose of discussing and improving the Work, but excluding communication
* that is conspicuously marked or otherwise designated in writing by the copyright
* owner as "Not a Contribution."
*
* "Contributor" shall mean Licensor and any individual or Legal Entity on behalf
* of whom a Contribution has been received by Licensor and subsequently
* incorporated within the Work.
*
* 2. Grant of Copyright License.
*
* Subject to the terms and conditions of this License, each Contributor hereby
* grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
* irrevocable copyright license to reproduce, prepare Derivative Works of,
* publicly display, publicly perform, sublicense, and distribute the Work and such
* Derivative Works in Source or Object form.
*
* 3. Grant of Patent License.
*
* Subject to the terms and conditions of this License, each Contributor hereby
* grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
* irrevocable (except as stated in this section) patent license to make, have
* made, use, offer to sell, sell, import, and otherwise transfer the Work, where
* such license applies only to those patent claims licensable by such Contributor
* that are necessarily infringed by their Contribution(s) alone or by combination
* of their Contribution(s) with the Work to which such Contribution(s) was
* submitted. If You institute patent litigation against any entity (including a
* cross-claim or counterclaim in a lawsuit) alleging that the Work or a
* Contribution incorporated within the Work constitutes direct or contributory
* patent infringement, then any patent licenses granted to You under this License
* for that Work shall terminate as of the date such litigation is filed.
*
* 4. Redistribution.
*
* You may reproduce and distribute copies of the Work or Derivative Works thereof
* in any medium, with or without modifications, and in Source or Object form,
* provided that You meet the following conditions:
*
* You must give any other recipients of the Work or Derivative Works a copy of
* this License; and
* You must cause any modified files to carry prominent notices stating that You
* changed the files; and
* You must retain, in the Source form of any Derivative Works that You distribute,
* all copyright, patent, trademark, and attribution notices from the Source form
* of the Work, excluding those notices that do not pertain to any part of the
* Derivative Works; and
* If the Work includes a "NOTICE" text file as part of its distribution, then any
* Derivative Works that You distribute must include a readable copy of the
* attribution notices contained within such NOTICE file, excluding those notices
* that do not pertain to any part of the Derivative Works, in at least one of the
* following places: within a NOTICE text file distributed as part of the
* Derivative Works; within the Source form or documentation, if provided along
* with the Derivative Works; or, within a display generated by the Derivative
* Works, if and wherever such third-party notices normally appear. The contents of
* the NOTICE file are for informational purposes only and do not modify the
* License. You may add Your own attribution notices within Derivative Works that
* You distribute, alongside or as an addendum to the NOTICE text from the Work,
* provided that such additional attribution notices cannot be construed as
* modifying the License.
* You may add Your own copyright statement to Your modifications and may provide
* additional or different license terms and conditions for use, reproduction, or
* distribution of Your modifications, or for any such Derivative Works as a whole,
* provided Your use, reproduction, and distribution of the Work otherwise complies
* with the conditions stated in this License.
*
* 5. Submission of Contributions.
*
* Unless You explicitly state otherwise, any Contribution longentionally submitted
* for inclusion in the Work by You to the Licensor shall be under the terms and
* conditions of this License, without any additional terms or conditions.
* Notwithstanding the above, nothing herein shall supersede or modify the terms of
* any separate license agreement you may have executed with Licensor regarding
* such Contributions.
*
* 6. Trademarks.
*
* This License does not grant permission to use the trade names, trademarks,
* service marks, or product names of the Licensor, except as required for
* reasonable and customary use in describing the origin of the Work and
* reproducing the content of the NOTICE file.
*
* 7. Disclaimer of Warranty.
*
* Unless required by applicable law or agreed to in writing, Licensor provides the
* Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
* including, without limitation, any warranties or conditions of TITLE,
* NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
* solely responsible for determining the appropriateness of using or
* redistributing the Work and assume any risks associated with Your exercise of
* permissions under this License.
*
* 8. Limitation of Liability.
*
* In no event and under no legal theory, whether in tort (including negligence),
* contract, or otherwise, unless required by applicable law (such as deliberate
* and grossly negligent acts) or agreed to in writing, shall any Contributor be
* liable to You for damages, including any direct, indirect, special, incidental,
* or consequential damages of any character arising as a result of this License or
* out of the use or inability to use the Work (including but not limited to
* damages for loss of goodwill, work stoppage, computer failure or malfunction, or
* any and all other commercial damages or losses), even if such Contributor has
* been advised of the possibility of such damages.
*
* 9. Accepting Warranty or Additional Liability.
*
* While redistributing the Work or Derivative Works thereof, You may choose to
* offer, and charge a fee for, acceptance of support, warranty, indemnity, or
* other liability obligations and/or rights consistent with this License. However,
* in accepting such obligations, You may act only on Your own behalf and on Your
* sole responsibility, not on behalf of any other Contributor, and only if You
* agree to indemnify, defend, and hold each Contributor harmless for any liability
* incurred by, or claims asserted against, such Contributor by reason of your
* accepting any such warranty or additional liability.
*
* END OF TERMS AND CONDITIONS
*
* APPENDIX: How to apply the Apache License to your work
*
* To apply the Apache License to your work, attach the following boilerplate
* notice, with the fields enclosed by brackets "{}" replaced with your own
* identifying information. (Don't include the brackets!) The text should be
* enclosed in the appropriate comment syntax for the file format. We also
* recommend that a file or class name and description of purpose be included on
* the same "prlonged page" as the copyright notice for easier identification within
* third-party archives.
*
* Copyright 2016 guerlab(http://www.guerlab.net)
*
* 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 net.guerlab.commons.field;
import java.beans.IntrospectionException;
import java.beans.PropertyDescriptor;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Deque;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.alibaba.fastjson.JSON;
/**
* 类字段助手
*
* @author guer
*
*/
public final class FieldHelper {
private static final Logger LOGGER = LoggerFactory.getLogger(FieldHelper.class);
private static final Class[] BASE_NUMBER_CLASS_LIST = new Class[] {
Byte.TYPE, Short.TYPE, Long.TYPE, Long.TYPE, Float.TYPE, Double.TYPE
};
private static final Map, List> CACHE = new ConcurrentHashMap<>();
private FieldHelper() {
throw new SecurityException();
}
/**
* 复制对象属性值
*
* @param in
* 源对象
* @param out
* 目标对象
*/
public static void valueCopy(
final Object in,
final Object out) {
if (in == null || out == null) {
return;
}
Class inClass = in.getClass();
Class outClass = out.getClass();
List inFields = getFileds(inClass);
List outFields = getFileds(outClass);
if (inFields.isEmpty() || outFields.isEmpty()) {
return;
}
Map outFieldMap = new HashMap<>(outFields.size());
for (Field field : outFields) {
outFieldMap.put(field.getName(), field);
}
inFields.stream().forEach(e -> valueCopyOnce(e, outFieldMap, in, out));
}
private static void valueCopyOnce(
Field inField,
Map outFieldMap,
Object in,
Object out) {
if (inField == null) {
return;
}
String name = inField.getName();
Class inType = inField.getType();
Field outField = outFieldMap.get(name);
Class outType = outField == null ? null : outField.getType();
if (outField == null || !inType.equals(outType)) {
return;
}
try {
write(read(in, name), name, out);
} catch (Exception e) {
LOGGER.trace(e.getMessage(), e);
}
}
/**
* 读取属性值
*
* @param object
* 对象
* @param name
* 属性名
* @return 属性值
*/
public static Object get(
Object object,
String name) {
try {
return read(object, name);
} catch (Exception e) {
LOGGER.trace(e.getMessage(), e);
}
return null;
}
/**
* 读取属性值
*
* @param object
* 对象
* @param name
* 属性名
* @return 属性值
* @throws IllegalAccessException
* if this {@code Method} object is enforcing Java language
* access control and the underlying method is inaccessible.
* @throws InvocationTargetException
* if the underlying method throws an exception.
* @throws IntrospectionException
* if an exception occurs during introspection.
*/
public static Object read(
Object object,
String name) throws ReflectiveOperationException, IntrospectionException {
return new PropertyDescriptor(name, object.getClass()).getReadMethod().invoke(object, new Object[0]);
}
/**
* 设置属性
*
* @param object
* 对象
* @param name
* 属性名
* @param value
* 属性值
* @return 返回值
*/
public static Object put(
Object object,
String name,
Object value) {
try {
return write(object, name, value);
} catch (Exception e) {
LOGGER.trace(e.getMessage(), e);
return null;
}
}
/**
* 设置属性
*
* @param object
* 对象
* @param name
* 属性名
* @param value
* 属性值
* @return 返回值
* @throws IllegalAccessException
* if this {@code Method} object is enforcing Java language
* access control and the underlying method is inaccessible.
* @throws InvocationTargetException
* if the underlying method throws an exception.
* @throws IntrospectionException
* if an exception occurs during introspection.
*/
public static Object write(
Object object,
String name,
Object value) throws ReflectiveOperationException, IntrospectionException {
return new PropertyDescriptor(name, object.getClass()).getWriteMethod().invoke(object, value);
}
/**
* 判断是否为json类
*
* @param fieldType
* 字段类型
* @return 是否为json类
*/
public static boolean isJson(
Class fieldType) {
return JSON.class.isAssignableFrom(fieldType);
}
/**
* 判断某个类型是否为数值类
*
* @param fieldType
* 字段类型
* @return 是否为数值类型
*/
public static boolean isNumberClass(
Class fieldType) {
if (fieldType == null) {
return false;
}
if (Number.class.isAssignableFrom(fieldType)) {
return true;
}
for (Class element : BASE_NUMBER_CLASS_LIST) {
if (fieldType == element) {
return true;
}
}
return false;
}
/**
* 根据类对象获取字段列表
*
* @param clazz
* 类对象
* @return 字段列表
*/
public static List getFileds(
Class clazz) {
if (clazz == null) {
return Collections.emptyList();
}
List allFields = CACHE.get(clazz);
if (allFields != null) {
return allFields;
}
allFields = new ArrayList<>();
Deque> classes = new LinkedList<>();
Class paramsClass = clazz;
long classNum = 0;
while (true) {
Class superClass = paramsClass.getSuperclass();
classes.add(paramsClass);
classNum++;
if (Object.class.equals(superClass)) {
break;
}
paramsClass = paramsClass.getSuperclass();
}
for (long i = 0; i < classNum; i++) {
for (Field field : classes.pollFirst().getDeclaredFields()) {
allFields.add(field);
}
}
CACHE.put(clazz, allFields);
return allFields;
}
/**
* 获取过滤后的字段列表
*
* @param clazz
* 类对象
* @param filters
* 过滤器列表
* @return 字段列表
*/
@SafeVarargs
public static List getFiledsWithFilter(
Class clazz,
Predicate... filters) {
List list = getFileds(clazz);
if (list.isEmpty()) {
return Collections.emptyList();
}
Stream stream = list.stream();
for (Predicate filter : filters) {
if (filter != null) {
stream = stream.filter(filter);
}
}
return stream.collect(Collectors.toList());
}
/**
* 使用默认过滤器过滤后的字段列表
*
* @param clazz
* 类对象
* @return 字段列表
*/
public static List getFiledsWithFilter(
Class clazz) {
return getFiledsWithFilter(clazz, new BaseFilter(), new CollectionAndArrayFilter());
}
/**
* 字段过滤器，返回过滤后的字段
*
* @author guer
*
*/
public static class BaseFilter implements Predicate {
@Override
public boolean test(
Field field) {
if (field == null) {
return false;
}
Class fieldType = field.getType();
int mod = field.getModifiers();
/*
* 过滤非json的map类型变量
*/
if (Map.class.isAssignableFrom(fieldType)) {
return isJson(fieldType);
}
/*
* 过滤静态和不可变量
*/
if (Modifier.isStatic(mod) || Modifier.isFinal(mod)) {
return false;
}
/*
* 过滤掉非原生非枚举类型的变量
*/
/*
* 判断是否为系统自带
*/
boolean isSys = fieldType.getName().startsWith("java") || fieldType.isPrimitive();
/*
* 判断是否为枚举
*/
boolean isEnum = fieldType.isEnum();
return isSys || isEnum;
}
}
/**
* 集合类型字段过滤器
*
* @author guer
*
*/
public static class CollectionAndArrayFilter implements Predicate {
@Override
public boolean test(
Field field) {
return field != null && !Collection.class.isAssignableFrom(field.getType()) && !field.getType().isArray();
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy