SpringBoot常用注解及使用方式（含代码）
@SpringBootApplication
用于启动Spring Boot应用程序的主类上，它组合了多个注解（@SpringBootConfiguration、@EnableAutoConfiguration和@ComponentScan）
@SpringBootApplication
public class MyApp {
public static void main(String[] args) {
SpringApplication.run(MyApp.class, args);
}
}
@RestController
这个注解用于创建一个 RESTful Web 服务的控制器类。它将类标记为控制器，并将返回的数据直接写入 HTTP 响应中。
@RestController
public class MyController {
@GetMapping("/hello")
public String hello() {
return "Hello, World!";
}
}
@RequestMapping
这个注解用于将请求映射到控制器的方法上。可以用于类级别和方法级别，用于定义 URL 路径和 HTTP 请求方法。
@RestController
@RequestMapping("/api")
public class MyController {
@GetMapping("/hello")
public String hello() {
return "Hello, World!";
}
}
@PathVariable
用于将URL路径变量绑定到方法参数。
@RestController
@RequestMapping("/api")
public class MyController {
@GetMapping("/hello/{name}")
public String hello(@PathVariable String name) {
return "Hello, " + name + "!";
}
}
@RequestParam
用于将请求参数绑定到方法参数。
@RestController
@RequestMapping("/api")
public class MyController {
@GetMapping("/hello")
public String hello(@RequestParam String name) {
return "Hello, " + name + "!";
}
}
@Autowired
这个注解用于自动装配依赖项。它可以在构造函数、属性和方法参数上使用，Spring Boot 将自动为这些依赖项提供实例。
@Service
public class MyService {
private final MyRepository repository;
@Autowired
public MyService(MyRepository repository) {
this.repository = repository;
}
}
@Component
这个注解用于将类标记为 Spring 管理的组件。它可以用于任何类，表示这个类需要被 Spring 进行管理。
@Component
public class MyComponent {
// 类的实现
}
@ConfigurationProperties
用于绑定配置文件中的属性到一个类上。
@ConfigurationProperties(prefix = "myapp")
public class MyAppProperties {
private String name;
private String version;
// 属性的getter和setter方法
}
@Configuration
这个注解用于将类标记为配置类，其中包含创建和组装 Bean 的方法。
@Configuration
public class MyConfiguration {
@Bean
public MyBean myBean() {
return new MyBean();
}
}
@Value
注入外部配置属性的值。
@Component
public class MyComponent {
@Value("${my.property}")
private String propertyValue;
}
@ConfigurationProperties和@Value都是用于将属性值注入到Bean中的注解。@ConfigurationProperties用于将属性值映射到Java对象，提供了更多处理复杂属性结构的灵活性，支持验证和重新加载，并自动处理类型转换。而@Value用于将单个属性值注入到Bean中，适用于简单属性，并且不提供内置的验证、重新加载或自动类型转换支持。
@Repository
用于标记一个类为持久化层（数据访问层）的组件。它通常与数据库交互，执行数据持久化操作，并提供对数据访问的方法。
@Repository
public class UserRepository {
public User findById(Long id) {
// 查询数据库中的用户
// ...
return user;
}
public void save(User user) {
// 将用户保存到数据库
// ...
}
public void deleteById(Long id) {
// 根据ID删除数据库中的用户
// ...
}
}
示例中，UserRepository类被标记为@Repository，表示它是数据访问层的组件。通过注解，Spring框架会自动将其实例化，并将其纳入应用程序上下文中，从而可以在其他组件中进行依赖注入。
@Service
用于标记一个类为服务层组件。服务层组件通常用于封装和处理业务逻辑，提供高层次的业务功能。通过@Service注解，可以让Spring框架自动将标记的类注册为应用程序上下文中的bean，并方便其他组件进行依赖注入。
@Service
public class UserService {
@Autowired
private UserRepository userRepository;
public User getUserById(Long id) {
return userRepository.findById(id);
}
public void createUser(User user) {
userRepository.save(user);
}
public void deleteUserById(Long id) {
userRepository.deleteById(id);
}
}
UserService类被标记为@Service，表示它是服务层的组件。通过注解，Spring框架会自动将其实例化，并将其纳入应用程序上下文中。在UserService中，我们可以注入UserRepository来执行具体的数据访问操作，并在服务层方法中封装业务逻辑。
@Qualifier
用于在进行依赖注入时指定特定的bean。当容器中存在多个相同类型的bean时，可以使用@Qualifier注解来区分它们，并选择性地注入所需的bean。 @Qualifier注解通常与@Autowired或@Resource注解一起使用，用于解决依赖注入时的歧义性。
public interface MessageService {
void sendMessage(String message);
}
@Service
@Qualifier("emailService")
public class EmailService implements MessageService {
@Override
public void sendMessage(String message) {
System.out.println("Sending email: " + message);
}
}
@Service
@Qualifier("smsService")
public class SmsService implements MessageService {
@Override
public void sendMessage(String message) {
System.out.println("Sending SMS: " + message);
}
}
@Service
public class MessageSender {
private final MessageService messageService;
public MessageSender(@Qualifier("emailService") MessageService messageService) {
this.messageService = messageService;
}
public void send(String message) {
messageService.sendMessage(message);
}
}
示例中，EmailService和SmsService实现了MessageService接口，并通过@Service注解标记为Spring的bean。在MessageSender类的构造函数中，我们使用@Qualifier("emailService")来指定注入EmailService实例。
这样，当MessageSender类被实例化时，Spring框架会查找名为"emailService"的bean，并注入到构造函数中。通过@Qualifier注解，我们可以明确指定要注入的特定bean，解决了多个相同类型的bean的歧义性。
@Resource
Java EE中的一个注解，也可以在Spring框架中使用。它用于进行依赖注入，指定要注入的bean或资源。在Spring中，@Resource注解可以用于自动装配bean或注入其他资源，例如数据源、JMS连接工厂等。它可以按名称或按类型进行自动装配，指定要注入的特定bean或资源。@Resource注解可以用于字段、setter方法和构造函数。
@Service
public class MyService {
@Resource(name = "myRepository")
private MyRepository myRepository;
// ...
}
示例中，MyService类使用@Resource(name = "myRepository")注解来指定注入名为myRepository的bean。Spring框架会在容器中查找匹配的bean，并将其注入到myRepository字段中。
@Resource注解还可以按类型进行自动装配，不指定name属性。Spring框架会根据字段的类型，在容器中查找与该类型匹配的bean，并注入到myRepository字段中。
@Service
public class MyService {
@Resource
private MyRepository myRepository;
// ...
}
注意事项
在使用注解时，特别是在Spring Boot应用程序中，以下是一些需要注意的事项：
-
引入合适的依赖：确保在构建项目时引入适当的Spring Boot依赖，以便可以使用注解。通常，您需要添加
spring-boot-starter相关的依赖，如spring-boot-starter-web、spring-boot-starter-data-jpa等。 -
组件扫描：Spring Boot会自动进行组件扫描，以查找带有特定注解的组件。确保注解所在的类位于扫描的包或子包中，并且Spring Boot能够正确识别它们。您可以使用
@ComponentScan注解来自定义组件扫描的包路径。 -
注解的位置：根据需要，注解可以放置在类级别（如
@RestController）或方法/字段级别（如@GetMapping和@Autowired）。确保将注解放置在适当的位置，以实现预期的效果。 -
注解的顺序：如果多个注解应用于同一个类或方法，注解的顺序可能会影响其行为。确保注解的顺序正确，以便按预期配置和处理。
-
依赖注入：使用
@Autowired、@Resource等注解进行依赖注入时，请确保目标依赖项（bean）已经定义和可用。您可以通过在目标bean上使用相应的注解（如@Service、@Repository）来声明和配置它们。 -
配置属性注入：如果使用
@Value注解将配置属性值注入到类的字段或方法参数中，请确保配置文件中具有相应的属性，并确保配置属性的名称和类型与目标字段或参数匹配。 -
条件注解：Spring Boot提供了一些条件注解（如
@ConditionalOnProperty、@ConditionalOnClass等），用于根据条件来配置和加载组件。确保条件注解的配置正确，并且满足所设置的条件，以便按需加载和配置组件。 -
注解的配置参数：不同的注解可能具有不同的配置参数，用于进一步自定义其行为。仔细阅读相关注解的文档，了解和理解可用的配置参数，并根据需要进行适当的配置。
-
注解的作用域：注解可能具有不同的作用域，例如类级别、方法级别等。确保将注解放置在适当的作用域内，以使其生效。
-
注解的生命周期：有些注解可能具有特定的生命周期，例如只在编译时存在，而不在运行时存在。确保理解注解的生命周期，并在正确的阶段使用它们。