Spring Boot 核心注解速查表

📋 Spring Boot 核心注解速查表

这份速查表涵盖了 Spring Boot 开发中最常用的注解，方便你随时查阅。

💬 看到不懂的注解？点右下角 ❓ 有疑问 提交，我会把解答做成青紫色方框插到相关章节，并告诉你它在哪。

🏗️ 应用启动注解

注解	作用	使用位置	示例
@SpringBootApplication	组合注解，启动 Spring Boot 应用	主类	`@SpringBootApplication public class MyApp { ... }`
@Configuration	标记为配置类	类	`@Configuration public class AppConfig { ... }`

注解

作用

使用位置

示例

@SpringBootApplication

组合注解，启动 Spring Boot 应用

主类

@SpringBootApplication
public class MyApp { ... }

@Configuration

标记为配置类

类

@Configuration
public class AppConfig { ... }

🌐 Web 控制器注解

注解	作用	HTTP 方法	示例
@RestController	RESTful 控制器（自动添加 @ResponseBody）	-	`@RestController public class API { ... }`
@Controller	MVC 控制器（返回视图）	-	`@Controller public class Web { ... }`
@GetMapping	处理 HTTP GET 请求	GET	`@GetMapping("/users") public List<User> getUsers() { ... }`
@PostMapping	处理 HTTP POST 请求	POST	`@PostMapping("/users") public User createUser(@RequestBody User user) { ... }`
@PutMapping	处理 HTTP PUT 请求	PUT	`@PutMapping("/users/{id}") public User updateUser(...) { ... }`
@DeleteMapping	处理 HTTP DELETE 请求	DELETE	`@DeleteMapping("/users/{id}") public void deleteUser(...) { ... }`

注解

作用

HTTP 方法

示例

@RestController

RESTful 控制器（自动添加 @ResponseBody）

@RestController
public class API { ... }

@Controller

MVC 控制器（返回视图）

@Controller
public class Web { ... }

@GetMapping

处理 HTTP GET 请求

GET

@GetMapping("/users")
public List<User> getUsers() { ... }

@PostMapping

处理 HTTP POST 请求

POST

@PostMapping("/users")
public User createUser(@RequestBody User user) { ... }

@PutMapping

处理 HTTP PUT 请求

PUT

@PutMapping("/users/{id}")
public User updateUser(...) { ... }

@DeleteMapping

处理 HTTP DELETE 请求

DELETE

@DeleteMapping("/users/{id}")
public void deleteUser(...) { ... }

📥 请求参数注解

注解	作用	示例
@PathVariable	获取 URL 路径中的变量	`@GetMapping("/users/{id}") public User getUser(@PathVariable Long id) { ... }`
@RequestParam	获取查询参数	`@GetMapping("/search") public List search(@RequestParam String keyword) { ... }`
@RequestBody	获取请求体（JSON）	`@PostMapping("/users") public User create(@RequestBody User user) { ... }`

注解

作用

示例

@PathVariable

获取 URL 路径中的变量

@GetMapping("/users/{id}")
public User getUser(@PathVariable Long id) { ... }

@RequestParam

获取查询参数

@GetMapping("/search")
public List search(@RequestParam String keyword) { ... }

@RequestBody

获取请求体（JSON）

@PostMapping("/users")
public User create(@RequestBody User user) { ... }

依赖注入注解

注解	作用	示例
@Autowired	自动注入依赖	`@Autowired private UserService userService;`
@Component	通用组件注解	`@Component public class MyComponent { ... }`
@Service	服务层组件	`@Service public class UserService { ... }`
@Repository	数据访问层组件	`@Repository public class UserRepository { ... }`

注解

作用

示例

@Autowired

自动注入依赖

@Autowired
private UserService userService;

@Component

通用组件注解

@Component
public class MyComponent { ... }

@Service

服务层组件

@Service
public class UserService { ... }

@Repository

数据访问层组件

@Repository
public class UserRepository { ... }

⚙️ 配置注解

注解	作用	示例
@Value	注入配置值	`@Value("${app.name}") private String appName;`
@ConfigurationProperties	绑定配置对象	`@ConfigurationProperties(prefix = "app") public class AppProperties { ... }`

注解

作用

示例

@Value

注入配置值

@Value("${app.name}")
private String appName;

@ConfigurationProperties

绑定配置对象

@ConfigurationProperties(prefix = "app")
public class AppProperties { ... }

💡 使用技巧： 大多数 IDE（如 IntelliJ IDEA）都支持注解自动补全和文档提示，输入 @ 后按 Ctrl+Space 可以查看可用注解。

📋 Spring Boot 核心注解速查表

🔗 相关链接