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

谁借莪１个温暖的怀抱￠ 2022-12-11 03:17 92阅读 0赞

点击上方“java大数据修炼之道”，选择“设为星标”

# 优质文章和精品资源, 第一时间送达 #

###  ###

![format_png][]

###  ###

![format_png 1][]

来源：u6.gg/sSXQU

**上一篇：**[面试必问的一致性Hash在负载均衡中的应用][Hash]

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

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

##     ##

![format_png 2][]

Spring部分

### 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配置（类上）

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

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

@ComponentScan 用于对Component进行扫描，相当于xml中的（类上）

@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;12

》注入配置文件

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

注入配置使用方法：

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

book.name=《三体》

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

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

③ 还需配置一个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 开启注解式事务的支持

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

### 10.测试相关注解 ###

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

@RunWith(SpringJUnit4ClassRunner.class)1

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

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

##     ##

![format_png 2][]

SpringMVC部分

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

@Controller 声明该类为SpringMVC中的Controller

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

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

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

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

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

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

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

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

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

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

*  ####  ####
    
    ![format_png 3][]
    
    \-- < End > --
 *  ####  ####
    
    **最近热文推荐：**
    
    1、[建议收藏 | Redis 使用 10 个小技巧][_ Redis _ 10]  
    
    
    2、[永远不要在代码中使用“User”这个单词][User]
    
    3、[项目中常用的19条MySQL优化][19_MySQL]
    
    4、[单怼多线程，60道面试题，你能答上几个？（附答案）][60]
    
    5、[这21 个刁钻的HashMap 面试题，我把阿里面试官吊打了！][21 _HashMap]
    
    6、[PanDownload复活了！60MB/s！附下载地址！][PanDownload_60MB_s]  
    
    
    7、[14 款牛逼的 IDEA 插件，让你开发速度飞起来！][14 _ IDEA]  
    
    
    8、[Redis分布式锁没用明白，搞出了大故障…][Redis]
    
    9、[程序员面试 10 大潜规则，千万不要踩坑！][10]  
    
    
    10、[*【收藏了】10分钟读懂进程线程、同步异步、阻塞非阻塞、并发并行*][10 1]
 *  #### **看完本文有收获？请转发分享给更多有需要的人** ####
 *  ####  ####
    
    关注 java大数据修炼之道
    
    **![format_png 4][]**每天学习java技术，你想学的Java知识这里都有！**![format_png 4][]**
    
    ![format_png 5][]
    
    微信扫描二维码，关注我的公众号
    
    写留言
 *  ####  ####
    
    如果对你有一点点帮助,请点个"在看",谢谢 ![format_png 6][]

[format_png]: /images/20221123/8c0a4a9361ea4a97bdb6206f1914d3dd.png
[format_png 1]: /images/20221123/8c7c978f2ce44d7aa2a3185db8917706.png
[Hash]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc22d53ccb5a4458368c5034905386313cc8eaf10dad2ba864989c613ae17febd1d1bfb91e3&idx=1&mid=2247492511&scene=21&sn=27c655b7b71e5a98abd810fd6f395450#wechat_redirect
[format_png 2]: /images/20221123/addd7d4d821c494792d9b3d5adc86373.png
[format_png 3]: /images/20221123/0805bbf139624ecca3ccbce3aed4573f.png
[_ Redis _ 10]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc22e05ccb5a713216d76a47efd7e4144ab9be9616235630f5f4edea4c8615182203fb8ef74&idx=1&mid=2247491785&scene=21&sn=a8cae67660d5733f1da6003c50d3529f#wechat_redirect
[User]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc1d142ccb65854ace9258a558f9fd0e17ad91a79020d569c567145f1dce2750f245a92a384&idx=1&mid=2247491470&scene=21&sn=b26fdeba68dab79e467857b93b2a547a#wechat_redirect
[19_MySQL]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc22c17ccb5a501df41ddeaecf0f7e85e292b45d6c7522e4d6a4d9c4a93a389338ee175eae8&idx=1&mid=2247492315&scene=21&sn=37c6888e30892c7fae56d0769c35a571#wechat_redirect
[60]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc1d557ccb65c41ec5d3b7dedd6c7a22949ddcb5de1406de482c3b702a1a4768c66b730b219&idx=1&mid=2247490459&scene=21&sn=66bc23ae41a8abcb9a6f00be754b2e47#wechat_redirect
[21 _HashMap]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc1d429ccb65d3fc4be6ab008e4318d3beeccb1394801c72e33cbb9fd162868dce2b9b0c0f2&idx=1&mid=2247490277&scene=21&sn=63d44db7ae6930f25478119f423227d4#wechat_redirect
[PanDownload_60MB_s]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc22c0eccb5a5182a51b78623168377d719bedbf820659acf2d1e71060c0046f6a18811be50&idx=1&mid=2247492290&scene=21&sn=fd4c3acf8e4589bc578b5425b1d7d8d1#wechat_redirect
[14 _ IDEA]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc22c62ccb5a574a582677624bade6875be9a2ed64c74e970aa92378b3aada01448d43c818e&idx=1&mid=2247492270&scene=21&sn=faa5635ed83673df61747b147cab46e7#wechat_redirect
[Redis]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc1d038ccb6592e2d08ccd07a31a069ebbfc64d9abd2d1cfd88dba5efc1439f14cc78392bf3&idx=1&mid=2247491316&scene=21&sn=59fdccb5447abec7e33c881110c5be1f#wechat_redirect
[10]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc22cc6ccb5a5d09ec368b85dfe087d1b68f6ccbf67d7275356f64f203d353dcba684b4012e&idx=1&mid=2247492106&scene=21&sn=e25c3eea649006f34fd6f5cb62ea78be#wechat_redirect
[10 1]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc1d748ccb65e5e8bfe2334dac9c4a1678fa77a4b1c6bb230fb4442682c36120cfb8d8941ae&idx=1&mid=2247489924&scene=21&sn=40b4b841430ae75879b25545291dbf0a#wechat_redirect
[format_png 4]: /images/20221123/2848a28b179240cf83f5c7399f790742.png
[format_png 5]: /images/20221123/5492fbe038b441fa83843acda3f14814.png
[format_png 6]: /images/20221123/75412c10a0174d898659058a7c68170c.png