詳細介紹Spring中的JavaConfig註解

在開發Java程序，尤其是Java EE應用程式的時候，總是免不了與各種設定檔打交道。 java註解則幫我們使之更整潔，不會設定檔滿天飛了。 以下這篇文章主要介紹了詳細介紹Spring中的JavaConfig註解，需要的朋友可以參考借鑒，下面來一起看看吧。

前言

大家都知道傳統spring一般都是基於xml配置的，不過後來新增了許多JavaConfig的註解。特別是springboot，基本上都是清一色的java config，不了解一下，還真是不適應。這裡備註一下。

@RestController

spring4為了更方便的支援restfull應用程式的開發，新增了RestController的註解，比Controller註解多的功能就是給底下的RequestMapping方法預設都加上ResponseBody註解，省得自己再去每個去加入該註解。

@Configuration

這個標註該類是spring的配置類，本身自帶Component註解

##@ImportResource

對應的xml

<import resource="applicationContext-ehcache.xml"/>

#存在的必要性

這個是相容於傳統xml配置的，畢竟JavaConfig還不是萬能的，例如JavaConfig不能很好地支援aop:advisor和tx:advice ， Introduce @EnableAspectJAutoProxy (equivalent to aop:aspectj-autoproxy) ，Introd @Configuration-d equivalent:aspectj-autoproxy) ，Introd @Configuration-d equivalent:aspect :config XML element

@ComponentScan

#對應的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指定的套件範圍內的，否則會報錯。

@Bean

對應的xml如下：

<bean id="objectMapper" class="org.codehaus.jackson.map.ObjectMapper" />

@EnableWebMvc

對應的xml如下：

<mvc:annotation-driven />

該設定自動註冊DefaultAnnotationHandlerMapping( 來註冊handler method和request的mapping關係)與AnnotationMethodHandlerAdapter( 在實際調用handler method前對其參數進行處理)兩個bean，以支援@Controller註解的使用。

主要的功能如下：

1. 可配置的ConversionService(方便進行自訂類型轉換)

2. 支援用@ NumberFormat格式化數字類型欄位

3. 支援用@DateTimeFormat格式化Date,Calendar以及Joda Time欄位( 如果classpath有Joda Time的話)

4. #支援@Valid的參數校驗( 如果JSR-303相關provider有在classpath的話)

5. 支援@RequestBody/@ResponseBody註解的XML讀寫( 如果JAXB在classpath的話)

6. 支援@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開發用，註解回傳的http回傳碼，具體值看org.springframework.http.HttpStatus列舉。一般post方法傳回HttpStatus.CREATED，DELETE和PUT方法傳回HttpStatus.OK。也可以配置異常處理，見@ExceptionHandler和@ControllerAdvice

@ExceptionHandler

主要用來處理指定的例外，傳回傳回指定的HTTP狀態碼，省得每個controller的方法自己去try catch。一般可以為每個應用定義一個異常基類，然後再定義業務異常，這樣這裡就可以統一捕獲業務異常。

@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的方法呼叫鏈產生的異常，如果在spring裡頭還使用了定時任務啥的，該註解是不會攔截到的。

@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());
 }
}

#總結#

以上是詳細介紹Spring中的JavaConfig註解的詳細內容。更多資訊請關注PHP中文網其他相關文章！