cn.easyproject.easycommons.objectutils.EasyObjectExtract Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of easycommons-object Show documentation
Obejct object manipulation components: extraction of the object, JaveBean Object property filtering, Object Properties empty.
The newest version!
package cn.easyproject.easycommons.objectutils;

import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * EasyCommons 项目下的 Obejct 对象操作工具类

 * EasyObjectExtract：对象抽取。 从对象中使用字段表达式(FieldExpression)抽取指定属性以 key-value
 * 存入Map集合。

 * 适合场景：JSON输出时，从对象中抽取指定输出属性和值。

 * 
 * FieldExpression 语法：

 * 指定属性： property

 * 指定属性的属性：property.property

 * 指定集合中每一个对象： {collection}

 * 指定数组中每一个对象： [array]

 * 指定集合中每一个对象的属性：{collection}.property

 * 指定数组中每一个对象的属性：[array].property

 * 
 * @author easyproject.cn
 * @version 1.7.4
 * 
 */
@SuppressWarnings({ "rawtypes", "unchecked" })
public class EasyObjectExtract {

	/**
	 * 从对象中抽取指定属性以 key-value 存入Map集合
	 * 
	 * @param objCollection 对象集合
	 * @param fieldExpressionAndOutNameMap 字段表达式和输出别名的映射列表，可选，默认字段表达式名作为输出名
	 * @param fieldExpressions 要抽取的字段表达式列表，不定参，区分大小写；支持#号分隔的别名定义
	 * @return 以List返回所有抽取的Map集合
	 */
	public static List extract(Collection objCollection, Map fieldExpressionAndOutNameMap, String... fieldExpressions) {
		List list = new ArrayList();
		// 表达式输出别名Map初始化
		getFieldExpressionAliasMap(fieldExpressionAndOutNameMap, fieldExpressions);
		for (Object o : objCollection) {
			list.add(extract(o,fieldExpressionAndOutNameMap, fieldExpressions));
		}
		return list;
	}

	/**
	 * 从对象中抽取指定属性以 key-value 存入Map集合
	 * 
	 * @param objCollection
	 *            对象集合
	 * @param fieldExpressions
	 *            要抽取的字段表达式列表，不定参，区分大小写；支持#号分隔的别名定义
	 * @return 以List返回所有抽取的Map集合
	 */
	public static List extract(Collection objCollection, String... fieldExpressions) {
		List list = new ArrayList();
		// 表达式输出别名Map初始化
		Map fieldExpressionAndOutNameMap=new HashMap();
		getFieldExpressionAliasMap(fieldExpressionAndOutNameMap, fieldExpressions);
				
		for (Object o : objCollection) {
			list.add(extract(o,fieldExpressionAndOutNameMap, fieldExpressions));
		}
		return list;
	}

	/**
	 * 从对象中抽取指定属性以 key-value 存入Map集合
	 * 
	 * @param o 对象
	 * @param fieldExpressionAndOutNameMap 字段表达式和输出别名的映射列表，可选，默认字段表达式名作为输出名
	 * @param fieldExpressions 要抽取的字段表达式列表，不定参，区分大小写；支持#号分隔的别名定义
	 * @return 抽取的Map集合
	 */
	public static Map extract(Object o,
			Map fieldExpressionAndOutNameMap,
			String... fieldExpressions) {
		// 表达式输出别名Map初始化
		getFieldExpressionAliasMap(fieldExpressionAndOutNameMap, fieldExpressions);
		
		Map map = new HashMap();

		if (fieldExpressionAndOutNameMap != null) {
			for (String name : fieldExpressions) {
				map.put(getKey(fieldExpressionAndOutNameMap, name),
						extractFieldExpressionsValue(o, name));
			}
		} else {
			for (String name : fieldExpressions) {
				map.put(name, extractFieldExpressionsValue(o, name));
			}
		}

		return map;
	}

	/**
	 * 从对象中抽取指定属性以 key-value 存入Map集合
	 * 
	 * @param o
	 *            对象
	 * @param fieldExpressions
	 *            要抽取的字段表达式列表，不定参，区分大小写；支持#号分隔的别名定义
	 * @return 抽取的Map集合
	 */
	public static Map extract(Object o, String... fieldExpressions) {
		// 表达式输出别名Map初始化
		Map fieldExpressionAndOutNameMap=new HashMap();
		getFieldExpressionAliasMap(fieldExpressionAndOutNameMap, fieldExpressions);
				
		return extract(o, fieldExpressionAndOutNameMap, fieldExpressions);
	}

	/**
	 * 从对象中抽取指定属性以 key-value 存入Map集合
	 * 
	 * @param array 对象数组
	 * @param fieldExpressionAndOutNameMap 字段表达式和输出别名的映射列表，可选，默认字段表达式名作为输出名
	 * @param fieldExpressions 要抽取的字段表达式列表，不定参，区分大小写；支持#号分隔的别名定义
	 * @return 以List返回所有抽取的Map集合
	 */
	public static List extract(Object[] array, Map fieldExpressionAndOutNameMap, String... fieldExpressions) {
		List list = new ArrayList();
		// 表达式输出别名Map初始化
		getFieldExpressionAliasMap(fieldExpressionAndOutNameMap, fieldExpressions);
				
		for (Object o : array) {
			list.add(extract(o,fieldExpressionAndOutNameMap, fieldExpressions));
		}
		return list;
	}
	/**
	 * 从对象中抽取指定属性以 key-value 存入Map集合
	 * 
	 * @param objArray
	 *            对象数组
	 * @param fieldExpressions
	 *            要抽取的字段表达式列表，不定参，区分大小写；支持#号分隔的别名定义
	 * @return 以List返回所有抽取的Map集合
	 */
	public static List extract(Object[] objArray, String... fieldExpressions) {
		List list = new ArrayList();
		// 表达式输出别名Map初始化
		Map fieldExpressionAndOutNameMap=new HashMap();
		getFieldExpressionAliasMap(fieldExpressionAndOutNameMap, fieldExpressions);
				
		for (Object o : objArray) {
			list.add(extract(o, fieldExpressionAndOutNameMap, fieldExpressions));
		}
		return list;
	}
	/**
	 * ExtractObject 内部使用，提取指定字段表达式的值
	 * 
	 * @param o 对象
	 * @param fieldExpression 字段表达式
	 * @return 从字段表达式抽取到的值
	 */
	private static Object extractFieldExpressionsValue(Object o,
			String fieldExpression) {
		Class c = o.getClass();
		Object value = null;
		fieldExpression = fieldExpression.trim();

		if (fieldExpression.indexOf(".") != -1) {

			String parentFields = fieldExpression.substring(0,
					fieldExpression.indexOf("."));
			String sonFields = fieldExpression.substring(fieldExpression
					.indexOf(".") + 1);

			if ((parentFields.startsWith("{") && parentFields.endsWith("}"))
					|| (parentFields.startsWith("[") && parentFields
							.endsWith("]"))) {
				// 集合属性
				if (parentFields.startsWith("{")) {

					parentFields = parentFields.replace("{", "")
							.replace("}", "").trim();
					List