ObjectMapper使用

文章介绍了ObjectMapper在Java中用于JSON序列化和反序列化的作用,对比了它与fastJson的性能差异。重点讲解了JsonInclude注解的四种模式,如何控制在序列化时忽略特定情况的字段,例如字段为null、空字符串或默认值。并提供了实体类示例和工具类方法来展示如何实际应用这些配置。

ObjectMapper使用

将Java对象序列化和反序列化操作

  1. fastJson
  2. Jackson的ObjectMapper操作
跟fastJson区别
  • fastJson是阿里开发的,利用Java的反射和泛型机制
  • ObjectMapper是jackson开发的,基于流的处理模式,对json字符串进行逐个字符的解析和构建
  • 总体来说,fastjson的性能要比objectMapper更加优秀一点
ObjectMapper操作

特别的是使用JsonInclude注解

  • JsonInclude.Include.ALWAYS:默认值,始终包含该字段。
  • JsonInclude.Include.NON_NULL:如果该字段不为 null,则输出该字段。
  • JsonInclude.Include.NON_EMPTY:如果该字段不为 null 且不为 “”,则输出该字段。
  • JsonInclude.Include.NON_DEFAULT:如果该字段的值与默认值不同,则输出该字段。
实体类带注解
  1. 当实体类中的某个字段为null时,不进行序列化
public class User {
    private Integer id;
    private String name;
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private Integer age;
    // getter and setter methods
}

User user = new User();
user.setId(1);
user.setName("Tom");
// age字段为null
ObjectMapper mapper = new ObjectMapper();
String json = mapper.writeValueAsString(user);
System.out.println(json); // 输出:{"id":1,"name":"Tom"}
  1. 当实体类中的某个字段为空字符串时,不进行序列化
public class User {
    private Integer id;
    private String name;
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    private String email;
    // getter and setter methods
}

User user = new User();
user.setId(1);
user.setName("Tom");
user.setEmail(""); // email字段为空字符串
ObjectMapper mapper = new ObjectMapper();
String json = mapper.writeValueAsString(user);
System.out.println(json); // 输出:{"id":1,"name":"Tom"}

  1. 当实体类中的某个字段为默认值时,不进行序列化
public class User {
    private Integer id;
    private String name;
    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
    private boolean isAdmin;
    // getter and setter methods
}

User user = new User();
user.setId(1);
user.setName("Tom");
// isAdmin字段为false,为boolean类型的默认值
ObjectMapper mapper = new ObjectMapper();
String json = mapper.writeValueAsString(user);
System.out.println(json); // 输出:{"id":1,"name":"Tom"}

实体类不带注解,直接用工具类操作

工具类为:

mapper.setSerializationInclusion(JsonInclude.Include.NON_DEFAULT); ----这个是将所有非默认值输出

mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); --这个是将所有非Null的输出

mapper.setSerializationInclusion(JsonInclude.Include.NON_EMPTY); --这个是将所有的非’'的输出

拿Non_Default举例
  • 假设现在有个Person类
public class Person {
    private String name;
    private int age;
    private boolean isMale;
    private double salary;

    // getter and setter methods
}
  • 用下面代码进行序列化 —结果为{}
ObjectMapper mapper = new ObjectMapper();
mapper.setSerializationInclusion(JsonInclude.Include.NON_DEFAULT);

Person person = new Person();
String json = mapper.writeValueAsString(person);
System.out.println(json);
  • 原因是non_default只会将所有非默认值的属性输出

    • 上面的person类
    • String默认值null
    • int 默认值0
    • boolean默认值false
    • double 默认值0.0
    • 上面代码只有Person person=new Person(); 里面的属性都还是默认值,所有进行non_default的时候,都不会被序列化,只有空串。
  • 现在将类的属性赋值 {“age”:18,“isMale”:true}

Person person = new Person();
person.setName("");
person.setAge(18);
person.setMale(true);
person.setSalary(0.0);

