gson序列化的时候,排除字段工具类

/**
涉及所需要字段的方法,排除字段的方法,并调用相对应的方法输出json格式的数据:如下所示
*/
第一步:
GsonUtils.java
package cn.itcast.oa.util;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonObject;
import org.apache.commons.io.IOUtils;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.security.InvalidParameterException;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
 * gson的工具类
 *
 * @author miles
 */
public class GsonUtils {
    /**
     * 将一个对象转成json字符串
     *
     * @param obj
     * @return
     */
    public static String toJson(Object obj) {
        return toJsonExclude(obj);
    }
    /**
     * 将一个对象转成json字符串并指定需要排除的属性名称列表
     * 如果没有指定属性名称集合,则将会全部转换
     * 默认时间会以时间戳的格式进行转换
     *
     * @param obj
     * @param exclusionFields
     * @return String
     */
    public static String toJsonExclude(Object obj, String... exclusionFields) {
        validateJsonObject(obj);
        //创建GsonBuilder
        GsonBuilder builder = new GsonBuilder();
        //设置时间格式
        builder.registerTypeAdapter(Date.class, new DateConverter());
        //设置需要被排除的属性列表
        if (exclusionFields != null && exclusionFields.length > 0) {
            GsonExclusion gsonFilter = new GsonExclusion();
            gsonFilter.addExclusionField(exclusionFields);
            builder.setExclusionStrategies(gsonFilter);
        }
        //创建Gson并进行转换
        Gson gson = builder.create();
        return gson.toJson(obj);
    }
    /**
     * 将一个对象转成json字符串并指定需要需要转换的属性名称列表
     * 如果没有指定属性名称集合,则将会全部转换
     * 默认时间会以yyyy-MM-dd HH:mm:ss的格式进行转换
     *
     * @param obj
     * @param includeFields
     * @return
     */
    public static String toJsonInclude(Object obj, String... includeFields) {
        validateJsonObject(obj);
        //创建GsonBuilder
        GsonBuilder builder = new GsonBuilder();
        //设置时间格式
        builder.registerTypeAdapter(Date.class, new DateConverter());
        //设置需要转换的属性名称
        if (includeFields != null && includeFields.length > 0) { 
            GsonInclusion gsonFilter = new GsonInclusion();
            gsonFilter.addInclusionFields(includeFields);
            builder.setExclusionStrategies(gsonFilter);
        }
        //创建Gson并进行转换
        Gson gson = builder.create();
        String json = gson.toJson(obj);
        System.out.println("json;;;;"+json);
        return json;
    }

    /**
     * 通过response输出json数据
     *
     * @param response HttpServletResponse对象
     * @param json     json字符串
     */
    public static void printJson(HttpServletResponse response, String json) {
        PrintWriter writer = null;
        try {
            response.setContentType("application/json");
            writer = response.getWriter();
            writer.print(json);
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (writer != null) {
                writer.close();
            }
        }
    }
    public static Map convertJson2Map(String json) {
        if (json == null) return null;
        Gson gson = new GsonBuilder().create();
        return gson.fromJson(json, HashMap.class);
    }
    public static void printJson(HttpServletResponse response, String key, String value) {
        JsonObject jsonObject = new JsonObject();
        jsonObject.addProperty(key, value);
        printJson(response, jsonObject.toString());
    }
    /**
     * 将一个集合转成{data:[]}形式的对象
     *
     * @param response
     * @param data
     */
    public static void printCollectionJson(HttpServletResponse response, List data, String... includes) {
        String json = toCollectionJson(data, includes);
        printJson(response, json);
    }
    /**
     * 将一个集合转成{data:[]}形式的字符串
     *
     * @param data
     * @return
     */
    public static String toCollectionJson(List data, String... includes) {
        Map map = new HashMap();
        map.put("data", data);
        return toJsonInclude(map, includes);
    }
    public static void printJson(HttpServletResponse response, String key, Integer value) {
        JsonObject jsonObject = new JsonObject();
        jsonObject.addProperty(key, value);
        printJson(response, jsonObject.toString());
    }
    public static void printJson(HttpServletResponse response, String key, Float value) {
        JsonObject jsonObject = new JsonObject();
        jsonObject.addProperty(key, value);
        printJson(response, jsonObject.toString());
    }
    public static void printJson(HttpServletResponse response, String key, Double value) {
        JsonObject jsonObject = new JsonObject();
        jsonObject.addProperty(key, value);
        printJson(response, jsonObject.toString());
    }
    public static void printJson(HttpServletResponse response, String key, Boolean value) {
        JsonObject jsonObject = new JsonObject();
        jsonObject.addProperty(key, value);
        printJson(response, jsonObject.toString());
    }
    /**
     * 通过response输出json数据
     *
     * @param response HttpServletResponse对象
     * @param obj      object
     */
    public static void printJsonObject(HttpServletResponse response, Object obj) {
        if (obj == null) return;
        if (obj instanceof String) {
            printJson(response, (String) obj);
            return;
        }
        String json = toJson(obj);
        printJson(response, json);
    }
    public static void printError(HttpServletResponse response, String reason) {
        JsonObject jsonObject = new JsonObject();
        jsonObject.addProperty("error", reason);
        printJson(response, jsonObject.toString());
    }
    private static void validateJsonObject(Object obj) {
        if (obj == null) {
            throw new NullPointerException("要转成json的对象不能为空!");
        }
        if (obj instanceof String || obj instanceof Number || obj instanceof Boolean) {
            throw new RuntimeException("要转成json字符串的必须是复杂(引用)类型的对象!");
        }
    }
    /**
     * 从request body中取出数据流(json字符串),并进行utf-8转码后,使用Gson转换成指定类型的对象
     * 如果request、clazz为空,则抛出异常
     *
     * @param request                  包含请求体的request对象
     * @param clazz                    要转成的对象的类型
     * @param excludeFields(可选,要排除的字段)
     * @param 
     * @return clazz指定的类型
     */
    public static  T wrapDataToEntity(HttpServletRequest request, Class clazz, String... excludeFields) {
        if (request == null || clazz == null) {
            throw new InvalidParameterException("参数不能为空!");
        }
        String data = null;
        try {
            data = IOUtils.toString(request.getInputStream(), "utf-8");
        } catch (IOException e) {
            e.printStackTrace();
        }
        GsonBuilder builder = new GsonBuilder();
        builder.registerTypeAdapter(Date.class, new DateConverter());
        //要排除的字段
        if (excludeFields != null && excludeFields.length > 0) {
            GsonExclusion exclusions = new GsonExclusion();
            exclusions.addExclusionField(excludeFields);
            builder.setExclusionStrategies(exclusions);
        }
        Gson gson = builder.create();
        T entity = gson.fromJson(data, clazz);
        return entity;
    }
    public static void printSuccess(HttpServletResponse response) {
        printJson(response, "success", true);
    }
}
第二步,方法的调用如下所示
 
 /**
  * 根据条件查询所有符合条件的菜单,并组装成树,返回
  */
 public String jsonQuery() {
  String id=this.getRequest().getParameter("id");
 
  
  
  
  List regions=regionService.jsonQuery(id);
  
  //this.getRequest().setAttribute("regions", regions);
        //GsonUtils.printJson(getResponse(), GsonUtils.toJsonInclude(regions, "id", "name", "isParent"));
  String json = GsonUtils.toJsonInclude(regions, "id","name","children","path","open");
  System.out.println("jsonAction:"+json);
  GsonUtils.printJson(getResponse(), json);
  
  return null;
  
 }

你可能感兴趣的:(gson序列化的时候,排除字段工具类)