Spring&SpringBoot常用注解总结

目录

1.前言

2.@SpringBootApplication

3.@Spring Bean相关

   3.1 @Autowired

   3.2 @Component,@Repository,@Service,@Controller

   3.3 @RestController

   3.4 @Scope 

   3.5 @Configuration

4.处理常见的 HTTP 请求类型

   4.1 GET 请求

   4.2 POST 请求

   4.3 PUT 请求

   4.4 DELETE 请求

   4.5 PATCH 请求

5.前后端传值

   5.1 @PathVariable和@RequestParam

   5.3 @RequestBody

6.事务@Transactional

---

1.前言

这篇文章主要介绍 Spring/SpringBoot 常用注解，基本涵盖项目中遇到的大部分场景。在之前的Spring系列文章中我每篇都有介绍一部分注解，但是过多就会让人感到杂乱，所以在此篇文章做一个总结，对于每一个注解我都尽力说清楚具体用法，大家一起来看看吧。

因为博主个人能力和知识有限，如果有任何不对或者需要完善的地方，请帮忙指出！感激不尽！

2.@SpringBootApplication

这里先单独拎出@SpringBootApplication 注解说一下，虽然我们一般不会主动去使用它。

我们在创建SpringBoot项目后，会发现此注解会默认在主类加上

@SpringBootApplication
public class SpringbootStudyApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootStudyApplication.class, args);
    }
}

可以进入到@SpringBootApplication 底层来看看

package org.springframework.boot.autoconfigure;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
		@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
   ......
}

package org.springframework.boot;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {

}

我们可以把@SpringConfiguration看作是@Configuration,@EnableAutoConfiguration,@ComponentScan注解的集合。

根据 SpringBoot 官网，这三个注解的作用分别是：

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

3.@Spring Bean相关

3.1 @Autowired

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

@Service
public class UserService {
  ......
}

@RestController
@RequestMapping("/users")
public class UserController {
   @Autowired
   private UserService userService;
   ......
}

3.2 @Component,@Repository,@Service,@Controller

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

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

3.3 @RestController

@RestController注解是@Controller和@ResponseBody的合集,表示这是个控制器 bean,并且是将函数的返回值直接填入 HTTP 响应体中,是 REST 风格的控制器。

基本上前后端分离的项目都是使用这类注解

单独使用@Controller不加@ResponseBody的话一般是用在要返回一个视图的情况，这种情况属于比较传统的 Spring MVC 的应用，对应于前后端不分离的情况。@Controller+@ResponseBody 返回 JSON 或 XML 形式数据

3.4 @Scope 

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

@Bean
@Scope("singleton")
public Person personSingleton() {
    return new Person();
}

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

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

3.5 @Configuration

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

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

}

4.处理常见的 HTTP 请求类型

5 种常见的请求类型:

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

4.1 GET 请求 

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

@GetMapping("/users")
public ResponseEntity> getAllUsers() {
 return userRepository.findAll();
}

4.2 POST 请求

@PostMapping("user")等价于@RequestMapping("/user",method=RequestMethod.POST)

@PostMapping("/users")
public ResponseEntity createUser(@Valid @RequestBody UserCreateRequest userCreateRequest) {
 return userRespository.save(userCreateRequest);
}

4.3 PUT 请求

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

@PutMapping("/users/{userId}")
public ResponseEntity updateUser(@PathVariable(value = "userId") Long userId,
  @Valid @RequestBody UserUpdateRequest userUpdateRequest) {
  ......
}

4.4 DELETE 请求

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

@DeleteMapping("/users/{userId}")
public ResponseEntity deleteUser(@PathVariable(value = "userId") Long userId){
  ......
}

4.5 PATCH 请求

一般都是 PUT 不够用了之后才用 PATCH 请求去更新数据。

  @PatchMapping("/profile")
  public ResponseEntity updateStudent(@RequestBody StudentUpdateRequest studentUpdateRequest) {
        studentRepository.updateDetail(studentUpdateRequest);
        return ResponseEntity.ok().build();
    }

5.前后端传值

5.1 @PathVariable和@RequestParam

@PathVariable用于获取路径参数，@RequestParam用于获取查询参数。

举个简单的例子：

@GetMapping("/klasses/{klassId}/teachers")
public List getKlassRelatedTeachers(
         @PathVariable("klassId") Long klassId,
         @RequestParam(value = "type", required = false) String type ) {
...
}

如果我们请求的 url 是:/klasses/123456/teachers?type=web

那么我们服务获取到的数据就是:klassId=123456,type=web

5.3 @RequestBody

用于读取 Request 请求（可能是 POST,PUT,DELETE,GET 请求）的 body 部分并且Content-Type 为 application/json 格式的数据，接收到数据之后会自动将数据绑定到 Java 对象上去。

6.事务@Transactional

在要开启事务的方法上使用@Transactional注解即可!

@Transactional(rollbackFor = Exception.class)
public void save() {
  ......
}

我们知道 Exception 分为运行时异常 RuntimeException 和非运行时异常。在@Transactional注解中如果不配置rollbackfor属性,那么事务只会在遇到RuntimeException的时候才会回滚,加上rollbackFor=Exception.class,可以让事务在遇到非运行时异常时也回滚。

@Transactional 注解一般可以作用在类或者方法上。

• 作用于类：当把@Transactional注解放在类上时，表示所有该类的 public 方法都配置相同的事务属性信息。
• 作用于方法：当类配置了@Transactional，方法也配置了@Transactional，方法的事务会覆盖类的事务配置信息。