Spring常用注解整理

Java知识学堂：https://gitee.com/zhangbw666/it-knowledge

传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop、事务，这么做有两个缺点：

1、如果所有的内容都配置在.xml文件中，那么.xml文件将会十分庞大；如果按需求分开.xml文件，那么.xml文件又会非常多。总之这将导致配置文件的可读性与可维护性变得很低。

2、在开发中在.java文件和.xml文件之间不断切换，是一件麻烦的事，同时这种思维上的不连贯也会降低开发的效率。

为了解决这两个问题，Spring引入了注解，通过"@XXX"的方式，让注解与Java Bean紧密结合，既大大减少了配置文件的体积，又增加了Java Bean的可读性与内聚性。

Spring的一个核心功能是IOC，就是将Bean初始化加载到容器中，Bean是如何加载到容器的，可以使用Spring注解方式或者Spring XML配置方式。

注解本身是没有功能的，和xml一样，注解和xml都是一种元数据，元数据即解释数据的数据，也就是所谓的配置。

一、Spring常用注解

1、声明bean的注解

@Component：泛指各种组件

@Controller、@Service、@Repository都可以称为@Component

@Controller：控制层

@Service：业务层

@Repository：数据访问层

2、注入bean的注解

@Autowired：由Spring提供

@Inject：由JSR-330提供

@Resource：由JSR-250提供

3、Java配置类相关注解

@Configuration：声明当前类为配置类

@Bean：注解在方法上，声明当前方法的返回值为一个bean，替代xml中的方式

@ComponentScan：用于对Component进行扫描

4、切面（AOP）相关注解

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

@Aspect：声明一个切面

@After：在方法执行之后执行（方法上）

@Before：在方法执行之前执行（方法上）

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

@PointCut：声明切点

@EnableAspectJAutoProxy：开启Spring对AspectJ代理的支持

5、@Bean的属性支持

@Scope设置类型包括：设置Spring容器如何新建Bean实例

Singleton：单例,一个Spring容器中只有一个bean实例，默认模式

Protetype：每次调用新建一个bean

Request：web项目中，给每个http request新建一个bean

Session：web项目中，给每个http session新建一个bean

GlobalSession：给每一个 global http session新建一个Bean实例

6、@Value注解

注入普通字符、注入操作系统属性、注入表达式结果、注入其它bean属性、注入文件资源、注入网站资源、注入配置文件

7、环境切换

@Profile：指定组件在哪个环境的情况下才能被注册到容器中，不指定，任何环境下都能注册这个组件。

@Conditional：通过实现Condition接口，并重写matches方法，从而决定该bean是否被实例化。

8、异步相关

@EnableAsync：配置类中通过此注解开启对异步任务的支持

@Async：在实际执行的bean方法使用该注解来声明其是一个异步任务（方法上或类上所有的方法都将异步，需要@EnableAsync开启异步任务）

9、定时任务相关

@EnableScheduling：在配置类上使用，开启计划任务的支持

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

10、Enable***注解说明

@EnableAspectAutoProxy：开启对AspectJ自动代理的支持

@EnableAsync：开启异步方法的支持

@EnableScheduling：开启计划任务的支持

@EnableWebMvc：开启web MVC的配置支持

@EnableConfigurationProperties：开启对@ConfigurationProperties注解配置Bean的支持

@EnableJpaRepositories：开启对SpringData JPA Repository的支持

@EnableTransactionManagement：开启注解式事务的支持

@EnableCaching：开启注解式的缓存支持

11、测试相关注解

@RunWith：运行器，Spring中通常用于对JUnit的支持

@ContextConfiguration

用来加载配置文件，其中classes属性用来加载配置类

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {"classpath*:/*.xml"})
public class CDPlayerTest {
 
}

二、SpringMVC常用注解

1、@EnableWebMvc：在配置类中开启Web MVC的配置支持

2、@Controller

3、@RequestMapping：用于映射web请求，包括访问路径和参数

4、@ResponseBody：支持将返回值放到response内，而不是一个页面，通常用户返回json数据

5、@RequestBody：允许request的参数在request体中，而不是在直接连接的地址后面

6、@PathVariable：用于接收路径参数，比如@RequestMapping(“/hello/{name}”)声明的路径，将注解放在参数前，即可获取该值，通常作为Restful的接口实现方法。

7、@RestController：该注解为一个组合注解，相当于@Controller和@ResponseBody的组合，注解在类上，意味着，该Controller的所有方法都默认加上了@ResponseBody。

8、@ControllerAdvice：全局异常处理、全局数据绑定、全局数据预处理

9、@ExceptionHandler：用于全局处理控制器里的异常

10、@InitBinder：用来设置WebDataBinder，WebDataBinder用来自动绑定前台请求参数到Model中

 你多学一样本事，就少说一句求人的话，现在的努力，是为了以后的不求别人，实力是最强的底气。记住，活着不是靠泪水博得同情，而是靠汗水赢得掌声。——《写给程序员朋友》 

点赞&在看是最大的支持