百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 文章教程 > 正文

28个SpringBoot项目中常用注解,日常开发、求职面试不再懵圈

yund56 2025-05-03 17:00 10 浏览

前言

在使用SpringBoot开发中或者在求职面试中都会使用到很多注解或者问到注解相关的知识。本文主要对一些常用的注解进行了总结,同时也会举出具体例子,供大家学习和参考。

注解一览表

启动类以及配置类相关

@SpringBootApplication

解释:

  • @SpringBootApplication是组合注解。相当于@Configuration、@EnableAutoConfiguration、@ComponentScan的组合。
  • 用于标记启动类,指出应用入口
@SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

@Configuration

解释:

  • 声明当前类为配置类。相当于xml配置中的beans标签。
@Configuration
public class MyConfig {
    @Bean
    public MyBean myBean() {
        return new MyBean();
    }
}

@EnableAutoConfiguration

解释:

  • 开启SpringBoot自动装配功能。
@SpringBootApplication
@EnableAutoConfiguration
public class MyApplication {
    // ...
}

@ComponentScan

解释:

  • 配置SpringBoot扫描包路径。
@SpringBootApplication
@ComponentScan("com.example")
public class MyApplication {
    // ...
}

控制层相关

@RestController

解释:

  • @RestController注解用于定义控制器类,将其返回的结果自动转换为JSON格式
@RestController
public class UserController {
    @GetMapping("/users")
    public List<User> getAllUsers() {
        // 返回所有用户列表的逻辑
    }
}

@RequestMapping

解释:

  • 用于映射HTTP请求到处理器上,指定处理器方法的URL路径和HTTP请求方法。
@RestController
@RequestMapping("/users")
public class UserController {
    @GetMapping("/{id}")
    public User getUserById(@PathVariable("id") Long id) {
        // 根据id获取用户的逻辑
    }
}

@GetMapping、@PostMapping、@DeleteMapping、@PutMapping

解释:

  • @GetMapping注解用于处理HTTP的GET请求,并将请求映射到相应的处理器方法上。
  • @PostMapping注解用于处理HTTP的POST请求,并将请求映射到相应的处理器方法上。
  • @DeleteMapping注解用于处理HTTP的DELETE请求,并将请求映射到相应的处理器方法上。
  • @PutMapping是Spring框架中用于处理HTTP的PUT请求的注解。PUT请求通常用于更新资源,即将新的数据替换掉指定的资源。


@RestController
@RequestMapping("/users")
public class UserController {
    @GetMapping("/{id}")
    public User getUserById(@PathVariable("id") Long id) {
        // 根据id获取用户的逻辑
    }
}


@RestController
@RequestMapping("/users")
public class UserController {
    @PostMapping
    public User createUser(@RequestBody User user) {
        // 创建用户的逻辑
    }
}


@RestController
@RequestMapping("/users")
public class UserController {
    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable("id") Long id) {
        // 删除用户的逻辑
    }
}


@RestController
@RequestMapping("/users")
public class UserController {
    @PutMapping("/{id}")
    public User updateUser(@PathVariable("id") Long id, @RequestBody User user) {
        // 更新用户信息的逻辑
    }
}

@RequestParam

解释:

  • @RequestParam注解用于获取请求参数的值,并将其绑定到处理器方法的形参上。一般用于路径中?传参形式。
@RestController
@RequestMapping("/users")
public class UserController {
    @GetMapping
    public List<User> getUsersByPage(@RequestParam("page") int page, 
                                     @RequestParam(value = "size", defaultValue = "10") int size) {
        // 分页查询用户列表的逻辑
    }
}

@PathVariable

解释:

  • 用于获取URL路径中的变量值,并将其绑定到处理器方法的形参上。一般用于/传参的形式。
@RestController
@RequestMapping("/users")
public class UserController {
    @GetMapping("/{id}")
    public User getUserById(@PathVariable("id") Long id) {
        // 根据id获取用户的逻辑
    }
}

@RequestBody

