spring boot 常用注解

简介: spring boot 常用注解

在spring boot 项目实际开发中,我们用的最多的就是各种注解,如果对各个注解都了如指掌,并能灵活运用的话,那对在实际开发中肯定会让生产力大大提高。下面就对spring boot的各种注解做一个总结。希望对大家有所帮助。

1、Spring Web MVC

1.1、@RequestMapping

@RequestMapping:将请求和处理请求的控制器方法关联起来,建立映射关系。

@RequestMapping 注解拥有以下的六个配置属性:

  • value:映射的请求URL或者其别名
  • method:兼容HTTP的方法名
  • params:根据HTTP参数的存在、缺省或值对请求进行过滤
  • header:根据HTTP Header的存在、缺省或值对请求进行过滤
  • consume:设定在HTTP请求正文中允许使用的媒体类型
  • product:在HTTP响应体中允许使用的媒体类型
提示:在使用 @RequestMapping之前,请求处理类还需要使用 @Controller@RestController进行标记。

使用 @RequestMapping 的两个例子:

用在方法名前:

在这里插入图片描述

用在类上:

在这里插入图片描述

类中的处理方法在映射请求路径时,会自动将类上@RequestMapping 设置的value拼接到方法中映射路径之前

1.2、@RequestBody

@RequestBody 作用:在处理请求方法的参数列表中使用,它可以将请求主体中的参数绑定到一个对象中。 根据请求主体中的参数名与对象的属性名进行匹配并绑定值。并且,还还可以通过@Valid 注解对请求主体中的参数进行校验。

示例:

在这里插入图片描述

1.3、@GetMapping

@GetMapping 作用:用于处理HTTP GET请求,并将请求映射到具体的处理方法中。

它相当于是 @RequestMapping(method=RequestMethod.GET) 的快捷方式。

示例:

在这里插入图片描述

1.4、@PostMapping

@PostMapping 作用:用于处理HTTP POST请求,并将请求映射到具体的处理方法中。

它相当于是 @RequestMapping(method=HttpMethod.POST) 的快捷方式。

示例:

在这里插入图片描述

1.5、@PutMapping

@PutMapping 作用: 用于处理HTTP PUT请求,并将请求映射到具体的处理方法中。

相当于是 @RequestMapping(method=HttpMethod.PUT) 的快捷方式。

示例:

在这里插入图片描述

1.6、@DeleteMapping

@DeleteMapping 作用: 用于处理HTTP DELETE请求,并将请求映射到删除方法中。

它相当于是 @RequestMapping(method=HttpMethod.DELETE) 的快捷方式。

示例:

在这里插入图片描述

1.7、@PatchMapping

@PatchMapping 作用: 用于处理HTTP PATCH请求,并将请求映射到对应的处理方法中。

它相当于是@RequestMapping(method=HttpMethod.PATCH)的快捷方式。

示例:

在这里插入图片描述

1.8、@ControllerAdvice

@ControllerAdvice 作用: 主要是用来处理控制器所抛出的异常信息。

它是@Component 注解的一个延伸注解,Spring会自动扫描并检测被 @ControllerAdvice 所标注的类。@ControllerAdvice 需要和@ExceptionHandler@InitBinder以及 @ModelAttribute 注解搭配使用。

首先,我们需要定义一个被@ControllerAdvice所标注的类,在该类中,定义一个用于处理具体异常的方法,并使用@ExceptionHandler注解进行标记。

此外,在有必要的时候,可以使用@InitBinder在类中进行全局的配置,还可以使用@ModelAttribute配置与视图相关的参数。使用@ControllerAdvice注解,就可以快速的创建统一的,自定义的异常处理类。

示例:

在这里插入图片描述

1.9、@ResponseBody

@ResponseBody 作用:自动将控制器中方法的返回值写入到HTTP响应中。

提示:

@ResponseBody注解只能用在被@Controller注解标记的类中。

如果在被@RestController标记的类中,则方法不需要使用@ResponseBody注解进行标注。

@RestController相当于是@Controller和@ResponseBody的组合注解。

示例:

在这里插入图片描述

1.10、@ExceptionHandler

@ExceptionHandler 作用:用于标注处理特定类型异常类所抛出异常的方法。

当控制器中的方法抛出异常时,Spring会自动捕获异常,并将捕获的异常信息传递给被@ExceptionHandler标注的方法。

示例:

在这里插入图片描述

1.11、@ResponseStatus

@ResponseStatus作用: 可以标注请求处理方法。使用此注解,可以指定响应所需要的HTTP STATUS。

特别地,我们可以使用HttpStauts类对该注解的value属性进行赋值。

示例:

在这里插入图片描述

1.11、@PathVariable

