常用的Spring Boot 注解及示例代码

小咪咪 2023-10-15 14:31 61阅读 0赞

简介：Spring Boot 是一个用于快速构建基于 Spring 框架的应用程序的工具，通过提供一系列的注解，它使得开发者可以更加轻松地配置、管理和控制应用程序的各种行为。以下是一些常用的 Spring Boot 注解，以及它们的功能和示例代码，可以帮助开发者更好地理解如何使用这些注解来构建功能强大的应用程序。

1.  **@SpringBootApplication**：
    
     *  功能：组合了@Configuration、@EnableAutoConfiguration和@ComponentScan，标识一个主要的Spring Boot应用程序类。
     *  作用：用于启用自动配置、组件扫描和Spring Boot应用程序的入口点。
     *  示例代码：
        
            @SpringBootApplication
            public class MyApp {
                    
                public static void main(String[] args) {
                    
                    SpringApplication.run(MyApp.class, args);
                }
            }
2.  **@RestController**：
    
     *  功能：结合@Controller和@ResponseBody，用于创建RESTful风格的控制器。
     *  作用：将控制器方法的返回值自动转换为JSON格式，适用于构建RESTful API。
     *  示例代码：
        
            @RestController
            public class MyController {
                    
                @GetMapping("/hello")
                public String hello() {
                    
                    return "Hello, Spring Boot!";
                }
            }
3.  **@RequestMapping**：
    
     *  功能：将HTTP请求映射到控制器方法。
     *  作用：定义URL路径和HTTP方法与控制器方法之间的映射关系，可以用于构建请求处理器。
     *  示例代码：
        
            @RestController
            public class MyController {
                    
                @RequestMapping(value = "/greet", method = RequestMethod.GET)
                public String greet() {
                    
                    return "Greetings from Spring Boot!";
                }
            }
4.  **@Autowired**：
    
     *  功能：自动装配Spring Bean。
     *  作用：将依赖的Bean注入到另一个Bean中，消除了手动配置Bean依赖的需求。
     *  示例代码：
        
            @Service
            public class MyService {
                    
                // Autowiring a dependency
                @Autowired
                private MyRepository repository;
            }
5.  **@Configuration**：
    
     *  功能：标识一个类为配置类。
     *  作用：用于定义Spring Bean配置，通常与@Bean一起使用。
     *  示例代码：
        
            @Configuration
            public class MyConfig {
                    
                @Bean
                public MyBean myBean() {
                    
                    return new MyBean();
                }
            }
6.  **@EnableAutoConfiguration**：
    
     *  功能：启用Spring Boot的自动配置机制。
     *  作用：根据类路径下的依赖和配置自动配置Spring Bean。
     *  示例代码：通常在@SpringBootApplication中隐式启用。
7.  **@ComponentScan**：
    
     *  功能：指定要扫描的包以寻找Spring组件。
     *  作用：用于在特定的包中查找Spring组件，如控制器、服务和存储库。
     *  示例代码：
        
            @SpringBootApplication
            @ComponentScan(basePackages = "com.example")
            public class MyApp {
                    
                // ...
            }
8.  **@Value**：
    
     *  功能：注入属性值。
     *  作用：将外部配置文件中的值注入到Bean的属性中。
     *  示例代码：
        
            @Service
            public class MyService {
                    
                @Value("${myapp.api.key}")
                private String apiKey;
            }
9.  **@ConfigurationProperties**：
    
     *  功能：将属性绑定到配置类。
     *  作用：将外部配置文件中的值绑定到配置类的属性中，便于统一管理配置。
     *  示例代码：
        
            @Component
            @ConfigurationProperties(prefix = "myapp")
            public class MyAppProperties {
                    
                private String apiKey;
                // getters and setters
            }

这些是Spring Boot中一些常用的核心注解，每个注解都有不同的用途和功能，用于简化应用程序的开发和配置。根据应用程序需求，可以灵活选择适合的注解来达到所需的效果。