SpringSpringBoot常⽤注解总结
可以毫不夸张地说，这篇⽂章介绍的 Spring/SpringBoot 常⽤注解基本已经涵盖你⼯作中遇到的⼤部分常⽤的场景。对于每⼀个注解我都说了具体⽤法，掌握搞懂，使⽤ SpringBoot 来开发项⽬基本没啥⼤问题了！
为什么要写这篇⽂章？
最近看到⽹上有⼀篇关于 SpringBoot 常⽤注解的⽂章被转载的⽐较多，我看了⽂章内容之后属实觉得质量有点低，并且有点会误导没有太多实际使⽤经验的⼈（这些⼈⼜占据了⼤多数）。所以，⾃⼰索性花了⼤概 两天时间简单总结⼀下了。
整个⽬录如下，内容有点多：
因为我个⼈的能⼒和精⼒有限，如果有任何不对或者需要完善的地⽅，请帮忙指出！Guide 哥感激不尽！
1. @SpringBootApplication
这⾥先单独拎出@SpringBootApplication 注解说⼀下，虽然我们⼀般不会主动去使⽤它。
Guide 哥：这个注解是 Spring Boot 项⽬的基⽯，创建 SpringBoot 项⽬之后会默认在主类加上。
@SpringBootApplication
public class SpringSecurityJwtGuideApplication {
public static void main(java.lang.String[] args) {
SpringApplication.run(SpringSecurityJwtGuideApplication.class, args);
}
}
我们可以把 @SpringBootApplication看作是 @Configuration、@EnableAutoConfiguration、@ComponentScan 注解的集合。
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 {
}
根据 SpringBoot 官⽹，这三个注解的作⽤分别是：
@EnableAutoConfiguration：启⽤ SpringBoot 的⾃动配置机制
@ComponentScan： 扫描被@Component (@Service,@Controller)注解的 bean，注解默认会扫描该类所在的包下所有的类。
@Configuration：允许在 Spring 上下⽂中注册额外的 bean 或导⼊其他配置类
2. Spring Bean 相关
2.1. @Autowired
⾃动导⼊对象到类中，被注⼊进的类同样要被 Spring 容器管理⽐如：Service 类注⼊到 Controller 类中。
@Service
public class UserService {
......
}
@RestController
@RequestMapping("/users")
public class UserController {
@Autowired
private UserService userService;
......
}
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的对⽐，请看这篇⽂章：。
2.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 请求都会产⽣⼀个新的 bean，该 bean 仅在当前 HTTP session 内有效。
2.5. Configuration
⼀般⽤来声明配置类，可以使⽤ @Component注解替代，不过使⽤Configuration注解声明配置类更加语义化。
@Configuration
public class AppConfig {
@Bean
public TransferService transferService() {
return new TransferServiceImpl();
}
}
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)
@GetMapping("/users")
public ResponseEntity<List<User>> getAllUsers() {
return userRepository.findAll();
}
springboot框架的作用3.2. POST 请求
@PostMapping("users") 等价于@RequestMapping(value="/users",method=RequestMethod.POST)
关于@RequestBody注解的使⽤，在下⾯的“前后端传值”这块会讲到。
@PostMapping("/users")
public ResponseEntity<User> createUser(@Valid @RequestBody UserCreateRequest userCreateRequest) {
return userRespository.save(user);
}
3.3. 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) {
......
}
3.4. DELETE 请求
@DeleteMapping("/users/{userId}")等价于@RequestMapping(value="/users/{userId}",method=RequestMethod.DELETE)
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论