REST Assured 36 - @JsonInclude Annotation - Payload中忽略默认值字段

最新推荐文章于 2022-08-24 17:58:52 发布
最新推荐文章于 2022-08-24 17:58:52 发布
阅读量217 收藏
点赞数
分类专栏： # Rest Assured 文章标签： rest assured api testing JsonInclude json
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wumingxiaoyao/article/details/120252016
版权

REST Assured 系列汇总 之 REST Assured 36 - @JsonInclude Annotation - Payload中忽略默认值字段

本文了解 Jackson library 中一个重要的注释 annotation @JsonInclude， 它有助于清除 默认，null， empty 等值，本文我们关注默认值。

有一个 Employee POJO 类：

public class Employee {
 
	// private variables or data members of pojo class
	private String firstName;
	private String lastName;
	private String gender;
	private int age;
	private double salary;
	private boolean married;
	
	// Getter and setter methods
	public String getFirstName() {
		return firstName;
	}
	public void setFirstName(String firstName) {
		this.firstName = firstName;
	}
	public String getLastName() {
		return lastName;
	}
	public void setLastName(String lastName) {
		this.lastName = lastName;
	}
	public String getGender() {
		return gender;
	}
	public void setGender(String gender) {
		this.gender = gender;
	}
	public int getAge() {
		return age;
	}
	public void setAge(int age) {
		this.age = age;
	}
	public double getSalary() {
		return salary;
	}
	public void setSalary(double salary) {
		this.salary = salary;
	}
	public boolean getMarried() {
		return married;
	}
	public void setMarried(boolean married) {
		this.married = married;
	} 	
}

一个 payload ，没有强制要求传递所有字段的值。例如：字段 gender 可能是可选的，没有必要在 payload 设置该值，需要传的 payload 如下：

{
  "firstName" : "Amod",
  "lastName" : "Mahajan",
  "age" : 29,
  "salary" : 3434343.0,
  "married" : true
}

不设置字段 gender 的值，序列化 Java Object 成 JSON Object 如下：

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
 
 
public class AnnotationJsonIncludeExample {
 
	public static void main(String[] args) throws JsonProcessingException {
 
		// Just create an object of Pojo class
		Employee employee = new Employee();
		// Set value as you wish
		employee.setFirstName("Amod");
		employee.setLastName("Mahajan");
		employee.setAge(29);
		employee.setSalary(3434343);
		employee.setMarried(true);
		
		// Converting a Java class object to a JSON payload as string
		ObjectMapper objectMapper = new ObjectMapper();
		String employeeJson = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(employee);
		System.out.println(employeeJson);
	}
}

输出：

{
  "firstName" : "Amod",
  "lastName" : "Mahajan",
  "gender" : null,
  "age" : 29,
  "salary" : 3434343.0,
  "married" : true
}

观察一下上面的 payload，并不是我们需要的，因为不需要包括字段 gender。我们知道 类中的变量会有一个默认值，当我们没有显示地设置类中的变量值，在序列化时会用字段的默认值。因为字段 gender 是一个字符串类型，所有它默认的值是 null

再尝试一把，不设置 字段 age 的值：

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
 
 
public class AnnotationJsonIncludeExample {
 
	public static void main(String[] args) throws JsonProcessingException {
 
		// Just create an object of Pojo class
		Employee employee = new Employee();
		// Set value as you wish
		employee.setFirstName("Amod");
		employee.setLastName("Mahajan");
		employee.setSalary(3434343);
		employee.setMarried(true);
		
		// Converting a Java class object to a JSON payload as string
		ObjectMapper objectMapper = new ObjectMapper();
		String employeeJson = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(employee);
		System.out.println(employeeJson);
	}
}

输出：

{
  "firstName" : "Amod",
  "lastName" : "Mahajan",
  "gender" : null,
  "age" : 0,
  "salary" : 3434343.0,
  "married" : true
}

可以看出在没有设置任何值时，整型类型字段 age 的默认值是 0

我们不想一个字段带着默认值包含在目标 payload 中，为此，我们需要用到 Jackson Java API 的 @JsonInclude annotation 在 POJO类中，使用范围可以是类级别和单个的属性级别。

import com.fasterxml.jackson.annotation.JsonInclude;
 
@JsonInclude(JsonInclude.Include.NON_DEFAULT)
public class Employee {
 
	// private variables or data members of pojo class
	private String firstName;
	private String lastName;
	private String gender;
	private int age;
	private double salary;
	private boolean married;
	
	// Getter and setter methods
	public String getFirstName() {
		return firstName;
	}
	public void setFirstName(String firstName) {
		this.firstName = firstName;
	}
	public String getLastName() {
		return lastName;
	}
	public void setLastName(String lastName) {
		this.lastName = lastName;
	}
	public String getGender() {
		return gender;
	}
	public void setGender(String gender) {
		this.gender = gender;
	}
	public int getAge() {
		return age;
	}
	public void setAge(int age) {
		this.age = age;
	}
	public double getSalary() {
		return salary;
	}
	public void setSalary(double salary) {
		this.salary = salary;
	}
	public boolean getMarried() {
		return married;
	}
	public void setMarried(boolean married) {
		this.married = married;
	} 	
}

