SpringBoot原生组件注入实现的方式有哪些

发布时间：2022-10-23 11:08:21 作者：iii
来源：亿速云阅读：148

SpringBoot原生组件注入实现的方式有哪些

引言

在Spring Boot应用中，依赖注入（Dependency Injection, DI）是一个核心概念，它允许开发者将对象之间的依赖关系交由Spring容器来管理，从而降低代码的耦合度，提高代码的可维护性和可测试性。Spring Boot提供了多种方式来实现组件的注入，本文将详细介绍这些方式，并探讨它们的优缺点及适用场景。

1. 基于注解的组件注入

1.1 `@Component` 注解

@Component 是Spring中最通用的注解，用于标注一个类为Spring容器管理的组件。Spring会自动扫描并注册这些组件为Bean。

@Component
public class MyComponent {
    // 业务逻辑
}

1.2 `@Service` 注解

@Service 是 @Component 的一个特化版本，通常用于标注服务层的组件。

@Service
public class MyService {
    // 业务逻辑
}

1.3 `@Repository` 注解

@Repository 是 @Component 的另一个特化版本，通常用于标注数据访问层的组件。

@Repository
public class MyRepository {
    // 数据访问逻辑
}

1.4 `@Controller` 和 `@RestController` 注解

@Controller 和 @RestController 是 @Component 的特化版本，用于标注控制器层的组件。@RestController 是 @Controller 和 @ResponseBody 的组合，通常用于RESTful Web服务。

@RestController
public class MyController {
    // 控制器逻辑
}

1.5 `@Configuration` 和 `@Bean` 注解

@Configuration 用于标注配置类，@Bean 用于标注方法，表示该方法返回的对象将被Spring容器管理。

@Configuration
public class MyConfig {
    @Bean
    public MyBean myBean() {
        return new MyBean();
    }
}

2. 基于XML配置的组件注入

虽然Spring Boot推荐使用基于注解的配置，但仍然支持基于XML的配置方式。

2.1 XML配置文件

在XML配置文件中定义Bean：

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="myBean" class="com.example.MyBean"/>
</beans>

2.2 加载XML配置文件

在Spring Boot应用中，可以通过 @ImportResource 注解加载XML配置文件：

@SpringBootApplication
@ImportResource("classpath:applicationContext.xml")
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}

3. 基于Java配置的组件注入

3.1 `@Configuration` 和 `@Bean` 注解

如前所述，@Configuration 和 @Bean 注解可以用于Java配置类中定义Bean。

@Configuration
public class MyConfig {
    @Bean
    public MyBean myBean() {
        return new MyBean();
    }
}

3.2 `@Import` 注解

@Import 注解用于导入其他配置类：

@Configuration
@Import(OtherConfig.class)
public class MyConfig {
    // 配置逻辑
}

3.3 `@Conditional` 注解

@Conditional 注解用于条件化地创建Bean，只有在满足特定条件时才会创建Bean。

@Configuration
public class MyConfig {
    @Bean
    @Conditional(MyCondition.class)
    public MyBean myBean() {
        return new MyBean();
    }
}

4. 基于构造器的组件注入

4.1 构造器注入

Spring推荐使用构造器注入，因为它可以确保依赖项在对象创建时就被注入，且不可变。

@Service
public class MyService {
    private final MyRepository myRepository;

    @Autowired
    public MyService(MyRepository myRepository) {
        this.myRepository = myRepository;
    }
}

4.2 自动装配

@Autowired 注解可以用于构造器、字段或方法上，Spring会自动注入相应的依赖。

@Service
public class MyService {
    private final MyRepository myRepository;

    @Autowired
    public MyService(MyRepository myRepository) {
        this.myRepository = myRepository;
    }
}

5. 基于字段的组件注入

5.1 字段注入

字段注入是一种简单直接的注入方式，但通常不推荐使用，因为它使得依赖关系不明确，且难以进行单元测试。

@Service
public class MyService {
    @Autowired
    private MyRepository myRepository;
}

5.2 `@Resource` 注解

@Resource 是Java EE的注解，Spring也支持它。它可以根据名称或类型注入Bean。

@Service
public class MyService {
    @Resource
    private MyRepository myRepository;
}

6. 基于方法的组件注入

6.1 方法注入

@Autowired 注解也可以用于方法上，Spring会在Bean创建后调用该方法并注入依赖。

@Service
public class MyService {
    private MyRepository myRepository;

