spring常用注解总结-CFANZ编程社区

1 声明bean的注解

@Component 组件，没有明确的角色
@Service 在业务逻辑层使用（service层）
@Repository 在数据访问层使用（dao层）
@Controller 在展现层使用，控制器的声明（C）

2 注入bean的注解

@Autowired：由Spring提供
@Inject：由JSR-330提供
@Resource：由JSR-250提供

都可以注解在set方法和属性上，推荐注解在属性上（一目了然，少写代码）。

3 java配置类相关注解

@Configuration 声明当前类为配置类，相当于xml形式的Spring配置（类上），其中内部组合了@Component注解，表明这个类是一个bean（类上）
@Bean 注解在方法上，声明当前方法的返回值为一个bean，替代xml中的方式（方法上）
@ComponentScan 用于对Component进行扫描，相当于xml中的（类上）
@WishlyConfiguration 为@Configuration与@ComponentScan的组合注解，可以替代这两个注解

4 Bean的属性支持

@Scope 设置Spring容器如何新建Bean实例（方法上，得有@Bean）其设置类型包括：

Singleton （单例,一个Spring容器中只有一个bean实例，默认模式）,
Protetype （每次调用新建一个bean）,
Request （web项目中，给每个http request新建一个bean）,
Session （web项目中，给每个http session新建一个bean）,
GlobalSession（给每一个 global http session新建一个Bean实例）

@PostConstruct 由JSR-250提供，在构造函数执行完之后执行，等价于xml配置文件中bean的initMethod
@PreDestory 由JSR-250提供，在Bean销毁之前执行，等价于xml配置文件中bean的destroyMethod

5 Value注解

@Value 为属性注入值（属性上）

6 SpringMVC部分

@RequestMapping：用于映射Web请求，包括访问路径和参数（类或方法上）

@RequestMapping(value="/get/{id:\d+}")：控制id智能是数字，否则报4xx错误
@RequestMapping(value={"/foo","/bar"})：一个方法对应两个url地址

@RequestParam：主要用于在SpringMVC后台控制层获取参数，类似一种是request.getParameter(“name”)，它有三个常用参数：defaultValue = “0”, required = false, value = “isApp”；

defaultValue 表示设置默认值，required 通过boolean设置是否是必须要传入的参数，value 值表示接受的传入的参数类型。

@RequestBody：允许request的参数在request体中，而不是在直接连接在地址后面。（放在参数前）
@ResponseBody：支持将返回值放在response内，而不是一个页面，通常用户返回json数据（返回值旁或方法上）
@RestController：该注解为一个组合注解，相当于@Controller和@ResponseBody的组合，注解在类上，意味着，该Controller的所有方法都默认加上了@ResponseBody。
@PathVariable：用于接收路径参数RequestMapping(“/hello/{name}”)申明的路径，将注解放在参数中前，即可获取该值，通常作为Restful的接口实现方法。
@ControllerAdvice：通过该注解，我们可以将对于控制器的全局配置放置在同一个位置，注解了@Controller的类的方法可使用@ExceptionHandler、@InitBinder、@ModelAttribute注解到方法上，这对所有注解了 @RequestMapping的控制器内的方法有效。

@ExceptionHandler：用于全局处理控制器里的异常
@InitBinder：用来设置WebDataBinder，WebDataBinder用来自动绑定前台请求参数到Model中。
@ModelAttribute：本来的作用是绑定键值对到Model里，在@ControllerAdvice中是让全局的@RequestMapping都能获得在此处设置的键值对。

@SpringBootApplication：这个注解就是集成了：@SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan这三个注解。

@SpringBootConfiguration：表示这个类为配置类；继承自@Configuration，二者功能也一致，标注当前类是配置类，并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到spring容器中，并且实例名就是方法名。
@EnableAutoConfiguration：表示开启自动配置，帮助SpringBoot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IoC容器。借助于Spring框架原有的一个工具类：SpringFactoriesLoader的支持，@EnableAutoConfiguration可以智能的自动配置功效才得以大功告成；
@ComponentScan：主要用于组件扫描和自动装配，这个扫描默认只能扫同一级的目录。自动扫描并加载符合条件的组件或bean定义，最终将这些bean定义加载到容器中。我们可以通过basePackages等属性指定@ComponentScan自动扫描的范围，如果不指定，则默认Spring框架实现从声明@ComponentScan所在类的package进行扫描，默认情况下是不指定的，所以SpringBoot的启动类最好放在root package下。

@Async与@EnableAsync：其中@Async表示这个方法为异步方法，相当于启动了一个新的线程；@EnableAsync这个注解需要加在启动类上，表示支持异步操作；如果不加，则@Async将不起作用。
@RequestHeader：放在方法参数前，用来获取request header中的参数值。
@CookieValue：放在方法参数前，用来获取request header cookie中的参数值。

7 定时任务相关

@EnableScheduling 在配置类上使用，开启计划任务的支持（类上EnableScheduling 在配置类上使用，开启计划任务的支持（类上@）
@Scheduled 来申明这是一个任务，包括cron,fixDelay,fixRate等类型（方法上，需先开启计划任务的支持）

8 测试相关注解

@RunWith 运行器，Spring中通常用于对JUnit的支持
@ContextConfiguration 用来加载配置ApplicationContext，其中classes属性用来加载配置类

9 切面（AOP）相关注解

Spring支持AspectJ的注解式切面编程。

在java配置类中使用@EnableAspectJAutoProxy注解开启Spring对AspectJ代理的支持（类上）

@Aspect 声明一个切面（类上）

@PointCut 声明切点

使用@After、@Before、@Around定义建言（advice），可直接将拦截规则（切点）作为参数。

@After 在方法执行之后执行（方法上）
@Before 在方法执行之前执行（方法上）
@Around 在方法执行之前与之后执行（方法上）

10 导入配置文件

// 引入单个properties文件
@PropertySource(value = {"classpath : xxxx/xxx.properties"})

// 引入多个properties文件
@PropertySource(value = {
    "classpath : xxxx/xxx.properties",
    "classpath : xxxx.properties"
})

11 @ImportResource导入xml配置文件

可以额外分为两种模式相对路径classpath，绝对路径（真实路径）file

注意：单文件可以不写value或locations，value和locations都可用

相对路径（classpath）

引入单个xml配置文件：@ImportSource(“classpath : xxx/xxxx.xml”)
引入多个xml配置文件：@ImportSource(locations={“classpath : xxxx.xml” , “classpath : yyyy.xml”})

绝对路径（file）

引入单个xml配置文件：@ImportSource(locations= {“file : d:/hellxz/dubbo.xml”})
引入多个xml配置文件：@ImportSource(locations= {“file : d:/hellxz/application.xml” , “file : d:/hellxz/dubbo.xml”})

取值：使用@Value注解取配置文件中的值

@Value("${properties中的键}")
private String xxx;