String json = mapper.writeValueAsString(person);
System.out.println(json);


由于name属性的值为null或空字符串,因此被忽略。salary属性的值为0.0,因此也被忽略。只有age和isMale属性的值不为默认值,因此被序列化成了JSON字符串。
ObjectMapper工具类提供
public class JsonMapper {

	private ObjectMapper mapper;

	public JsonMapper() {
		this(null);
	}

	public JsonMapper(JsonInclude.Include include) {
		mapper = new ObjectMapper();
		//设置输出时包含属性的风格
		if (include != null) {
			mapper.setSerializationInclusion(include);
		}
		//设置输入时忽略在JSON字符串中存在但Java对象实际没有的属性
		mapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
	}

	/**
	 * 创建只输出非Null且非Empty(如List.isEmpty)的属性到Json字符串的Mapper,建议在外部接口中使用.
	 */
	public static JsonMapper nonEmptyMapper() {
		return new JsonMapper(JsonInclude.Include.NON_EMPTY);
	}

	/**
	 * 创建只输出初始值被改变的属性到Json字符串的Mapper, 最节约的存储方式,建议在内部接口中使用。
	 */
	public static JsonMapper nonDefaultMapper() {
		return new JsonMapper(JsonInclude.Include.NON_DEFAULT);
	}

	public static JsonMapper defaultMapper() {
		return new JsonMapper(JsonInclude.Include.ALWAYS);
	}

	/**
	 * Object可以是POJO,也可以是Collection或数组。
	 * 如果对象为Null, 返回"null".
	 * 如果集合为空集合, 返回"[]".
	 */
	public String toJson(Object object) {

		try {
			return mapper.writeValueAsString(object);
		} catch (IOException e) {
			System.err.println("write to json string error:" + e);
			return null;
		}
	}

	/**
	 * 反序列化POJO或简单Collection如List<String>.
	 * <p>
	 * 如果JSON字符串为Null或"null"字符串, 返回Null.
	 * 如果JSON字符串为"[]", 返回空集合.
	 * <p>
	 * 如需反序列化复杂Collection如List<MyBean>, 请使用fromJson(String,JavaType)
	 *
	 * @see # fromJson(String, com.fasterxml.jackson.databind.JavaType)
	 */
	public <T> T fromJson(String jsonString, Class<T> clazz) {
		if (StringUtils.isEmpty(jsonString)) {
			return null;
		}

		try {
			return mapper.readValue(jsonString, clazz);
		} catch (IOException e) {
			System.err.println("parse json string error:" + e);
			return null;
		}
	}

	public <T> T fromJson(String jsonString, TypeReference<T> clazz) {
		if (StringUtils.isEmpty(jsonString)) {
			return null;
		}

		try {
			return mapper.readValue(jsonString, clazz);
		} catch (IOException e) {
			System.err.println("parse json string error:" + e);
			return null;
		}
	}

	/**
	 * 反序列化复杂Collection如List<Bean>, 先使用函數createCollectionType构造类型,然后调用本函数.
	 *
	 * @see #createCollectionType(Class, Class...)
	 */
	public <T> T fromJson(String jsonString, JavaType javaType) {
		if (StringUtils.isEmpty(jsonString)) {
			return null;
		}

		try {
			return (T) mapper.readValue(jsonString, javaType);
		} catch (IOException e) {
			System.err.println("from json string error:" + e);
			return null;
		}
	}

	/**
	 * 構造泛型的Collection Type如:
	 * ArrayList<MyBean>, 则调用constructCollectionType(ArrayList.class,MyBean.class)
	 * HashMap<String,MyBean>, 则调用(HashMap.class,String.class, MyBean.class)
	 */
	public JavaType createCollectionType(Class<?> collectionClass, Class<?>... elementClasses) {
		return mapper.getTypeFactory().constructParametricType(collectionClass, elementClasses);
	}

