重新认识Spring Boot（八）Spring Boot 基础（中）-注解

缺乏、安全感 2022-11-21 03:42 203阅读 0赞

**目录**

Spring Boot 常用注解

1、什么是注解编程

2、了解系统注解

3、Spring Boot的常用注解

3.1、在类名上的注解

3.2、使用在方法上的注解

3.3、其他常用注解

--------------------

前言

参考书是 龙中华 《Spring Boot 实战派》

相关链接：

[https://blog.csdn.net/u013840066/article/details/104070447][https_blog.csdn.net_u013840066_article_details_104070447]

--------------------

# Spring Boot 常用注解 #

## 1、什么是注解编程 ##

注解（annotation）用来定义一个类，属性和一些方法，以便程序能够被快速编译处理，相当于一个说明文件，告诉应用程序某个被注解的类或者属性是什么，要怎么处理，注解可以用于标注包、类、方法、和变量等。

下方代码中的注解@RestController使用来定义Rest风格的控制器，其中，注解@GetMapping（“/hello”）定义的访问路径是"/hello"

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70][]

--------------------

## 2、了解系统注解 ##

系统注解表:

<table> 
 <tbody> 
  <tr> 
   <td>注解</td> 
   <td>说明</td> 
  </tr> 
  <tr> 
   <td>@Overrdie</td> 
   <td>用于修饰方法，表示此方法重写了父类内容</td> 
  </tr> 
  <tr> 
   <td>@Deprecated</td> 
   <td>用于修饰方法，表示该方法已过时，经常在版本升级后遇到</td> 
  </tr> 
  <tr> 
   <td>@SupperessWarnnings</td> 
   <td>告诉编译器忽视某类编译器警告。</td> 
  </tr> 
 </tbody> 
</table>

关于@SupperessWarnnings的注解 有以下几种属性

<table> 
 <tbody> 
  <tr> 
   <td>unchecked</td> 
   <td>未检查的转化</td> 
  </tr> 
  <tr> 
   <td>unused</td> 
   <td>未使用的变量</td> 
  </tr> 
  <tr> 
   <td>resource</td> 
   <td>泛型，即未指定类型</td> 
  </tr> 
  <tr> 
   <td>path</td> 
   <td>在类中的路径。原文件中有不存在的路径</td> 
  </tr> 
  <tr> 
   <td>deprecation</td> 
   <td>使用了某些不赞成使用的类和方法</td> 
  </tr> 
  <tr> 
   <td>fallthrough</td> 
   <td>switch语句执行到底，没有遇到break的关键字。</td> 
  </tr> 
  <tr> 
   <td>serial</td> 
   <td>实现了Serializable，但未定义SerialVersionUID</td> 
  </tr> 
  <tr> 
   <td>rawtypes</td> 
   <td>没有传递带有泛型的参数</td> 
  </tr> 
  <tr> 
   <td>all</td> 
   <td>代表全部类型的警告</td> 
  </tr> 
 </tbody> 
</table>

--------------------

## 3、Spring Boot的常用注解 ##

### 3.1、在类名上的注解 ###

<table>  使用在类名上的注解  
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>使用位置</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@RestController</td> 
   <td>类名上</td> 
   <td>作用相当于@ResponseBody+@Controller</td> 
  </tr> 
  <tr> 
   <td>@Controller</td> 
   <td>同上</td> 
   <td>声明此类是一个SpringMvc Controller对象</td> 
  </tr> 
  <tr> 
   <td>@Service</td> 
   <td>同上</td> 
   <td>声明一个业务处理类（实现非接口类）</td> 
  </tr> 
  <tr> 
   <td>@Repository</td> 
   <td>同上</td> 
   <td>声明数据库访问类（实现非接口类）</td> 
  </tr> 
  <tr> 
   <td>@Component</td> 
   <td>同上</td> 
   <td>代表其Spring的管理类，常用在无法用@Service，@Repository，描述的Spring管理的类，长和@Bean配合使用</td> 
  </tr> 
  <tr> 
   <td>@Configuration</td> 
   <td>同上</td> 
   <td>声明此类是一个配置类，长和@Bean配合使用</td> 
  </tr> 
  <tr> 
   <td>@Resource</td> 
   <td>同上</td> 
   <td>默认按byName自动注入</td> 
  </tr> 
  <tr> 
   <td>@AutoWired</td> 
   <td>类名上，属性或者构造函数参数上</td> 
   <td>默认按照byType自动注入</td> 
  </tr> 
  <tr> 
   <td>@RequestMapping</td> 
   <td>类名或者方法名称上</td> 
   <td>如果用在类，则表示所有的响应请求的方法都是以该地址作为父路径的</td> 
  </tr> 
  <tr> 
   <td>@Transaction</td> 
   <td>类名或者方法名称上</td> 
   <td>用于处理事务</td> 
  </tr> 
  <tr> 
   <td>@Qualifier</td> 
   <td>类名或者属性上</td> 
   <td>为Bean指定名称，随后在通过名字引用Bean</td> 
  </tr> 
 </tbody> 
