Spring与SpringBoot 常用注解

常用注解

Bean相关

实用工具

其他

Bean处理

HTTP请求

前后端参数传递

读取配置

参数校验

统一异常处理

JPA数据持久化

JSON格式处理

测试处理

配置启动

简单介绍

更多详细内容查看 

相关注解：

• @ControllerAdvice：注解定义全局异常处理类
• @ExceptionHandler：注解声明异常处理方法

如何使用呢？拿我们上面的参数校验这块来举例子。如果方法参数不对的话
就会抛出 MethodArgumentNotValidException，我们来处理这个异常。

更多关于 Spring Boot 异常处理的内容：

封装一个优雅的 Spring Boot 全局异常处理：

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

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

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

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

详细讲解：

1. 过滤 json 数据

2. 格式化 json 数据

3. 扁平化对象

@ActiveProfiles 一般作用于测试类上， 用于声明生效的 Spring 配置文件。

• @Test声明一个方法为测试方法
• @Transactional 被声明的测试方法的数据会回滚，避免污染测试数据。
• @WithMockUser Spring Security 提供的，用来模拟一个真实用户，并且可以赋予权限。

这个注解是 Spring Boot 项目的基石，创建 SpringBoot 项目之后会默认在主类加上：

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

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

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

自动导入 Bean 对象到类中

将 Bean 类注入到 Spring 组件

控制器 Bean

声明 Bean 的作用域

声明配置类 Bean

5 种常见的请求类型:

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

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

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

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

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

PATCH 请求：一般实际项目中，我们都是 PUT 不够用了之后才用 PATCH 请求去更新数据。

@PathVariable 和 @RequestParam

@RequestBody

👉 需要注意的是：一个请求方法只可以有一个 @RequestBody，但是可以有多个 @RequestParam 和 @PathVariable。 
如果你的方法必须要用两个 @RequestBody 来接受数据的话，大概率是你的数据库设计或者系统设计出问题了！

很多时候我们需要将一些常用的配置信息比如阿里云 oss、发送短信、微信认证的相关配置信息等等放到配置文件中。

下面我们来看一下 Spring 为我们提供了哪些方式帮助我们从配置文件中读取这些配置信息。

编写一个 yaml 的配置文件：

1. 通过 @value 读取比较简单的配置信息

2. 通过 @ConfigurationProperties 读取并与 bean 绑定

3. 通过 @ConfigurationProperties 读取并校验

4. @PropertySource 读取指定的 properties 文件

