SpringBoot常见的注解

🕗 发布于 2024-12-12 11:44 spring boot 后端 java

在这里插入图片描述

Spring Boot 常见注解详解

在 Spring Boot 开发中，注解是简化开发过程和提高效率的核心工具。通过使用各种注解，我们可以实现依赖注入、配置管理、Web 开发、数据访问等功能。以下是一些常见的 Spring Boot 注解，并对每个注解的作用进行了详细说明。

1. Spring Boot 核心注解

这些注解用于配置 Spring Boot 应用的基础设置和启用自动配置。

@SpringBootApplication
这个注解是 Spring Boot 的核心注解，通常放置在主类上，作用是整合 @Configuration、@EnableAutoConfiguration 和 @ComponentScan。它使得 Spring Boot 应用可以自动配置和启动。
```
@SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}
```

@Configuration
用于标注一个类是配置类，相当于传统 Spring 中的 XML 配置。可以在配置类中使用 @Bean 来定义 Beans。

@Configuration
public class AppConfig {
    @Bean
    public MyService myService() {
        return new MyService();
    }
}

@EnableAutoConfiguration
启用 Spring Boot 的自动配置机制，帮助根据当前项目的类路径自动配置相关的 Spring Beans。一般不需要显式使用，通常由 @SpringBootApplication 自动包含。
@ComponentScan
用于自动扫描指定包中的组件，并将其注册为 Spring 管理的 Beans。Spring 会自动扫描当前类所在包及其子包中的所有类。

2. Web 开发相关注解

这些注解用于创建 RESTful API 和处理 Web 请求。

@RestController
组合注解 @Controller 和 @ResponseBody，表示该类是一个控制器，并且所有方法的返回值会自动作为 HTTP 响应体返回，通常用于构建 RESTful 服务。
```
@RestController
public class MyController {
    @GetMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }
}
```
@RequestMapping
用于将 HTTP 请求映射到相应的处理方法。可以指定请求的 URL、请求方法、参数等。它可以与 GET、POST、PUT、DELETE 等 HTTP 方法结合使用。
```
@RequestMapping(value = "/hello", method = RequestMethod.GET)
public String hello() {
    return "Hello, World!";
}
```

@GetMapping
是 @RequestMapping 的快捷方式，用于映射 HTTP GET 请求。

@GetMapping("/hello")
public String hello() {
    return "Hello, World!";
}

@PostMapping
是 @RequestMapping 的快捷方式，用于映射 HTTP POST 请求。

@PostMapping("/submit")
public String submit(@RequestBody MyRequest request) {
    return "Data received: " + request.getData();
}

@PathVariable
用于将 URL 中的变量值映射到方法参数。

@GetMapping("/users/{id}")
public String getUserById(@PathVariable String id) {
    return "User ID: " + id;
}

@RequestParam
用于将请求的查询参数映射到方法的参数。

@GetMapping("/search")
public String search(@RequestParam String query) {
    return "Search query: " + query;
}

@RequestBody
用于将请求体中的 JSON 数据转换为 Java 对象。

@PostMapping("/data")
public String postData(@RequestBody MyData data) {
    return "Received: " + data.getValue();
}

3. 依赖注入相关注解

用于管理应用中的 Bean 依赖关系，实现松耦合和自动装配。

@Autowired
自动注入 Spring 容器中的 Bean，Spring 会根据类型匹配进行自动装配。
```
@Autowired
private MyService myService;
```
@Qualifier
当多个相同类型的 Bean 存在时，使用 @Qualifier 指定注入的具体 Bean。
```
@Autowired
@Qualifier("specificService")
private MyService myService;
```
@Inject
来自 JSR-330 标准，功能与 @Autowired 类似，用于自动注入依赖。
@Resource
JSR-250 标准注解，通过名称进行自动注入。
@Value
用于注入配置文件中的属性值，支持表达式和系统变量。
```
@Value("${app.name}")
private String appName;
```

4. 数据访问相关注解

用于定义 JPA 实体、数据库交互等。

@Entity
标识一个类是 JPA 实体，它会映射到数据库中的一张表。

@Entity
public class User {
    @Id
    @GeneratedValue
    private Long id;
    private String name;
}

@Table
用于指定实体类对应的数据库表名。

@Entity
@Table(name = "users")
public class User {
    // Fields and methods
}

@Id
标记字段为实体的主键。
@GeneratedValue
配合 @Id 使用，指定主键生成策略（如自增、序列等）。
@Repository
标记数据访问层的 Bean，通常与 JPA 或 MyBatis 配合使用。

5. 事务管理相关注解

用于声明和管理事务，确保数据一致性。

@Transactional
用于声明事务，保证方法的原子性。可以标注在类或方法上。
```
@Transactional
public void updateData() {
    // Method logic
}
```

6. Spring Boot 配置相关注解

这些注解用于读取和处理配置文件中的属性。

@Value
读取单个配置项或配置文件中的值。
@ConfigurationProperties
用于将配置文件中的一组属性映射到一个 POJO 类。可以减少硬编码，方便管理大量的配置项。
```
@ConfigurationProperties(prefix = "app")
public class AppConfig {
    private String name;
    private String version;
}
```

7. Spring Boot 测试相关注解

用于单元测试和集成测试。

@SpringBootTest
启动一个完整的 Spring 容器，适用于集成测试。
@WebMvcTest
专门用于测试 Spring MVC 控制器。
@DataJpaTest
仅启动 JPA 相关的配置，用于测试数据访问层。
@MockBean
用于模拟 Bean，通常与 @SpringBootTest 配合使用，模拟外部服务。

8. 其他常见注解

这些注解用于更细粒度的 Bean 管理和环境控制。

@Profile
用于根据不同的环境或配置文件激活某个 Bean 或配置。
@PropertySource
用于加载外部的配置文件到 Spring 环境中。
@Component
用于标注一个类为 Spring 管理的 Bean。
@Service
用于标注服务层的 Bean。
@Controller
用于标注 MVC 控制器类。
@Configuration
用于标注配置类，相当于 XML 配置文件。