自定義Jackson的ObjectMapper如何實(shí)現(xiàn)@ResponseBody的自定義渲染
XML
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd">
<bean id="bean1" class="test.Bean1" />
<bean id="bean2" class="test.Bean2" />
</beans>通常,我們可以采用下面的Java Config方式代替上面的Xml,實(shí)現(xiàn) fine-grained(細(xì)粒度) 配置。
Java Config
package test;
@Configuration
public class WebConfig {
@Bean
public Bean1 bean1(){
//……
}
@Bean
public Bean2 bean2(){
//……
}
}XXXConfigurer
但是,有時(shí)候我們希望:
一組功能相關(guān)的Bean之間能夠建立更直接更明確的關(guān)系。
那么我們可以選擇實(shí)現(xiàn) XXXConfigurer 這類 回調(diào)接口,然后使用 @Configuration注解該實(shí)現(xiàn)類,并Override它們的抽象方法。
例如:
| 功能 | 回調(diào)接口 |
|---|---|
| 緩存 | org.springframework.cache.annotation.CachingConfigurer |
| 定時(shí)任務(wù) | org.springframework.scheduling.annotation.SchedulingConfigurer |
| 異步(并發(fā))任務(wù) | org.springframework.scheduling.annotation.AsyncConfigurer |
| Spring MVC高級(jí)配置 | org.springframework.web.servlet.config.annotation.WebMvcConfigurer |
注意:
XXXConfigurer 接口的實(shí)現(xiàn)類無疑需要復(fù)寫其全部抽象方法(Java8之前,Spring舊版本),但是如果不希望覆蓋默認(rèn)或增加額外配置:
- 方法有返回值,則 return null。
- 方法無返回值,則不寫任何實(shí)現(xiàn)代碼。
- 當(dāng)然你也可以直接繼承其抽象適配器
XXXConfigurerAdapter,根據(jù)配置需要復(fù)寫方法。 - 當(dāng)然
Java8以后,接口方法有了默認(rèn)實(shí)現(xiàn)default,在新版的Spring中,你可以直接實(shí)現(xiàn)XXXConfigurer接口,并根據(jù)配置復(fù)寫方法。
示例:WebMvcConfigurer
我們以 WebMvcConfigurer 為例:自定義Jackson的ObjectMapper,實(shí)現(xiàn)@ResponseBody的自定義渲染?
- 解決方法是配置Spring MVC的 HttpMessageConverter 消息轉(zhuǎn)換器
先來看xml方式
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:p="http://www.springframework.org/schema/p"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd">
<mvc:annotation-driven >
<mvc:message-converters>
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
<property name="objectMapper" ref="objectMapper"/>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>
<bean id="objectMapper" class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"
p:serializationInclusion="NON_NULL"/>WebMvcConfigurer的抽象適配器
我們還可以通過繼承 WebMvcConfigurer 的抽象適配器
org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter
來實(shí)現(xiàn)Spring MVC在Java Config 形式下的高級(jí)配置:
@Configuration
@EnableWebMvc
public class WebConfiguration extends WebMvcConfigurerAdapter {
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
ObjectMapper mapper = new ObjectMapper();
mapper.setDefaultPropertyInclusion(Include.NON_NULL);
converters.add(new MappingJackson2HttpMessageConverter(mapper));
}
}@EnableWebMvc
到這里,我們已經(jīng)實(shí)現(xiàn)了Spring MVC在Java Config 形式下的高級(jí)配置,但是需要注意,這里我們使用了 @EnableWebMvc。
@EnableWebMvc源碼
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(DelegatingWebMvcConfiguration.class)
public @interface EnableWebMvc {
}第4行,導(dǎo)入了配置類
org.springframework.web.servlet.config.annotation.DelegatingWebMvcConfiguration
DelegatingWebMvcConfiguration源碼
@Configuration
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
@Autowired(required = false)
public void setConfigurers(List<WebMvcConfigurer> configurers) {
if (!CollectionUtils.isEmpty(configurers)) {
this.configurers.addWebMvcConfigurers(configurers);
}
}
}可以看到,DelegatingWebMvcConfiguration的作用就是注入WebMvcConfigurer的實(shí)現(xiàn)類, 而 DelegatingWebMvcConfiguration 又需要@EnableWebMvc來導(dǎo)入。
所以如果你沒有使用Spring Boot,而是傳統(tǒng)的
Spring項(xiàng)目,又想要使用WebMvcConfigurer來實(shí)現(xiàn)細(xì)粒度配置,你需要@EnableWebMvc。
官方文檔上給出了另一種解決方式:
If WebMvcConfigurer does not expose some advanced setting that needs to be configured,
consider removing the @EnableWebMvc annotation and extending directly from
WebMvcConfigurationSupport or DelegatingWebMvcConfiguration,
如果WebMvcConfigurer沒能解決你的需求,那么你可以考慮移除 @EnableWebMvc并且直接繼承WebMvcConfigurationSupport or DelegatingWebMvcConfiguration。
注意:
Spring boot已經(jīng)通過Spring MVC的自動(dòng)配置類WebMvcAutoConfiguration導(dǎo)入了DelegatingWebMvcConfiguration,所以不再需要@EnableWebMvc。
If you want to take complete control of Spring MVC, you can add your own @Configuration annotated with @EnableWebMvc.
相對(duì)的,如果你使用了@EnableWebMvc,那么Spring MVC的自動(dòng)配置將被忽略。
@EnableXXX與<xxx:annotation-driven>的沖突
對(duì)于傳統(tǒng)Spring項(xiàng)目,Java Config的使用勢必導(dǎo)致Xml 與Java Config 同時(shí)存在于項(xiàng)目中。
這時(shí)候就需要我們?nèi)タ紤]Xml與annotation-based之間是否會(huì)產(chǎn)生沖突。
比如下面這些基本功能相同的標(biāo)簽和注解:
這里強(qiáng)調(diào)基本功能,因?yàn)镴ava Config的配置更細(xì)粒度,自然容易獲得其他擴(kuò)展導(dǎo)致某些功能不一致。
例如:@EnableWebMvc導(dǎo)入了DelegatingWebMvcConfiguration,從而實(shí)現(xiàn)了WebMvcConfigurer接口的注入。
<cache:annotation-driven /> <!--@EnableCaching--> <task:annotation-driven scheduler=""/> <!--@EnableScheduling--> <task:annotation-driven executor=""/> <!--@EnableAsync--> <mvc:annotation-driven /> <!--@EnableWebMvc--> <!-- …… 等等,諸如此類 -->
這里還是以<mvc:annotation-driven />與 @EnableWebMvc為例,如果二者同時(shí)存在:
- 傳統(tǒng)Spring項(xiàng)目以
web.xml加載dispatcher-servlet.xml,毫無疑問配置在xml中的<mvc:annotation-driven />將會(huì)優(yōu)先生效。 - 所以,此時(shí)
@EnableWebMvc不生效,WebMvcConfigurer的實(shí)現(xiàn)類將不會(huì)被注入,Java Config的配置方式不會(huì)生效。 - 所以,這種情況需要二選一。
至于,其他**XXXConfigurer** 在傳統(tǒng)Spring項(xiàng)目中的配置方式,與示例同理。
總結(jié)
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
基于Apache組件分析對(duì)象池原理的實(shí)現(xiàn)案例分析
本文從對(duì)象池的一個(gè)簡單案例切入,主要分析common-pool2組件關(guān)于:池、工廠、配置、對(duì)象管理幾個(gè)角色的源碼邏輯,并且參考其在Redis中的實(shí)踐,對(duì)Apache組件分析對(duì)象池原理相關(guān)知識(shí)感興趣的朋友一起看看吧2022-04-04
Java數(shù)據(jù)結(jié)構(gòu)之KMP算法的實(shí)現(xiàn)
這篇文章主要為大家詳細(xì)介紹了Java數(shù)據(jù)結(jié)構(gòu)中KMP算法的原理與實(shí)現(xiàn),文中的示例代碼講解詳細(xì),對(duì)我們學(xué)習(xí)Java有一定的幫助,需要的可以參考一下2022-11-11
基于SpringBoot項(xiàng)目遇到的坑--Date入?yún)栴}
這篇文章主要介紹了SpringBoot項(xiàng)目遇到的坑--Date入?yún)栴},具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-10-10
prometheus數(shù)據(jù)遠(yuǎn)程寫入elasticsearch方式
這篇文章主要介紹了prometheus數(shù)據(jù)遠(yuǎn)程寫入elasticsearch方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2025-06-06
springboot 微信授權(quán)網(wǎng)頁登錄操作流程
這篇文章主要介紹了springboot 微信授權(quán)網(wǎng)頁登錄操作流程,本文通過實(shí)例圖文相結(jié)合給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-11-11
Spring Boot 2.x 實(shí)現(xiàn)文件上傳功能
這篇文章主要介紹了Spring Boot 2.x 實(shí)現(xiàn)文件上傳功能,本文分步驟通過實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-01-01
解決cmd執(zhí)行javac報(bào)錯(cuò):不是內(nèi)部或外部命令,也不是可運(yùn)行的程序
剛接觸JAVA的新手可能就不知道怎么解決'JAVAC'不是內(nèi)部命令或外部命令,這篇文章主要給大家介紹了關(guān)于解決cmd執(zhí)行javac報(bào)錯(cuò):不是內(nèi)部或外部命令,也不是可運(yùn)行的程序的相關(guān)資料,需要的朋友可以參考下2023-11-11
springsecurity第三方授權(quán)認(rèn)證的項(xiàng)目實(shí)踐
Spring security 是一個(gè)強(qiáng)大的和高度可定制的身份驗(yàn)證和訪問控制框架,本文主要介紹了springsecurity第三方授權(quán)認(rèn)證的項(xiàng)目實(shí)踐,具有一定的參考價(jià)值,感興趣可以了解一下2023-08-08
Spring Security SecurityContextHolder組件示例說明
SpringSecurity的SecurityContextHolder組件是存儲(chǔ)當(dāng)前安全上下文的地方,包括認(rèn)證用戶信息,它支持全局訪問、線程局部存儲(chǔ)和上下文傳播,是SpringSecurity認(rèn)證和授權(quán)的核心,文章通過示例展示了如何訪問已認(rèn)證用戶的詳細(xì)信息、手動(dòng)設(shè)置認(rèn)證信息以及使用認(rèn)證信息保護(hù)方法2024-11-11

