org.yelong.support.json.gson.ClassExclusionStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yelong-support Show documentation

对各种开源框架的包装、支持、拓展。这里也包含的yelong-core与orm框架的整合。默认对所有依赖为 scope 为 provided 。您需要针对自己的需要进行再次依赖

There is a newer version: 2.2.0

/**
 * 
 */
package org.yelong.support.json.gson;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.google.gson.ExclusionStrategy;
import com.google.gson.FieldAttributes;

/**
 * Gson 排除策略
 * 
 * @author PengFei
 * @since 1.0.0
 */
public class ClassExclusionStrategy implements ExclusionStrategy {

	private final List> ignoreClasss = new ArrayList<>();

	private final Map, List> ignoreClassFields = new HashMap<>();

	private List> onlyOperationClasss = new ArrayList<>();

	private Map, List> onlyOperationClassFields = new HashMap<>();

	/**
	 * 添加忽略的类
	 * 
	 * @param classes 忽略的类
	 * @return this
	 */
	public ClassExclusionStrategy addIgnoreClasss(Class... classes) {
		this.ignoreClasss.addAll(Arrays.asList(classes));
		return this;
	}

	/**
	 * 添加忽略的类的属性。 如果这个类已经被忽略({@link #addIgnoreClass(Class...)}，那么将不起作用
	 * 
	 * @param classes    忽略的类
	 * @param fieldNames 忽略类中的属性
	 * @return this
	 */
	public ClassExclusionStrategy addIgnoreClassFields(Class c, String... fieldNames) {
		this.ignoreClassFields.put(c, Arrays.asList(fieldNames));
		return this;
	}

	/**
	 * 设置只操作的类型 设置之后忽略的类将不起作用，已只操作的类型为准
	 * 
	 * @param classes 只操作的类
	 * @return this
	 */
	public ClassExclusionStrategy addOnlyOperationClasss(Class... classes) {
		onlyOperationClasss.addAll(Arrays.asList(classes));
		return this;
	}

	/**
	 * 添加只操作的类型属性。 如果这个类型不存在只操作的类型中将不起作用。
	 * 如果这个类已经被忽略({@link #addIgnoreClass(Class...)}，那么将不起作用
	 * 
	 * @param classes    只操作的类
	 * @param fieldNames 只操作类的属性
	 * @return this
	 */
	public ClassExclusionStrategy addOnlyOperationClassFields(Class c, String... fieldNames) {
		this.onlyOperationClassFields.put(c, Arrays.asList(fieldNames));
		return this;
	}

	@Override
	public boolean shouldSkipField(FieldAttributes f) {
		if (this.onlyOperationClassFields.containsKey(f.getDeclaringClass())) {
			List fieldList = this.onlyOperationClassFields.get(f.getDeclaringClass());
			if (null == fieldList) {
				return false;
			}
			return !fieldList.contains(f.getName());
		} else {
			List fieldList = ignoreClassFields.get(f.getDeclaringClass());
			if (null == fieldList) {
				return false;
			}
			return fieldList.contains(f.getName());
		}
	}

	@Override
	public boolean shouldSkipClass(Class clazz) {
		if (onlyOperationClasss.isEmpty()) {
			return this.ignoreClasss.contains(clazz);
		} else {
			return !this.onlyOperationClasss.contains(clazz);
		}
	}

}