詳細解說Java Spring的JavaConfig註解

詳細解說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) ， Introduce @Configuration-based equivalent to aop: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註解的使用。

主要的作用如下：

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

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

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

• 支援@Valid的參數校正( 如果JSR-303相關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開發用，註解返回的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()); 
    } 
}