詳解Spring中的JavaConfig注解
前言
大家都知道傳統(tǒng)spring一般都是基于xml配置的,不過后來新增了許多JavaConfig的注解。特別是springboot,基本都是清一色的java config,不了解一下,還真是不適應(yīng)。這里備注一下。
@RestController
spring4為了更方便的支持restfull應(yīng)用的開發(fā),新增了RestController的注解,比Controller注解多的功能就是給底下的RequestMapping方法默認(rèn)都加上ResponseBody注解,省得自己再去每個去添加該注解。
@Configuration
這個標(biāo)注該類是spring的配置類,本身自帶Component注解
@ImportResource
對應(yīng)的xml
<import resource="applicationContext-ehcache.xml"/>
存在的必要性
這個是兼容傳統(tǒng)xml配置的,畢竟JavaConfig還不是萬能的,比如 JavaConfig不能很好地支持aop:advisor和tx:advice , Introduce @EnableAspectJAutoProxy (equivalent to aop:aspectj-autoproxy) ,Introduce @Configuration-based equivalent to aop:config XML element
@ComponentScan
對應(yīng)的xml
<context:component-scan base-package="com.xixicat.app"/>
該配置自動包含了如下配置的功能:
<context:annotation-config/>
就是向Spring容器注冊AutowiredAnnotationBeanPostProcessor( 使用@Autowired必須注冊 )、CommonAnnotationBeanPostProcessor( 使用@Resource 、@PostConstruct、@PreDestroy等必須注冊 )、PersistenceAnnotationBeanPostProcessor( 使用@PersistenceContext必須注冊 ) 以及RequiredAnnotationBeanPostProcessor( 使用@Required必須注冊 )這4個BeanPostProcessor。
值得注意的是 Spring3.1RC2版本 是不允許注解Configuration的類在ComponentScan指定的包范圍內(nèi)的,否則會報錯。
@Bean
對應(yīng)的xml如下:
<bean id="objectMapper" class="org.codehaus.jackson.map.ObjectMapper" />
@EnableWebMvc
對應(yīng)的xml如下:
<mvc:annotation-driven />
該配置自動注冊DefaultAnnotationHandlerMapping( 來注冊handler method和request的mapping關(guān)系 )與AnnotationMethodHandlerAdapter( 在實(shí)際調(diào)用handler method前對其參數(shù)進(jìn)行處理 )兩個bean,以支持@Controller注解的使用。
主要的作用如下:
- 可配置的ConversionService(方便進(jìn)行自定義類型轉(zhuǎn)換)
- 支持用@NumberFormat格式化數(shù)字類型字段
- 支持用@DateTimeFormat格式化Date,Calendar以及Joda Time字段( 如果classpath有Joda Time的話 )
- 支持@Valid的參數(shù)校驗(yàn)( 如果JSR-303相關(guān)provider有在classpath的話 )
- 支持@RequestBody/@ResponseBody注解的XML讀寫( 如果JAXB在classpath的話 )
- 支持@RequestBody/@ResponseBody注解的JSON讀寫( 如果Jackson在classpath的話 )
@ContextConfiguration
主要在junit測試時指定java config
@RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration({ "classpath*:spring/*.xml", "classpath:applicationContext.xml", "classpath:applicationContext-rabbitmq.xml", "classpath:applicationContext-mail.xml", "classpath:applicationContext-medis.xml", "classpath:applicationContext-mybatis.xml"}) @TransactionConfiguration(transactionManager = "mybatisTransactionManager", defaultRollback = false) public class AppBaseTest { //...... }
@ResponseStatus
主要是rest開發(fā)用,注解返回的http返回碼,具體值看org.springframework.http.HttpStatus枚舉。一般post方法返回HttpStatus.CREATED,DELETE和PUT方法返回HttpStatus.OK。還可以配置異常處理,見@ExceptionHandler和@ControllerAdvice
@ExceptionHandler
主要用來處理指定的異常,返回返回指定的HTTP狀態(tài)碼,省得每個controller的方法自己去try catch。一般可以為每個應(yīng)用定義一個異常基類,然后再定義業(yè)務(wù)異常,這樣這里就可以統(tǒng)一捕獲業(yè)務(wù)異常。
@ExceptionHandler(BizException.class) @ResponseStatus(HttpStatus.BAD_REQUEST) public @ResponseBody ReturnMessage bizExceptionHandler(Exception ex) { logger.error(ex.getMessage(),ex); return new ReturnMessage(HttpStatus.BAD_REQUEST.value(),ex.getMessage()); }
不過值得注意的是這種方法僅限于controller的方法調(diào)用鏈產(chǎn)生的異常,如果在spring里頭還使用了定時任務(wù)啥的,該注解是不會攔截到的。
@ControllerAdvice
配合@ExceptionHandler使用的,用來攔截controller的方法。
@ControllerAdvice public class ErrorController { private static final Logger logger = LoggerFactory.getLogger(ErrorController.class); @ExceptionHandler(BizException.class) @ResponseStatus(HttpStatus.BAD_REQUEST) public @ResponseBody ReturnMessage bizExceptionHandler(Exception ex) { logger.error(ex.getMessage(),ex); return new ReturnMessage(HttpStatus.BAD_REQUEST.value(),ex.getMessage()); } @ExceptionHandler(Exception.class) @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) public @ResponseBody ReturnMessage serverExceptionHandler(Exception ex) { logger.error(ex.getMessage(),ex); return new ReturnMessage(HttpStatus.INTERNAL_SERVER_ERROR.value(),ex.getMessage()); } }
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作能帶來一定的幫助,如果有疑問大家可以留言交流。
相關(guān)文章
JavaWeb HttpServletResponse對象及常用方法
這篇文章主要介紹了JavaWeb-HttpServletResponse對象,本文通過實(shí)例代碼給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2022-03-03Mybatis -如何處理clob類型數(shù)據(jù)
這篇文章主要介紹了Mybatis 如何處理clob類型數(shù)據(jù)的操作,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-06-06springboot之SpringApplication生命周期和事件機(jī)制解讀
這篇文章主要介紹了springboot之SpringApplication生命周期和事件機(jī)制,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2023-06-06SpringBoot整合Milvus的實(shí)現(xiàn)
本文主要介紹了SpringBoot整合Milvus的實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-07-07Spring AOP如何整合redis(注解方式)實(shí)現(xiàn)緩存統(tǒng)一管理詳解
這篇文章主要給大家介紹了關(guān)于Spring AOP如何整合redis(注解方式)實(shí)現(xiàn)緩存統(tǒng)一管理的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),需要的朋友可以參考借鑒,下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2018-08-08xxl-job定時任務(wù)配置應(yīng)用及添加到springboot項(xiàng)目中實(shí)現(xiàn)動態(tài)API調(diào)用
XXL-JOB是一個分布式任務(wù)調(diào)度平臺,其核心設(shè)計目標(biāo)是開發(fā)迅速、學(xué)習(xí)簡單、輕量級、易擴(kuò)展,本篇文章主要是對xuxueli的xxl-job做一個簡單的配置,以及將其添加到自己已有的項(xiàng)目中進(jìn)行api調(diào)用,感興趣的朋友跟隨小編一起看看吧2024-04-04詳解SpringBoot中添加@ResponseBody注解會發(fā)生什么
這篇文章主要介紹了詳解SpringBoot中添加@ResponseBody注解會發(fā)生什么,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-11-11