Spring MVC自動(dòng)配置

Spring Boot為Spring MVC提供了自動(dòng)配置，可以在大多數(shù)應(yīng)用程序中很好地工作。

自動(dòng)配置在Spring默認(rèn)的基礎(chǔ)上添加了以下特性：

【資料圖】

包含ContentNegotiatingViewResolver和BeanNameViewResolverbean。支持提供靜態(tài)資源，包括對(duì)WebJars的支持。自動(dòng)注冊(cè)Converter、GenericConverter和Formatter對(duì)HttpMessageConverters的支持。MessageCodesResolver的自動(dòng)注冊(cè)。靜態(tài)index.html支持。自動(dòng)使用ConfigurableWebBindingInitializerbean。

如果你想保留這些Spring Boot MVC自定義并進(jìn)行更多的MVC自定義(攔截器、格式化器、視圖控制器和其他特性)，你可以自定義配置類實(shí)現(xiàn)WebMvcConfigurer類型的@Configuration類，但不需要@EnableWebMvc。

如果你想提供RequestMappingHandlerMapping、RequestMappingHandlerAdapter或ExceptionHandlerExceptionResolver的自定義實(shí)例，并且仍然保持Spring Boot MVC自定義，你可以聲明一個(gè)WebMvcRegistrations類型的bean，并使用它來(lái)提供這些組件的自定義實(shí)例，源碼如下：?

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 mvcRegistrationsProvider) {    this.mvcRegistrations = mvcRegistrationsProvider.getIfUnique();  }  @Override  protected RequestMappingHandlerAdapter createRequestMappingHandlerAdapter() {    // 如果自定義了WebMvcRegistrations,則使用自定義的，其他的默認(rèn)配置行為不變    if (this.mvcRegistrations != null) {      RequestMappingHandlerAdapter adapter = this.mvcRegistrations.getRequestMappingHandlerAdapter();      if (adapter != null) {        return adapter;      }    }    return super.createRequestMappingHandlerAdapter();  }}

如果你想要完全控制Spring MVC，你可以添加你自己的@Configuration注解@EnableWebMvc，或者自定義配置類該類繼承DelegatingWebMvcConfiguration并使用@Configuration注解。

消息轉(zhuǎn)換HttpMessageConverters

SpringMVC使用HttpMessageConverter接口來(lái)轉(zhuǎn)換HTTP請(qǐng)求和響應(yīng)。明智的默認(rèn)值是開箱即用的。例如，對(duì)象可以自動(dòng)轉(zhuǎn)換為JSON（通過(guò)使用Jackson庫(kù)）或XML（通過(guò)使用JacksonXML擴(kuò)展（如果可用），或者通過(guò)使用JAXB（如果Jackson XML擴(kuò)展不可用））。默認(rèn)情況下，字符串以UTF-8編碼。

如果需要添加或自定義轉(zhuǎn)換器，可以使用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);  }}

系統(tǒng)默認(rèn)也提供了HttpMessageConvertersBean，其實(shí)我們可以直接將自定義的HttpMessageConverter注冊(cè)為Bean即可：?