    @Autowired
    public void setMyRepository(MyRepository myRepository) {
        this.myRepository = myRepository;
    }
}

6.2 `@PostConstruct` 注解

@PostConstruct 注解用于标注一个方法，该方法在Bean初始化完成后被调用。

@Service
public class MyService {
    private MyRepository myRepository;

    @Autowired
    public void setMyRepository(MyRepository myRepository) {
        this.myRepository = myRepository;
    }

    @PostConstruct
    public void init() {
        // 初始化逻辑
    }
}

7. 基于条件的组件注入

7.1 `@Conditional` 注解

@Conditional 注解用于条件化地创建Bean，只有在满足特定条件时才会创建Bean。

@Configuration
public class MyConfig {
    @Bean
    @Conditional(MyCondition.class)
    public MyBean myBean() {
        return new MyBean();
    }
}

7.2 `@Profile` 注解

@Profile 注解用于根据不同的环境配置创建Bean。

@Configuration
public class MyConfig {
    @Bean
    @Profile("dev")
    public MyBean devBean() {
        return new MyBean();
    }

    @Bean
    @Profile("prod")
    public MyBean prodBean() {
        return new MyBean();
    }
}

8. 基于自定义注解的组件注入

8.1 自定义注解

开发者可以定义自己的注解，并通过 @Component 或其他注解将其标注为Spring组件。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Component
public @interface MyCustomAnnotation {
    String value() default "";
}

8.2 使用自定义注解

@MyCustomAnnotation
public class MyCustomComponent {
    // 业务逻辑
}

9. 基于AOP的组件注入

9.1 `@Aspect` 注解

@Aspect 注解用于标注一个类为切面，Spring会自动将其注册为Bean。

@Aspect
@Component
public class MyAspect {
    // 切面逻辑
}

9.2 `@Pointcut` 和 `@Around` 注解

@Pointcut 用于定义切点，@Around 用于定义环绕通知。

@Aspect
@Component
public class MyAspect {
    @Pointcut("execution(* com.example.MyService.*(..))")
    public void myPointcut() {}

    @Around("myPointcut()")
    public Object myAdvice(ProceedingJoinPoint joinPoint) throws Throwable {
        // 环绕通知逻辑
        return joinPoint.proceed();
    }
}

10. 基于事件驱动的组件注入

10.1 `@EventListener` 注解

@EventListener 注解用于标注一个方法为事件监听器，Spring会在事件发布时调用该方法。

@Component
public class MyEventListener {
    @EventListener
    public void handleMyEvent(MyEvent event) {
        // 事件处理逻辑
    }
}

10.2 `@Async` 注解

@Async 注解用于标注一个方法为异步方法，Spring会在调用该方法时异步执行。

@Service
public class MyService {
    @Async
    public void asyncMethod() {
        // 异步逻辑
    }
}

11. 基于Spring Boot Starter的组件注入

11.1 Spring Boot Starter

Spring Boot Starter 是一组预定义的依赖项，它们简化了Spring应用的配置。通过引入Starter，Spring Boot会自动配置相关的Bean。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

11.2 自动配置

Spring Boot的自动配置机制会根据类路径上的依赖自动配置相关的Bean。

@SpringBootApplication
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}

12. 基于Spring Boot Actuator的组件注入

12.1 Spring Boot Actuator

Spring Boot Actuator 提供了生产级别的监控和管理功能。通过引入Actuator，Spring Boot会自动配置相关的Bean。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

12.2 自定义端点

开发者可以自定义Actuator端点，Spring Boot会自动将其注册为Bean。

@Component
@Endpoint(id = "myEndpoint")
public class MyEndpoint {
    @ReadOperation
    public String myOperation() {
        return "My Endpoint";
    }
}

13. 基于Spring Boot Test的组件注入

13.1 Spring Boot Test

Spring Boot Test 提供了对Spring Boot应用的测试支持。通过引入Test Starter，Spring Boot会自动配置相关的Bean。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

13.2 测试配置

在测试类中，可以使用 @SpringBootTest 注解加载Spring Boot应用的配置。

@SpringBootTest
public class MyTest {
    @Autowired
    private MyService myService;

    @Test
    public void testMyService() {
        // 测试逻辑
    }
}

14. 基于Spring Boot CLI的组件注入

14.1 Spring Boot CLI

Spring Boot CLI 是一个命令行工具，用于快速开发和运行Spring Boot应用。通过CLI，Spring Boot会自动配置相关的Bean。