我们在回到 AnnotationJsonIncludeExample 类中， 将会得到如下输出：

{
  "firstName" : "Amod",
  "lastName" : "Mahajan",
  "salary" : 3434343.0,
  "married" : true
}

@JsonInclude annotation 用于表明被注释的属性（某个字段，方法， 构造函数参数），或 被注释类的所有属性将要序列化。使用这个注释可以具体指定简单的排除规则来减少属性的输入。

Include 枚举有很多选项：

ALWAYS Value that indicates that property is to be always included, independent of value of the property.
CUSTOM Value that indicates that separate filter Object (specified by JsonInclude.valueFilter() for value itself, and/or
JsonInclude.contentFilter() for contents of structured types) is to be used for determining inclusion criteria.
NON_ABSENT Value that indicates that properties are included unless their value is: null “absent” value of a referential type (like Java 8 Optional, or {link java.utl.concurrent.atomic.AtomicReference}); that is, something that would not deference to a non-null value.
NON_DEFAULT Meaning of this setting depends on context: whether annotation is specified for POJO type (class), or not.
NON_EMPTY Value that indicates that only properties with null value, or what is considered empty, are not to be included.
NON_NULL Value that indicates that only properties with non-null values are to be included.
USE_DEFAULTS Pseudo-value used to indicate that the higher-level defaults make sense, to avoid overriding inclusion value.

上面的例子，我们将 @JsonInclude 加在 class 级别，将应用到 class 的所有成员。如果我们想针对某个字段，我们可以加在 属性级别，如下：

import com.fasterxml.jackson.annotation.JsonInclude;
 
public class Employee {
 
	// private variables or data members of pojo class
	@JsonInclude(JsonInclude.Include.NON_DEFAULT)
	private String firstName;
	@JsonInclude(JsonInclude.Include.NON_DEFAULT)
	private String lastName;
	@JsonInclude(JsonInclude.Include.NON_DEFAULT)
	private String gender;
	private int age;
	private double salary;
	private boolean married;
	
	// Getter and setter methods
	public String getFirstName() {
		return firstName;
	}
	public void setFirstName(String firstName) {
		this.firstName = firstName;
	}
	public String getLastName() {
		return lastName;
	}
	public void setLastName(String lastName) {
		this.lastName = lastName;
	}
	public String getGender() {
		return gender;
	}
	public void setGender(String gender) {
		this.gender = gender;
	}
	public int getAge() {
		return age;
	}
	public void setAge(int age) {
		this.age = age;
	}
	public double getSalary() {
		return salary;
	}
	public void setSalary(double salary) {
		this.salary = salary;
	}
	public boolean getMarried() {
		return married;
	}
	public void setMarried(boolean married) {
		this.married = married;
	} 	
}

如果 class 所有字段有相同的 annotation 那么最好应用 class 级别。但是如果用不同的 annotation 如 NON_NULL, NON_DEFAULT, NON_EMPTY 作用于不同的字段上，最好应用属性级别。

