写点什么

SpringBoot 必须掌握的常用注解!

作者:王磊
  • 2024-11-07
    陕西
  • 本文字数:3880 字

    阅读完需:约 13 分钟

SpringBoot必须掌握的常用注解!

Spring Boot 提供了大量的注解,用于简化配置和加速程序开发


那么接下来,咱们就一起来看下 Spring Boot 中的常用注解有哪些?及其这些注解的具体使用。


1.Bean 相关

  1. @Component:将一个类标识为 Spring 组件(Bean),可以被 Spring 容器自动检测和注册。通用注解,适用于任何层次的组件。


@Componentpublic class MyComponent {    public void doSomething() {        System.out.println("MyComponent is doing something.");    }}
复制代码


  1. @ComponentScan:自动扫描指定包及其子包中的 Spring 组件。


@ComponentScan("com.example") // 扫描com.example包下的组件,加载到Spring容器@SpringBootApplicationpublic class DemoApplication {    public static void main(String[] args) {        SpringApplication.run(DemoApplication.class, args);    }}
复制代码


  1. @Controller:标识控制层组件,实际上是 @Component 的一个特化,用于表示 Web 控制器。处理 HTTP 请求并返回视图或响应数据。


@Controllerpublic 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"; }}
复制代码


  1. @RestController:是 @Controller 和 @ResponseBody 的结合,返回的对象会自动序列化为 JSON 或 XML,并写入 HTTP 响应体中。


@RestControllerpublic class MyController {    @Autowired    private final UserService userService;
@GetMapping("/user") public User getUser() { User user = userService.getUserById(1); return user; }}
复制代码


  1. @Service:标识服务层组件,实际上是 @Component 的一个特化,用于表示业务逻辑服务。


@Servicepublic class MyService {}
复制代码


  1. @Repository:标识持久层组件(DAO 层),实际上是 @Component 的一个特化,用于表示数据访问组件。常用于与数据库交互。


@Repositorypublic interface UserDao {}
复制代码


  1. @Bean:方法注解,用于修饰方法,主要功能是将修饰方法的返回对象添加到 Spring 容器中,使得其他组件可以通过依赖注入的方式使用这个对象。


@Configurationpublic class AppConfig {    @Bean    public MyBean myBean() {        return new MyBean();    }}
复制代码


  1. @Configuration:标识一个类作为配置类,@Component 的一个特化,通常配合 @Bean 注解一起使用。


@Configurationpublic class AppConfig {}
复制代码


  1. @Scope:用于声明一个 Spring Bean 实例的作用域,作用域的范围有单例模式、原型模式(多例模式)等。


@Configurationpublic class AppConfig {    @Bean    @Scope("prototype")    public MyPrototypeBean myPrototypeBean() {        return new MyPrototypeBean();    }}
复制代码

2.依赖注入

  1. @Autowired:用于自动注入依赖对象,Spring 框架提供的注解。


@RestControllerpublic class MyController {    @Autowired    private final UserService userService;
@GetMapping("/user") public User getUser() { User user = userService.getUserById(1); return user; }}
复制代码


  1. @Resource:按名称自动注入依赖对象(也可以按类型,但默认按名称),JDK 提供注解。


@RestControllerpublic class MyController {    @Resource    private final UserService userService;
@GetMapping("/user") public User getUser() { User user = userService.getUserById(1); return user; }}
复制代码


  1. @Qualifier:与 @Autowired 一起使用,用于指定要注入的 Bean 的名称。当存在多个相同类型的 Bean 时,可以使用 @Qualifier 来指定注入哪一个。


@RestControllerpublic class MyController {    @Autowired    @Qualifier("userService")    private final UserService us;
@GetMapping("/user") public User getUser() { User user = userService.getUserById(1); return user; }}
复制代码

3.Web 相关

  1. @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; }}
复制代码


  1. @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; }}
复制代码


  1. @RequestParam:用于将请求参数绑定到 Controller 方法的参数上。它主要用于处理 GET、POST 等请求中的查询参数,例如将 http://example.com/api?param1=value1&param2=value2 中的 param1 和 param2 参数设置到方法的参数上。


@RestControllerpublic class MyController {    @GetMapping("/hello")    public String sayHello(@RequestParam("name") String userName) {        return "Hello, " + userName;    }}
复制代码


  1. @PathVariable:用于从请求的 URL 路径中提取变量值,并将其绑定到控制器方法的参数上。


@GetMapping("/user/{userId}")public String getUserById(@PathVariable("userId") Long id) {    return "User with ID " + id;}
复制代码


  1. @RequestBody:将 HTTP 请求体的内容(如 JSON、XML)转换为 Java 对象。通常用于接收前端传递的数据,标注在方法的参数上。


@Controllerpublic class MyController {    @PostMapping("/submit")    public String submitData(@RequestBody MyData myData) {        System.out.println(myData);        return "success";    }}
复制代码


  1. @ResponseBody:将方法的返回值转换为指定格式(如 JSON、XML)作为 HTTP 响应的内容返回给客户端。通常与 @RequestMapping 或 @GetMapping 等注解一起使用在方法上。


@RestControllerpublic class MyController {    @GetMapping("/data")    @ResponseBody    public String getData() {        return "Some data";    }}
复制代码

4. 读取配置

  1. @Value:用于注入属性值,通常从配置文件中获取。标注在字段上,并指定属性值的来源(如配置文件中的某个属性)。


@Componentpublic class MyComponent {    @Value("${my.property}")    private String myPropertyValue;
public void printValue() { System.out.println(myPropertyValue); }}
复制代码


  1. @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. 配置启动注解

  1. @SpringBootApplication:用于标识 SpringBoot 应用程序的入口类。它是一个组合注解,包括了 @Configuration、@EnableAutoConfiguration 和 @ComponentScan 三个注解。


@SpringBootApplicationpublic class DemoApplication {    public static void main(String[] args) {        SpringApplication.run(DemoApplication.class, args);    }}
复制代码


  1. @EnableAutoConfiguration:启用 Spring Boot 的自动配置机制,根据添加的依赖和配置文件自动配置 Spring 应用。

6. 其他常用注解

  1. @Transactional:声明事务管理。标注在类或方法上,指定事务的传播行为、隔离级别等。


import org.springframework.stereotype.Service;import org.springframework.transaction.annotation.Transactional;
@Servicepublic class MyService { @Transactional public void performTransactionalOperation() { // Database operations }}
复制代码


  1. @Scheduled:声明一个方法需要定时执行。标注在方法上,并指定定时执行的规则(如每隔一定时间执行一次)。


import org.springframework.scheduling.annotation.Scheduled;import org.springframework.stereotype.Component;
@Componentpublic class MyScheduledTask { @Scheduled(fixedRate = 5000) public void performTask() { System.out.println("Task executed."); }}
复制代码

小结

Spring Boot 中的注解用很多,本文也是走马观花的带大家了解了一下 Spring Boot 中的常见注解。当然这些注解也不需要全部记住,只需有一个大概的印象即可,用的时候再查具体的使用就可以了。最后,欢迎小伙伴在评论区补充和发表更多的常用注解。


本文已收录到我的面试小站 www.javacn.site,其中包含的内容有:并发编程、MySQL、Redis、Spring、Spring MVC、Spring Boot、Spring Cloud、MyBatis、JVM、设计模式、消息队列等模块。

用户头像

王磊

关注

javacn.site 2018-08-25 加入

我的小站:javacn.site

评论

发布
暂无评论
SpringBoot必须掌握的常用注解!_王磊_InfoQ写作社区