spring run MyApp.groovy

14.2 Groovy Bean

在Groovy脚本中，可以直接定义Bean，Spring Boot会自动将其注册为Bean。

@RestController
class MyController {
    @GetMapping("/")
    String home() {
        "Hello, World!"
    }
}

15. 基于Spring Boot DevTools的组件注入

15.1 Spring Boot DevTools

Spring Boot DevTools 提供了开发时的自动重启和热部署功能。通过引入DevTools，Spring Boot会自动配置相关的Bean。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-devtools</artifactId>
    <optional>true</optional>
</dependency>

15.2 自动重启

在开发过程中，Spring Boot DevTools 会自动重启应用，使得代码更改立即生效。

@SpringBootApplication
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}

16. 基于Spring Boot Security的组件注入

16.1 Spring Boot Security

Spring Boot Security 提供了对Spring Security的自动配置。通过引入Security Starter，Spring Boot会自动配置相关的Bean。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>

16.2 安全配置

在配置类中，可以使用 @EnableWebSecurity 注解启用Web安全配置。

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
            .anyRequest().authenticated()
            .and()
            .formLogin();
    }
}

17. 基于Spring Boot Data的组件注入

17.1 Spring Boot Data

Spring Boot Data 提供了对Spring Data的自动配置。通过引入Data Starter，Spring Boot会自动配置相关的Bean。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

17.2 数据访问配置

在配置类中，可以使用 @EnableJpaRepositories 注解启用JPA仓库配置。

@Configuration
@EnableJpaRepositories(basePackages = "com.example.repository")
public class DataConfig {
    // 数据访问配置
}

18. 基于Spring Boot Web的组件注入

18.1 Spring Boot Web

Spring Boot Web 提供了对Spring MVC的自动配置。通过引入Web Starter，Spring Boot会自动配置相关的Bean。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

18.2 Web配置

在配置类中，可以使用 @EnableWebMvc 注解启用Web MVC配置。

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    // Web配置
}

19. 基于Spring Boot Batch的组件注入

19.1 Spring Boot Batch

Spring Boot Batch 提供了对Spring Batch的自动配置。通过引入Batch Starter，Spring Boot会自动配置相关的Bean。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-batch</artifactId>
</dependency>

19.2 批处理配置

在配置类中，可以使用 @EnableBatchProcessing 注解启用批处理配置。

@Configuration
@EnableBatchProcessing
public class BatchConfig {
    // 批处理配置
}

20. 基于Spring Boot Integration的组件注入

20.1 Spring Boot Integration

Spring Boot Integration 提供了对Spring Integration的自动配置。通过引入Integration Starter，Spring Boot会自动配置相关的Bean。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-integration</artifactId>
</dependency>

20.2 集成配置

在配置类中，可以使用 @EnableIntegration 注解启用集成配置。

@Configuration
@EnableIntegration
public class IntegrationConfig {
    // 集成配置
}

21. 基于Spring Boot AMQP的组件注入

21.1 Spring Boot AMQP

Spring Boot AMQP 提供了对Spring AMQP的自动配置。通过引入AMQP Starter，Spring Boot会自动配置相关的Bean。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-amqp</artifactId>
</dependency>

21.2 AMQP配置

在配置类中，可以使用 @EnableRabbit 注解启用RabbitMQ配置。

@Configuration
@EnableRabbit
public class AmqpConfig {
    // AMQP配置
}

22. 基于Spring Boot Kafka的组件注入

22.1 Spring Boot Kafka

Spring Boot Kafka 提供了对Spring Kafka的自动配置。通过引入Kafka Starter，Spring Boot会自动配置相关的Bean。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-kafka</artifactId>
</dependency>

22.2 Kafka配置

在配置类中，可以使用 @EnableKafka 注解启用Kafka配置。

@Configuration
@EnableKafka
public class KafkaConfig {
    // Kafka配置
}

23. 基于Spring Boot Redis的组件注入

23.1 Spring Boot Redis

Spring Boot Redis 提供了对Spring Data Redis的自动配置。通过引入Redis Starter，Spring Boot会自动配置相关的Bean。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

23.2 Redis配置

在配置类中，可以使用 @EnableRedisRepositories 注解启用Redis仓库配置。

@Configuration
@EnableRedisRepositories
public class RedisConfig {
    // Redis配置
}

24. 基于Spring Boot MongoDB的组件注入

