在使用Spring Boot进行项目开发时常用的注解都在这里了

最新推荐文章于 2022-10-18 15:11:09 发布

pan_jianping

最新推荐文章于 2022-10-18 15:11:09 发布

阅读量434

点赞数

分类专栏： Spring相关框架基础知识文章标签： spring boot spring java

本文链接：https://blog.csdn.net/pan_jianping/article/details/125746825

版权

Spring相关框架基础知识专栏收录该内容

1 篇文章 0 订阅

订阅专栏

                    
                        
                    
                    @Configuration：添加在类的声明之前，表示此类是配置类，会自动执行配置类中的@Bean方法，并解读配置类上的其它注解。
@Bean：添加在配置类中用于创建对象的方法之前，使得Spring框架自动调用此方法，并管理此方法返回的结果，@Bean方法必须存在于@Configuration类中。
@Component：组件注解，添加在类的声明之前，表示此类是组件类，是通用注解，应该添加在不是控制器类，也不是业务逻辑类，也不是数据访问类的类上。
@ComponentScan：组件扫描，当加载到此注解时，Spring会扫描此注解配置的根包下是否存在组件类，如果存在，会自动创建组件类的对象，如果某些类不是组件，会被跳过(无视)。
@Controller：组件注解，添加在类的声明之前，表示此类是组件类，应该添加在控制器类上。
@Service：组件注解，添加在类的声明之前，表示此类是组件类，应该添加在业务逻辑类上。
@Repository：组件注解，添加在类的上面之前，表示此类是组件类，应该添加在数据访问类上。
@Scope：配置Spring Bean的作用域，当配置为@Scope(“prototype”)时，Spring Bean将是“非单例的”，如果使用@Bean方法创建对象，则此注解添加在@Bean方法之前，如果使用组件扫描创建对象，则此注解添加在组件类之前。
@Lazy：配置单例的Spring Bean是否是“懒加载”的，当在@Bean方法之前，或在组件类的声明之前添加此注解，则会使得Spring Bean是懒加载的，如果使用@Bean方法创建对象，则此注解添加在@Bean方法之前，如果使用组件扫描创建对象，则此注解添加在组件类之前。
@Autowired：自动装配的注解，当某个属性组要被Spring装配值时，在属性之前添加此注解，另外，此注解可以添加在Setter方法、构造方法之前，通常不需要这样处理。
@EnableWebMvc：添加在Spring MVC配置类上的注解，当响应正文，且响应的是JSON格式的结果时，必须添加此注解，否则将导致406错误，另外，在Spring Boot项目中不需要手动添加。
@ResponseBody：响应正文，可以添加在处理请求/处理异常的方法之前，将作用于对应的方法，或添加在类之前，将作用于类中所有处理请求/处理异常的方法。
@RestController：等效于@Controller+@ResponseBody。
@RequestMapping：通常添加在类上，用于配置请求路径的前缀部分，也使用produces属性配置此控制器类中所有处理请求的方法响应时的文档类型，例如在类上配置为@RequestMapping(value=“user”,produces=“application/json”;charset=utf-8)。
GetMapping：是将请求类型限制为GET的@RequestMapping，通常添加在处理请求的方法上，用于配置此方法映射的请求路径。
@PostMapping：参考@GetMapping。
@RequestParam：添加在处理请求的方法的参数之前，可用于：指定请求参数名称、配置是否必须提交此请求参数、配置请求参数的默认值。
@PathVariable：添加在处理请求的方法参数之前，仅当在请求路径中使用占位符匹配变量值时使用，如果占位符中的名称与方法的参数名称不同，还可以配置此注解的参数，以指定占位符中的名称。
@RequestBody：添加在处理请求的方法的参数之前，仅当客户端使用JSON格式组织请求参数时使用此注解，如果客户端的请求参数是FormData格式的(使用&拼接的)，则不可添加此注解。
@ExceptionHandler：添加在处理异常的方法之前，可以通过注解参数配置需要处理的异常类型。
@ControllerAdvice：添加在类之前，此类中的代码在处理任何请求时都会生效。
@RestControllerAdvice：等效于@ControllerAdvice+@ResponseBody。
@Mapper：添加在使用Mybatis时访问数据的(每一个)接口上，使得Mybatis明确这是用于访问数据的接口，从而Mybatis会生成此接口的代理对象，实现最终的数据访问功能，但此方式不推荐，另见@MapperScan注解。
@MapperScan：添加在配置类上，用于扫描使用Mybatis时访问数据的接口所在的根包，使用此注解后，各接口不再使用@Mapper注解，在配置根包时，应保证此包下只有访问数据的接口，切不可存在其它接口，因为Mybatis并不会解析接口的内部代码，只要是接口都会创建代理对象，如果你自行创建类实现了此接口还被Spring创建了对象，会出现错误。
@Param：添加在使用Mybatis时访问数据的接口中的抽象方法的参数上，用于指定参数名称，在配置SQL语句时使用占位符时，占位符内的名称就是此注解的参数值，当抽象方法的参数超过一个时，必须使用此注解配置参数名称。
@SpringBootApplication：添加在Spring Boot项目中的启动类上的注解，每个Spring Boot只能有一个类添加此注解，此注解的元注解包括@SpringBootConfiguration和@ComponentScan，所以，启动类本身也是配置类，且默认就执行组件扫描。
@SpringBootConfiguration：是SpringBootApplication的元注解之一，此注解的元注解包括@Configuration，使得Spring Boot启动类也是配置类。
@SpringBootTest：添加在Spring Boot项目中测试类上的注解，使得测试类会加载当前项目中所有配置和环境，例如可以在测试类中使用自动装配机制、使用MokMvc等，如果某些测试类是明确的不需要加载当前项目的配置和环境时，可以不添加此注解。
@AutoConfigureMockMvc：添加在Spring Boot项目中测试类上的注解，需添加spring-boot-starter-web依赖，当需要对控制器层使用MokMvc进行模拟测试时需要添加此注解，才可以在测试类中自动装配MokMvc对象。
@Sql：可以添加在测试类上，也可以添加在测试类的测试方法上，如果同时添加，以测试方法上的注解为准；可以在注解中配置参数，使得测试方法执行之前去执行指定的若干个SQL脚本，还可以配置脚本的执行阶段是在测试方法之前或测试方法之后。
@Validated：添加在控制器类中处理请求的方法的参数之前，表示此参数将被Validation框架进行验证，具体的验证规则由其它的验证注解来解决。
@Valid：在开发实践中，绝大部分情况下与@Validated情况相同。
@NotNull：验证注解，通常添加在被注解为@Validated/@Valid的类的属性上，表示不允许为null，可以配置message属性，用于指定验证失败的提示文本。
@Range：验证注解，通常添加在@Validated/@Valid的类的数值型属性上，可以通过此注解的min和max属性配置数值型属性的取值区间，可以配置message属性，用于指定验证失败时的提示的文本。
@Pattern：验证注解，通常添加在被注解为@Validated/@Valid的类的字符串属性上，可以通过此注解的regexp属性来指定正则表达式，将应用正则表达式对请求参数进行验证，可以配置message属性，用于指定验证失败时的提示文本。
@JsonInclude：可以添加在POJO类上，也可以添加在POJO类的属性上，用于配置响应JSON结果时，什么样的属性会包含在响应结果中，默认值是JsonInclude.Include.ALWAYS，即始终包含，通常建议配置为JsonInclude.Include.NON_NULL，表示“值不为null时被包含在响应结果中”，此配置可以通过在配置文件中配置spring.jackson.default-property-inclusion属性实现全局的配置。
@Data：添加在POJO类上的属性，使得Lombok会在编译器自动生成全属性的Setter&Getter 、hashCode()、equals()、toString()方法。
@Slf4j：添加在任意类上，在类中可以使用名为log变量输出日志。

                