Spring框架注解 核心注解 @Required  用在Bean的Setter方法上，表示Bean组装时必须要有该属性，否则抛出BeanInitializationExpection @Autowired  自动导入依赖的Bean，默认byType,完成属性，方法的组装，可以对类成员变量，方法，构造函数进行标注，加上(required=false)时找不到也不报错，JSR规范中相对应的注解：JSR250 @Resource JSR330 @Inject  @Qualifier  该注解通常跟@Autowired一起使用，当想对注入的过程做更多的控制，@Qualifier可帮助配置，比如两个以上相同类型的Bean时 Spring无法抉择，用到此注解 @Configuration  等价于Spring的XML配置文件，使用Java代码可以检查类型安全。如果有些时候必须用到xml配置文件，可通过@Configuration 类作为项目的配置主类，使用@ImportResource注解加载xml 文件  @ComponentScan  一般跟@Comfiguration 一起用，来进行选择性的做一些类的扫描跟排除  @Bean  等价xml中配置的bean, 用在方法上哦，来生产出一个bean,然后交给Spring管理 @Lazy  懒加载: 主要针对单实例bean:默认在容器启动的时候创建对象用了@Lazy容器启动时候不创建对象, 仅当第一次使用(获取)bean的时候才创建被初始化可以跟@Configuration一起使用作用到类上，表示所有@Bean方法都被延时 @Value  可用在字段，构造器参数跟方法参数，指定一个默认值，支持 #{} 跟 ${} 两个方式。一般上将Springboot中的application.properties 配置的属性值 @Import  跟@Bean类似，更灵活的导入其他配置类。ImportSelector，ImportBeanDefinitionRegistrar等 @ImportResource  用来加载xml配置文件 @Resource  @Resource 默认ByName（按名字注入），若找不到对应的Bean，会继续按类型去找；但一旦指定了name，那么只会按名字去找Bean  @Inject  @Inject是Javax提供的依赖注入，效果与Autowired一样可以装配bean，不支持Primary功能，不支持Autowired false 原型注解 @Component  可以配置CommandLineRunner使用，当一个组件不好归属到下面类的时候会用该注解标注 @Controller  用在自定义的控制类，项目中一般由控制类负责处理介绍用户的URL请求，然后转发到service层，注解一般在类上，切配合@RequestMapping 使用  @Service  一般用于修饰service层的类 @Repository  可以确保DAO或repositories提供异常转译，该注解修饰的DAO或repositories 会被ComponentScan发现并配置， SpringBoot注解 @EnableAutoConfiguration 自动配置类，尝试根据我们添加的jar依赖自动配置我们的Spring应用，也就是说pom.xml引入需要的jar后，各种配置按照约定大于配置规则自动帮我们配置好了 @SpringBootApplication 包含@ComponentScan,@Configuration,@EnableAutoconfiguration。其中@ComponentScan让SpringBoot 扫描到Configuration类丙把它加入到程序上下文 SpringCloud注解 @EnableConfigServer  配置服务器 @EnableEurekaServer  注册服务器 @EnavbleDiscoveryClient 发现客户端 @EnableCircuitBreaker  熔断器 @HystrixCommand  服务降级 缓存注解 @Cacheable  方法级 @CachePut  方法级别 更新缓存 @CacheEvict  方法级 清除缓存 @CacheCinfig  类级别配置缓存，避免多次配置 任务执行跟调度注解 @Scheduled  方法级，有该注解的方法无返回值，不接受任何参数 @Async  方法级，每个方法都单独在线程中，可以接受参数，可返回，也可不返回 测试注解 @BootstapWith  类级别，配置Spring测试上下文框架的启动 @ContextConfiguration  类级别指定配置文件 @WebAppConfiguration  类级别，指示ApplicationContext加载的集成测试环境应为WebApplicationContext @TImed  指定测试方法执行时间，超时则失败 @Repeat  运行次数 @Commit  类级别跟方法级别 指示事务的提交 @RollBack  类级别跟方法级别 事务回滚 @DirtiesContext  类级别跟方法级别 指示ApplicationContext已修改， 重加载再测试 @BeforeTransaction  测试类void 方法上，在所有@Transactional 注解前执行  @AfterTransaction  测试类void 方法上，在所有@Transactional 注解后执行  @Sql  类级别跟方法几杯 执行SQL脚本 @SqlConfig  跟@Sql一起用，定义如何解析跟执行SQL脚本 @SqlGroup  方法级 包含多个@Sql  @SpringBootTest  启动集成测试上下文 ，底层用Junit 数据库访问注解 @Transactional  用在接口 接口中的方法 类 类中的公共方法，运行时候框架给它配置具有事务的Bean 支持一下特性 传播类型 隔离级别 操作超时 只读标记 JPA注解 @Entity  @Table  @Column  @Id @GeneratedValue  @SequenceGeneretor  @MaooedSuperClass  @NoRepositoryBean  @Transient  SpringMVC跟REST注解 @Controller  用来定义控制器类，在Spring项目中有控制器负责接受用户通过URL发送的请求，然后将请求转发给service层，一般跟@RequestMapping 配合使用  @RestController  @Controller 跟@ResponseBody 的组合体，表示这个是控制器bean,并且是将函数的返回值直接填入到HTTP响应体，是REST风格控制器  @RequestMapping  是一个用来处理请求响应的注解，用子啊类或方法上用在类上表示所有响应请求方法都以该地址为父路径params：指定request 方法必须包含某些参数值headers：指定request中必须包含某些指定的header值，value： 指定请求的实际地址，指定的地址是URI Template 模式method: 请求方法是GET POST PUTDELETE等consumes:请求的提交内容 Content-Type application/json text/htmlproduces:指定返回内容类型，仅昂request请求头中的Accept包含该类型才返回。 @RequestMapping细分 @Getmapping  @PostMapping  @PutMapping  @PatchMapping  @DeleteMapping  @CookieValue  用于方法参数上获得cookie @CrossOrigin  用在类跟方法上，实现跨域请求， @ExceptionHandler  方法上 指示异常处理类 @InitBinder  初始化绑定器，用来数据绑定跟参数转换器 @Mappings@Mapping  用在字段上，Mapping 是一个Meta注解，以指示web映射注解Mappings 可用多个 @MatrixVariable  矩阵变量 @PathVariable  路径变量，获得路径上参数 @RequestAttribute  绑定请求属性到handler 方法参数 @RequestBody  指示方法参数保定到HTTp 请求的body，HttpMessageConveter 负责将HTTP请求消息转为对象 @ResponseStatus  用在方法跟异常类，以一个状态码作为指示，原因必须返回 可注解Controller,所有@RequestMapping 方法都会继承它  @SessionAttribute  用在方法参数，绑定方法参数到会话属性 @SessionAttributes  用于将会话属性Bean 封装 @Valid  验证器，配合@InitBinder使用 @ModelAttribute  把值绑定到Model中，使全局@RequestMappiing 可以获得该值  全局异常处理 @ControllerAdvice  包含@Component,可以被扫描到，统一处理异常，一般跟@ExceptionHandler一起使用 @RestControllerAdivce  @ControllerAdvice 跟@ResponseBody组合使用 