</table>

详解:

1、@RestController

/**
    用于返回JSON、XML、等数据，但不能返回 HTML 页面，相当于注解@Controller + @ResponseBody一起使用
    比如：
    */
    @RestController
    public class HelloWorldController {
    
        @RequestMapping("/hello")
        public String hello(){
            return "Hello World";
        }
    
        /**
         * @RestController 代表是REST风格的控制器，返回JSON/XML类型的数据
         * @RequestMapping 配置URL和方法之间的映射。可注解在类和方法上，注解在方法中的@requestMapping 路径会继承在类的路径上
         * Hello 方法名
         * Return 返回的字符串 实例输出的就是Json格式的字符串"Hello World"
         */
    
    }

2、@controller

/**
    用于标注控制器层，在MVC开发模式中代表C（控制器）
    
    下面的程序代码代表的意思 和 @RestController的结果是一样的。
    */
    @Controller
    @ResponseBody
    public class HelloWorldController {
    
        @RequestMapping("/hello")
        public String hello(){
            return "Hello World";
        }
    
        /**
         * @RestController 代表是REST风格的控制器，返回JSON/XML类型的数据
         * @RequestMapping 配置URL和方法之间的映射。可注解在类和方法上，注解在方法中的@requestMapping 路径会继承在类的路径上
         * Hello 方法名
         * Return 返回的字符串 实例输出的就是Json格式的字符串"Hello World"
         */
    
    }

3、@Service

/**
    *用余生你给一个业务处理类（实现非接口类），用于标注浮层没出合理业务逻辑比如：
    */
    
    
    public interface UserService {
        
        void sayHello();
    }
    
    
    @Service
    public class UserServiceImpl implements UserService {
    
        /**
         * Description:重写了Service接口的实现了
         */
        @Override
        public void sayHello() {
            /*todo:就这*/
        }
    }

4、@Repository

用于标注数据库访问层

比如mapper层

5、Component

用于把普通的POJO（Plain Ordinary Java Object）简单的java对象，实例化到Spring容器中，该类不属于@controller，和@Service等，就可以使用@Component来标注这个类，可以配合CommandLineRunner是用，以便在程序启动后执行一些基础任务。

**注意:Spring 会把被注解@Controller、@Service、@Repository、@Component标注的类纳入Spring管理容器当中**

6、@Configuration

用于标注配置类，并且可以由Spring 容器自动处理，它作为Bean的载体，用于指示一个类声明，一个或者多个@Bean方法，在运行时为这些Bean生成BeanDefinition和服务请求。

7、@Resource

@AutoWired 和 @Resource 都可以用来装备Bean，也都可以写在字段上或者setter方法上

![20201030141454587.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70 2][]

8、@Autowired

他表示被修饰的类需要注入对象，Spring会扫描所有被@Autowired标注的类，然后根据类型在IoC容器中找到匹配度类进行注入。被@Autowired注解后的类不需要再导入文件。

9、@RequestMapping

用于处理请求地址映射，用在类或者方法上。如果用在类上，则表示类中的所有响应请求的方法都是以该地址作为父路径的。该注解有6个属性。

<table> 
 <tbody> 
  <tr> 
   <td>Params</td> 
   <td>指定Request中必须包含某些参数值，才让该方法处理</td> 
  </tr> 
  <tr> 
   <td>Headers</td> 
   <td>指定Request中必须包含某些制定的header值，才能让该方法处理请求</td> 
  </tr> 
  <tr> 
   <td>Value</td> 
   <td>指定请求的实际地址，指定的地址可以使URI Template模式</td> 
  </tr> 
  <tr> 
   <td>Method</td> 
   <td>指定请求的Method类型，比如GET、POST、PUT、DELETE等</td> 
  </tr> 
  <tr> 
   <td>Consumes</td> 
   <td>指定处理请求提交内容类型Content-type。比如"application/json,text/html"等</td> 
  </tr> 
  <tr> 
   <td>Produces</td> 
   <td>指定返回的内容类型，只有当Request请求头中的Accept类型中包含该指定类型时才返回</td> 
  </tr> 
 </tbody> 
