Spring - Spring 常用注解

Posted 2020-11-22 轩辕拾銉

1. 概述

   1. 简单整理一些 Spring 的注解
   2. 这个算是一个 水一波 类型的整理
      1. 内容不全
      2. 分类可能有的地方不会太符合逻辑
      3. 而且时间也不太充裕
      4. 先把自己想写的写下来, 然后随缘整理吧

2. 约定

   1. 版本
      1. Spring
         1. 5

3. 后悔

   1. 相关的书, 看了 半个月后 才想起来整理
      1. 现在看起来, 有点累
      2. 有些东西, 可能记的不那么精准
         1. 发现问题, 及时修补吧

1. 基本

1. @SpringBootApplication

   1. 概述

      1. spring 入口类的注解
      2. 由 3 个老注解合成

   2. 类型

      1. 类注解
         1. SpringBoot 的入口类

   3. 组成

      1. @SpringBootConfiguration
         1. 配置类
            1. 是 @Configuration 的一个特殊形式
            2. 告诉大家, 这是一个 配置类
      2. @EnableAutoConfiguration
         1. 选项
            1. 开启自动配置
               1. 自动配置, 是 spring boot 的特性
               2. 用很多的约定代替了配置
      3. @ComponentScan

         1. 选项

            1. 开启组件扫描
               1. 为后面的自动注入, 做了基础

         2. 相关注解

            1. @Component
            2. @Controller
            3. @Service

   4. ref

      1. Annotation Type SpringBootApplication

2. @Component

   1. 概述

      1. spring 组件注解
         1. 有子类
            1. @Controller
            2. @Service

   2. 类型

      1. 类注解
         1. 组件类
         2. 自动扫描

   3. 配合

      1. 需要与 @SpringBootApplication 配合
         1. 主要是 自动扫描

   4. ref

      1. @Component

3. @Controller

   1. 概述

      1. Spring WebMvc 的注解

   2. 类型

      1. 类注解
         1. 出现在 Controller 上

   3. 配合

      1. 需要与 @SpringBootApplication 配合
         1. 主要是 自动扫描

   4. ref

      1. Annotation Type Controller

4. @Service

   1. 概述

      1. Spring 注解

   2. 类型

      1. 类注解
         1. 出现在 Service 上
            1. Service 通常是某个接口的实现

   3. 配合

      1. 需要与 @SpringBootApplication 配合
         1. 主要是 自动扫描

   4. ref

      1. Annotation Type Service

5. @Autowired

   1. 概述

      1. Spring 注解
      2. 自动注入

   2. 类型

      1. 对象注解
         1. 出现在对象声明上
         2. 自动识别类型进行填充
            1. 也可以手动执行

   3. 配合

      1. @Component
      2. @Controller
      3. @Service
      4. @Repository

   4. ref

      1. Annotation Type Autowired
      2. Spring 注解配置（2）——@Autowired
         1. Autowired 指定特定类型来 填充对象

6. @Configuration

   1. 概述

      1. Spring 注解类

   2. 类型

      1. 类注解
         1. 类中会有方法
            1. 运行时生成 bean
            2. 运行时处理 对这些 bean 的秦秋
         2. 比如 WebConfig
            1. web 配置
            2. 本身也是 bean

   3. ref

      1. Annotation Type Configuration

7. @Repository

   1. 概述

      1. Spring 数据库交互类注解

   2. 类型

      1. 类注解
         1. 通常会借助 各种template类, 与持久化数据交互

   3. ref

      1. Annotation Type Repository

2. mvc

1. @RequestMapping

   1. 概述

      1. 声明 Controller 负责的路径

   2. 类型

      1. 类注解
         1. 规定了整个 controller 下的默认路径
            1. 下面的 处理方法, 如果没有描述 路径, 按这个路径来
            2. 如果描述了, 则以这个为 根路径, 继续处理
      2. 方法注解
         1. 通常还需要指定其他
            1. 请求方式
            2. 路径
            3. 路径中的参数

   3. 配合

      1. 各种 @Mapping

   4. ref

      1. Annotation Type RequestMapping

