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()); } }
相關文章
- Spring的JavaConfig註解SpringJava
- Spring中XML,註解,JavaConfig如何選擇SpringXMLJava
- Java必須掌握的Spring常用註解JavaSpring
- Spring MVC 零配置 / Spring MVC JavaConfigSpringMVCJava
- Java利用spring註解做反射機制JavaSpring反射
- Spring註解Spring
- Java中的註解-自定義註解Java
- 【Spring註解】事務註解@TransactionalSpring
- Java Spring各種依賴注入註解的區別JavaSpring依賴注入
- 丟掉xml使用JavaConfig配置SpringXMLJavaSpring
- Spring註解詳解Spring
- Spring中重要的註解Spring
- Spring的@PropertySource註解使用Spring
- Spring AOP的AspectJ註解Spring
- Spring的註解開發Spring
- spring @profile註解的使用Spring
- Spring中的@scope註解Spring
- Spring MVC常用的註解SpringMVC
- Java註解的使用Java
- Spring5:@Autowired註解、@Resource註解和@Service註解Spring
- Spring常用註解Spring
- Spring註解大全Spring
- Spring boot註解Spring Boot
- Spring新註解Spring
- spring註解2Spring
- Spring 各種註解備註Spring
- Java Web之基於註解的Spring MVC環境配置JavaWebSpringMVC
- java註解Java
- 註解 javaJava
- SPRING-spring註解整理Spring
- Spring 註解程式設計之模式註解Spring程式設計模式
- Spring MVC 常用註解的使用SpringMVC
- Spring中@Import註解的使用SpringImport
- Spring的註解@Qualifier小結Spring
- 【譯】Spring的@EnableCaching註解Spring
- Spring中Value註解的使用Spring
- Spring IOC容器-註解的方式Spring
- Spring Boot配置類的註解Spring Boot