</table>

10、@Transcational

它可以用在接口、接口方法、类、类方法上。

但是Spring 不建议在接口或者接口方法上使用该注解；因为该注解只有在使用基于接口的代理时候

才会生效。

如果异常被try catch了，则事务就不回滚了，如果想让事务回滚，必须在往外抛出异常。

·11、@Qualifier

他的意思是“合格者”，用于标注哪一个实现类才是需要注入的。需要注意的是，@Qualifier的参数名称为被注入的雷总的注解@Service标注的名称。

@Qualifier 长和 @Autowired一起使用

比如：

![20201030144353121.png][]

@Resource 和 Qualifier 不一样，@Resource自带name 属性。

--------------------

### 3.2、使用在方法上的注解 ###

<table>  使用在方法上的主要注解  
 <thead> 
  <tr> 
   <th>注解</th> 
   <th style="width:112px;">使用位置</th> 
   <th style="width:660px;">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@RequestBody</td> 
   <td style="width:112px;">方法参数前</td> 
   <td style="width:660px;">常用来处理application/json，application/xml，等Content-type类型的数据，意味着HTTP消息是JSON/XML格式，需要将其转化为指定类型的参数。</td> 
  </tr> 
  <tr> 
   <td>@pathVariable</td> 
   <td style="width:112px;">方法参数前</td> 
   <td style="width:660px;">将URL获取的参数映射到方法参数上</td> 
  </tr> 
  <tr> 
   <td>@Bean</td> 
   <td style="width:112px;">方法上</td> 
   <td style="width:660px;">声明该方法的返回结果是一个由Spring容器管理的Bean</td> 
  </tr> 
  <tr> 
   <td>@ResponseBody</td> 
   <td style="width:112px;">方法上</td> 
   <td style="width:660px;">通过适当的HttpMessageConverter将控制器中的方法返回对象转换为指定格式（JSON/XML），写入Response对象的body数据区</td> 
  </tr> 
 </tbody> 
</table>

1、@RequestBody

常用来处理JSON/XML格式的数据，通过@RequestBody可以将请求体重的（JSON/XML)字符串绑定到相应的Bean上，也可以将其分别绑定到对应的字符串上。

举例：AJAX提交数据，然后再控制器（后端）接收数据。

ajax前端:

$.ajax({
            url: "/postSelect",
            type: 'POST',
            contentType :'application/json charset=utf-8',
            data: {
                "name":帅气郭二狗"
            },
            dataType: 'JSON',
    
            /*加载中显示..*/
            beforeSend : function () {
                
            },
            /*加载完毕.取消*/
            complete: function () {
              
            },
            success: function (data) {
               alert(data)
            },
            error: function (e) {
                $("#result").html('ajax数据数据获取异常!' + e.status);
            }
        });

后端的控制器可以写成的代码如下：

@RequestMapping("/postSelect")
        public void postSelect(@RequestBody String name){
            /*todo:省略*/
        }

2、@PathVariable

用于获取路径中的参数

