SpringBoot常用注解大全（详细）

妖狐艹你老母 2023-10-04 22:46 38阅读 0赞

#### 文章目录 ####

*  @SpringBootApplication
 *  @==Component==、@Service、@Controller、@Repository
 *  @ResponseBody
 *  @RestController
 *  @AutoWired、@Qualifier、@Resource
 *  @RequestMapping、@GetMapping、@PostMapping
 *  @Value、@ConfigurationProperties、@PropertySource
 *  @Configuration、@Bean
 *  @RequestParam、@RequestBody、@PathVariable、@RequestHeader、@CookieValue

***SpringBoot的常用注解总结***  
**本文仅为借鉴csdn上一位大佬总结学习，如有侵权，联系删除。**

## @SpringBootApplication ##

包含@Configuration、@EnableAutoConfiguration、@ComponentScan通常用在主类上；  
![在这里插入图片描述][0494ce4e77c34e0a9eb1800224b03a1f.png]

<table> 
 <thead> 
  <tr> 
   <th>相关注解</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@ComponentScan</td> 
   <td>用来自动扫描被这些注解标识的类，最终生成ioc容器里的bean，默认扫描范围是@ComponentScan注解所在配置类包及子包的类</td> 
  </tr> 
  <tr> 
   <td>@SpringBootConfiguration</td> 
   <td>与@Configuration作用相同，都是用来声明当前类是一个配置类，这里表明是springboot主类使用的配置类</td> 
  </tr> 
  <tr> 
   <td>@EnableAutoConfiguration</td> 
   <td>是springboot实现自动化配置的核心注解，通过这个注解把spring应用所需的bean注入容器中</td> 
  </tr> 
 </tbody> 
</table>

## @Component、@Service、@Controller、@Repository ##

这几个注解放在一起是因为功能基本一样的，都是将类注入到spring容器中，只不过它们使用的场景不同，被@Component,@Service,@Controller,@Repository注解标注的类，这些类会被纳入进spring容器中管理。

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Repository</td> 
   <td>持久层（dao）注入spring容器</td> 
  </tr> 
  <tr> 
   <td>@Service</td> 
   <td>业务逻辑层（server）注入spring容器</td> 
  </tr> 
  <tr> 
   <td>@Controller</td> 
   <td>控制层（controller）注入spring容器</td> 
  </tr> 
  <tr> 
   <td>@Component</td> 
   <td>普通pojo注入spring容器</td> 
  </tr> 
 </tbody> 
</table>

## @ResponseBody ##

@ResponseBody可以作用在方法上或类上，表示该方法的返回结果直接写入 HTTP response body 中，而不会被解析为跳转路径，即不会经过视图解析器，返回什么数据即在页面输入什么数据。

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@ResponseBody</td> 
   <td>@ResponseBody的作用其实是将java对象转为json格式的数据。</td> 
  </tr> 
 </tbody> 
</table>

![在这里插入图片描述][a5589a6691e243e4b9624a4a52a17989.png]

## @RestController ##

该注解是@Controller和@ResponseBody的结合体，一般用于类，作用等于在类上面添加了@ResponseBody和@Controller

## @AutoWired、@Qualifier、@Resource ##

这3个注解都是基于注解方式进行自动装配，在容器里面将查找到的bean返回，一般@AutoWired用得最多，@Qualifier则需要配合@AutoWired使用，@Resource则是可以通过名字进行自动装配

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@AutoWired</td> 
   <td>@Autowired默认按类型装配，如果发现找到多个bean，则按照name方式比对，如果还有多个，则报出异常</td> 
  </tr> 
  <tr> 
   <td>@Qualifier</td> 
   <td>spring的注解，按名字注入 一般当出现两个及以上bean时,不知道要注入哪个，结合@AutoWired使用</td> 
  </tr> 
  <tr> 
   <td>@Resource</td> 
   <td>默认按名称注入例如@Resource(name = “zhaozhao”)则根据name属性注入找不到则报错，若无name属性则根据属性名称注入，如果匹配不成功则按照类型匹配匹配不成功则报错。</td> 
  </tr> 
 </tbody> 
</table>

@AutoWired  
![在这里插入图片描述][5a7e4ef319334ea4a691f9863d71fa8f.png]  
@Qualifier  
当有一个接口的多个实现类时，只用@AutoWired会报错，因为它有多个接口的实现类，不知道你要找哪一个，这个时候就需要在注入bean的时候起个名字，然后用@Qualifier注解指定哪一个bean(按照名字注入与装配)  
![在这里插入图片描述][4a8928213ff54545ab821866bd0140c0.png]  
@Resource  
该注解的使用相当于@AutoWired和@Qualifier配合使用的效果  
![在这里插入图片描述][dae5f190bcf947e7a8e848777493a020.png]

## @RequestMapping、@GetMapping、@PostMapping ##

这3个注解功能也是类似的，通过这3个注解来映射请求，也就是通过它来指定控制器可以处理哪些URL请求，用在方法上，可以通过配置的url进行访问

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@RequestMapping</td> 
   <td>@RequestMapping（url），通过该注解就可以通过配置的url进行访问，方式可以是get或post请求，两种方式均可</td> 
  </tr> 
  <tr> 
   <td>@GetMapping</td> 
   <td>@GetMapping（url） ，功能类似的，只是这个限定了只能是Get请求</td> 
  </tr> 
  <tr> 
   <td>@@PostMapping</td> 
   <td>@PostMapping（url），功能类似的，只是这个限定了只能是Post请求</td> 
  </tr> 
 </tbody> 
</table>

@RequestMapping  
发起get请求或者post请求都可以![在这里插入图片描述][7ab0096516f842e7b6f75d073aa40026.png]  
@GetMapping  
只能用get请求  
![在这里插入图片描述][e8e28508462c4250937facca5aeeced6.png]  
@PostMapping  
只能发起post请求  
![在这里插入图片描述][79576dece1264cafa9e7a0b5c6d4b77d.png]

## @Value、@ConfigurationProperties、@PropertySource ##

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Value</td> 
   <td>用于获取bean的属性，一般用于读取配置文件的数据，作用在变量上</td> 
  </tr> 
  <tr> 
   <td>@ConfigurationProperties</td> 
   <td>用于注入Bean属性，然后再通过当前Bean获取注入值，作用在类上</td> 
  </tr> 
  <tr> 
   <td>@PropertySource</td> 
   <td>用于指定要读取的配置文件，可以和@Value或@ConfigurationProperties配合使用</td> 
  </tr> 
 </tbody> 
</table>

***@PropertySource不支持yml文件读取。***  
@Value  
这里用yml配置文件进行演示，propres配置文件也是同样的效果，在application.yml配置文件里设置开发环境的的配置文件（dev），这样用@Value获取到的就是开发环境的配置文件的数据，切换成生产环境（pro）则获取到的是生产环境的数据  
![在这里插入图片描述][3ddcd38afb84497cb4ca79bd77f92a07.png]  
![在这里插入图片描述][630ea33bc6bf4186ae1081ef9ccb138c.png]  
@ConfigurationProperties  
该注解可以直接注入整个类的数据，作用于类

配置文件如下，这里使用pro环境  
![在这里插入图片描述][8e7b65014bd8485fb0b3c78f6d19ab79.png]  
![在这里插入图片描述][a44ab21844344094bf4d9ef60001226b.png]  
@PropertySource  
注意：@PropertySource不支持yml文件读取。  
配置文件如下：people.properties  
![在这里插入图片描述][fad787cfc8214d5d97ee79b5358bf3f6.png]  
测试  
![在这里插入图片描述][e7730f4a421c44878688658eba87d4c5.png]  
当然@PropertySource还可以和@Value配合使用，即一个一个注入值。

## @Configuration、@Bean ##

@Configuration作用于类上面，表明这是一个配置类，@Bean产生一个Bean对象加入Spring IOC容器

注意：@Configuration标注在类上，相当于把该类作为spring的xml配置文件中，作用为：配置spring容器(应用上下文)

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Configuration</td> 
   <td>作用于类上表示这是一个配置类，可理解为用spring的时候xml里面的&lt; beans&gt;标签</td> 
  </tr> 
  <tr> 
   <td>@Bean</td> 
   <td>产生bean对象加入容器，作用于方法，可理解为用spring的时候xml里面的标签</td> 
  </tr> 
 </tbody> 
