Spring 提供对 Jackson JSON 库的支持。
对 jackson json 提供了内置的支持,所以说可以直接引入 jackson 的依赖
implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.13.2.2'
前面章节的 body 只能返回字符串的例子就可以直接改成返回对象了,如下所示。对于 @ResponseBody
的注解返回的对象(期望返回 JSON 数据),也可以直接生效使用了
@GetMapping("/files")
public ResponseEntity<Pet> upload1(HttpEntity<Pet> entity) {
return ResponseEntity.ok().eTag("etag").body(new Pet());
}
JSON Views / JSON 视图
Spring MVC 为 Jackson 的序列化视图 提供了内置支持,它只允许渲染一个对象中所有字段的子集。为了与 @ResponseBody
或 ResponseEntity
控制器方法一起使用,你可以使用 Jackson 的 @JsonView
注解来激活一个序列化视图类,如下例所示:
@RestController
public class UserController {
@GetMapping("/user")
@JsonView(User.WithoutPasswordView.class)
public User getUser() {
return new User("eric", "7!jd#h23");
}
}
public class User {
public interface WithoutPasswordView {};
public interface WithPasswordView extends WithoutPasswordView {};
private String username;
private String password;
public User() {
}
public User(String username, String password) {
this.username = username;
this.password = password;
}
@JsonView(WithoutPasswordView.class)
public String getUsername() {
return this.username;
}
@JsonView(WithPasswordView.class)
public String getPassword() {
return this.password;
}
}
:::info @JsonView 允许一个视图类的数组,但每个控制器方法只能指定一个。如果你需要激活多个视图,你可以使用一个复合接口。 :::
如果你想以编程方式进行上述操作,而不是声明一个 @JsonView
注解,用 MappingJacksonValue 来包裹返回值,并使用它来提供序列化的视图:
@RestController
public class UserController {
@GetMapping("/user")
public MappingJacksonValue getUser() {
User user = new User("eric", "7!jd#h23");
MappingJacksonValue value = new MappingJacksonValue(user);
value.setSerializationView(User.WithoutPasswordView.class);
return value;
}
}
对于依赖视图解析的控制器,你可以将序列化的视图类添加到模型中,如下例所示:
@Controller
public class UserController extends AbstractController {
@GetMapping("/user")
public String getUser(Model model) {
model.addAttribute("user", new User("eric", "7!jd#h23"));
model.addAttribute(JsonView.class.getName(), User.WithoutPasswordView.class);
return "userView";
}
}