APP正在开发中...
返回顶部
您的位置： 主页 > 软件编程 > java >

收藏
分享到

Spring Boot 常用注解详解与使用最佳实践建议

java 来源：互联网 作者：佚名 发布时间：2025-05-11 07:59:31 人浏览
摘要

一、核心启动注解 1. @SpringBootApplication 作用：Spring Boot应用的入口注解，组合了@Configuration、@EnableAutoConfiguration和@ComponentScan 使用场景：主启动类上必须使用 示例： 1 2 3 4 5 6 @SpringBootApplication

一、核心启动注解

1. @SpringBootApplication

  • 作用：Spring Boot应用的入口注解，组合了@Configuration、@EnableAutoConfiguration和@ComponentScan
  • 使用场景：主启动类上必须使用
  • 示例：

1

2

3

4

5

6

@SpringBootApplication

public class MyApplication {

    public static void main(String[] args) {

        SpringApplication.run(MyApplication.class, args);

    }

}

2. @EnableAutoConfiguration

  • 作用：启用Spring Boot的自动配置机制
  • 使用场景：当需要自定义自动配置时使用
  • 注意：通常不需要单独使用，@SpringBootApplication已包含

3. @Configuration

  • 作用：标记类为配置类，替代XML配置
  • 使用场景：定义Bean配置时使用
  • 示例：

1

2

3

4

5

6

7

@Configuration

public class AppConfig {

    @Bean

    public MyService myService() {

        return new MyServiceImpl();

    }

}

4. @ComponentScan

  • 作用：自动扫描并注册Bean到Spring容器
  • 使用场景：需要自定义扫描路径时使用
  • 示例：

1

2

3

4

5

@SpringBootApplication

@ComponentScan({"com.example.main", "com.example.controllers"})

public class MyApplication {

    // ...

}

二、Bean定义与管理

1. @Bean

  • 作用：声明方法返回的对象由Spring管理
  • 使用场景：配置类中定义第三方库组件的Bean
  • 示例：

1

2

3

4

5

6

7

@Configuration

public class AppConfig {

    @Bean

    public RestTemplate restTemplate() {

        return new RestTemplate();

    }

}

2. @Component/@Service/@Repository/@Controller

  • 作用：将类标记为Spring组件，分别对应通用组件、服务层、数据层和控制层
  • 使用场景：开发业务组件时根据分层选择对应注解
  • 示例：

1

2

3

4

5

6

7

8

@Service

public class UserServiceImpl implements UserService {

    // 业务逻辑

}

@Repository

public class UserRepositoryImpl implements UserRepository {

    // 数据访问逻辑

}

3. @ConfigurationProperties

  • 作用：将配置文件属性绑定到Bean
  • 使用场景：需要集中管理配置属性时
  • 示例：

1

2

3

4

5

6

@ConfigurationProperties(prefix = "app")

public class AppProperties {

    private String name;

    private String version;

    // getters/setters

}

4. @Scope

  • 作用：定义Bean的作用域（singleton, prototype等）
  • 使用场景：需要非单例Bean时
  • 示例：

1

2

3

4

5

@Bean

@Scope("prototype")

public MyPrototypeBean myPrototypeBean() {

    return new MyPrototypeBean();

}

三、依赖注入

1. @Autowired

  • 作用：按类型自动注入依赖
  • 使用场景：需要注入依赖时首选
  • 示例：

1

2

3

4

5

@Service

public class UserService {

    @Autowired

    private UserRepository userRepository;

}

2. @Qualifier

  • 作用：指定注入的Bean名称（解决多个同类型Bean冲突）
  • 使用场景：有多个同类型Bean时
  • 示例：

1

2

3

@Autowired

@Qualifier("primaryDataSource")

private DataSource dataSource;

3. @Value

  • 作用：注入属性值
  • 使用场景：注入简单配置值
  • 示例：

1

2

3

4

3. @Value

作用：注入属性值

使用场景：注入简单配置值

示例：

四、Web MVC开发

1. @RestController/@Controller

  • 作用：标记类为Web控制器
  • 使用场景：开发REST API或传统MVC控制器
  • 示例：

1

2

3

4

5

6

7

8

@RestController

@RequestMapping("/api/users")

public class UserController {

    @GetMapping("/{id}")

    public User getUser(@PathVariable Long id) {

        // ...

    }

}

2. @RequestMapping/@GetMapping/@PostMapping等

  • 作用：映射HTTP请求路径和方法
  • 使用场景：定义API端点
  • 示例：

1

2

3

4

@PostMapping("/create")

public ResponseEntity<User> createUser(@RequestBody UserDto userDto) {

    // ...

}

3. @RequestBody/@ResponseBody

  • 作用：请求体绑定和响应体转换
  • 使用场景：REST API开发
  • 示例：

1

2

3

4

@PostMapping

public User create(@RequestBody User user) {

    return userService.save(user);

}

4. @PathVariable/@RequestParam

  • 作用：从URL路径或参数中获取值
  • 使用场景：需要获取URL中的变量或查询参数
  • 示例：

1

2

3

4

@GetMapping("/search")

public List<User> searchUsers(@RequestParam String keyword) {

    // ...

}

五、数据访问

1. @Entity/@Table

  • 作用：定义JPA实体类和对应表
  • 使用场景：数据库表映射
  • 示例：

1

2

3

4

5

6

7

8

@Entity

@Table(name = "users")

public class User {

    @Id

    @GeneratedValue(strategy = GenerationType.IDENTITY)

    private Long id;

    // ...

}

2. @Transactional

  • 作用：声明事务
  • 使用场景：需要事务管理的方法或类
  • 示例：

1

2

3

4

5

6

7

@Service

public class UserService {

    @Transactional

    public void updateUser(User user) {

        // ...

    }

}

3. @RepositoryRestResource

作用：将JPA仓库暴露为REST端点

使用场景：快速开发RESTful数据服务

示例：

  • 1

    2

    3

    @RepositoryRestResource(path = "users")

    public interface UserRepository extends JpaRepository<User, Long> {

    }

六、测试相关

1. @SpringBootTest

  • 作用：加载完整应用上下文进行集成测试
  • 使用场景：集成测试
  • 示例：

1

2

3

4

5

6

@SpringBootTest

class MyIntegrationTests {

    @Autowired

    private MyService myService;

    // 测试方法

}

2. @WebMvcTest

  • 作用：仅测试Web层
  • 使用场景：控制器单元测试
  • 示例：

1

2

3

4

5

6

@WebMvcTest(UserController.class)

class UserControllerTests {

    @Autowired

    private MockMvc mockMvc;

    // 测试方法

}

七、高级特性

1. @EnableCaching/@Cacheable

  • 作用：启用缓存和声明可缓存方法
  • 使用场景：需要方法结果缓存时
  • 示例：

1

2

3

4

5

6

7

@Service

public class UserService {

    @Cacheable("users")

    public User getUser(Long id) {

        // 只有第一次会执行，后续从缓存获取

    }

}

2. @EnableScheduling/@Scheduled

  • 作用：启用定时任务和定义任务执行时间
  • 使用场景：需要定时执行任务时
  • 示例：

1

2

3

4

5

6

7

@Component

public class MyScheduler {

    @Scheduled(fixedRate = 5000)

    public void doTask() {

        // 每5秒执行一次

    }

}

3. @Async

  • 作用：标记方法为异步执行
  • 使用场景：需要异步执行耗时操作时
  • 示例：

1

2

3

4

5

6

7

@Service

public class AsyncService {

    @Async

    public void asyncMethod() {

        // 异步执行

    }

}

最佳实践建议

  • 分层清晰：严格遵循Controller-Service-Repository分层，使用对应注解
  • 合理使用自动配置：优先使用Spring Boot的自动配置，必要时通过@ConfigurationProperties自定义
  • 依赖注入选择：构造函数注入优于字段注入（特别是必选依赖）
  • 事务管理：在Service层使用@Transactional，保持事务边界清晰
  • 测试策略：根据测试目标选择合适的测试注解（单元测试用@WebMvcTest，集成测试用@SpringBootTest）
  • REST API开发：优先使用@RestController和HTTP方法特定注解（@GetMapping等）
版权声明 : 本文内容来源于互联网或用户自行发布贡献，该文观点仅代表原作者本人。本站仅提供信息存储空间服务和不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权， 违法违规的内容， 请发送邮件至2530232025#qq.cn(#换@)举报，一经查实，本站将立刻删除。

您可能感兴趣的文章 :

原文链接 :
相关文章
推荐阅读
最新更新
友情链接
  • 本站所有内容来源于互联网或用户自行发布，本站仅提供信息存储空间服务，不拥有版权，不承担法律责任。如有侵犯您的权益，请您联系站长处理！
  • Copyright © 2017-2022 F11.CN All Rights Reserved. F11站长开发者网 版权所有 | 苏ICP备2022031554号-1 | 51LA统计