详细解说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:adviceIntroduce @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如下:


  1. <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


  1. @RunWith(SpringJUnit4ClassRunner.class) 
  2. @ContextConfiguration({ 
  3.     "classpath*:spring/*.xml", 
  4.     "classpath:applicationContext.xml", 
  5.     "classpath:applicationContext-rabbitmq.xml", 
  6.     "classpath:applicationContext-mail.xml", 
  7.     "classpath:applicationContext-medis.xml", 
  8.     "classpath:applicationContext-mybatis.xml"}) 
  9. @TransactionConfiguration(transactionManager = "mybatisTransactionManager", defaultRollback = false) 
  10. public class AppBaseTest { 
  11.    //...... 

@ResponseStatus

主要是rest开发用,注解返回的http返回码,具体值看org.springframework.http.HttpStatus枚举。一般
post方法返回HttpStatus.CREATED,DELETE和PUT方法返回HttpStatus.OK。还可以配置异常处理,见
@ExceptionHandler和@ControllerAdvice

@ExceptionHandler

主要用来处理指定的异常,返回返回指定的HTTP状态码,省得每个controller的方法自己去try catch。一般可以为每个应用定义一个异常基类,然后再定义业务异常,这样这里就可以统一捕获业务异常。


  1. @ExceptionHandler(BizException.class) 
  2.  @ResponseStatus(HttpStatus.BAD_REQUEST) 
  3.  public @ResponseBody 
  4.  ReturnMessage bizExceptionHandler(Exception ex) { 
  5.      logger.error(ex.getMessage(),ex); 
  6.      return new ReturnMessage(HttpStatus.BAD_REQUEST.value(),ex.getMessage()); 
  7.  } 

不过值得注意的是这种方法仅限于controller的方法调用链产生的异常,如果在spring里头还使用了定时任务啥的,该注解是不会拦截到的。

@ControllerAdvice

配合@ExceptionHandler使用的,用来拦截controller的方法。


  1. @ControllerAdvice 
  2. public class ErrorController { 
  3.  
  4.     private static final Logger logger = LoggerFactory.getLogger(ErrorController.class); 
  5.  
  6.     @ExceptionHandler(BizException.class) 
  7.     @ResponseStatus(HttpStatus.BAD_REQUEST) 
  8.     public @ResponseBody 
  9.     ReturnMessage bizExceptionHandler(Exception ex) { 
  10.         logger.error(ex.getMessage(),ex); 
  11.         return new ReturnMessage(HttpStatus.BAD_REQUEST.value(),ex.getMessage()); 
  12.     } 
  13.  
  14.     @ExceptionHandler(Exception.class) 
  15.     @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) 
  16.     public @ResponseBody 
  17.     ReturnMessage serverExceptionHandler(Exception ex) { 
  18.         logger.error(ex.getMessage(),ex); 
  19.         return new ReturnMessage(HttpStatus.INTERNAL_SERVER_ERROR.value(),ex.getMessage()); 
  20.     } 

来源:51CTO

时间: 2024-08-20 21:49:29

详细解说Java Spring的JavaConfig注解的相关文章

Java Spring各种依赖注入注解的区别

Spring对于Bean的依赖注入,支持多种注解方式: @Resource  javax.annotation  JSR250 (Common Annotations for Java)    @Inject  javax.inject  JSR330 (Dependency Injection for Java)    @Autowired  org.springframework.bean.factory  Spring  直观上看起来,@Autowired是Spring提供的注解,其他几个

java spring 面试题 找错

问题描述 java spring 面试题 找错 大神们帮忙,去了滴答拼车给的面试题,小弟我愣是没看懂,求解惑. 如下代码用spring管理,请说出代码是否有问题,如果有错请指出并修改. classTestDao(){ public void doUpdate(){ try{ update table1;//一个更新操作,无需关注语法 update table2;//一个更新操作,无需关注语法 insert history;//一个插入操作,无需关注语法 }catch(Exception e){

Spring 3.0 注解注入详解

原文地址: http://developer.51cto.com/art/201104/255395.htm 一.各种注解方式 1.@Autowired注解(不推荐使用,建议使用@Resource) @Autowired可以对成员变量.方法和构造函数进行标注,来完成自动装配的工作.@Autowired的标注位置不同,它们都会在Spring在初始化这个bean时,自动装配这个属性.要使@Autowired能够工作,还需要在配置文件中加入以下 Xml代码 <bean class="org.sp

Java Spring MVC 上传下载文件配置及controller方法详解_java

下载: 1.在spring-mvc中配置(用于100M以下的文件下载) <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"> <property name="messageConverters"> <list> <!--配置下载返回类型--> <bean class="or

Java Spring Controller 获取请求参数的几种方法详解_java

Java Spring Controller 获取请求参数的几种方法  1.直接把表单的参数写在Controller相应的方法的形参中,适用于get方式提交,不适用于post方式提交.若"Content-Type"="application/x-www-form-urlencoded",可用post提交        url形式:http://localhost:8080/SSMDemo/demo/addUser1?username=lixiaoxi&pas

java Spring 5 新特性函数式Web框架详细介绍_java

java Spring 5 新特性函数式Web框架 举例 我们先从示例应用程序的一些摘录开始.下面是暴露Person对象的响应信息库.很类似于传统的,非响应信息库,只不过它返回Flux<Person>而传统的返回List<Person>,以及返回Mono<Person>的地方返回Person.Mono<Void>用作完成标识:指出何时保存被完成. public interface PersonRepository { Mono<Person> g

Java+Spring+MySql环境中安装和配置MyBatis的教程_java

1.MyBatis简介与配置MyBatis+Spring+MySql 1.1MyBatis简介      MyBatis 是一个可以自定义SQL.存储过程和高级映射的持久层框架.MyBatis 摒除了大部分的JDBC代码.手工设置参数和结果集重获.MyBatis 只使用简单的XML 和注解来配置和映射基本数据类型.Map 接口和POJO 到数据库记录.相对Hibernate和Apache OJB等"一站式"ORM解决方案而言,Mybatis 是一种"半自动化"的OR

java spring mvc怎么设置全局增删改方法为post请求

问题描述 java spring mvc怎么设置全局增删改方法为post请求 我不想在每个增删改方法注解的形式表明此方法为post请求,想在配置文件中设置全局的以add*updata*等开头的方法为post请求 解决方案 @Controller@RequestMapping(value=""t""method=RequestMethod.POST)public class TestController {...} 解决方案二: @Controller@Request

Spring IoC — 基于注解的配置

原文:Spring IoC - 基于注解的配置 基于XML的配置,Bean定义信息和Bean实现类本身是分离的,而采用基于注解的配置方式时,Bean定义信息即通过在Bean实现类上标注注解实现. @Component:对类进行标注,Spring容器自动将POJO转换为容器管理的Bean: @Repository:用于对DAO实现类进行标注: @Service:用于对Service实现类进行标注: @Controller:用于对Controller实现类进行标注.   1.自动装配Bean: