springboot常用注解大全(超详细, 30个)

于 2024-07-15 15:01:16 发布
阅读量478 收藏 7
点赞数 15
分类专栏： 后端 文章标签： spring boot java 后端 spring maven intellij idea
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_74065705/article/details/140356125
版权

Spring Boot注解主要用于简化配置、自动装配组件和实现声明式服务。以下是详细的介绍：

1、Springboot注解

核心注解

1. @SpringBootApplication
  • 作用: 标注一个主程序类，表明这是一个Spring Boot应用程序的入口。
  • 功能: 这是一个复合注解，组合了@Configuration、@EnableAutoConfiguration和@ComponentScan。
    • @Configuration: 标识一个类作为配置类，类似于Spring XML配置文件。
    • @EnableAutoConfiguration: 启用Spring Boot的自动配置机制，根据项目中的依赖和应用上下文自动配置Spring应用程序。
    • @ComponentScan: 自动扫描指定包及其子包中的Spring组件。
  • 示例:
    @SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

自动配置注解

2. @EnableAutoConfiguration
  • 作用: 启用Spring Boot的自动配置机制，根据项目中的依赖和应用上下文自动配置Spring应用程序。
  • 细节: 它会尝试根据添加的依赖和项目中的配置自动配置Spring Bean。例如，如果项目中有HSQLDB的依赖，Spring Boot会自动配置一个内存数据库。
  • 示例:
    @EnableAutoConfiguration
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}
3. @Configuration
  • 作用: 标注一个类作为配置类，相当于一个Spring XML配置文件。
  • 细节: 配置类可以包含一个或多个@Bean注解的方法，这些方法会返回要注册到Spring应用上下文中的Bean。
  • 示例:
    @Configuration
public class AppConfig {
    @Bean
    public MyService myService() {
        return new MyServiceImpl();
    }
}

组件扫描和注入注解

4. @ComponentScan
  • 作用: 指定要扫描的包，以便发现和注册Spring组件。
  • 细节: 默认情况下，@ComponentScan会扫描主应用类所在的包及其子包。
  • 示例:
    @ComponentScan(basePackages = "com.example")
public class MyApplication {
}
5. @Component
  • 作用: 将一个类标识为Spring组件（Bean），可以被Spring容器自动检测和注册。
  • 细节: @Component是一个通用的注解，可以用来标注任何Spring管理的Bean。
  • 示例:
    @Component
public class MyComponent {
}
6. @Service
  • 作用: 标识服务层组件，实际上是@Component的一个特化，用于表示业务逻辑服务。
  • 细节: 用于标识服务层的类，这些类通常包含业务逻辑。
  • 示例:
    @Service
public class MyService {
}
7. @Repository
  • 作用: 标识持久层组件，实际上是@Component的一个特化，用于表示数据访问组件。

数据访问组件（Data Access Component）通常是指在软件系统中负责数据访问和持久化的部分或模块。在典型的企业应用程序中，数据访问组件通常涉及与数据库交互、执行数据操作（如增删改查）、数据转换和持久化等任务。

  • 示例:
    @Repository
public class MyRepository {
}
8. @Controller
  • 作用: 标识控制层组件，实际上是@Component的一个特化，用于表示Web控制器。
  • 细节: 用于标识Spring MVC控制器，处理Web请求并返回视图。
  • 示例:
    @Controller
public class MyController {
}
9. @RestController
  • 作用: 标识一个RESTful Web服务的控制器，实际上是@Controller和@ResponseBody的结合。
  • 细节: 返回的对象会自动序列化为JSON或XML，并写入HTTP响应体中。
  • 示例:
    @RestController
public class MyRestController {
}

数据绑定和验证注解

10. @RequestMapping
  • 作用: 映射HTTP请求到处理方法上（GET、POST、PUT、DELETE等）。
  • 示例:
    @Controller
public class MyController {
    @RequestMapping("/hello")
    public String sayHello() {
        return "hello";
    }
}
11. @GetMapping
  • 作用: 映射HTTP GET请求到处理方法上。
  • 示例:
    @RestController
public class MyRestController {
    @GetMapping("/users")
    public List<User> getUsers() {
        return userService.getAllUsers();
    }
}
12. @PostMapping
  • 作用: 映射HTTP POST请求到处理方法上。
  • 示例:
    @RestController
public class MyRestController {
    @PostMapping("/users")
    public User
13. @ResponseBody
  • 作用: 将方法的返回值转换为指定格式（如JSON、XML）作为HTTP响应的内容返回给客户端。
  • 细节: 常用于RESTful服务中，标识方法返回的对象不是视图名称，而是直接写入HTTP响应体中的数据。
  • 示例:
    @RestController
public class MyRestController {
    @GetMapping("/hello")
    @ResponseBody
    public String sayHello() {
        return "Hello, World!";
    }
}
14. @RequestBody
  • 作用: 将HTTP请求体的内容（如JSON、XML等）映射到一个Java对象。
  • 细节: 通常用于POST请求中，将客户端发送的数据绑定到方法的参数上。
  • 示例:
    @RestController
public class MyRestController {
    @PostMapping("/users")
    public ResponseEntity<String> addUser(@RequestBody User user) {
        // 处理用户添加逻辑
        return ResponseEntity.ok("User added successfully");
    }
}
15. @PathVariable
  • 作用: 从URI路径中提取参数值，将其映射到方法的参数上。
  • 细节: 常用于RESTful服务中，允许动态地将URL中的部分作为方法参数使用。
  • 示例:
    @RestController
public class MyRestController {
    @GetMapping("/users/{userId}")
    public ResponseEntity<User> getUserById(@PathVariable Long userId) {
        // 根据userId查询用户信息
        User user = userService.getUserById(userId);
        return ResponseEntity.ok(user);
    }
}
16. @RequestParam
  • 作用: 用于从请求中获取参数的值。
  • 细节: 可以指定参数的默认值，是否必需等属性。适用于处理查询参数或表单数据。
  • 示例:
    @RestController
public class MyRestController {
    @GetMapping("/users")
    public ResponseEntity<User> getUserByName(@RequestParam String username) {
        // 根据用户名查询用户信息
        User user = userService.getUserByUsername(username);
        return ResponseEntity.ok(user);
    }
}

这些注解是Spring MVC和Spring Boot中常用的数据绑定和处理注解，帮助开发者更方便地处理HTTP请求和响应，实现灵活的接口设计和数据交互。

数据访问注解

17. @Entity
  • 作用: 标识一个JPA实体。
  • 细节: 用于定义一个与数据库表映射的持久化类。
  • 示例:
    @Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
}
18. @Table
  • 作用: 指定实体对应的数据库表名称。
  • 细节: 如果类名与数据库表名不同，可以使用@Table注解进行指定。
  • 示例:
    @Entity
@Table(name = "users")
public class User {
    // fields and methods
}

其他常用注解

19. @Value
  • 作用: 用于将外部属性值注入到Spring Bean中。
  • 细节: 可以用于注入属性文件中的值、系统环境变量、系统属性等。
  • 示例:
    @Value("${my.property}")
private String myProperty;
20. @Autowired
  • 作用: 自动装配Bean，进行依赖注入。
  • 细节: Spring会自动满足Bean的依赖。可以用于字段、构造函数和方法上。
  • 示例:
    @Service
public class MyService {
    @Autowired
    private MyRepository myRepository;
}
21. @Bean
  • 作用: 用于定义一个Spring Bean。
  • 细节: 通常用于配置类中，定义的方法返回的对象会被注册为Spring容器中的Bean。
  • 示例:
    @Configuration
public class AppConfig {
    @Bean
    public MyService myService() {
        return new MyServiceImpl();
    }
}
22. @Conditional
  • 作用: 根据特定条件创建Bean。
  • 细节: 可以与自定义条件类一起使用，只有在条件满足时，Spring才会创建该Bean。
  • 示例:
    @Bean
@Conditional(MyCondition.class)
public MyService myService() {
    return new MyServiceImpl();
}
23. @Primary
  • 作用: 指定当一个接口有多个实现时，优先选择的Bean。
  • 示例:
    @Service
@Primary
public class PrimaryService implements MyService {
}
24. @Qualifier
  • 作用: 配合@Autowired使用，用于指定注入的Bean的名称或ID。
  • 示例:
    @Service
public class MyService {
    @Autowired
    @Qualifier("myRepositoryImpl")
    private MyRepository myRepository;
}
25. @Lazy
  • 作用: 延迟初始化Bean，只有在首次使用时才创建Bean。
  • 示例:
    @Service
@Lazy
public class LazyService {
}
26. @Scope
  • 作用: 指定Bean的作用域（单例、多例、请求、会话等）。
  • 示例:
    @Service
@Scope("prototype")
public class PrototypeService {
}

其他注解

简化POJO开发的注解

这三个注解通常与Lombok（一种Java库）结合使用，用于简化POJO（Plain Old Java Object）的开发。

1. @Data

  • 作用: @Data 是一个复合注解，集成了 @ToString、@EqualsAndHashCode、@Getter、@Setter 和 @RequiredArgsConstructor 的功能。

  • 功能:

    • @ToString: 自动生成 toString() 方法，包含所有字段。
    • @EqualsAndHashCode: 自动生成 equals() 和 hashCode() 方法，基于所有非静态和非瞬态字段。
    • @Getter 和 @Setter: 自动生成字段的 getter 和 setter 方法。
    • @RequiredArgsConstructor: 自动生成包含必需字段的构造方法。

  • 示例:

    import lombok.Data;

@Data
public class User {
    private Long id;
    private String username;
    private String email;
}

    编译时，Lombok会自动生成如下代码：

    public class User {
    private Long id;
    private String username;
    private String email;

    // 自动生成的 toString(), equals(), hashCode(), getter 和 setter 方法
    // 以及包含所有字段的构造方法
}

2. @AllArgsConstructor

  • 作用: 自动生成包含所有字段的构造方法。

  • 示例:

    import lombok.AllArgsConstructor;
import lombok.Data;

@Data
@AllArgsConstructor
public class User {
    private Long id;
    private String username;
    private String email;
}

    编译时，Lombok会自动生成如下构造方法：

    public User(Long id, String username, String email) {
    this.id = id;
    this.username = username;
    this.email = email;
}

3. @NoArgsConstructor

  • 作用: 自动生成无参构造方法。

  • 示例:

    import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
public class User {
    private Long id;
    private String username;
    private String email;
}

    编译时，Lombok会自动生成如下无参构造方法：

    public User() {
    // 空构造方法
}

文章到这里就这束了！~

其他文章地址:

快速入门，springboot知识点汇总

springboot常用注解大全(超详细, 30个)

springboot websocket知识点汇总

spring cloud 知识点汇总, 待更

