SpringBoot必须掌握的常用注解!
mhr18 2024-12-01 09:04 12 浏览 0 评论
Spring Boot 提供了大量的注解,用于简化配置和加速程序开发。
那么接下来,咱们就一起来看下 Spring Boot 中的常用注解有哪些?及其这些注解的具体使用。
1.Bean相关
- @Component:将一个类标识为 Spring 组件(Bean),可以被 Spring 容器自动检测和注册。通用注解,适用于任何层次的组件。
@Component
public class MyComponent {
public void doSomething() {
System.out.println("MyComponent is doing something.");
}
}
- @ComponentScan:自动扫描指定包及其子包中的 Spring 组件。
@ComponentScan("com.example") // 扫描com.example包下的组件,加载到Spring容器
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
- @Controller:标识控制层组件,实际上是 @Component 的一个特化,用于表示 Web 控制器。处理 HTTP 请求并返回视图或响应数据。
@Controller
public class MyController {
@Autowired
private final UserService userService;
@GetMapping("/user")
public String getUser(Model model) {
User user = userService.getUserById(1);
model.addAttribute("user", user);
return "user";
}
}
- @RestController:是 @Controller 和 @ResponseBody 的结合,返回的对象会自动序列化为 JSON 或 XML,并写入 HTTP 响应体中。
@RestController
public class MyController {
@Autowired
private final UserService userService;
@GetMapping("/user")
public User getUser() {
User user = userService.getUserById(1);
return user;
}
}
- @Service:标识服务层组件,实际上是 @Component 的一个特化,用于表示业务逻辑服务。
@Service
public class MyService {
}
- @Repository:标识持久层组件(DAO 层),实际上是 @Component 的一个特化,用于表示数据访问组件。常用于与数据库交互。
@Repository
public interface UserDao {
}
- @Bean:方法注解,用于修饰方法,主要功能是将修饰方法的返回对象添加到 Spring 容器中,使得其他组件可以通过依赖注入的方式使用这个对象。
@Configuration
public class AppConfig {
@Bean
public MyBean myBean() {
return new MyBean();
}
}
- @Configuration:标识一个类作为配置类,@Component 的一个特化,通常配合 @Bean 注解一起使用。
@Configuration
public class AppConfig {
}
- @Scope:用于声明一个 Spring Bean 实例的作用域,作用域的范围有单例模式、原型模式(多例模式)等。
@Configuration
public class AppConfig {
@Bean
@Scope("prototype")
public MyPrototypeBean myPrototypeBean() {
return new MyPrototypeBean();
}
}
2.依赖注入
- @Autowired:用于自动注入依赖对象,Spring 框架提供的注解。
@RestController
public class MyController {
@Autowired
private final UserService userService;
@GetMapping("/user")
public User getUser() {
User user = userService.getUserById(1);
return user;
}
}
- @Resource:按名称自动注入依赖对象(也可以按类型,但默认按名称),JDK 提供注解。
@RestController
public class MyController {
@Resource
private final UserService userService;
@GetMapping("/user")
public User getUser() {
User user = userService.getUserById(1);
return user;
}
}
- @Qualifier:与 @Autowired 一起使用,用于指定要注入的 Bean 的名称。当存在多个相同类型的 Bean 时,可以使用 @Qualifier 来指定注入哪一个。
@RestController
public class MyController {
@Autowired
@Qualifier("userService")
private final UserService us;
@GetMapping("/user")
public User getUser() {
User user = userService.getUserById(1);
return user;
}
}
3.Web相关
- @RequestMapping:用于映射 HTTP 请求到处理方法上,支持 GET、POST、PUT、DELETE 等请求方法。可以标注在类或方法上。标注在类上时,表示类中的所有响应请求的方法都是以该类路径为父路径。
@RestController
@RequestMapping("/contoller")
public class MyController {
@Resource
private final UserService userService;
@RequestMapping("/user")
public User getUser() {
User user = userService.getUserById(1);
return user;
}
}
- @GetMapping、@PostMapping、@PutMapping、@DeleteMapping:分别用于映射 HTTP GET、POST、PUT、DELETE 请求到处理方法上。它们是 @RequestMapping 的特化,分别对应不同的 HTTP 请求方法。
@RestController
@GetMapping("/contoller")
public class MyController {
@Resource
private final UserService userService;
@GetMapping("/user")
public User getUser() {
User user = userService.getUserById(1);
return user;
}
}
- @RequestParam:用于将请求参数绑定到 Controller 方法的参数上。它主要用于处理 GET、POST 等请求中的查询参数,例如将 http://example.com/api?param1=value1¶m2=value2 中的 param1 和 param2 参数设置到方法的参数上。
@RestController
public class MyController {
@GetMapping("/hello")
public String sayHello(@RequestParam("name") String userName) {
return "Hello, " + userName;
}
}
- @PathVariable:用于从请求的 URL 路径中提取变量值,并将其绑定到控制器方法的参数上。
@GetMapping("/user/{userId}")
public String getUserById(@PathVariable("userId") Long id) {
return "User with ID " + id;
}
- @RequestBody:将 HTTP 请求体的内容(如 JSON、XML)转换为 Java 对象。通常用于接收前端传递的数据,标注在方法的参数上。
@Controller
public class MyController {
@PostMapping("/submit")
public String submitData(@RequestBody MyData myData) {
System.out.println(myData);
return "success";
}
}
- @ResponseBody:将方法的返回值转换为指定格式(如 JSON、XML)作为 HTTP 响应的内容返回给客户端。通常与 @RequestMapping 或 @GetMapping 等注解一起使用在方法上。
@RestController
public class MyController {
@GetMapping("/data")
@ResponseBody
public String getData() {
return "Some data";
}
}
4. 读取配置
- @Value:用于注入属性值,通常从配置文件中获取。标注在字段上,并指定属性值的来源(如配置文件中的某个属性)。
@Component
public class MyComponent {
@Value("${my.property}")
private String myPropertyValue;
public void printValue() {
System.out.println(myPropertyValue);
}
}
- @ConfigurationProperties:用于将配置属性绑定到一个实体类上。通常用于从配置文件中读取属性值并绑定到类的字段上。
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "my.app")
public class MyAppProperties {
private String property1;
private int property2;
// Getters and setters
}
5. 配置启动注解
- @SpringBootApplication:用于标识 SpringBoot 应用程序的入口类。它是一个组合注解,包括了 @Configuration、@EnableAutoConfiguration 和 @ComponentScan 三个注解。
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
- @EnableAutoConfiguration:启用 Spring Boot 的自动配置机制,根据添加的依赖和配置文件自动配置 Spring 应用。
6. 其他常用注解
- @Transactional:声明事务管理。标注在类或方法上,指定事务的传播行为、隔离级别等。
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
@Service
public class MyService {
@Transactional
public void performTransactionalOperation() {
// Database operations
}
}
- @Scheduled:声明一个方法需要定时执行。标注在方法上,并指定定时执行的规则(如每隔一定时间执行一次)。
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
@Component
public class MyScheduledTask {
@Scheduled(fixedRate = 5000)
public void performTask() {
System.out.println("Task executed.");
}
}
小结
Spring Boot 中的注解用很多,本文也是走马观花的带大家了解了一下 Spring Boot 中的常见注解。当然这些注解也不需要全部记住,只需有一个大概的印象即可,用的时候再查具体的使用就可以了。最后,欢迎小伙伴在评论区补充和发表更多的常用注解。
本文已收录到我的面试小站 [www.javacn.site](https://www.javacn.site),其中包含的内容有:并发编程、MySQL、Redis、Spring、Spring MVC、Spring Boot、Spring Cloud、MyBatis、JVM、设计模式、消息队列等模块。
相关推荐
- 使用 Docker 部署 Java 项目(通俗易懂)
-
前言:搜索镜像的网站(推荐):DockerDocs1、下载与配置Docker1.1docker下载(这里使用的是Ubuntu,Centos命令可能有不同)以下命令,默认不是root用户操作,...
- Spring Boot 3.3.5 + CRaC:从冷启动到秒级响应的架构实践与踩坑实录
-
去年,我们团队负责的电商订单系统因扩容需求需在10分钟内启动200个Pod实例。当运维组按下扩容按钮时,传统SpringBoot应用的冷启动耗时(平均8.7秒)直接导致流量洪峰期出现30%的请求超时...
- 《github精选系列》——SpringBoot 全家桶
-
1简单总结1SpringBoot全家桶简介2项目简介3子项目列表4环境5运行6后续计划7问题反馈gitee地址:https://gitee.com/yidao620/springbo...
- Nacos简介—1.Nacos使用简介
-
大纲1.Nacos的在服务注册中心+配置中心中的应用2.Nacos2.x最新版本下载与目录结构3.Nacos2.x的数据库存储与日志存储4.Nacos2.x服务端的startup.sh启动脚...
- spring-ai ollama小试牛刀
-
序本文主要展示下spring-aiollama的使用示例pom.xml<dependency><groupId>org.springframework.ai<...
- SpringCloud系列——10Spring Cloud Gateway网关
-
学习目标Gateway是什么?它有什么作用?Gateway中的断言使用Gateway中的过滤器使用Gateway中的路由使用第1章网关1.1网关的概念简单来说,网关就是一个网络连接到另外一个网络的...
- Spring Boot 自动装配原理剖析
-
前言在这瞬息万变的技术领域,比了解技术的使用方法更重要的是了解其原理及应用背景。以往我们使用SpringMVC来构建一个项目需要很多基础操作:添加很多jar,配置web.xml,配置Spr...
- 疯了!Spring 再官宣惊天大漏洞
-
Spring官宣高危漏洞大家好,我是栈长。前几天爆出来的Spring漏洞,刚修复完又来?今天愚人节来了,这是和大家开玩笑吗?不是的,我也是猝不及防!这个玩笑也开的太大了!!你之前看到的这个漏洞已...
- 「架构师必备」基于SpringCloud的SaaS型微服务脚手架
-
简介基于SpringCloud(Hoxton.SR1)+SpringBoot(2.2.4.RELEASE)的SaaS型微服务脚手架,具备用户管理、资源权限管理、网关统一鉴权、Xss防跨站攻击、...
- SpringCloud分布式框架&分布式事务&分布式锁
-
总结本文承接上一篇SpringCloud分布式框架实践之后,进一步实践分布式事务与分布式锁,其中分布式事务主要是基于Seata的AT模式进行强一致性,基于RocketMQ事务消息进行最终一致性,分布式...
- SpringBoot全家桶:23篇博客加23个可运行项目让你对它了如指掌
-
SpringBoot现在已经成为Java开发领域的一颗璀璨明珠,它本身是包容万象的,可以跟各种技术集成。本项目对目前Web开发中常用的各个技术,通过和SpringBoot的集成,并且对各种技术通...
- 开发好物推荐12之分布式锁redisson-sb
-
前言springboot开发现在基本都是分布式环境,分布式环境下分布式锁的使用必不可少,主流分布式锁主要包括数据库锁,redis锁,还有zookepper实现的分布式锁,其中最实用的还是Redis分...
- 拥抱Kubernetes,再见了Spring Cloud
-
相信很多开发者在熟悉微服务工作后,才发现:以为用SpringCloud已经成功打造了微服务架构帝国,殊不知引入了k8s后,却和CloudNative的生态发展脱轨。从2013年的...
- Zabbix/J监控框架和Spring框架的整合方法
-
Zabbix/J是一个Java版本的系统监控框架,它可以完美地兼容于Zabbix监控系统,使得开发、运维等技术人员能够对整个业务系统的基础设施、应用软件/中间件和业务逻辑进行全方位的分层监控。Spri...
- SpringBoot+JWT+Shiro+Mybatis实现Restful快速开发后端脚手架
-
作者:lywJee来源:cnblogs.com/lywJ/p/11252064.html一、背景前后端分离已经成为互联网项目开发标准,它会为以后的大型分布式架构打下基础。SpringBoot使编码配置...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- oracle位图索引 (63)
- oracle批量插入数据 (62)
- oracle事务隔离级别 (53)
- oracle 空为0 (50)
- oracle主从同步 (55)
- oracle 乐观锁 (51)
- redis 命令 (78)
- php redis (88)
- redis 存储 (66)
- redis 锁 (69)
- 启动 redis (66)
- redis 时间 (56)
- redis 删除 (67)
- redis内存 (57)
- redis并发 (52)
- redis 主从 (69)
- redis 订阅 (51)
- redis 登录 (54)
- redis 面试 (58)
- 阿里 redis (59)
- redis 搭建 (53)
- redis的缓存 (55)
- lua redis (58)
- redis 连接池 (61)
- redis 限流 (51)