引用:[https://blog.csdn.net/sswqzx/article/details/84194979][https_blog.csdn.net_sswqzx_article_details_84194979]

package com.day01springmvc.controller;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.*;
    import org.springframework.web.servlet.ModelAndView;
     
    /**
     * @ Author     ：ShaoWei Sun.
     * @ Date       ：Created in 20:58 2018/11/16
     */
    @Controller
    @RequestMapping("hello")
    public class HelloController2 {
        /**
         *3、占位符映射
         * 语法：@RequestMapping(value=”user/{userId}/{userName}”)
         * 请求路径：http://localhost:8080/hello/show5/1/james
         * @param ids
         * @param names
         * @return
         */
        @RequestMapping("show5/{id}/{name}")
        public ModelAndView test5(@PathVariable("id") Long ids ,@PathVariable("name") String names){
            ModelAndView mv = new ModelAndView();
            mv.addObject("msg","占位符映射：id:"+ids+";name:"+names);
            mv.setViewName("hello2");
            return mv;
        }
    }

3、@Bean

代表产生一个Bean  并交给Spring 管理。用于封装对象，一般有Setter Getter方法。在MVC模型中对应的是M（模型）

参考：[https://www.cnblogs.com/feiyu127/p/7700090.html][https_www.cnblogs.com_feiyu127_p_7700090.html]

@Configuration
    public class AppConfig {
    
        @Bean
        public TransferService transferService() {
            return new TransferServiceImpl();
        }
    
    }

4、@ResponseBody

作用是通过转换器将控制器方法返回的对象转换为指定的格式，然后写入Response对象的body区。他常用来返回JSON/XML格式的数据。

在还是用直接后，数据直接写入数据流中，不需要视图渲染，比如：

@RequestMapping("/index")
        @ResponseBody
        public String index() {
            
            return "index";
        }

--------------------

### 3.3、其他常用注解 ###

<table>  其他常用注解  
 <thead> 
  <tr> 
   <th>注解</th> 
   <th style="width:167px;">使用位置</th> 
   <th style="width:545px;">作用说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@EnableAutoConfiguration</td> 
   <td style="width:167px;">入口类/类名上</td> 
   <td style="width:545px;">用来提供自动配置</td> 
  </tr> 
  <tr> 
   <td>@SpringBootApplication</td> 
   <td style="width:167px;">入口类/类名上</td> 
   <td style="width:545px;">用来启动入口类Application</td> 
  </tr> 
  <tr> 
   <td>@EnableScheduling</td> 
   <td style="width:167px;">入口类/类名上</td> 
   <td style="width:545px;"> <p>用来开启计划任务，Spring 通过@Scheduled支持多种类型的设计任务，包含cron,fixDelay,fixRate等</p> </td> 
  </tr> 
  <tr> 
   <td>@EnableAsync</td> 
   <td style="width:167px;">入口类/类名上</td> 
   <td style="width:545px;">用来开启异步注解功能</td> 
  </tr> 
  <tr> 
   <td>@ComponentScan</td> 
   <td style="width:167px;">入口类/类名上</td> 
   <td style="width:545px;">用来扫描组件可以自动发现和装配一些Bean，根据定义的扫描路径，把符合扫描规则的类装配到Spring容器中，告诉Spring 那个包（package）的类会被Spring自动扫描并且装入IOC容器，他对应XML配置中的元素，可以通过basePackages等属性来细粒度的定制自动扫描的范围，默认会从声明@ComponentScan所在类的包进行扫描</td> 
  </tr> 
  <tr> 
   <td>@Aspec</td> 
   <td style="width:167px;">入口类/类名上</td> 
   <td style="width:545px;">标注切面，可以用来配置事务，日志，权限验证，在用户请求是做一些处理等</td> 
  </tr> 
  <tr> 
   <td>@ControllerAdvice</td> 
   <td style="width:167px;">类名上</td> 
   <td style="width:545px;">包含@component，可以被扫描到，统一异常处理</td> 
  </tr> 
  <tr> 
   <td>@ExceptionHandler</td> 
   <td style="width:167px;">方法上</td> 
   <td style="width:545px;">用在方法上，表示遇到这个异常就执行该方法</td> 
  </tr> 
  <tr> 
   <td>@Value</td> 
   <td style="width:167px;">属性上</td> 
   <td style="width:545px;">用于获取配置文件的值</td> 
  </tr> 
 </tbody> 
</table>

Spring Boot 提供的注解还是有很多的。

--------------------

结尾：

做了两年开发，发现对Spring Boot 的认知上缺少了很多东西。因此想重新认识 Spring Boot 框架 仅此而已。

[https_blog.csdn.net_u013840066_article_details_104070447]: https://blog.csdn.net/u013840066/article/details/104070447
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70]: /images/20221120/0d1608bf32764231bd7f45f1eda7c19d.png
[20201030141454587.png]: https://img-blog.csdnimg.cn/20201030141454587.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20201030141655214.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20201030141810343.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx,size_16,color_FFFFFF,t_70
[20201030144353121.png]: https://img-blog.csdnimg.cn/20201030144353121.png
[https_blog.csdn.net_sswqzx_article_details_84194979]: https://blog.csdn.net/sswqzx/article/details/84194979
[https_www.cnblogs.com_feiyu127_p_7700090.html]: https://www.cnblogs.com/feiyu127/p/7700090.html