Spring&SpringBoot常用注解总结

为什么要写这篇文章？
最近看到网上有一篇关于 SpringBoot 常用注解的文章被转载的比力多，我看了文章内容之后属实觉得质量有点低，并且有点会误导没有太多实际利用经验的人（这些人又占据了大多数）。以是，自己索性花了大概 两天时间简单总结一下了。
1. @SpringBootApplication

这里先单独拎出@SpringBootApplication 注解说一下，虽然我们一般不会主动去利用它。
Guide：这个注解是 Spring Boot 项目标基石，创建

SpringBoot 项目之后会默认在主类加上。
我们可以把 @SpringBootApplication看作是 @Configuration、@EnableAutoConfiguration、@ComponentScan 注解的集合。
根据 SpringBoot 官网，这三个注解的作用分别是：

• @EnableAutoConfiguration：启用 SpringBoot 的自动设置机制
  
• @ComponentScan：扫描被@Component (@Repository,@Service,@Controller)注解的 bean，注解默认会扫描该类所在的包下所有的类。
  
• @Configuration：允许在 Spring 上下文中注册额外的 bean 或导入其他设置类
  

2. Spring Bean 相干

2.1. @Autowired

自动导入对象到类中，被注入进的类同样要被 Spring 容器管理好比：Service 类注入到 Controller 类中。

2.2. @Component,@Repository,@Service, @Controller

我们一般利用 @Autowired 注解让 Spring 容器帮我们自动装配 bean。要想把类标识成可用于 @Autowired 注解自动装配的 bean 的类,可以采用以下注解实现：

• @Component：通用的注解，可标注恣意类为 Spring 组件。假如一个 Bean 不知道属于哪个层，可以利用@Component 注解标注。
  
• @Repository : 对应持久层即 Dao 层，主要用于数据库相干操作。
  
• @Service : 对应服务层，主要涉及一些复杂的逻辑，需要用到 Dao 层。
  
• @Controller : 对应 Spring MVC 控制层，主要用于接受用户哀求并调用 Service 层返回数据给前端页面。
  

2.3. @RestController

@RestController注解是@Controller和@ResponseBody的合集,表现这是个控制器 bean,并且是将函数的返回值直接填入 HTTP 响应体中,是 REST 风格的控制器。
Guide：如今都是前后端分离，说实话我已经很久没有用过@Controller。假如你的项目太老了的话，就当我没说。
单独利用 @Controller 不加 @ResponseBody的话一般是用在要返回一个视图的环境，这种环境属于比力传统的 Spring MVC 的应用，对应于前后端不分离的环境。@Controller +@ResponseBody 返回 JSON 或 XML 情势数据
关于@RestController 和 @Controller的对比，请看这篇文章：@RestController vs @Controller。
2.4. @Scope

声明 Spring Bean 的作用域，利用方法:

四种常见的 Spring Bean 的作用域：

• singleton : 唯一 bean 实例，Spring 中的 bean 默认都是单例的。
  
• prototype : 每次哀求都会创建一个新的 bean 实例。
  
• request : 每一次 HTTP 哀求都会产生一个新的 bean，该 bean 仅在当前 HTTP request 内有用。
  
• session : 每一个 HTTP Session 会产生一个新的 bean，该 bean 仅在当前 HTTP session 内有用。
  

2.5. @Configuration

一般用来声明设置类，可以利用 @Component注解替代，不过利用@Configuration注解声明设置类更加语义化。

3. 处置惩罚常见的 HTTP 哀求范例

5 种常见的哀求范例:

• GET：哀求从服务器获取特定资源。举个例子：GET /users（获取所有门生）
  
• POST：在服务器上创建一个新的资源。举个例子：POST /users（创建门生）
  
• PUT：更新服务器上的资源（客户端提供更新后的整个资源）。举个例子：PUT /users/12（更新编号为 12 的门生）
  
• DELETE：从服务器删除特定的资源。举个例子：DELETE /users/12（删除编号为 12 的门生）
  
• PATCH：更新服务器上的资源（客户端提供更改的属性，可以看做作是部门更新），利用的比力少，这里就不举例子了。
  

3.1. GET 哀求

@GetMapping("users") 等价于@RequestMapping(value="/users",method=RequestMethod.GET)

3.3. PUT 哀求

@PutMapping("/users/{userId}") 等价于@RequestMapping(value="/users/{userId}",method=RequestMethod.PUT

3.4. DELETE 哀求

@DeleteMapping("/users/{userId}")等价于@RequestMapping(value="/users/{userId}",method=RequestMethod.DELETE)

3.5. PATCH 哀求

一般实际项目中，我们都是 PUT 不敷用了之后才用 PATCH 哀求去更新数据。

4. 前后端传值

掌握前后端传值的正确姿势，是你开始 CRUD 的第一步！
4.1. @PathVariable 和 @RequestParam

@PathVariable用于获取路径参数，@RequestParam用于获取查询参数。
举个简单的例子：

假如我们哀求的 url 是：/klasses/123456/teachers?type=web
那么我们服务获取到的数据就是：klassId=123456,type=web。
4.2. @RequestBody

用于读取 Request 哀求（可能是 POST,PUT,DELETE,GET 哀求）的 body 部门并且Content-Type 为 application/json 格式的数据，接收到数据之后会自动将数据绑定到 Java 对象上去。系统会利用HttpMessageConverter大概自定义的HttpMessageConverter将哀求的 body 中的 json 字符串转换为 java 对象。
我用一个简单的例子来给演示一下基本利用！
我们有一个注册的接口：

UserRegisterRequest对象：        

我们发送 post 哀求到这个接口，并且 body 携带 JSON 数据：        

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。