@PathVariable 作用:是将方法中的参数绑定到请求URI中的模板变量上。通过@RequestMapping注解来指定URI的模板变量,然后使用@PathVariable注解将方法中的参数绑定到模板变量上。

示例:

在这里插入图片描述

1.12、@RequestParam

@RequestParam 作用:用于将方法的参数与Web请求的传递的参数进行绑定。

使用@RequestParam可以轻松的访问HTTP请求参数的值。

示例:

在这里插入图片描述

1.13、@Controller

@Controller 作用:@Component 注解的一个延伸,Spring 会自动扫描并配置被该注解标注的类。此注解用于标注Spring MVC的控制器。

示例:

在这里插入图片描述

1.14、@RestController

@RestController 作用:这是一个特定的控制器注解。此注解相当于@Controller@ResponseBody的快捷方式。当使用此注解时,不需要再在方法上使用@ResponseBody注解。

示例:

在这里插入图片描述

1.15、@ModelAttribute

@ModelAttribute 作用:通过此注解,可以通过模型索引名称来访问已经存在于控制器中的model。

示例:

在这里插入图片描述

1.16、@CrossOrigin

@CrossOrigin 作用:为请求处理类或请求处理方法提供跨域调用支持

如果我们将此注解标注类,那么类中的所有方法都将获得支持跨域的能力。

使用此注解的好处是可以微调跨域行为。

示例:

在这里插入图片描述

1.17、@InitBinder

@InitBinder 作用: 用于标注初始化WebDataBinider 的方法,该方法用于对Http请求传递的表单数据进行处理,如时间格式化、字符串处理等。

示例:

在这里插入图片描述

2、Spring Bean 注解

2.1、@ComponentScan

@ComponentScan 作用:配置Spring需要扫描的被组件注解注释的类所在的包。

说白了就是 告诉Spring从哪里找到bean,由你来定义哪些包需要被扫描。

示例:

@ComponentScan({"com.demo.springboot","com.demo.somethingelse"})
@SpringBootApplication
public class SpringbootApplication {
}

2.2、@Component

@Component 作用:用于标注一个普通的组件类,它没有明确的业务范围,只是通知Spring被此注解的类需要被纳入到Spring Bean容器中并进行管理

示例:

在这里插入图片描述

2.3、@Service

@Service 作用:@Component 的一个延伸(特例),它用于标注业务逻辑类。与@Component注解一样,被此注解标注的类,会自动被Spring所管理

示例:

在这里插入图片描述

2.4、@Repository

@Repository 作用:@Component 注解的延伸,与@Component注解一样,被此注解标注的类会被Spring自动管理起来,@Repository注解用于标注DAO层的数据持久化类

作用:

在这里插入图片描述

3、Spring Dependency Inject注解

3.1、@DependsOn

@DependsOn 作用:可以配置Spring IoC容器在初始化一个Bean之前,先初始化其他的Bean对象。

示例:

在这里插入图片描述

3.2、@Bean

@Bean 作用:主要的作用是告知Spring,被此注解所标注的类将需要纳入到Bean管理工厂中。

着重介绍@Bean注解中initMethoddestroyMethod的用法。

示例:

在这里插入图片描述

4、Bean Scops注解

4.1、@Scope

@Scope 作用:可以用来定义@Component标注的类的作用范围以及@Bean所标记的类的作用范围。

@Scope所限定的作用范围有:

  • singleton
  • prototype
  • request
  • session
  • globalSession
  • 其他的自定义范围

这里以prototype为例子:

当一个Spring Bean被声明为prototype(原型模式)时,在每次需要使用到该类的时候,Spring IoC容器都会初始化一个新的该类的实例。在定义一个Bean时,可以设置Bean的scope属性为prototype:scope=“prototype”,也可以使用@Scope注解设置。

如下:

@Scope(value=ConfigurableBeanFactory.SCOPE_PROPTOTYPE)

示例:

在这里插入图片描述

4.2、@Scope 单例模式

@Scope 单例模式 作用:
当@Scope的作用范围设置成Singleton时,被此注解所标注的类只会被Spring IoC容器初始化一次。

在默认情况下,Spring IoC容器所初始化的类实例都为singleton。

示例:

在这里插入图片描述

5、容器配置注解

5.1、@Autowired

@Autowired 作用: 用于标记Spring将要解析和注入的依赖项。此注解可以作用在构造函数、字段和setter方法上。

作用于构造函数
在这里插入图片描述

作用于setter方法

在这里插入图片描述

作用于字段

在这里插入图片描述

5.2、@Primary

@Primary 作用:当系统中需要配置多个具有相同类型的bean时,@Primary可以定义这些Bean的优先级。

示例:

在这里插入图片描述

6、Spring Boot注解

6.1、@SpringBootApplication