24.1 Spring Boot MongoDB

Spring Boot MongoDB 提供了对Spring Data MongoDB的自动配置。通过引入MongoDB Starter，Spring Boot会自动配置相关的Bean。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>

24.2 MongoDB配置

在配置类中，可以使用 @EnableMongoRepositories 注解启用MongoDB仓库配置。

@Configuration
@EnableMongoRepositories
public class MongoConfig {
    // MongoDB配置
}

25. 基于Spring Boot Elasticsearch的组件注入

25.1 Spring Boot Elasticsearch

Spring Boot Elasticsearch 提供了对Spring Data Elasticsearch的自动配置。通过引入Elasticsearch Starter，Spring Boot会自动配置相关的Bean。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
</dependency>

25.2 Elasticsearch配置

在配置类中，可以使用 @EnableElasticsearchRepositories

SpringBoot原生组件注入实现的方式有哪些

SpringBoot原生组件注入实现的方式有哪些

引言

1. 基于注解的组件注入

1.1 @Component 注解

1.2 @Service 注解

1.3 @Repository 注解

1.4 @Controller 和 @RestController 注解

1.5 @Configuration 和 @Bean 注解

2. 基于XML配置的组件注入

2.1 XML配置文件

2.2 加载XML配置文件

3. 基于Java配置的组件注入

3.1 @Configuration 和 @Bean 注解

3.2 @Import 注解

3.3 @Conditional 注解

4. 基于构造器的组件注入

4.1 构造器注入

4.2 自动装配

5. 基于字段的组件注入

5.1 字段注入

5.2 @Resource 注解

6. 基于方法的组件注入

6.1 方法注入

6.2 @PostConstruct 注解

7. 基于条件的组件注入

7.1 @Conditional 注解

7.2 @Profile 注解

8. 基于自定义注解的组件注入

8.1 自定义注解

8.2 使用自定义注解

9. 基于AOP的组件注入

9.1 @Aspect 注解

9.2 @Pointcut 和 @Around 注解

10. 基于事件驱动的组件注入

10.1 @EventListener 注解

10.2 @Async 注解

11. 基于Spring Boot Starter的组件注入

11.1 Spring Boot Starter

11.2 自动配置

12. 基于Spring Boot Actuator的组件注入

12.1 Spring Boot Actuator

12.2 自定义端点

13. 基于Spring Boot Test的组件注入

13.1 Spring Boot Test

13.2 测试配置

14. 基于Spring Boot CLI的组件注入

14.1 Spring Boot CLI

14.2 Groovy Bean

15. 基于Spring Boot DevTools的组件注入

15.1 Spring Boot DevTools

15.2 自动重启

16. 基于Spring Boot Security的组件注入

16.1 Spring Boot Security

16.2 安全配置

17. 基于Spring Boot Data的组件注入

17.1 Spring Boot Data

17.2 数据访问配置

18. 基于Spring Boot Web的组件注入

18.1 Spring Boot Web

18.2 Web配置

19. 基于Spring Boot Batch的组件注入

19.1 Spring Boot Batch

19.2 批处理配置

20. 基于Spring Boot Integration的组件注入

20.1 Spring Boot Integration

20.2 集成配置

21. 基于Spring Boot AMQP的组件注入

21.1 Spring Boot AMQP

21.2 AMQP配置

22. 基于Spring Boot Kafka的组件注入

22.1 Spring Boot Kafka

22.2 Kafka配置

23. 基于Spring Boot Redis的组件注入

23.1 Spring Boot Redis

23.2 Redis配置

24. 基于Spring Boot MongoDB的组件注入

24.1 Spring Boot MongoDB

24.2 MongoDB配置

25. 基于Spring Boot Elasticsearch的组件注入

1.1 `@Component` 注解

1.2 `@Service` 注解

1.3 `@Repository` 注解

1.4 `@Controller` 和 `@RestController` 注解

1.5 `@Configuration` 和 `@Bean` 注解

3.1 `@Configuration` 和 `@Bean` 注解

3.2 `@Import` 注解

3.3 `@Conditional` 注解

5.2 `@Resource` 注解

6.2 `@PostConstruct` 注解

7.1 `@Conditional` 注解

7.2 `@Profile` 注解

9.1 `@Aspect` 注解

9.2 `@Pointcut` 和 `@Around` 注解

10.1 `@EventListener` 注解

10.2 `@Async` 注解