wumingxiaoyao
关注
专栏目录
java如果属性为空返回其他_后台返回前台数据（实体类）如果存在为空或‘’的属性，如何过滤掉...
weixin_39614831的博客
02-23 963
public enum Include{/*** Value that indicates that property is to be always included,* independent of value of the property.* 包含所有属性，默认为ALWAYS*/ALWAYS,/*** Value that indicates that only properties wi...
RestAssured-API测试：使用Rest Assured进行API测试
03-02
RestAssured-API测试 使用Rest Assured进行API测试 放心罐 下载所有当前直接下载 必填项：rest-assured-4.3.1-dist.zip，json-path-4.3.1-dist.zip，xml-path-4.3.1-dist.zip，json-schema-validator-4.3.1-dist 。...
自定义注解Annotation对请求参数长度、非空校验并自定义提示内容
码家不想说话
08-17 942
请求对象参数中引用注解 @ValidateAnnotation(field = "apply title",length = 100,isNotNull = true) private String applyTitle; controller层中针对参数请求对象加入注解@Valid @PostMapping("/add_employee_change_apply") @ApiOperation(("保存、修改、提交审批")) @WebLog("人员信息变动保存、修改、提交审批")
对象中的字段隐藏
NewBeeMu的博客
08-24 526
工作中遇到了一个情况，一个对象里面的字段挺多的，但是每次调用接口只会用到其中的部分字段，全传过去前端渲染就会花很久，然后就会很卡，这个时候就需要将对象中为空的字段隐藏掉，保证给前端的对象中只有有值的字段。点进去这个Include枚举。这个时候就可以用这个注释。
常用注解（Annotation）整理
Atelas
12-29 3629
1.Java中@Autowired或@Resource这两个注解功能都是相同的，这两个注解的区别：@Autowired默认按类型装配，@Resource默认按名称装配，当找不到与名称匹配的bean时才会按类型装配。2.@Autowired、@Qualifier、@Resource三者的区别：简单理解： @Autowired 默认根据类型注入； @Resource 默认根据名字注入，其次按照类型
Java 对象序列化
qq_44671005的博客
09-19 163
序列化作用： 提供一种简单又可扩展的对象保存恢复机制。 远程调用时方便对对象进行编码和解码，实现对象直接传输。 将对象持久化到介质中，实现对象直接存储。 允许对象自定义外部存储的格式。 Java 将对象序列化为二进制文件，在大部分情况下，开发人员只需要使被序列化的类实现 Serializable 接口，使用 ObjectInputStream 和 ObjectOutputStream 进行对象的读写。 需要注意的点： 序列化ID（在版本升级时反序列化仍保持对象的唯一性） private static
rest-assured-1.3.jar
05-28
Java DSL，可轻松测试REST服务 com.jayway.restassured/rest-assured/1.3/rest-assured-1.3.jar
rest-assured-1.4.jar
05-28
Java DSL，可轻松测试REST服务 com.jayway.restassured/rest-assured/1.4/rest-assured-1.4.jar
rest-assured-2.9.0.jar
04-14
rest-assured-2.9.0.jar
31-03-rest-assured-rest-tests
04-08
在文件列表"31-03-rest-assured-rest-tests-master"中，我们可以期待找到一个完整的项目结构，包含测试类、配置文件以及可能的依赖库。通过查看这些文件，我们可以学习如何在实际项目中应用RestAssured，了解其组织...
java 自定义注解之ElementType.PARAMETER
行者常至
04-14 2万+
需求：controller方法获取数据列表，orderPackagePayedAmount等于desc时按照packagePayedAmount字段倒叙排序，等于asc时按照packagePayedAmount字段正叙排序． @Api("项目管理") @RestController @RequestMapping("/project") @Validated public class Proj...
代码参数里的 payload 是什么意思???
热门推荐
Allen技术小站
06-02 5万+
首先解释一下什么是 payload? payload 字面意思 “有效载荷，有效负荷，有效载重”。 payload 维基百科payload中的解释： 在计算机科学与电信领域，负载（英语：Payload）是数据传输中所欲传输的实际信息，通常也被称作实际数据或者数据体。信头与元数据，或称为开销数据，仅用于辅助数据传输。[1][2] 在计算机病毒或电脑蠕虫领域中，负载指的是进行...
REST Assured 19 - Default Host And Port
wumingxiaoyao的博客
08-22 256
REST Assured 系列汇总 之 REST Assured 19 - Default Host And Port 我们本地或服务器上安装Jenkins，访问Jenkins是通过某个特殊的端口号。所以，有一些service运行在特殊的端口上，我们需要在访问这些端口，URL就得拼接上对应的端口号，规则就是BaseURL上追加:port 例如: http://localhost:8080/ 让我们先看看下面的request的输出： import io.restassured.RestAssured;
关于使用@JsonInclude(JsonInclude.Include.NON_NULL)标签去除json数据中的空值问题
qq_31404603的博客
03-14 2万+
@JsonInclude(JsonInclude.Include.NON_NULL)标记是jackson包提供的json序列化方法，已经集成于Springboot2.0中，此方法的配置意在可以对实体json序列化的时候进行对应的数值处理， //将该标记放在属性上，如果该属性为NULL则不参与序列化 //如果放在类上边,那对这个类的全部属性起作用 //Include.Include.ALWAY...
@JsonInclude注解的使用
麻烦来杯Mojito
04-23 6263
@JsonInclude注解的使用 解释 @JsonInclude注解的作用是指定实体类在序列化时的策略 用法 @JsonInclude注解用在实体类上，可配合一些参数来使用，例如 @JsonInclude(JsonInclude.Include.NON_NULL) public class User { // ... } 我们来看看具体的参数枚举类 public enum Include ...
spring-自定义校验注解
燕少江湖
01-10 3123
  java注解编程：https://blog.csdn.net/u014292162/article/details/53001224   1、ValueValidNotNull package com.cn.dl.controller; import javax.validation.Constraint; import javax.validation.Payload; impo...
自定义注解与validation结合使用案例
weihainan
09-27 6181
案例1： import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; import javax.validation.Constrai
jackSon中@JsonInclude注解详解
飞龙的博客
05-12 5722
场景：实体类中的某个字段为特定值/空的话，就不需要序列化该字段保存到xml文件中。 @JsonInclude用法： JsonInclude.Include.ALWAYS这个是默认策略，任何情况下都序列化该字段，和不写这个注解是一样的效果。JsonInclude.Include.NON_NULL这个最常用，即如果加该注解的字段为null，那么就不序列化这个字段了。JsonInclude.Include.NON_ABSENT这个包含NON_NULL，即为null的时候不序列化，详情看源码。 ...
使用REST-Assured与TestNG进行自动化接口测试
本资源探讨了如何在这样的环境下，利用REST-Assured、TestNG和ExtentReports构建一个强大的接口测试解决方案。 接口测试的主要目标是验证API是否达到预期，包括功能、性能、安全和可靠性方面。在项目中引入GraphQL...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值