数媒在线课堂 Spring Boot 常用注解介绍及使用

一、项目配置注解

1、@SpringBootApplication

这是一个注解组合，包括了 @SpringBootConfiguration、@EnableAutoConfiguration 和 @ComponentScan 注解。

（1） @SpringBootConfiguration 继承自 @Configuration，对于熟悉 spring 的开发者而言，此标注当当前类是配置类，并会将当前类内声明的一个或多个以 @Bean 注解标记的方法的实例纳入到 spring 容器中，并且实例名就是方法名。

（2）@EnableAutoConfiguration 这个注解就是 springboot 能自动进行配置的魔法所在。主要通过此注解，能将所有符合自动配置条件的 bean 的定义加载到 spring 容器中，比如根据 spring-boot-starter-web，来判断你的项目是否需要添加 webmvc 和 tomcat，就会自动的帮你配置 web 项目中所需要的默认配置。需要排除一些无需自动配置的类时，可利用 exclude 进行排除。

（3）@ComponentScan 会扫描当前包及其子包下被 @Component， @Controller，@Service，@Repository 等注解标记的类并纳入到 spring 容器中进行管理

2、@MapperScan

springboot 支持 mybatis 组件的一个注解，通过此注解指定 mybatis 接口类的路径，即可完成对 mybatis 接口的扫描。

它和 @mapper 注解是一样的作用，不同的地方是扫描入口不一样。@mapper 需要加在每一个 mapper 接口类上面。所以大多数情况下，都是在规划好工程目录之后，通过 @MapperScan 注解配置路径完成 mapper 接口的注入。

添加 mybatis 相应组建依赖之后。就可以使用该注解。

3、资源导入注解

@ImportResource、@Import、@PropertySource 这三个注解都是用来导入自定义的一些配置文件。

@ImportResource(locations={}) 导入其他 xml 配置文件，需要标准在主配置类上。

导入 property 的配置文件 @PropertySource 指定文件路径，这个相当于使用 spring 的 <importresource/> 标签来完成配置项的引入。

@import 注解是一个可以将普通类导入到 spring 容器中做管理

二、controller 层

1、@Controller 和 @RestController

@RestController 是 spring4 之后加入的注解，原本在 @Controller 中返回 json 需要 @ResponseBody 来配合，如果直接用 @RestController 替代 @Controller 就不需要再配置 @ResponseBody，默认返回 json 格式。而 @Controller 是用来创建处理 http 请求的对象，一般结合 @RequestMapping 使用。

2、@CrossOrigin

@CrossOrigin(origins="",maxAge=1000)

这个注解主要是为了解决跨域访问的问题。这个注解可以为整个 controller 配置启用跨域，也可以在方法级别启用。

我们在项目中使用这个注解是为了解决微服务在做定时任务调度编排的时候，会访问不到 spider 节点而出现跨域问题。

3、@Autowired

自动装配。

需要从 bean 工厂中获取一个 bean 时，spring 会自动为我们装配该 bean 中标记为 @Autowired 的元素。

4、@EnableCaching

这个注解是 spring framework 中的注解驱动的缓存管理功能。作用相当于 spring 配置文件中的 cache manager 标签。

5、@RequestMapping

一个用来处理请求地址映射的注解，可用于类和方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。

常用属性：

（1）value：指定请求的实际地址，指定的地址可以是 URI Template 模式；

（2）method：指定请求的 method 方法，GET、POST、PUT、DELETE 等；

（3）consumes：指定处理请求的提交内容类型（content-type），例如 application/json、text/html；

（4）produces： 指定返回的内容类型，仅当 request 请求头中的 (Accept) 类型中包含该指定类型才返回；

（5） params： 指定 request 中必须包含某些参数值是，才让该方法处理。

（6）headers： 指定 request 中必须包含某些指定的 header 值，才能让该方法处理请求。

常用的就是 value 和 method。

其简化注解有：

@GetMapping 等同于 @RequestMapping (method = RequestMethod.GET)@PostMapping 等同于 @RequestMapping (method = RequestMethod.POST)@PutMapping 等同于 @RequestMapping (method = RequestMethod.PUT)@DeleteMapping 等同于 @RequestMapping (method = RequestMethod.DELETE)@PatchMapping 等同于 @RequestMapping (method = RequestMethod.PATCH)

6、@RequestBody 和 @ResponseBody

@RequestBody 注解允许 request 的参数在 reqeust 体中，常常结合前端 POST 请求，进行前后端交互。

@ResponseBody 注解支持将的参数在 reqeust 体中，通常返回 json 格式给前端。

7、@PathVariable、@RequestParam、@RequestAttribute

@PathVariable 用来接收参数，如 /path/001, 可接收 001 作为参数

@GetMapping("/path/{id}")public String PathVariable(@PathVariable("id")String id){ return "id:"+id;}

@RequestParam 用来接收 URL 中的参数，如 /param?id=001, 可接收 001 作为参数

@GetMapping("/param")public String param(@RequestParam("id")String id){ return "id:"+id;}

@RequestAttribute 用于访问由过滤器或拦截器创建的、预先存在的请求属性，效果等同与 request.getAttrbute ()。

@GetMapping("/req/attr")public String reqAttr(@RequestAttribute("id")String id){ return "id:"+id;}

8、@ModelAttribute

主要是绑定请求参数到指定对象上，此注解可被用于方法、参数上。

运用在参数上，会将客户端传递过来的参数按名称注入到指定对象中，并且会将这个对象自动加入到 modelMap 中，便于 view 层使用；

运用在方法上，会在每一个 @RequestMapping 标注的方法前执行，如果有返回值，则自动将返回值加入到 ModelMap 中；

由于现在都采用前后端分离开发，故此注解相对用的较少，但对于一些在每次请求前需要进行一些额外操作时。使用此注解依然是个选择，比如进行统一的业务校验等，但使用此注解实现类似功能时需要注意，使用异步调用时，比如 callable 或者 DeferredResult 时，被此注解的方法会执行两次，因为异步请求时，是挂起另一个线程去重新执行，对于配置了拦截器，它们的执行顺序为：

preHandle ---->afterConcurrentHandlingStarted ----> Controller---->preHandler----> postHandler ----> afterCompletion

三、service 层注解、持久层注解

1、@Component、@Service、@Repository

这三者都是申明一个单例的 bean 类并纳入 spring 容器中，后两者其实都是继承于 @Component。

（1） @Component 最普通的组件，可以被注入到 spring 容器进行管理。

通过这个注解的分层管理，就能将请求处理，业务逻辑处理，数据库操作处理分离出来，为代码解耦，也方便了以后项目的维护和开发。

所以我们在正常开发中，如果能用 @Service, @Controller, @Repository 其中一个标注这个类的定位的时候，就不要用 @Component 来标注。

（2） @Repository 作用于持久层

（3） @Service 作用于业务逻辑层

通常一些类无法确实是使用 @service 还是 @Component 时，注解使用 @Component，比如 Redis 的配置类等。

2、@Transational

通过这个注解可以声明事务，可以添加在类上或者方法上。

在 spring boot 中 不用再单独配置事务管理，一般情况是我们会在 servcie 层添加了事务注解，即可开启事务。要注意的是，事务的开启只能在 public 方法上。并且主要事务切面的回滚条件。正常我们配置 rollbackfor exception 时 ，如果在方法里捕获了异常就会导致事务切面配置的失效。