	/**
	 * 輸出JSONP格式數據.
	 */
	public String toJsonP(String functionName, Object object) {
		return toJson(new JSONPObject(functionName, object));
	}

	/**
	 * 設定是否使用Enum的toString函數來讀寫Enum,
	 * 為False時時使用Enum的name()函數來讀寫Enum, 默認為False.
	 * 注意本函數一定要在Mapper創建後, 所有的讀寫動作之前調用.
	 */
	public void enableEnumUseToString() {
		mapper.enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING);
		mapper.enable(DeserializationFeature.READ_ENUMS_USING_TO_STRING);
	}


	/**
	 * 取出Mapper做进一步的设置或使用其他序列化API.
	 */
	public ObjectMapper getMapper() {
		return mapper;
	}
<think>嗯,用户的问题是关于ObjectMapper使用示例,特别是Java中JSON的序列化和反序列化。首先,我需要回忆一下ObjectMapper的基本用法,以及如何正确地进行序列化和反序列化操作。用户可能已经了解过一些基本概念,但需要具体的代码示例来加深理解。 根据引用内容,比如引用[1]提到了ObjectMapper处理序列化和反序列化的基本例子,引用[2]详细说明了配置选项和方法,而引用[3]和[4]也提供了相关的工具类和示例。因此,我应该整合这些信息,给出一个结构清晰的回答,包括基础示例和高级特性。 首先,用户可能需要一个简单的示例,展示如何将Java对象转换为JSON字符串,以及反向操作。然后,可能需要介绍一些高级功能,如忽略未知属性和使用注解自定义序列化,这些在引用中都有提到。同时,用户可能关心在Spring Boot中的全局配置,这也是引用[2]中的内容,所以需要包含这部分信息。 另外,用户可能遇到的常见问题,比如如何处理未知字段,或者如何自定义日期格式,这些都应该在回答中提及。此外,确保代码示例正确无误,使用正确的语法,比如使用$...$和$$...$$格式,符合用户给出的系统级指令。 还需要生成相关问题,帮助用户进一步学习。问题应该围绕ObjectMapper的高级配置、异常处理、性能优化等方面展开,这样用户可以有更深入的学习路径。 最后,要检查所有引用的正确性,确保每个引用标识对应正确的来源,并且自然地融入回答中,避免突兀。确保回答结构清晰,步骤明确,让用户能够逐步理解和应用ObjectMapper的各种功能。</think>### ObjectMapper 使用示例详解 #### 一、基础示例 1. **Java对象转JSON(序列化)** ```java ObjectMapper mapper = new ObjectMapper(); User user = new User("张三", 25); String jsonStr = mapper.writeValueAsString(user); // 输出: {"name":"张三","age":25} ``` 2. **JSON转Java对象(反序列化)** ```java String jsonInput = "{\"name\":\"李四\",\"age\":30}"; User user = mapper.readValue(jsonInput, User.class); // 自动填充对象属性 ``` #### 二、高级配置 1. **忽略未知属性** ```java mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); // 遇到未定义字段不报错 ``` 2. **日期格式处理** ```java mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")); // 统一日期格式 ``` 3. **自定义序列化器(通过注解)** ```java public class Product { @JsonIgnore // 忽略字段 private String secretCode; @JsonProperty("product_name") // 自定义JSON字段名 private String name; } ``` #### 三、Spring Boot全局配置 在`application.properties`中配置: ```properties spring.jackson.date-format=yyyy-MM-dd spring.jackson.default-property-inclusion=non_null # 忽略空值 spring.jackson.deserialization.fail-on-unknown-properties=false ``` #### 四、特殊类型处理 1. **集合类型转换** ```java List<User> users = mapper.readValue(jsonArrayStr, new TypeReference<List<User>>(){}); ``` 2. **树模型处理** ```java JsonNode rootNode = mapper.readTree(jsonStr); String name = rootNode.get("name").asText(); // 直接获取节点值 ```
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值