@SpringBootApplication 作用:一个快捷的配置注解,在被它标注的类中,可以定义一个或多个Bean,并自动触发自动配置Bean和自动扫描组件。

此注解相当于@Configuration、@EnableAutoConfiguration和@ComponentScan的组合。

在Spring Boot应用程序的主类中,就使用了此注解。

示例:

在这里插入图片描述

6.2、@EnableAutoConfiguration

@EnableAutoConfiguration作用:用于通知Spring,根据当前类路径下引入的依赖包,自动配置与这些依赖包相关的配置项。

6.3、@ConditionalOnClass与@ConditionalOnMissingClass

这两个注解属于类条件注解,它们根据是否存在某个类作为判断依据来决定是否要执行某些配置。

在这里插入图片描述

6.4、@ConditionalOnBean与@ConditionalOnMissingBean

这两个注解属于对象条件注解,根据是否存在某个对象作为依据来决定是否要执行某些配置方法。

示例:

在这里插入图片描述

6.5、@ConditionalOnProperty

@ConditionalOnProperty 作用:会根据Spring配置文件中的配置项是否满足配置要求,从而决定是否要执行被其标注的方法。

示例:

在这里插入图片描述

6.6、@ConditionalOnResource

@ConditionalOnResource 作用:此注解用于检测当某个配置文件存在时,则触发被其标注的方法。

示例:

在这里插入图片描述

6.7、@ConditionalOnWebApplication与@ConditionalOnNotWebApplication

这两个注解用于判断当前的应用程序是否是Web应用程序。如果当前应用是Web应用程序,则使用Spring WebApplicationContext,并定义其会话的生命周期。

示例:

在这里插入图片描述

6.8、@Conditional

@Conditional注解可以控制更为复杂的配置条件。在Spring内置的条件控制注解不满足应用需求的时候,可以使用此注解定义自定义的控制条件,以达到自定义的要求。

示例:

在这里插入图片描述

对于一些经常使用的注解,有尚未被列到的,欢迎大佬在评论方添加。

相关文章
|
6月前
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行,支持固定间隔、延迟或Cron表达式触发,基于Spring Task,适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`,注意线程阻塞与分布式重复问题,推荐结合`@Async`异步处理,提升任务调度效率。
1034 128
|
6月前
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
691 0
|
5月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
657 2
|
6月前
|
Java 测试技术 数据库
使用Spring的@Retryable注解进行自动重试
在现代软件开发中,容错性和弹性至关重要。Spring框架提供的`@Retryable`注解为处理瞬时故障提供了一种声明式、可配置的重试机制,使开发者能够以简洁的方式增强应用的自我恢复能力。本文深入解析了`@Retryable`的使用方法及其参数配置,并结合`@Recover`实现失败回退策略,帮助构建更健壮、可靠的应用程序。
812 1
使用Spring的@Retryable注解进行自动重试
|
6月前
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
467 12
|
6月前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
360 0
探索Spring Boot的@Conditional注解的上下文配置
|
6月前
|
智能设计 Java 测试技术
Spring中最大化@Lazy注解,实现资源高效利用
本文深入探讨了 Spring 框架中的 `@Lazy` 注解,介绍了其在资源管理和性能优化中的作用。通过延迟初始化 Bean,`@Lazy` 可显著提升应用启动速度,合理利用系统资源,并增强对 Bean 生命周期的控制。文章还分析了 `@Lazy` 的工作机制、使用场景、最佳实践以及常见陷阱与解决方案,帮助开发者更高效地构建可扩展、高性能的 Spring 应用程序。
278 0
Spring中最大化@Lazy注解,实现资源高效利用
|
6月前
|
安全 IDE Java
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码
本文介绍了如何在 Spring 应用程序中使用 Project Lombok 的 `@Data` 和 `@FieldDefaults` 注解来减少样板代码,提升代码可读性和可维护性,并探讨了其适用场景与限制。
242 0
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码
|
6月前
|
Java 测试技术 编译器
@GrpcService使用注解在 Spring Boot 中开始使用 gRPC
本文介绍了如何在Spring Boot应用中集成gRPC框架,使用`@GrpcService`注解实现高效、可扩展的服务间通信。内容涵盖gRPC与Protocol Buffers的原理、环境配置、服务定义与实现、测试方法等,帮助开发者快速构建高性能的微服务系统。
1339 0
|
6月前
|
XML Java 测试技术
使用 Spring 的 @Import 和 @ImportResource 注解构建模块化应用程序
本文介绍了Spring框架中的两个重要注解`@Import`和`@ImportResource`,它们在模块化开发中起着关键作用。文章详细分析了这两个注解的功能、使用场景及最佳实践,帮助开发者构建更清晰、可维护和可扩展的Java应用程序。
335 0

热门文章

最新文章