Spring MVC自動配置
Spring Boot為Spring MVC提供了自動配置,可以在大多數應用程序中很好地工作。
自動配置在Spring默認的基礎上添加了以下特性:
- 包含ContentNegotiatingViewResolver和BeanNameViewResolver bean。
- 支持提供靜態資源,包括對WebJars的支持。
- 自動注冊Converter、GenericConverter和Formatter
- 對HttpMessageConverters的支持。
- MessageCodesResolver的自動注冊。
- 靜態index.html支持。
- 自動使用ConfigurableWebBindingInitializer bean。
如果你想保留這些Spring Boot MVC自定義并進行更多的MVC自定義(攔截器、格式化器、視圖控制器和其他特性),你可以自定義配置類實現WebMvcConfigurer類型的@Configuration類,但不需要@EnableWebMvc。
如果你想提供RequestMAppingHandlerMapping、RequestMappingHandlerAdapter或ExceptionHandlerExceptionResolver的自定義實例,并且仍然保持Spring Boot MVC自定義,你可以聲明一個WebMvcRegistrations類型的bean,并使用它來提供這些組件的自定義實例,源碼如下:
public interface WebMvcRegistrations {
default RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
return null;
}
default RequestMappingHandlerAdapter getRequestMappingHandlerAdapter() {
return null;
}
default ExceptionHandlerExceptionResolver getExceptionHandlerExceptionResolver() {
return null;
}
}
EnableWebMvcConfiguration
public static class EnableWebMvcConfiguration {
private final WebMvcRegistrations mvcRegistrations;
public EnableWebMvcConfiguration(ObjectProvider<WebMvcRegistrations> mvcRegistrationsProvider) {
this.mvcRegistrations = mvcRegistrationsProvider.getIfUnique();
}
@Override
protected RequestMappingHandlerAdapter createRequestMappingHandlerAdapter() {
// 如果自定義了WebMvcRegistrations,則使用自定義的,其他的默認配置行為不變
if (this.mvcRegistrations != null) {
RequestMappingHandlerAdapter adapter = this.mvcRegistrations.getRequestMappingHandlerAdapter();
if (adapter != null) {
return adapter;
}
}
return super.createRequestMappingHandlerAdapter();
}
}
如果你想要完全控制Spring MVC,你可以添加你自己的@Configuration注解@EnableWebMvc,或者自定義配置類該類繼承DelegatingWebMvcConfiguration并使用@Configuration注解。
消息轉換HttpMessageConverters
SpringMVC使用HttpMessageConverter接口來轉換HTTP請求和響應。明智的默認值是開箱即用的。例如,對象可以自動轉換為JSON(通過使用Jackson庫)或XML(通過使用JacksonXML擴展(如果可用),或者通過使用JAXB(如果Jackson XML擴展不可用))。默認情況下,字符串以UTF-8編碼。
如果需要添加或自定義轉換器,可以使用Spring Boot的HttpMessageConverters類,如以下列表所示:
@Configuration(proxyBeanMethods = false)
public class CustomHttpMessageConvertersConfiguration {
@Bean
public HttpMessageConverters customConverters() {
HttpMessageConverter<?> additional = new AdditionalHttpMessageConverter();
HttpMessageConverter<?> another = new AnotherHttpMessageConverter();
return new HttpMessageConverters(additional, another);
}
}
系統默認也提供了HttpMessageConverters Bean,其實我們可以直接將自定義的HttpMessageConverter注冊為Bean即可:
public class HttpMessageConvertersAutoConfiguration {
@Bean
@ConditionalOnMissingBean
// 這里的參數就能夠收集所有HttpMessageConverter類型的Bean
public HttpMessageConverters messageConverters(ObjectProvider<HttpMessageConverter<?>> converters) {
return new HttpMessageConverters(converters.orderedStream().collect(Collectors.toList()));
}
}
自定義JSON序列化和反序列化
如果你使用Jackson來序列化和反序列化JSON數據,你可能需要編寫自己的JsonSerializer和JsonDeserializer類。自定義序列化程序通常通過一個模塊向Jackson注冊,但Spring Boot提供了一個替代的@JsonComponent注釋,可以更容易地直接注冊Spring Beans。
你可以在JsonSerializer、JsonDeserializer或KeyDeserialize實現上直接使用@JsonComponent注釋。您也可以在包含序列化程序/反序列化程序作為內部類的類上使用它,如以下示例所示:
@JsonComponent
public class MyJsonComponent {
public static class Serializer extends JsonSerializer<MyObject> {
@Override
public void serialize(MyObject value, JsonGenerator jgen, SerializerProvider serializers) throws IOException {
jgen.writeStartObject();
jgen.writeStringField("name", value.getName());
jgen.writeNumberField("age", value.getAge());
jgen.writeEndObject();
}
}
public static class Deserializer extends JsonDeserializer<MyObject> {
@Override
public MyObject deserialize(JsonParser jsonParser, DeserializationContext ctxt) throws IOException, JsonProcessingException {
ObjectCodec codec = jsonParser.getCodec();
JsonNode tree = codec.readTree(jsonParser);
String name = tree.get("name").textValue();
int age = tree.get("age").intValue();
return new MyObject(name, age);
}
}
}
ApplicationContext中的所有@JsonComponent bean都會自動注冊到Jackson中。因為@JsonComponent是用@Component進行元注釋的,所以應用了通常的組件掃描規則。
MessageCodesResolver
Spring MVC有一個生成錯誤代碼的策略,用于從綁定錯誤中呈現錯誤消息:MessageCodesResolver。如果你設置
spring.mvc.message-codes-resolver-format屬性PREFIX_ERROR_CODE或POSTFIX_ERROR_CODE,則spring Boot會為你創建一個屬性。
靜態內容
默認情況下,Spring Boot從類路徑中名為/static(或/public或/resources或/META-INF/resources)的目錄或ServletContext的根目錄提供靜態內容。它使用Spring MVC中的
ResourceHttpRequestHandler,因此您可以通過添加自己的WebMvcConfigurer并重寫addResourceHandlers方法來修改該行為。
在獨立的web應用程序中,不會啟用容器中的默認servlet??梢允褂?br />server.servlet.register-default-servlet屬性啟用它。
默認的servlet充當后備,如果Spring決定不處理ServletContext的根,則從ServletContext提供內容。大多數情況下,這不會發生(除非您修改默認的MVC配置),因為Spring總是可以通過DispatcherServlet處理請求。
默認情況下,資源映射在/**上,但您可以使用
spring.mvc.static-path-pattern屬性對其進行調優。例如,將所有資源重新定位到/resources/**可以通過以下方式實現:
spring:
mvc:
static-path-pattern: "/resources/**"
你還可以使用spring.web.resources自定義靜態資源位置。static-locations屬性(用目錄位置列表替換默認值)。根servlet上下文路徑“/”也會自動添加為位置。
除了前面提到的“標準”靜態資源位置之外,還有一個針對Webjars內容的特殊情況。任何路徑在/webjars/**中的資源,如果它們被打包成webjars格式,就會從jar文件中提供。
Spring Boot還支持Spring MVC提供的高級資源處理功能,允許使用緩存破壞靜態資源或為Webjars使用版本不可知的URL等用例。
要為Webjars使用與版本無關的URL,請添加Webjars定位器核心依賴項。然后聲明您的Webjar。以jQuery為例,添加“
/webjars/jQuery/jQuery.min.js”會導致“/Webjar/jQuery/x.y.z/jQuery.min.js”,其中x.y.z是Webjar版本。
要使用緩存破壞,以下配置為所有靜態資源配置緩存破壞解決方案,從而有效地在URL中添加內容哈希,如<link href=“
/css/spring-2a2d595e6ed9a0b24f027f2b63b134d6.css”/>:?
spring:
web:
resources:
chain:
strategy:
content:
enabled: true
paths: "/**"
路徑匹配與內容協商
Spring MVC可以通過查看請求路徑并將其與應用程序中定義的映射(例如,Controller方法上的@GetMapping注釋)進行匹配,將傳入的HTTP請求映射到處理程序。
Spring Boot默認選擇禁用后綴模式匹配,這意味著像"GET/projects/Spring Boot.json"這樣的請求將不會與@GetMapping("/projects/Spring Boot")映射匹配。這被認為是Spring MVC應用程序的最佳實踐。這個功能在過去主要適用于沒有發送正確的“Accept”請求頭的HTTP客戶端;我們需要確保向客戶端發送正確的內容類型。如今,內容協商更加可靠。
還有其他方法可以處理那些不一致地發送正確的"Accept"請求頭的HTTP客戶端。我們可以使用查詢參數來確保像"GET/projects/spring-boot?format=json"這樣的請求將被映射到@GetMapping("/projects/spring-boot"),而不是使用后綴匹配:
spring:
mvc:
contentnegotiation:
favor-parameter: true
或者自定義參數名稱:
spring:
mvc:
contentnegotiation:
favor-parameter: true
parameter-name: "myparam"
大多數標準media type都支持開箱即用,但你也可以定義新的:
spring:
mvc:
contentnegotiation:
media-types:
markdown: "text/markdown"
后綴模式匹配已棄用,并將在將來的版本中刪除。如果你理解注意事項,并且仍然希望你的應用程序使用后綴模式匹配,則需要以下配置:
spring:
mvc:
contentnegotiation:
favor-path-extension: true
pathmatch:
use-suffix-pattern: true
ConfigurableWebBindingInitializer
Spring MVC使用WebBindingInitializer為特定請求初始化WebDataBinder。如果你創建自己的ConfigurationWebBindingInitializer@Bean,則Spring Boot會自動配置Spring MVC以使用它。
錯誤處理
默認情況下,Spring Boot提供了一個/error映射,以合理的方式處理所有錯誤,并且它在servlet容器中注冊為“全局”錯誤頁面。對于機器客戶端,它會生成一個JSON響應,其中包含錯誤、HTTP狀態和異常消息的詳細信息。對于瀏覽器客戶端,有一個“白標簽”錯誤視圖,它以HTML格式呈現相同的數據(要自定義它,請添加一個解決錯誤的視圖)。
服務器有很多。如果要自定義默認錯誤處理行為,可以設置的錯誤屬性。
要完全替換默認行為,可以實現ErrorController并注冊該類型的bean定義,或者添加ErrorAttributes類型的bean以使用現有機制,但替換內容。
你也可以定義一個帶有@ControllerAdvice注解的類來定制JSON文檔,以返回特定的控制器和/或異常類型,如下例所示:
@ControllerAdvice(basePackageClasses = SomeController.class)
public class MyControllerAdvice extends ResponseEntityExceptionHandler {
@ResponseBody
@ExceptionHandler(MyException.class)
public ResponseEntity<?> handleControllerException(HttpServletRequest request, Throwable ex) {
HttpStatus status = getStatus(request);
return new ResponseEntity<>(new MyErrorBody(status.value(), ex.getMessage()), status);
}
private HttpStatus getStatus(HttpServletRequest request) {
Integer code = (Integer) request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
HttpStatus status = HttpStatus.resolve(code);
return (status != null) ? status : HttpStatus.INTERNAL_SERVER_ERROR;
}
}
完畢?。?!