SpringBoot 常用注解

2017-06-06 本文已影响294人天神Deity

@Bean 注解

Indicates that a method produces a bean to be managed
by the Spring container.
该注解用于方法上，使用该注解的方法将会生成一个实体对象，该实体对象将统一由Spring容器管理

这个注解属性的名称和语义是有意与Spring xml配置模式中的<bean/>元素类似

@Bean注解返回的实体对象名称默认使用被@Bean注解的方法名称

       @Bean  ----①
       //@Bean("helloBean")  ----②
       public MyBean myBean() {
           // instantiate and configure MyBean obj
           return obj;
       }

如上①注释，默认情况下，返回的实体对象名称为myBean，当然我们可以使用②注释的方法来给实体类指定一个别名(特别注意，@Bean是允许有多个别名存在)

// bean 可用作 'b1' 和'b2', 但不可用作'myBean'       
@Bean({"b1", "b2"}) 
public MyBean myBean() {
     // instantiate and configure MyBean obj
     return obj;
}

@Bean 注解不提供Scope、depends-on、primary、lazy属性，相反的，@Bean属性应该与上述提到的属性配合使用，例如

@Bean
@Scope("prototype")
public MyBean myBean() {
     // instantiate and configure MyBean obj
     return obj;
}

在@Configuration中声明@Bean属性

通常情况下，携带@Bean注解的方法在携带@Configuration注解的类中声明，在这种情况下，相同的类中，不同的@Bean方法可以直接相互调用.作为代价@Configuration类及其工厂方法不能声明为私有.

   @Configuration
   public class AppConfig {
  
       @Bean
       public FooService fooService() {
           return new FooService(fooRepository());
       }
  
       @Bean
       public FooRepository fooRepository() {
           return new JdbcFooRepository(dataSource());
       }
       // ...
   }

@Bean的Lite模式

@Bean 注解并不一定非要在注解的了@Configuration的类中使用，你也可以在@Component类中或者甚至在普通的java类中使用@Bean注解，在这种情况下，@Bean注解将以所谓的Lite模式被处理

@Configuration

该注解表示该类为Spring容器的配置类

@EnableAutoConfiguration

开启SpringBoot的自动配置功能，它主要告诉springboot根据你配置的依赖进行自动配置，比如你配置了spring-boot-started-web，springboot假设你正在开发一个web应用，并进行一些web相关的配置.

@ComponentScan

扫描SpringBoot根Package下所有的Bean.

@RestController[2018年1月2日22:27:01]

返回文本形式的数据(json,xml)
@RestController相当于在@Controller注解的类中的每个方法加上@ResponseBody注解

@RequestMapping(value="/xxx",method = RequestMethod.DELETE)

Url路径映射
value：表示实际请求的URL地址
method：请求方法，可以是POST/GET/DELETE/PUT等

@PathVariable

url传参,被该@PathVariable注解的参数将被填充到@RequestMapping中的Url地址的通配符中。

@ControllerAdvice

被@ControllerAdvice注解的类
内部被@ExceptionHandler、@InitBinder、@ModelAttribute注解的方法
将被应用到所有的被@RequestMapping注解的方法

@ControllerAdvice 一般作为全局异常处理的切面类，它可以指定扫描范围，返回值定义：
如果直接返回Model类，需要使用@ResponseBody 进行json转化
如果返回的是String，表示跳转到某个View
如果返回的是ModelAndView则相当于 Model+@ResponseBody