9.4 Spring MVC

优质
小牛编辑
127浏览
2023-12-01

Spring Boot有许多包含Spring MVC的启动器。 请注意,一些启动器包含对Spring MVC的依赖,而不是直接包含它。 本节回答有关Spring MVC和Spring Boot的常见问题。

9.4.1 编写JSON REST服务

只要Jackson2在类路径中,Spring Boot应用程序中的任何Spring @RestController都应默认呈现JSON响应,如以下示例所示:

@RestController
public class MyController {

	@RequestMapping("/thing")
	public MyThing thing() {
			return new MyThing();
	}

}

只要MyThing可以被Jackson2序列化(对于普通的POJO或Groovy对象都是如此),那么localhost:8080/thing默认提供它的JSON表示。 请注意,在浏览器中,您有时可能会看到XML响应,因为浏览器倾向于发送更喜欢XML的接受标头。

9.4.2 编写XML REST服务

如果在类路径上有Jackson XML扩展(jackson-dataformat-xml),则可以使用它来呈现XML响应。 我们用于JSON的前一个示例可以使用。 要使用Jackson XML渲染器,请将以下依赖项添加到项目中:

<dependency>
	<groupId>com.fasterxml.jackson.dataformat</groupId>
	<artifactId>jackson-dataformat-xml</artifactId>
</dependency>

如果Jackson的XML扩展不可用,则使用JAXB(默认情况下在JDK中提供),并且需要将MyThing注释为@XmlRootElement,如以下示例所示:

@XmlRootElement
public class MyThing {
	private String name;
	// .. getters and setters
}

要使服务器呈现XML而不是JSON,您可能必须发送Accept:text/xml标头(或使用浏览器)。

9.4.3 自定义Jackson ObjectMapper

Spring MVC(客户端和服务器端)使用HttpMessageConverters在HTTP交换中协商内容转换。 如果Jackson在类路径上,您已经获得了Jackson2ObjectMapperBuilder提供的默认转换器,其中一个实例是为您自动配置的。

ObjectMapper(或Jackson XML转换器的XmlMapper)实例(默认创建)具有以下自定义属性:

  • MapperFeature.DEFAULT_VIEW_INCLUSION已禁用
  • DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES已禁用
  • SerializationFeature.WRITE_DATES_AS_TIMESTAMPS已禁用

Spring Boot还具有一些功能,可以更轻松地自定义此行为。

您可以使用环境配置ObjectMapper和XmlMapper实例。 Jackson提供了一套广泛的简单开/关功能,可用于配置其处理的各个方面。 这些功能在六个enum(在Jackson中)中描述,它们映射到环境中的属性:

EnumPropertyValues
com.fasterxml.jackson.databind.DeserializationFeaturespring.jackson.deserialization.true, false
com.fasterxml.jackson.core.JsonGenerator.Featurespring.jackson.generator.<feature_name>true, false
com.fasterxml.jackson.databind.MapperFeaturespring.jackson.mapper.<feature_name>true, false
com.fasterxml.jackson.core.JsonParser.Featurespring.jackson.parser.<feature_name>true, false
com.fasterxml.jackson.databind.SerializationFeaturespring.jackson.serialization.<feature_name>true, false
com.fasterxml.jackson.annotation.JsonInclude.Includespring.jackson.default-property-inclusionalways, non_null, non_absent, non_default, non_empty

例如,要启用格式化打印,请设置spring.jackson.serialization.indent_output = true。 请注意,由于使用了宽松绑定,indent_output的情况不必与相应的枚举常量(即INDENT_OUTPUT)的情况相匹配。

此基于环境的配置应用于自动配置的Jackson2ObjectMapperBuilder bean,并应用于使用构建器创建的任何映射器,包括自动配置的ObjectMapper bean。

上下文的Jackson2ObjectMapperBuilder可以由一个或多个Jackso