一、简介

基于 SpringBoot 平台开发的项目数不胜数，与常规的基于Spring开发的项目最大的不同之处，SpringBoot 里面提供了大量的注解用于快速开发，而且非常简单，基本可以做到开箱即用!

那 SpringBoot 为开发者提供了多少注解呢?我们该如何使用?

针对此问题，小编特意对其进行了一番整理，内容如下，个人感觉还是比较清晰的，今天我们就一起来整一整每个注解的含义和用法，以免踩坑!

二、注解总结

2.1. SpringMVC 相关注解

• @Controller

通常用于修饰controller层的组件，由控制器负责将用户发来的URL请求转发到对应的服务接口，通常还需要配合注解@RequestMapping使用。

• @RequestMapping

提供路由信息，负责URL到Controller中具体函数的映射，当用于方法上时，可以指定请求协议，比如GET、POST、PUT、DELETE等等。

• @RequestBody

表示请求体的Content-Type必须为application/json格式的数据，接收到数据之后会自动将数据绑定到Java对象上去

• @ResponseBody

表示该方法的返回结果直接写入HTTP response body中，返回数据的格式为application/json。

比如，请求参数为json格式，返回参数也为json格式，示例代码如下：

复制

/*** 登录服务*/
@Controller
@RequestMapping("api")
public class LoginController {/*** 登录请求，post请求协议，请求参数数据格式为json* @param request*/@RequestMapping(value = "login", method = RequestMethod.POST)@ResponseBodypublic ResponseEntity login(@RequestBody UserLoginDTO request){//...业务处理return new ResponseEntity(HttpStatus.OK);}
}

• @RestController

和@Controller一样，用于标注控制层组件，不同的地方在于：它是@ResponseBody和@Controller的合集，也就是说，在当@RestController用在类上时，表示当前类里面所有对外暴露的接口方法，返回数据的格式都为application/json，示范代码如下：

复制

@RestController
@RequestMapping("api")
public class LoginController {/*** 登录请求，post请求协议，请求参数数据格式为json* @param request*/@RequestMapping(value = "login", method = RequestMethod.POST)public ResponseEntity login(@RequestBody UserLoginDTO request){//...业务处理return new ResponseEntity(HttpStatus.OK);}
}

• @RequestParam

用于接收请求参数为表单类型的数据，通常用在方法的参数前面，示范代码如下：

复制

/*** 登录请求，post请求协议，请求参数数据格式为表单*/
@RequestMapping(value = "login", method = RequestMethod.POST)
@ResponseBody
public ResponseEntity login(@RequestParam(value = "userName",required = true) String userName,@RequestParam(value = "userPwd",required = true) String userPwd){//...业务处理return new ResponseEntity(HttpStatus.OK);
}

• @PathVariable

用于获取请求路径中的参数，通常用于restful风格的api上，示范代码如下：

复制

/*** restful风格的参数请求* @param id*/
@RequestMapping(value = "queryProduct/{id}", method = RequestMethod.POST)
@ResponseBody
public ResponseEntity queryProduct(@PathVariable("id") String id){//...业务处理return new ResponseEntity(HttpStatus.OK);
}

• @GetMapping

除了@RequestMapping可以指定请求方式之外，还有一些其他的注解，可以用于标注接口路径请求，比如GetMapping用在方法上时，表示只支持get请求方法，等价于@RequestMapping(value="/get",method=RequestMethod.GET)。

复制

@GetMapping("get")
public ResponseEntity get(){return new ResponseEntity(HttpStatus.OK);
}

• @PostMapping

用在方法上，表示只支持post方式的请求。

复制

@PostMapping("post")
public ResponseEntity post(){return new ResponseEntity(HttpStatus.OK);
}

• @PutMapping

用在方法上，表示只支持put方式的请求，通常表示更新某些资源的意思。

复制

@PutMapping("put")
public ResponseEntity put(){return new ResponseEntity(HttpStatus.OK);
}

• @DeleteMapping

用在方法上，表示只支持delete方式的请求，通常表示删除某些资源的意思。

复制

@DeleteMapping("delete")
public ResponseEntity delete(){return new ResponseEntity(HttpStatus.OK);
}

2.2. bean 相关注解

• @Service

通常用于修饰service层的组件，声明一个对象，会将类对象实例化并注入到bean容器里面。

复制

@Service
public class DeptService {//具体的方法
}

• 1.
• 2.
• 3.
• 4.
• 5.

• @Component

泛指组件，当组件不好归类的时候，可以使用这个注解进行标注，功能类似于于@Service。

复制

@Component
public class DeptService {//具体的方法
}

• 1.
• 2.
• 3.
• 4.
• 5.

• @Repository

通常用于修饰dao层的组件，@Repository注解属于Spring里面最先引入的一批注解，它用于将数据访问层 (DAO层 ) 的类标识为Spring Bean，具体只需将该注解标注在 DAO类上即可，示例代码如下：

复制

@Repository
public interface RoleRepository extends JpaRepository<Role,Long> {//具体的方法
}

• 1.
• 2.
• 3.
• 4.
• 5.

为什么现在使用的很少呢?

主要是因为当我们配置服务启动自动扫描dao层包时，Spring会自动帮我们创建一个实现类，然后注入到bean容器里面。当某些类无法被扫描到时，我们可以显式的在数据持久类上标注@Repository注解，Spring会自动帮我们声明对象。

• @Bean

相当于 xml 中配置 Bean，意思是产生一个 bean 对象，并交给spring管理，示例代码如下：

复制

@Configuration
public class AppConfig {//相当于 xml 中配置 Bean@Beanpublic Uploader initFileUploader() {return new FileUploader();}}

• @Autowired

自动导入依赖的bean对象，默认时按照byType方式导入对象，而且导入的对象必须存在，当需要导入的对象并不存在时，我们可以通过配置required = false来关闭强制验证。

复制

@Autowired
private DeptService deptService;

• @Resource

也是自动导入依赖的bean对象，由JDK提供，默认是按照byName方式导入依赖的对象;而@Autowired默认时按照byType方式导入对象，当然@Resource还可以配置成通过byType方式导入对象。

复制

/*** 通过名称导入（默认通过名称导入依赖对象）*/
@Resource(name = "deptService")
private DeptService deptService;/*** 通过类型导入*/
@Resource(type = RoleRepository.class)
private DeptService deptService;

• @Qualifier

当有多个同一类型的bean时，使用@Autowired导入会报错，提示当前对象并不是唯一，Spring不知道导入哪个依赖，这个时候，我们可以使用@Qualifier进行更细粒度的控制，选择其中一个候选者，一般于@Autowired搭配使用，示例如下：

复制

@Autowired
@Qualifier("deptService")
private DeptService deptService;

• @Scope

用于生命一个spring bean的作用域，作用的范围一共有以下几种：

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

复制

/*** 单例对象*/
@RestController
@Scope("singleton")
public class HelloController {}

2.3. JPA 相关注解

• @Entity和@Table

表明这是一个实体类，这两个注解一般一块使用，但是如果表名和实体类名相同的话，@Table可以省略。

• @Id

表示该属性字段对应数据库表中的主键字段。

• @Column

表示该属性字段对应的数据库表中的列名，如果字段名与列名相同，则可以省略。

• @GeneratedValue

表示主键的生成策略，有四个选项，分别如下：

• AUTO：表示由程序控制，是默认选项 ，不设置就是这个
• IDENTITY：表示由数据库生成，采用数据库自增长，Oracle 不支持这种方式
• SEQUENCE：表示通过数据库的序列生成主键ID，MYSQL 不支持
• Table：表示由特定的数据库产生主键，该方式有利于数据库的移植
• @SequenceGeneretor

SpringBoot注解详解，建议收藏！-springboot的核心注解