2. 各种 @Mapping

   1. 概述

      1. 对应各种协议

   2. 类型

      1. 方法注解
         1. 注解处理特定协议的 controller 方法

   3. 注解

      1. @GetMapping
      2. @PostMapping
      3. @PutMapping
      4. @DeleteMapping
      5. @PatchMapping

   4. 配合

      1. @RequestMapping

   5. ref

      1. Annotation Type GetMapping
         1. 只给了 GetMapping
         2. 其他的可以从页面跳转

3. @SessionAttributes

   1. 概述

      1. 声明要保存在 session 的 model 属性值

   2. 类型

      1. 类注解
         1. 对特定 controller 使用
            1. 一个 controller 使用就行

   3. ref

      1. Annotation Type SessionAttributes

4. @ModelAttribute

   1. 概述

      1. model 属性
         1. 功能有点多

   2. 类型

      1. 属性注解
         1. 用在 reqeust 方法的形参里
            1. 可以从 请求的 model 里抓取出相应类型对象, 并传给形参
      2. 方法注解
         1. 将方法的返回值, 作为 model 对应属性的值
            1. 这块还需要 复习, 有点模糊了

   3. ref

      1. Annotation Type ModelAttribute

3. rest

1. @RestController

   1. 概述

      1. 将 controller 标注为 restcontroller

   2. 类型

      1. 类注解
         1. 默认类里的 controller 方法, 带有一下注解
            1. @ResponseBody
               1. 返回 数据, 写到 responsebody 里

   3. ref

      1. Annotation Type RestController

2. @PathVariable

   1. 概述

      1. 属性作为形参

   2. 类型

      1. 属性注解
         1. 从 url 路径中, 取出 同名字段, 作为形参

   3. ref

      1. Annotation Type PathVariable

3. @ResponseStatus

   1. 概述

      1. 为 response 指定属性

   2. 类型

      1. 方法注解
         1. 为 response 指定属性

   3. 配合

      1. @Mapping
      2. @RequestMapping
      3. Enum HttpStatus

   4. ref

      1. Annotation Type ResponseStatus
      2. Enum HttpStatus
         1. 状态, 配合 responsestatus

4. @RequestBody

   1. 概述

      1. 从 RequestBody 里获取内容

   2. 类型

      1. 属性注解
         1. controller 方法参数
            1. 从 request 的 body 里获取
            2. 问题, 貌似 request body 里, 必须是一个完整的对象

   3. ref

      1. Annotation Type RequestBody

4. 测试

1. @RunWith(SpringRunner.class)

   1. 概述

      1. spring boot 的测试注解
      2. 其实是 JUnit 的一个注解
         1. JUnit 4

   2. 类型

      1. 类注解
         1. 测试类
            1. 需要 spring 注解, 都需要添加
            2. 否则 spring 相关注解会被无视

   3. SpringRunner.class

      1. 指定的 runner
         1. 这个不太清楚
         2. 一般用这个没错

2. @SpringBootTest

   1. 概述

      1. spring boot 测试
      2. 完整的 spring 上下文

   2. 类注解

      1. 类注解
         1. spring boot 测试类

   3. 作用

      1. 启动 spring boot application context
      2. 使用默认的 SpringBootContextLoader 加载 context
      3. 使用默认的 @SpringBootConfiguration 加载配置
      4. 其他详见 api 文档吧...

   4. ref

      1. Annotation Type SpringBootTest

3. @WebMvcTest

   1. 概述

      1. spring boot 测试注解
      2. spring web mvc 相关测试

   2. 类型

      1. 类注解
      2. spring boot webmvc 测试类
         1. 只测试 webmvc

   3. 补充

      1. 如果需要完整的 spring 上下文
         1. 请带上 @SpringBootTest

   4. 配合

      1. 可能会和 MockMvc 这个类做配合

   5. ref

      1. [Annotation Type WebMvcTest](https://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/test/autoconfigure/web/servlet/WebMvcTest.html

4. @RequestParam

   1. 略

ps

1. ref

   1. spring in action 5th edition

2. 其他注解

   1. lombok
   2. testng
   3. spring security
      1. 这个要补充...
   4. spring valid
      1. 这个随缘补充
   5. spring configuration properties
      1. 这个需要补充