public class HttpMessageConvertersAutoConfiguration {  @Bean  @ConditionalOnMissingBean  // 這里的參數(shù)就能夠收集所有HttpMessageConverter類型的Bean  public HttpMessageConverters messageConverters(ObjectProvider> converters) {    return new HttpMessageConverters(converters.orderedStream().collect(Collectors.toList()));  }  }

自定義JSON序列化和反序列化

如果你使用Jackson來(lái)序列化和反序列化JSON數(shù)據(jù)，你可能需要編寫自己的JsonSerializer和JsonDeserializer類。自定義序列化程序通常通過(guò)一個(gè)模塊向Jackson注冊(cè)，但Spring Boot提供了一個(gè)替代的@JsonComponent注釋，可以更容易地直接注冊(cè)Spring Beans。

你可以在JsonSerializer、JsonDeserializer或KeyDeserialize實(shí)現(xiàn)上直接使用@JsonComponent注釋。您也可以在包含序列化程序/反序列化程序作為內(nèi)部類的類上使用它，如以下示例所示：?

@JsonComponentpublic class MyJsonComponent {  public static class Serializer extends JsonSerializer {    @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 {    @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中的所有@JsonComponentbean都會(huì)自動(dòng)注冊(cè)到Jackson中。因?yàn)锧JsonComponent是用@Component進(jìn)行元注釋的，所以應(yīng)用了通常的組件掃描規(guī)則。

MessageCodesResolver

Spring MVC有一個(gè)生成錯(cuò)誤代碼的策略，用于從綁定錯(cuò)誤中呈現(xiàn)錯(cuò)誤消息：MessageCodesResolver。如果你設(shè)置spring.mvc.message-codes-resolver-format屬性PREFIX_ERROR_CODE或POSTFIX_ERROR_CODE，則spring Boot會(huì)為你創(chuàng)建一個(gè)屬性。

靜態(tài)內(nèi)容

默認(rèn)情況下，Spring Boot從類路徑中名為/static（或/public或/resources或/META-INF/resources）的目錄或ServletContext的根目錄提供靜態(tài)內(nèi)容。它使用Spring MVC中的ResourceHttpRequestHandler，因此您可以通過(guò)添加自己的WebMvcConfigurer并重寫addResourceHandlers方法來(lái)修改該行為。

在獨(dú)立的web應(yīng)用程序中，不會(huì)啟用容器中的默認(rèn)servlet?？梢允褂胹erver.servlet.register-default-servlet屬性啟用它。

默認(rèn)的servlet充當(dāng)后備，如果Spring決定不處理ServletContext的根，則從ServletContext提供內(nèi)容。大多數(shù)情況下，這不會(huì)發(fā)生（除非您修改默認(rèn)的MVC配置），因?yàn)镾pring總是可以通過(guò)DispatcherServlet處理請(qǐng)求。

默認(rèn)情況下，資源映射在/**上，但您可以使用spring.mvc.static-path-pattern屬性對(duì)其進(jìn)行調(diào)優(yōu)。例如，將所有資源重新定位到/resources/**可以通過(guò)以下方式實(shí)現(xiàn)：

spring:  mvc:    static-path-pattern: "/resources/**"

你還可以使用spring.web.resources自定義靜態(tài)資源位置。static-locations屬性(用目錄位置列表替換默認(rèn)值)。根servlet上下文路徑“/”也會(huì)自動(dòng)添加為位置。

除了前面提到的“標(biāo)準(zhǔn)”靜態(tài)資源位置之外，還有一個(gè)針對(duì)Webjars內(nèi)容的特殊情況。任何路徑在/webjars/**中的資源，如果它們被打包成webjars格式，就會(huì)從jar文件中提供。

Spring Boot還支持Spring MVC提供的高級(jí)資源處理功能，允許使用緩存破壞靜態(tài)資源或?yàn)閃ebjars使用版本不可知的URL等用例。

要為Webjars使用與版本無(wú)關(guān)的URL，請(qǐng)?zhí)砑覹ebjars定位器核心依賴項(xiàng)。然后聲明您的Webjar。以jQuery為例，添加“/webjars/jQuery/jQuery.min.js”會(huì)導(dǎo)致“/Webjar/jQuery/x.y.z/jQuery.min.js”，其中x.y.z是Webjar版本。

要使用緩存破壞，以下配置為所有靜態(tài)資源配置緩存破壞解決方案，從而有效地在URL中添加內(nèi)容哈希，如：?

spring:  web:    resources:      chain:        strategy:          content:            enabled: true            paths: "/**"

路徑匹配與內(nèi)容協(xié)商

Spring MVC可以通過(guò)查看請(qǐng)求路徑并將其與應(yīng)用程序中定義的映射（例如，Controller方法上的@GetMapping注釋）進(jìn)行匹配，將傳入的HTTP請(qǐng)求映射到處理程序。

Spring Boot默認(rèn)選擇禁用后綴模式匹配，這意味著像"GET/projects/Spring Boot.json"這樣的請(qǐng)求將不會(huì)與@GetMapping("/projects/Spring Boot")映射匹配。這被認(rèn)為是Spring MVC應(yīng)用程序的最佳實(shí)踐。這個(gè)功能在過(guò)去主要適用于沒(méi)有發(fā)送正確的“Accept”請(qǐng)求頭的HTTP客戶端；我們需要確保向客戶端發(fā)送正確的內(nèi)容類型。如今，內(nèi)容協(xié)商更加可靠。

還有其他方法可以處理那些不一致地發(fā)送正確的"Accept"請(qǐng)求頭的HTTP客戶端。我們可以使用查詢參數(shù)來(lái)確保像"GET/projects/spring-boot?format=json"這樣的請(qǐng)求將被映射到@GetMapping("/projects/spring-boot")，而不是使用后綴匹配：?

spring:  mvc:    contentnegotiation:      favor-parameter: true

或者自定義參數(shù)名稱：

spring:  mvc:    contentnegotiation:      favor-parameter: true      parameter-name: "myparam"

大多數(shù)標(biāo)準(zhǔn)media type都支持開箱即用，但你也可以定義新的:?

spring:  mvc:    contentnegotiation:      media-types:        markdown: "text/markdown"

后綴模式匹配已棄用，并將在將來(lái)的版本中刪除。如果你理解注意事項(xiàng)，并且仍然希望你的應(yīng)用程序使用后綴模式匹配，則需要以下配置：?

spring:  mvc:    contentnegotiation:      favor-path-extension: true    pathmatch:      use-suffix-pattern: true

ConfigurableWebBindingInitializer

Spring MVC使用WebBindingInitializer為特定請(qǐng)求初始化WebDataBinder。如果你創(chuàng)建自己的ConfigurationWebBindingInitializer@Bean，則Spring Boot會(huì)自動(dòng)配置Spring MVC以使用它。

錯(cuò)誤處理

默認(rèn)情況下，Spring Boot提供了一個(gè)/error映射，以合理的方式處理所有錯(cuò)誤，并且它在servlet容器中注冊(cè)為“全局”錯(cuò)誤頁(yè)面。對(duì)于機(jī)器客戶端，它會(huì)生成一個(gè)JSON響應(yīng)，其中包含錯(cuò)誤、HTTP狀態(tài)和異常消息的詳細(xì)信息。對(duì)于瀏覽器客戶端，有一個(gè)“白標(biāo)簽”錯(cuò)誤視圖，它以HTML格式呈現(xiàn)相同的數(shù)據(jù)（要自定義它，請(qǐng)?zhí)砑右粋€(gè)解決錯(cuò)誤的視圖）。

服務(wù)器有很多。如果要自定義默認(rèn)錯(cuò)誤處理行為，可以設(shè)置的錯(cuò)誤屬性。

要完全替換默認(rèn)行為，可以實(shí)現(xiàn)ErrorController并注冊(cè)該類型的bean定義，或者添加ErrorAttributes類型的bean以使用現(xiàn)有機(jī)制，但替換內(nèi)容。

你也可以定義一個(gè)帶有@ControllerAdvice注解的類來(lái)定制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;  }}

完畢?。?！

關(guān)鍵詞：