SpringBoot 常用注解总结超详细

一、核心启动注解

@SpringBootApplication

作用：Spring Boot项目的核心启动注解，相当于以下三个注解的组合：

@Configuration（标记为配置类）

@EnableAutoConfiguration（启用自动配置）

@ComponentScan（组件扫描）

使用场景：主启动类上必须添加此注解

java

Copy Code

@SpringBootApplication

public class MyApplication {

public static void main(String[] args) {

SpringApplication.run(MyApplication.class, args);

}

}

二、控制器相关注解

@RestController

作用：组合注解，相当于@Controller + @ResponseBody，表示该类是控制器且返回值直接写入HTTP响应体

java

Copy Code

@RestController

@RequestMapping("/api")

public class UserController {

// 控制器方法...

}

@RequestMapping

作用：映射HTTP请求路径到控制器方法

常用属性：

value/path：请求路径

method：请求方法（GET/POST等）

produces：指定返回内容类型

java

Copy Code

@RequestMapping(value = "/users", method = RequestMethod.GET)

@GetMapping / @PostMapping / @PutMapping / @DeleteMapping

作用：简化版@RequestMapping，专门用于特定HTTP方法

java

Copy Code

@GetMapping("/users/{id}")

public User getUser(@PathVariable Long id) {

// 方法实现...

}

三、请求参数处理

@PathVariable

作用：获取URL路径中的变量

java

Copy Code

@GetMapping("/users/{id}")

public User getUser(@PathVariable("id") Long userId) {

// 方法实现...

}

@RequestParam

作用：获取请求参数

常用属性：

value：参数名

required：是否必须（默认true）

defaultValue：默认值

java

Copy Code

@GetMapping("/users")

public List<User> getUsers(@RequestParam(value = "page", defaultValue = "1") int page) {

// 方法实现...

}

@RequestBody

作用：将请求体中的JSON/XML数据绑定到Java对象

java

Copy Code

@PostMapping("/users")

public User createUser(@RequestBody User user) {

// 方法实现...

}

四、Bean相关注解

@Component

作用：通用组件注解，标识一个类为Spring组件

@Service

作用：业务逻辑层组件

@Repository

作用：数据访问层组件，会自动转换数据库异常为Spring统一异常

@Configuration

作用：声明一个类为配置类，可以替代XML配置文件

java

Copy Code

@Configuration

public class AppConfig {

@Bean

public MyService myService() {

return new MyServiceImpl();

}

}

@Bean

作用：声明一个方法返回的对象作为Spring Bean

java

Copy Code

@Bean

public DataSource dataSource() {

// 创建并返回DataSource实例

}

五、自动装配相关

@Autowired

作用：自动注入依赖，默认按类型匹配

java

Copy Code

@Service

public class UserService {

@Autowired

private UserRepository userRepository;

}

@Qualifier

作用：当有多个相同类型的Bean时，指定具体注入哪一个

java

Copy Code

@Autowired

@Qualifier("primaryDataSource")

private DataSource dataSource;

@Primary

作用：当有多个相同类型的Bean时，优先使用标记@Primary的Bean

java

Copy Code

@Bean

@Primary

public DataSource primaryDataSource() {

// 主数据源配置

}

六、事务管理

@Transactional

作用：声明事务，可应用于类或方法

常用属性：

propagation：事务传播行为

isolation：事务隔离级别

timeout：超时时间

rollbackFor：指定哪些异常触发回滚

java

Copy Code

@Transactional(rollbackFor = Exception.class)

public void updateUser(User user) {

// 方法实现...

}

七、测试相关

@SpringBootTest

作用：Spring Boot集成测试注解，会加载完整的应用程序上下文

java

Copy Code

@SpringBootTest

class MyApplicationTests {

@Test

void contextLoads() {

}

}

@MockBean

作用：在测试环境中模拟一个Bean

java

Copy Code

@SpringBootTest

class UserServiceTest {

@MockBean

private UserRepository userRepository;

}

八、配置相关

@Value

作用：注入配置文件中的属性值

java

Copy Code

@Value("${app.name}")

private String appName;

@ConfigurationProperties

作用：批量注入配置属性到对象

java

Copy Code

@ConfigurationProperties(prefix = "app")

public class AppProperties {

private String name;

private String version;

// getters/setters...

}

九、AOP相关

@Aspect

作用：声明一个切面类

java

Copy Code

@Aspect

@Component

public class LoggingAspect {

// 切面方法...

}

@Before / @After / @Around

作用：定义通知类型

java

Copy Code

@Before("execution(* com.example.service.*.*(..))")

public void beforeAdvice(JoinPoint joinPoint) {

// 前置通知逻辑...

}

十、定时任务

@Scheduled

作用：声明定时任务方法

常用属性：

fixedRate：固定频率执行

fixedDelay：固定延迟执行

cron：Cron表达式

java

Copy Code

@Scheduled(cron = "0 0 12 * * ?")

public void dailyTask() {

// 定时任务逻辑...

}

十一、缓存相关

@Cacheable

作用：声明方法结果可缓存

java

Copy Code

@Cacheable(value = "users", key = "#id")

public User getUser(Long id) {

// 方法实现...

}

@CacheEvict

作用：清除缓存

java

Copy Code

@CacheEvict(value = "users", key = "#user.id")

public void updateUser(User user) {

// 方法实现...

}

十二、其他实用注解

@Profile

作用：指定Bean在特定环境下激活

java

Copy Code

@Bean

@Profile("dev")

public DataSource devDataSource() {

// 开发环境数据源配置

}

@ConditionalOnProperty

作用：根据配置属性条件化创建Bean

java

Copy Code

@Bean

@ConditionalOnProperty(name = "app.feature.enabled", havingValue = "true")

public FeatureService featureService() {

return new FeatureServiceImpl();

}

总结

Spring Boot通过丰富的注解极大简化了Java开发，这些注解大致可分为：

核心启动类注解

Web开发相关注解

依赖注入相关注解

配置相关注解

测试相关注解

事务管理注解

AOP相关注解

定时任务注解

缓存相关注解

掌握这些注解的使用场景和组合方式，能够显著提高Spring Boot开发效率和代码质量。建议开发者根据实际项目需求，灵活运用这些注解构建高效、可维护的应用程序。