</table>

新建配置类，将User加入容器，并自定义生命周期  
![在这里插入图片描述][a406a9136b024168a8ebc6127c61288f.png]  
测试  
![在这里插入图片描述][450b8c85441440ab97ff0772e75f63db.png]

## @RequestParam、@RequestBody、@PathVariable、@RequestHeader、@CookieValue ##

这几个注解放在一起主要是经常在控制层用来接收参数的

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@RequestParam</td> 
   <td>获取查询参数。即url?name=这种形式</td> 
  </tr> 
  <tr> 
   <td>@PathVariable</td> 
   <td>获取路径参数。即url/{id}这种形式。</td> 
  </tr> 
  <tr> 
   <td>@RequestParam</td> 
   <td>获取Body的参数，一般用于post获取参数</td> 
  </tr> 
  <tr> 
   <td>@RequestHeader</td> 
   <td>获取请求头的信息</td> 
  </tr> 
  <tr> 
   <td>@CookieValue</td> 
   <td>获取Cookie的信息</td> 
  </tr> 
  <tr> 
   <td>@RequestParam</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>@RequestParam主要用于接收url?后面的参数，get或post请求，只要后面的url?有参数都可以获取到对应的参数</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

@RequestParam注解有几个比较重要的属性，required 表示是否必须，默认为 true，必须。defaultValue 可设置请求参数的默认值。value 为接收url的参数名（相当于key值）。

示例代码如下

@GetMapping("/requestParam")
        @ResponseBody
        public Map<String, String> requestParam(
                UserDto userDto,//通过一个实体类来接收，字段名必须一致
                @RequestParam(value = "id", required = false) String userId,
                @RequestParam(value = "name", required = false) String userName,
                @RequestParam(value = "pageIndex", required = true, defaultValue = "1") String pageIndex,
                @RequestParam(value = "pageSize", required = true, defaultValue = "5") String pageSize) {
        
    
            Map<String, String> map = new HashMap<>();
            map.put("userDto",userDto.toString());
            map.put("id", userId);
            map.put("name", userName);
            map.put("pageIndex", pageIndex);
            map.put("pageSize", pageSize);
            return map;
        }

运行  
![在这里插入图片描述][91a76f32ef874f86a6c7bbd9580ccd6f.png]  
@PathVariable  
该注解主要用于获取路径参数，像url/\{id\}/\{name\}这种形式的参数都可以，get获取post请求均可

示例代码如下：

@PostMapping("/pathVariable/{id}/{name}")
        @ResponseBody
        public Map<String, String> pathVariable(
                @PathVariable(name = "id") String userId,
                @PathVariable(name = "name") String userName) {
        
    
            Map<String, String> map = new HashMap<>();
            map.put("id", userId);
            map.put("name", userName);
            return map;
        }

运行结果  
![在这里插入图片描述][dd687ac849d644fe82aa6aaac3186a80.png]@RequestBody  
该注解用于获取请求体数据（body）,get没有请求体，故而一般用于post请求

示例代码如下：

@PostMapping("/test01")
        @ResponseBody
        public UserDto test01(@RequestBody UserDto userDto) {
        
            return userDto;
        }
    
        @PostMapping("/test02")
        @ResponseBody
        public String test02(@RequestBody String str) {
        
            return str;
        }

运行结果  
![在这里插入图片描述][76dac826b25243f1ad093ced8b93a188.png]  
![在这里插入图片描述][efd10c0ac4694f40b38292ee00c8c259.png]  
注意，如果要传多个参数过去只能将其封装成一个类，如果是出现了多个@RequestBody注解访问的时候会报400错误，例如下面这种代码就是错误的

@PostMapping("/requestBody")
        @ResponseBody
        public Map<String,String> requestBody(
                @RequestBody(required = true) String id,
                @RequestBody(required = true) String name,
                @RequestBody(required = false) String sex,
                @RequestBody(required = false) String age
                ){
        
    
            Map<String,String> map = new HashMap<>();
            map.put("id","id");
            map.put("name","name");
    
            return map;
        }

@RequestHeader  
示例代码如下

@PostMapping("/requestHeader")
        @ResponseBody
        public String requestBody03(@RequestHeader(name = "Content-Type") String contentType){
        
            return contentType;
        }

