Java开发必须掌握的20+种 Spring常用注解

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

本文主要罗列Spring|SpringMVC相关注解的简介。
Spring部分

1. 声明bean的注解

@Component 组件，没有明确的角色

@Service 在业务逻辑层使用（service层）

@Repository 在数据访问层使用（dao层）

@Controller 在展现层使用，控制器的声明（Controller层）

2. 注入bean的注解

@Autowired：Spring，根据类型，在变量、setter方法、构造函数上；

@Inject：JSR-330，根据类型（@Name根据名字），在变量、setter方法、构造函数上；

@Resource：JSR-250，根据名称（指定name属性），在变量、setter方法上。

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

关于 @Autowired 的歧义性问题可详见@Autowired 详解-三种实现方式，多种歧义性解决方法
@Qualifier 与 @Primary 都可以用于bean的歧义性问题

3. java配置类相关注解

@Configuration 声明当前类为配置类，相当于xml形式的Spring配置（类上）

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

@Configuration 声明当前类为配置类，其中内部组合了@Component注解，表明这个类是一个bean（类上）

@ComponentScan 用于对Component进行扫描，相当于xml中的context:component-scan/（类上）

@WishlyConfiguration 为@Configuration与@ComponentScan的组合注解，可以替代这两个注解

4. 切面（AOP）相关注解

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

@Aspect 声明一个切面（类上）
使用@After、@Before、@Around定义建言（advice），可直接将拦截规则（切点）作为参数。

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

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

5. @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实例）

@StepScope 在Spring Batch中还有涉及

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

@PreDestory 由JSR-250提供，在Bean销毁之前执行，等价于xml配置文件中bean的destroyMethod

6. @Value注解

@Value 为属性注入值（属性上）
支持如下方式的注入：

• 注入普通字符

@Value("Michael Jackson")
String name;

• 注入操作系统属性

@Value("#{systemProperties['os.name']}")
String osName;

• 注入表达式结果

@Value("#{ T(java.lang.Math).random() * 100 }")
String randomNumber;

• 注入其它bean属性

@Value("#{domeClass.name}")
String name;

• 注入文件资源

@Value("classpath:com/hgs/hello/test.txt")
String Resource file;

• 注入网站资源

@Value("http://www.cznovel.com")
Resource url;

• 注入配置文件

@Value("${book.name}")
String bookName;

注入配置使用方法：

1. 编写配置文件（test.properties）

book.name=《三体》

1. @PropertySource 加载配置文件(类上)

@PropertySource("classpath:com/hgs/hello/test/test.propertie")

1. 还需配置一个PropertySourcesPlaceholderConfigurer的bean。

7. 环境切换

@Profile 通过设定Environment的ActiveProfiles来设定当前context需要使用的配置环境。（类或方法上）

@Conditional Spring4中可以使用此注解定义条件话的bean，通过实现Condition接口，并重写matches方法，从而决定该bean是否被实例化。（方法上）

8. 异步相关

@EnableAsync 配置类中，通过此注解开启对异步任务的支持，叙事性AsyncConfigurer接口（类上）

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

9. 定时任务相关

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

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

10. @Enable*注解说明

这些注解主要用来开启对xxx的支持。

• @EnableAspectJAutoProxy 开启对AspectJ自动代理的支持

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

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

• @EnableWebMvc 开启Web MVC的配置支持

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

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

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

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

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

11. 测试相关注解

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

• @RunWith(SpringJUnit4ClassRunner.class)

• @ContextConfiguration 用来加载配置ApplicationContext，其中classes属性用来加载配置类

• @ContextConfiguration(classes={TestConfig.class})

12. SpringMVC部分
@EnableWebMvc 在配置类中开启Web MVC的配置支持，如一些ViewResolver或者MessageConverter等，若无此句，重写WebMvcConfigurerAdapter方法（用于对SpringMVC的配置）。

@Controller 声明该类为SpringMVC中的Controller，和前端调试用，@RestController单调后台用

@RestController 该注解为一个组合注解，相当于@Controller和@ResponseBody的组合，注解在类上，意味着，该Controller的所有方法都默认加上了@ResponseBody。
其中配置的视图解析器InternalResourceViewResolver则不起作用，方法无法返回jsp页面，或者html，返回String/Json。

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

@ResponseBody 支持将返回值放在response内，而不是一个页面，通常用户返回json数据（返回值旁或方法上）

@RequestBody 允许request的参数在request体中，而不是在直接连接在地址后面。（放在参数前）

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

@RequestRaram 用于传递参数和值，可以放在属性或者方法参数前。 (1) value 请求参数的参数名,作为参数映射名称；​ (2) required 该参数是否必填，默认为true(必填)，当设置成必填时，如果没有传入参数，报错；​ (3) defaultValue 设置请求参数的默认值；

@ControllerAdvice 通过该注解，我们可以将对于控制器的全局配置放置在同一个位置，注解了@Controller的类的方法可使用@ExceptionHandler、@InitBinder、@ModelAttribute注解到方法上，
这对所有注解了 @RequestMapping的控制器内的方法有效。

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

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

@ModelAttribute 本来的作用是绑定键值对到Model里，在@ControllerAdvice中是让全局的@RequestMapping都能获得在此处设置的键值对。

@CrossOrigin 用于解决跨域问题，只需在接口上进行声明即可，替代过滤器或拦截方式。

如有遗漏或有误的地方，希望帮忙指出。

13. SpringBoot部分
@ServletComponentScan 在SpringBootApplication上使用@ServletComponentScan注解后，Servlet、Filter、Listener可以直接通过@WebServlet、@WebFilter、@WebListener注解自动注册，无需其他代码。

————————————————
版权声明：本文为CSDN博主「IT_faquir」的原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/IT_faquir/article/details/78025203

• 点赞
• 收藏
• 分享
• 文章举报

neheqi 发布了17 篇原创文章 · 获赞 0 · 访问量 287 私信 关注