[Java知识库]跟小笼子一起学之SpringBoot注解对比分析

@SpringBootApplication

我们可以看到@SpringBootApplication中包含@SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan通常用在主类上。

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

这是 Spring Boot 最最最核心的注解，用在 Spring Boot 主类上，标识这是一个 Spring Boot 应用，用来开启 Spring Boot 的各项能力。

SpringBean相关

@Component

@Component是Spring中的一个注解，它的作用就是实现bean的注入。与@Component注解功能上相同的还有@Service、@Controller、@Repository。

@Autowired

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

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

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

@Autowired、@Qualifier和@Resource

与@Autowired功能相似的还有@Qualifier，@Resource这三个注解都是基于自动装配，@Autowired使用的较多，而@Qualifier需要配合@Autowired进行使用，@Resource则是通过名字进行自动装配

具体的代码实现请看另一篇文章：

@RestController

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

在传统的 Spring MVC 的应用中关于单独使用单独使用 @Controller 不加 @ResponseBody的话一般使用在要返回一个视图。

@Controller +@ResponseBody 返回 JSON 或 XML 形式数据

@Controller 和 @RestController的对比

@Controller 返回一个页面

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

@RestController 返回JSON 或 XML 形式数据

但@RestController只返回对象，对象数据直接以 JSON 或 XML 形式写入 HTTP 响应(Response)中，这种情况属于 RESTful Web服务，这也是目前日常开发所接触的最常用的情况（前后端分离）。

如果你需要在Spring4之前开发 RESTful Web服务的话，你需要使用@Controller并结合@ResponseBody注解，也就是说@Controller +@ResponseBody=@RestController（Spring 4 之后新加的注解）。

此处仅作简单介绍，具体内容请参考@RestController vs @Controller

@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 请求都会产生一个新的 bean，该 bean 仅在当前 HTTP session 内有效。

@Configuration

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

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

@Configuration和@Bean对比

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

一般来说，这俩个注解会在一起使用

处理常见的 HTTP 请求类型

5 种常见的请求类型:

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

GET 请求

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

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

POST 请求

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

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

PUT 请求

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

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

DELETE 请求

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

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

@RequestMapping、@GetMapping、@PostMapping对比

上面提到了五种请求类型，在使用的过程中，他们都可以等价于一种RequestMapping。只不过RequestMapping可以发起get请求或者post，而GetMapping和PostMapping只能发起get、post的请求。

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