结果  
![在这里插入图片描述][099d15a2f525492aadf46ed32e93f391.png]  
@CookieValue

@GetMapping("/demo3")
    public void demo3(@RequestHeader(name = "myHeader") String myHeader,
            @CookieValue(name = "myCookie") String myCookie) {
        
        System.out.println("myHeader=" + myHeader);
        System.out.println("myCookie=" + myCookie);
    }

***加油叭 程序猿！***  
原文链接：[https://blog.csdn.net/qq\_40298902/article/details/107746642][https_blog.csdn.net_qq_40298902_article_details_107746642]

[0494ce4e77c34e0a9eb1800224b03a1f.png]: https://img-blog.csdnimg.cn/0494ce4e77c34e0a9eb1800224b03a1f.png
[a5589a6691e243e4b9624a4a52a17989.png]: https://img-blog.csdnimg.cn/a5589a6691e243e4b9624a4a52a17989.png
[5a7e4ef319334ea4a691f9863d71fa8f.png]: https://img-blog.csdnimg.cn/5a7e4ef319334ea4a691f9863d71fa8f.png
[4a8928213ff54545ab821866bd0140c0.png]: https://img-blog.csdnimg.cn/4a8928213ff54545ab821866bd0140c0.png
[dae5f190bcf947e7a8e848777493a020.png]: https://img-blog.csdnimg.cn/dae5f190bcf947e7a8e848777493a020.png
[7ab0096516f842e7b6f75d073aa40026.png]: https://img-blog.csdnimg.cn/7ab0096516f842e7b6f75d073aa40026.png
[e8e28508462c4250937facca5aeeced6.png]: https://img-blog.csdnimg.cn/e8e28508462c4250937facca5aeeced6.png
[79576dece1264cafa9e7a0b5c6d4b77d.png]: https://img-blog.csdnimg.cn/79576dece1264cafa9e7a0b5c6d4b77d.png
[3ddcd38afb84497cb4ca79bd77f92a07.png]: https://img-blog.csdnimg.cn/3ddcd38afb84497cb4ca79bd77f92a07.png
[630ea33bc6bf4186ae1081ef9ccb138c.png]: https://img-blog.csdnimg.cn/630ea33bc6bf4186ae1081ef9ccb138c.png
[8e7b65014bd8485fb0b3c78f6d19ab79.png]: https://img-blog.csdnimg.cn/8e7b65014bd8485fb0b3c78f6d19ab79.png
[a44ab21844344094bf4d9ef60001226b.png]: https://img-blog.csdnimg.cn/a44ab21844344094bf4d9ef60001226b.png
[fad787cfc8214d5d97ee79b5358bf3f6.png]: https://img-blog.csdnimg.cn/fad787cfc8214d5d97ee79b5358bf3f6.png
[e7730f4a421c44878688658eba87d4c5.png]: https://img-blog.csdnimg.cn/e7730f4a421c44878688658eba87d4c5.png
[a406a9136b024168a8ebc6127c61288f.png]: https://img-blog.csdnimg.cn/a406a9136b024168a8ebc6127c61288f.png
[450b8c85441440ab97ff0772e75f63db.png]: https://img-blog.csdnimg.cn/450b8c85441440ab97ff0772e75f63db.png
[91a76f32ef874f86a6c7bbd9580ccd6f.png]: https://img-blog.csdnimg.cn/91a76f32ef874f86a6c7bbd9580ccd6f.png
[dd687ac849d644fe82aa6aaac3186a80.png]: https://img-blog.csdnimg.cn/dd687ac849d644fe82aa6aaac3186a80.png
[76dac826b25243f1ad093ced8b93a188.png]: https://img-blog.csdnimg.cn/76dac826b25243f1ad093ced8b93a188.png
[efd10c0ac4694f40b38292ee00c8c259.png]: https://img-blog.csdnimg.cn/efd10c0ac4694f40b38292ee00c8c259.png
[099d15a2f525492aadf46ed32e93f391.png]: https://img-blog.csdnimg.cn/099d15a2f525492aadf46ed32e93f391.png
[https_blog.csdn.net_qq_40298902_article_details_107746642]: https://blog.csdn.net/qq_40298902/article/details/107746642