小程xy
关注
  • 15
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
基于 SpringBoot 开发的超简洁音乐播放器.zip
05-18
【标题】：“基于SpringBoot开发的超简洁音乐播放器”是一个使用SpringBoot框架构建的音乐播放应用程序项目。SpringBoot是Spring框架的一个子项目，旨在简化Java应用的初始搭建以及开发过程，通过内置的默认配置，...
Springboot初学者项目demo（超实用）
12-20
它集成了大量常用的第三方库配置，如 JDBC、MongoDB、RabbitMQ、Quartz 等，让开发者可以“零配置”地启动项目，大大提升了开发效率。 Spring Boot 的核心特性包括自动配置、嵌入式服务器、运行时指标和健康检查等...
Java EE常用框架.xmind
06-19
Java EE常用框架 WebService 介绍 基于Web的服务。它使用Web(HTTP)方式，接收和响应外部系统的某种请求。从而实现远程调用 术语 XML. Extensible Markup Language －扩展性标记语言 WSDL – ...
springboot知识点整理
03-20
1.4 第一个Spring Boot项目（jar）：HelloWorld 8 1.5 入门案例详解 11 1.5.1 POM文件 11 1.5.2 主程序类，主入口类 12 1.6 使用Spring Initializer向导快速创建Spring Boot 16 2 Spring Boot配置 18 2.1 配置文件 ...
【java深入学习第5章】Spring Boot 统一功能的实现及处理方式
liyananweb的博客
07-14 556
通过本文的介绍，我们了解了如何在 Spring Boot 中实现统一的数据返回格式和异常处理，并通过一个图书管理系统的案例代码演示了这些功能的实现。采用统一的功能处理方式可以提高代码的可维护性和可扩展性，提高开发效率，并且可以提供更好的用户体验。希望本文对你有所帮助。AI写论文🔥🔥🔥。
【PostgreSQL】Spring boot + Mybatis-plus + PostgreSQL 处理json类型情况
No8g攻城狮的博客
07-11 1301
在 Springboot 项目开发中，一般使用关系型数据库作为主库存储数据，有时候业务场景需要在既有的表结构上，扩展自定义业务信息。这种场景下一般使用json类型存储。本文总结 Springboot 项目中，借助 Mybatis-plus 操作json实践方案。在 MyBatis-Plus 中，除了使用内置的类型处理器外，开发者还可以根据需要自定义类型处理器。例如，当使用 PostgreSQL 数据库时，可能会遇到 JSON 类型的字段，这时可以创建一个自定义的类型处理器来处理 JSON 数据。
项目实战--Spring Boot + GraphQL实现实时数据推送
qq_40623672的博客
07-10 608
GraphQL是一种用于API的查询语言，核心思想是让客户端能够根据自身需求精确地获取所需的数据，而不是像传统的RESTful API那样只能获取整个资源对象。（1）灵活性：客户端可以精确指定所需的数据字段，而不是被限制于服务器端提供的固定数据结构。（2）效率：减少了不必要的数据传输和处理，提高了数据获取效率。（3）类型系统：GraphQL具有严格的类型系统，能够在编译阶段检测出潜在的错误，提高了开发效率。
Spring Boot中的多租户架构实现
微赚淘客开发者博客
07-06 1599
在多租户系统中，每个租户都能够安全且有效地使用相同的应用程序，同时确保数据隔离和性能独立性。通过合理的设计和实施，开发人员可以有效地管理和运行支持多个租户的应用程序，从而提升系统的灵活性和扩展性。每个租户是一个逻辑上独立的客户，拥有自己的数据、配置、用户界面等资源，而这些资源又可以在同一个应用程序实例中共享。在Spring Boot中配置多租户数据源，可以使用AbstractRoutingDataSource实现动态数据源切换，根据不同的租户标识动态选择数据源。
spring boot实现短信验证码功能
weixin_41463944的博客
07-05 997
spring boot实现短信验证码功能
Java异常体系、UncaughtExceptionHandler、Spring MVC统一异常处理、Spring Boot统一异常处理
lonelymanontheway的博客
07-12 1049
Java异常体系概述、try...catch...finally语句块、常见异常、最佳实践； 异常表、异常throw事件；UncaughtExceptionHandler、Spring MVC异常处理机制、Spring MVC全局异常处理、Spring Boot全局异常处理
Spring Boot和Spring有什么区别
weixin_44337480的博客
07-12 586
Spring Boot和Spring之间的主要区别体现在操作简化、配置流程、非功能性特性、集成框架以及核心设计思想等方面。
Windows中安装部署MinIo文件系统，在Spring Boot中引入MinIo依赖实现上传文件到MinIo文件系统中
番茄Salad
07-11 412
Windows中安装部署MinIo文件系统，在Spring Boot中引入MinIo依赖实现上传文件到MinIo文件系统中
Spring Boot日志
最新发布
persistence_PSH的博客
07-14 550
trace：微量，少许的意思，级别最低，一般记录了框架底层的日志，很少使用。fatal：致命的，因为代码异常导致程序退出执行的事件，例如jvm系统崩溃。warn：警告，不影响使用，但需要注意的问题，例如类的版本过时了。error：错误信息，级别较高的错误日志信息；debug：需要开发调试时候的关键信息打印；info：普通的打印信息（默认日志级别）；SpringBoot预定义两个组。日志门面（日志的抽象层）all ：打印所有的日志。off ：关闭所有的日志。日志文件归档与滚动切割。
基于Spring Boot的高校后勤餐饮管理系统
java一只鱼的博客
07-11 634
互联网+”时代的到来，既给高校后勤管理发展带来了机遇，也带来了更大的挑战。信息化应用已经开始普及，传统的高校后勤餐饮管理模式往往存在着效率低下、信息不透明、资源浪费等问题，已经难以满足现代高校师生对餐饮服务高效化的需求。高校师生规模的扩大和餐饮需求的多样化及信息化行业不断地变化，使得对高校后勤餐饮管理的需求不断提高。传统的管理模式往往难以应对这种变化，从而导致服务质量和效率低下。比如采用线下操作的方式，无法及时更新数据、共享数据参考，甚至存在数据丢失等问题。
spring boot 基础特性
persistence_PSH的博客
07-14 612
Springboot四大组件spring boot的依赖管理profiles 提供了环境隔离能力，可以快速切换开发、测试、生产环境Profile 配置文件{profile}yaml文件。
Spring Boot Vue 毕设系统讲解 9 【Spark】
java一只鱼的博客
07-12 357
这段代码是一个用于配置Apache Spark的Java配置类，它利用了Spring Boot的自动配置和条件注解功能来创建和管理Spark的配置和上下文。总之，这个类通过Spring Boot的自动配置和条件注解功能，提供了一种灵活的方式来配置和管理Spark应用的配置和上下文。
Spring boot 更改启动LOGO
qq_45523857的博客
07-02 838
在resources目录下创建banner.txt文件，然后编辑对应的图案即可。
Spring Boot实战：无缝对接OpenAI
德乐懿的博客
07-09 1067
通过本文的介绍，你应该已经了解了如何使用Spring Boot无缝对接OpenAI，并在你的应用中实现AI功能。你可以通过探索OpenAI的官方文档来了解更多关于这些功能的信息，并按照类似的方式在你的Spring Boot应用中实现它们。要使用OpenAI的API，首先需要注册一个OpenAI账号，并在Dashboard中获取你的API密钥。这个密钥将用于后续的API调用中，以验证你的身份。此外，你还可以考虑使用Spring Boot的其他特性来增强你的应用，如异步处理、安全性、数据库集成等。
在Spring Boot项目中集成监控与报警
微赚淘客开发者博客
07-08 770
本文详细介绍了在Spring Boot项目中集成监控与报警的方法，包括使用Actuator端点进行基本的监控配置、集成Spring Boot Admin进行高级监控和报警配置，以及使用Micrometer进行度量。Spring Boot作为广泛使用的Java框架，提供了丰富的支持来集成监控和报警功能，本文将介绍如何在Spring Boot项目中实现这些功能。通过Spring Boot Admin的界面，可以配置报警规则和通知方式，如邮件、Slack等，来实现对应用程序异常和重要指标的实时监控和报警通知。
springboot常用注解
04-25
好的，关于springboot常用注解，以下是一些比较常用的注解： 1. @SpringBootApplication：该注解用于标记Spring Boot的主类，表示该类是一个Spring Boot应用程序的入口点。 2. @RestController：该注解用于标记一个类，表示该类中的所有方法都返回JSON格式的数据。 3. @RequestMapping：该注解用于标记一个Controller或者方法，表示该Controller或者方法可以处理哪些请求。 4. @Autowired：该注解用于自动注入一个Bean对象，Spring Boot会自动扫描所有可用的Bean，并进行自动注入。 5. @Value：该注解用于获取配置文件中的属性值。 6. @Component：该注解用于标记一个类，表示该类是一个可被Spring容器管理的Bean。 7. @Repository：该注解用于标记一个类，表示该类是一个数据访问对象（DAO）。 8. @Service：该注解用于标记一个类，表示该类是一个业务逻辑对象。 以上是一些比较常用的Spring Boot注解，如果需要了解更多注解的使用方式，可以查看Spring Boot的官方文档。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值