Json排除指定字段小工具

最新推荐文章于 2024-07-04 18:31:45 发布

到中流遏飞舟

最新推荐文章于 2024-07-04 18:31:45 发布

阅读量281

点赞数

分类专栏： Java 文章标签： json java 开发语言

本文链接：https://blog.csdn.net/qq_38746380/article/details/121213235

版权

Java JSON 序列化注解字段排除

关键词由CSDN通过智能技术生成

Java 专栏收录该内容

33 篇文章 3 订阅

订阅专栏

json 时排除指定字段小工具1.0

demo:

	public static void main(String[] args) {
		TestJsonBean test = new TestJsonBean();
        Object s1 = objs2JsonExcludeField(test);
        System.out.println(s1);
    }

测试类：

import com.biligame.access.annotaition.ExcludeField;

import java.util.HashMap;

public class TestJsonBean {

    private int field1 = 1;

	/**
	 * 排除此字段
	 */
    @ExcludeField
    private String str1 = "123";

    private HashMap<Integer, Integer> map = new HashMap<>();

    {
        map.put(1, 1);
        map.put(2, 2);
    }


    public int getField1() {
        return field1;
    }

    public void setField1(int field1) {
        this.field1 = field1;
    }

    public String getStr1() {
        return str1;
    }

    public void setStr1(String str1) {
        this.str1 = str1;
    }

    public HashMap<Integer, Integer> getMap() {
        return map;
    }

    public void setMap(HashMap<Integer, Integer> map) {
        this.map = map;
    }
}

输出结果：

在这里插入图片描述

具体实现：

/**
 * @Author: xuanyu.liu
 * @Date: 2021/11/5 20:57
 * @Description: json时排除此字段
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ExcludeField {
    boolean isExclude() default true;
}

	/**
     * 外部调用的方法
     * @param object
     * @return
     * @throws IllegalAccessException
     */
    public static String obj2JsonUseExclude(Object object) throws IllegalAccessException {
        Object o = objs2JsonExcludeField(object);
        String resStr = null;
        if (o instanceof JSONArray) {
            JSONArray jsonArray = (JSONArray) o;
            resStr = jsonArray.toJSONString();
        } else {
            JSONObject jsonObject = (JSONObject) o;
            resStr = jsonObject.toJSONString();
        }
        return resStr;
    }
    /**
     * 1. 判断类型 list  or map(obj)  构建JSONArray  or JSONObject
     * 2. 如果存在子类型， 判断子类型，list or map  构建JSONArray  or JSONObject
     * 3. 判断exclude 标签
     * @param object
     * @return
     */
    private static Object objs2JsonExcludeField(Object object) throws IllegalAccessException {
        Object returnObj = null;
        if (object instanceof List) {
            JSONArray jsonArray = new JSONArray();
            List list = (List)object;
            for (Object obj : list) {
                Object s = objs2JsonExcludeField(obj);
                jsonArray.add(s);
            }
            returnObj = jsonArray;
        } else if (object instanceof Map) {
            returnObj = buildJsonObjByMap(object);
        } else {
            returnObj = buildJsonByObj(object);
        }

        return returnObj;
    }

    /**
     * 传入obj , 转出JSON
     * @param obj
     * @return
     * @throws IllegalAccessException
     */
    private static Object buildJsonByObj(Object obj) throws IllegalAccessException {
        JSONObject jsonObject = new JSONObject();
        Field[] fields = obj.getClass().getDeclaredFields();
        for (Field f : fields) {
            f.setAccessible(true);
            ExcludeField excludeField = f.getAnnotation(ExcludeField.class);
            if (excludeField != null) {
                continue;
            }
            // 如果这个值是List 格式
            Object o = f.get(obj);
            Object sub = buildSubJsonObj(o);
            jsonObject.put(f.getName(), sub);
        }
        return jsonObject;
    }

    /**
     * 传入map , 转出JSON， 第一版只支持 String key
     * @param obj
     * @return
     * @throws IllegalAccessException
     */
    private static Object buildJsonObjByMap(Object obj) throws IllegalAccessException {
        JSONObject jsonObject = new JSONObject();
        Map map = (Map) obj;
        Iterator iterator = map.keySet().iterator();
        while (iterator.hasNext()) {
            // 只支持String key
            Object next = iterator.next();
            Object valObj = map.get(next);
            Object subValObj = buildSubJsonObj(valObj);
            jsonObject.put(String.valueOf(next), subValObj);

        }
        return jsonObject;
    }

    /**
     * 构建子JSON obj对象
     * @param obj
     * @return
     * @throws IllegalAccessException
     */
    private static Object buildSubJsonObj(Object obj) throws IllegalAccessException {
        boolean isBaseType = false;
        try {
            isBaseType = ((Class) obj.getClass().getField("TYPE").get(null)).isPrimitive();
        } catch (NoSuchFieldException e) {
            isBaseType = false;
        }
        boolean isOtherType = obj instanceof String;
        // 基础类型 或者其他指定类型
        if (isBaseType || isOtherType) {
            return obj;
        }
        // 其他的
        Object returnObj = objs2JsonExcludeField(obj);
        return returnObj;
    }