解释:

  • 用于接收HTTP请求的请求体内容,并将其转化为对应的Java对象或其他类型的参数。
@RestController
@RequestMapping("/users")
public class UserController {
    @PostMapping
    public User createUser(@RequestBody User user) {
        // 创建用户的逻辑
    }
}

@Valid

解释:

  • @Valid用于开启数据验证功能,对方法参数进行校验,确保其满足定义的验证规则
@RestController
@RequestMapping("/users")
public class UserController {
    @PostMapping
    public ResponseEntity<User> createUser(@Valid @RequestBody User user) {
        // 创建用户的逻辑
        return ResponseEntity.status(HttpStatus.CREATED).body(user);
    }
}

Bean管理相关

  • @Autowired: 自动装配,用于自动注入依赖的Bean实例。
  • @Service: 用于标识一个服务类,表示它是业务逻辑层的组件。
  • @Repository: 用于标识一个数据访问类,表示它是数据访问层的组件。
  • @Component: 通用的Spring组件注解,用于标识一个普通的Bean组件。
  • @Value: 注入配置文件中的值到对应的变量中。


异步和定时相关

@EnableScheduling、@Scheduled

解释:

  • @EnableScheduling:启动类添加@EnableScheduling开启任务调度功能。
  • @Scheduled:定时任务注解,用于标识定时任务的方法。
@SpringBootApplication
@EnableScheduling
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}


@Component
public class MyScheduler {
    @Scheduled(fixedRate = 5000)
    public void myTask() {
        // 每个5秒执行一次的任务逻辑
    }
}


@Component
public class MyScheduler {
    @Scheduled(cron = "0 0 8 * * ?")
    public void myTask() {
        // 每天早上8点执行的任务逻辑
    }
}

@EnableAsync、@Async

解释:

  • @EnableAsync:启动类添加,开启异步任务。
  • @Async:标识异步任务方法。
@SpringBootApplication
@EnableAsync
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}


@Service
public class MyService {
    @Async
    public CompletableFuture<String> asyncTask() {
        // 异步执行的任务逻辑
        // 返回一个CompletableFuture以支持异步结果的处理
    }
}

缓存和事务管理

解释:

  • @EnableCaching: 开启Spring的缓存支持,用于缓存方法的结果,提高性能。
  • @Transactional: 提供声明式事务管理,用于标识需要使用事务的方法或类。
  • @EnableTransactionManagement: 开启事务管理支持,用于启用Spring的声明式事务管理功能


@SpringBootApplication
@EnableCaching
@EnableTransactionManagement
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}
@Service
public class MyService {
    @Transactional
    public void performTransaction() {
        // 执行数据库操作等需要事务管理的逻辑
    }
}

异常处理相关

@RestControllerAdvice、@ExceptionHandler

  • @RestControllerAdvice:结合了@ControllerAdvice和@ResponseBody注解的功能。它用于定义全局的异常处理和统一的响应处理。
  • @ExceptionHandler:指定类型的异常进行统一处理。
@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception e) {
        // 异常处理逻辑,可以根据实际需求进行对异常的处理和返回相应的错误信息
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Internal Server Error");
    }
}

写在最后

有关于SpringBoot常用注解到此就结束了。感谢大家的阅读,希望大家对此部分内容散发讨论或者还有其他注解可以在评论区进行补充,便于学到更多的知识。感激不尽!

相关推荐

豆包编程能力升级:支持HTML代码实时预览、交互

IT之家3月19日消息,IT之家从豆包官方获悉,豆包宣布AI编程功能迎来三项升级,包括HTML预览、Python运行、生成完整项目。据介绍,目前豆包支持HTML代码实时预览和交互...

1898款游戏!80、90回忆杀,重温旧梦,快速搭建中文DOS游戏服务

本内容来源于@什么值得买APP,观点仅代表作者本人|作者:羊刀仙大家好,我是羊刀仙。本期来介绍一个特别情怀向的游戏项目:chinese-dos-games。这套包含1898款经典中文DOS游戏的合集...