常用注解 @SpringBootApplication 包含@Configuration、@EnableAutoConfiguration、@ComponentScan 通常用在主类上 @Repository 用于标注数据访问组件，即DAO组件 @Service 用于标注业务层组件 @RestController 用于标注控制层组件(如struts中的action)，包含@Controller和@ResponseBody @ResponseBody 表示该方法的返回结果直接写入HTTP response body中 @Component 泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注 @ComponentScan   组件扫描。相当于，如果扫描到有@Component @Controller @Service等这些注解的类，则把这些类注册为bean @Configuration 指出该类是 Bean 配置的信息源，相当于XML中的，一般加在主类上 @EnableAutoConfiguration 让 Spring Boot 根据应用所声明的依赖来对 Spring 框架进行自动配置，一般加在主类上 @AutoWired byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。   当加上（required=false）时，就算找不到bean也不报错 @Resource(name="name",type="type") 没有括号内内容的话，默认byName。与@Autowired干类似的事 @Qualifier 当有多个同一类型的Bean时，可以用@Qualifier("name")来指定。与@Autowired配合使用 @RequestMapping RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径 属性 params:指定request中必须包含某些参数值是，才让该方法处理。 headers:指定request中必须包含某些指定的header值，才能让该方法处理请求。 value:指定请求的实际地址，指定的地址可以是URI Template 模式 method:指定请求的method类型， GET、POST、PUT、DELETE等 consumes:指定处理请求的提交内容类型（Content-Type），如application/json,text/html; produces:指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回 @RequestParam 用在方法的参数前面 @PathVariable 路径变量。参数与大括号里的名字一样要相同。   @Profiles Spring Profiles提供了一种隔离应用程序配置的方式，并让这些配置只能在特定的环境下生效 @ConfigurationProperties @ConfigurationProperties(prefix = "前缀") 绑定一组属性 属性必须和配置严格对应 @Value 获取单个配置 @Value("${参数名称}") @ControllerAdvice controller增强 使用场景 全局异常处理 全局数据绑定 全局数据预处理 @RestControllerAdvice api项目的controller增强 @ExceptionHandler(Exception.class): 统一处理异常 @PostConstruct 加在初始化的函数上面

Spring常用注解