Spring ResponseBody without null field 2017-10-26 03:18
The annotation @ResponseBody can help you convert object to json. Sometimes if the field of object is null the json returned like following.
{
"name": "henry",
"age": 27,
"department": null
}
There are two ways to remove the null field in the returned json.
-
Add
@JsonInclude(JsonInclude.Include.NON_NULL)on the object you returned. -
Add
spring.jackson.serialization-inclusionin application.properties file when you use Spring Boot.
The whole example is like following.
structure of project
├─main
│ ├─java
│ │ └─com
│ │ └─henryxi
│ │ └─json
│ │ └─nullfield
│ │ SimpleController.java
│ │ User.java
│ │ UserIgnoreNullField.java
│ │
│ └─resources
│ application.properties
pom.xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>1.3.3.RELEASE</version>
</dependency>
SimpleController
@Controller
@EnableAutoConfiguration
public class SimpleController {
@RequestMapping("/user-info")
@ResponseBody
public User userInfo() {
User user = new User();
user.setName("henry");
user.setAge(27);
return user;
}
@RequestMapping("/user-info-without-null-field")
@ResponseBody
public UserIgnoreNullField userInfoWithoutNullField() {
UserIgnoreNullField user = new UserIgnoreNullField();
user.setName("henry");
user.setAge(27);
return user;
}
public static void main(String[] args) {
SpringApplication.run(SimpleController.class, args);
}
}
UserIgnoreNullField
@JsonInclude(JsonInclude.Include.NON_NULL)
public class UserIgnoreNullField implements Serializable {
private String name;
private int age;
private String department;
//getter and setter methods
}
User
public class UserIgnoreNullField implements Serializable {
private String name;
private int age;
private String department;
//getter and setter methods
}
application.properties
#spring.jackson.serialization-inclusion=NON_NULL
EOF