利用 SVG 文件内的 HTML 代码进行网络钓鱼攻击

随着时间的推移,网络钓鱼攻击的技术越来越精妙,旨在欺骗用户并规避安全措施。攻击者会使用欺骗性的URL重定向策略,例如将恶意网站地址附加到看似安全的链接后,在PDF中嵌入链接,以及发送HTML...

aardio + AI 大模型自动编写 Python 代码、网页前端代码的经验与技巧

在AI时代,老式的编程习惯完全被颠覆。原来可能要一大堆插件或工具辛苦堆出来的程序,现在只要把AI调教好了就行。aardio支持调用十几种编程语言,这很适合发挥AI大模型的优势。对于AI...

用AI制作游戏就是如此简单!

很多人不知道如何利用AI提高效率,不知道AI能帮我们做什么,其实可以让我们实现很多自己根本不懂的领域取得直观体验,比如利用DS或者豆包,输入“我想做一个简单的单机俄罗斯方块游戏”,AI会给出phtho...

不会写代码?教你用DeepSeek 三步做出小游戏

如今,借助人工智能技术,哪怕你完全看不懂代码,也能通过DeepSeek制作出属于自己的网页版大鱼吃小鱼游戏。接下来,就为大家详细介绍制作过程。第一步、向DeepSeek描述需求为何要做网页版的...

《暗黑1》被移植成网页游戏 可在浏览器上玩了

《暗黑1》,这款1996年发售的“鼠标杀手”砍杀游戏,现在可以在浏览器上玩了。国外专注暴雪游戏的Rivsoft分享了一个《暗黑1》的共享版本,该版本只包含地下城的头2个地区和三个角色职业中的一个。不...

网页代码过滤 轻松获取专辑目录

通过过滤网页代码,可以将网页上显示不全的长文件名列表完整地提取出来。我有一个含有75个视频文件的《中医诊断学》课件,文件名是以01.RMVB、02.RMVB……75.RMVB这种格式命名的。我希望能找...

IDEA 2021首个大版本发布,Java开发者感动哭了(附新亮点演示)

工欲善其事,必先利其器!就在不久之前,Java领域的开发神器IntelliJIDEA终于迎来2021年的一个重要的大版本更新:IntelliJIDEA2021.1。现如今大量的Java开发者深度...

View Source:在 iOS 上轻松查看网页源代码

在移动互联网时代,移动端的应用和web体验都尤为重要,在PC上有很多web前端工具可以选择,而在移动端貌似就少之又少了,在NEXT出现的ViewSource能帮你在iOS上查看...

当我们《寻找房祖名》,我们能找到什么?

游戏葡萄原创专稿,未经允许请勿转载柯震东,因为在九把刀电影《那些年我们追过的女孩》中饰演男主角柯景腾而走红的台湾影星,在昨天被爆出了和著名演员成龙之子房祖名吸毒被抓的丑闻,一时间相关讨论席卷社交网络。...

多用途游戏娱乐新闻网站HTML5模板

Retnews是一个响应式的HTML新闻,博客,杂志网站模板,可以使用这套前端模板简约很多设计的工作。模板有许多特性适合流行的主题商业、时尚,游戏,娱乐,生活方式、体育、科技、政治、旅行、天气、视频等...

简约好看的个人引导页HTML源码下载

源码介绍一款非常简约好看的个人引导页HTML源码,非常适合个人主页以及个人导航使用,纯HTML不需要数据库,上传服务器即可使用!...

教你如何在微信公共平台上插入小游戏(图文教程)

很多玩微信公共平台的朋友都想在公共平台上面插入几个小游戏,用来跟用户之间互动,这里花生来分享一下如何在微信公共平台上插入游戏,以及如何制作html5微信小游戏。首先是找游戏,总共有三个方法,本人比较倾...

html5重力感应剖析附源码

下面是测试html5重力感应的demohttp://bbs.qietu.com/html/zhongli/http://www.qietu.com/html/f2/qqqianbao/demo2是切图...