几种方式可以配置和管理Spring Bean

长风朗月碎梦2024-07-06 12:27

为什么这个知识点重要？

因为所有的开源中间件 ，基本上跑不掉这些方式进行对业务项目进行侵入增强

  • spring.providers spi
  • 使用 @Configuration 和 @Bean 注解
  • 使用 XML 配置文件
  • 使用 ApplicationContextInitializer
  • 使用 Spring Boot 自动配置
  • 使用 BeanDefinitionRegistryPostProcessor

示例：使用 spring.providers 声明模块提供的服务

假设我们有一个分布式锁模块和一个 Redis 数据访问模块。我们将通过 spring.providers 文件来声明这些模块提供的服务。

1. 创建服务接口和实现

首先，我们定义分布式锁服务和 Redis 服务的接口和实现。

DistributedLockService.java
java 复制代码 
package com.example.distributed;

public interface DistributedLockService {
    void lock(String key);
    void unlock(String key);
}
DistributedLockServiceImpl.java
java 复制代码 
package com.example.distributed;

public class DistributedLockServiceImpl implements DistributedLockService {
    @Override
    public void lock(String key) {
        System.out.println("Locking key: " + key);
    }

    @Override
    public void unlock(String key) {
        System.out.println("Unlocking key: " + key);
    }
}
RedisService.java
java 复制代码 
package com.example.redis;

public interface RedisService {
    void save(String key, String value);
    String get(String key);
}
RedisServiceImpl.java
java 复制代码 
package com.example.redis;

public class RedisServiceImpl implements RedisService {
    @Override
    public void save(String key, String value) {
        System.out.println("Saving key: " + key + ", value: " + value);
    }

    @Override
    public String get(String key) {
        System.out.println("Getting value for key: " + key);
        return "value"; // Simulated return value
    }
}

2. 创建 spring.providers 文件

在 META-INF 目录下创建一个名为 spring.providers 的文件，并在其中声明模块提供的服务。

META-INF/spring.providers
properties 复制代码 
provides: distributedLock,spring-data-redis

3. 配置 Spring 加载这些服务

在 Spring 配置中，我们可以使用 @Configuration 注解和 @Bean 注解来声明这些服务的加载。

DistributedLockConfig.java
java 复制代码 
package com.example.distributed;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class DistributedLockConfig {
    @Bean
    public DistributedLockService distributedLockService() {
        return new DistributedLockServiceImpl();
    }
}
RedisConfig.java
java 复制代码 
package com.example.redis;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class RedisConfig {
    @Bean
    public RedisService redisService() {
        return new RedisServiceImpl();
    }
}

4. 使用这些服务

我们可以在应用程序中使用这些服务：

Application.java
java 复制代码 
package com.example;

import com.example.distributed.DistributedLockService;
import com.example.redis.RedisService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application implements CommandLineRunner {

    @Autowired
    private DistributedLockService distributedLockService;

    @Autowired
    private RedisService redisService;

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

    @Override
    public void run(String... args) throws Exception {
        distributedLockService.lock("myKey");
        distributedLockService.unlock("myKey");

        redisService.save("myKey", "myValue");
        System.out.println(redisService.get("myKey"));
    }
}

运行应用程序

当运行这个 Spring Boot 应用程序时，Spring 会自动加载和配置 DistributedLockService 和 RedisService，并根据 spring.providers 文件中的声明进行相应的初始化和使用。

参考资料

通过这个示例，我们展示了如何使用 spring.providers 文件声明模块提供的服务，并在 Spring 应用程序中动态加载和使用这些服务。 在 Spring 框架中，即使不配置 spring.providers 文件，你仍然可以使用其他方式来声明和加载服务提供者。例如，可以使用 Spring 的 @Configuration 注解、@Component 注解以及 XML 配置文件等方式来配置和管理 Spring Bean。下面是几种常见的方式来实现相同的功能：

1. 使用 @Configuration 和 @Bean 注解

直接在 Java 类中使用 @Configuration 和 @Bean 注解来声明和配置 Bean。

java 复制代码 
package com.example.distributed;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class DistributedLockConfig {
    @Bean
    public DistributedLockService distributedLockService() {
        return new DistributedLockServiceImpl();
    }
}
java 复制代码 
package com.example.redis;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class RedisConfig {
    @Bean
    public RedisService redisService() {
        return new RedisServiceImpl();
    }
}

2. 使用 @Component 注解

将服务实现类标注为 Spring 的组件，并使用 @ComponentScan 注解扫描这些组件。

java 复制代码 
package com.example.distributed;

import org.springframework.stereotype.Component;

@Component
public class DistributedLockServiceImpl implements DistributedLockService {
    @Override
    public void lock(String key) {
        System.out.println("Locking key: " + key);
    }

    @Override
    public void unlock(String key) {
        System.out.println("Unlocking key: " + key);
    }
}
java 复制代码 
package com.example.redis;

import org.springframework.stereotype.Component;

@Component
public class RedisServiceImpl implements RedisService {
    @Override
    public void save(String key, String value) {
        System.out.println("Saving key: " + key + ", value: " + value);
    }

    @Override
    public String get(String key) {
        System.out.println("Getting value for key: " + key);
        return "value"; // Simulated return value
    }

如果不使用注解来配置 Spring Bean，你可以使用 XML 配置文件来声明和加载服务提供者。Spring 提供了强大的 XML 配置功能，允许你在 XML 文件中定义 Bean 和它们的依赖关系。

使用 XML 配置文件

以下是如何使用 XML 配置文件来实现相同的功能： 不介绍了

除了使用注解、XML配置和编程式注册Bean之外，还有其他几种方式可以配置和管理Spring Bean。以下是一些常见的替代方法：

1. 使用 ApplicationContextInitializer

ApplicationContextInitializer 是 Spring 提供的一种机制，用于在 ApplicationContext 初始化时对其进行编程式配置。

示例：

java 复制代码 
package com.example;

import com.example.distributed.DistributedLockServiceImpl;
import com.example.redis.RedisServiceImpl;
import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.support.GenericApplicationContext;

public class CustomApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {

    @Override
    public void initialize(ConfigurableApplicationContext applicationContext) {
        GenericApplicationContext genericApplicationContext = (GenericApplicationContext) applicationContext;

        // 注册 DistributedLockServiceImpl
        genericApplicationContext.registerBean(DistributedLockServiceImpl.class);

        // 注册 RedisServiceImpl
        genericApplicationContext.registerBean(RedisServiceImpl.class);
    }
}

在启动类中使用：

java 复制代码 
package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication application = new SpringApplication(Application.class);
        application.addInitializers(new CustomApplicationContextInitializer());
        application.run(args);
    }
}

2. 使用 Spring Boot 自动配置

Spring Boot 自动配置机制允许你创建自定义的自动配置类，并将其注册为Spring上下文的一部分。

示例：

自动配置类
java 复制代码 
package com.example.config;

import com.example.distributed.DistributedLockService;
import com.example.distributed.DistributedLockServiceImpl;
import com.example.redis.RedisService;
import com.example.redis.RedisServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class CustomAutoConfiguration {

    @Bean
    public DistributedLockService distributedLockService() {
        return new DistributedLockServiceImpl();
    }

    @Bean
    public RedisService redisService() {
        return new RedisServiceImpl();
    }
}
META-INF/spring.factories

在 META-INF/spring.factories 文件中注册自动配置类：

properties 复制代码 
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.config.CustomAutoConfiguration

3. 使用 BeanDefinitionRegistryPostProcessor

BeanDefinitionRegistryPostProcessor 允许在Bean定义注册表完成后进行自定义处理，可以用于注册自定义Bean。

示例：

java 复制代码 
package com.example;

import com.example.distributed.DistributedLockServiceImpl;
import com.example.redis.RedisServiceImpl;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.type.AnnotationMetadata;

@Configuration
public class CustomBeanDefinitionRegistryPostProcessor implements ImportBeanDefinitionRegistrar {

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        registry.registerBeanDefinition("distributedLockService", new RootBeanDefinition(DistributedLockServiceImpl.class));
        registry.registerBeanDefinition("redisService", new RootBeanDefinition(RedisServiceImpl.class));
    }
}

在启动类中使用：

java 复制代码 
package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Import;

@SpringBootApplication
@Import(CustomBeanDefinitionRegistryPostProcessor.class)
public class Application {

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

通过这些替代方法，你可以灵活地配置和管理Spring Bean，而无需依赖注解或XML配置文件。每种方法都有其适用的场景，可以根据具体需求选择合适的方式。

相关推荐
夜月行者1 小时前
如何使用ssm实现民族大学创新学分管理系统分析与设计+vue
java·后端·ssm
艾伦~耶格尔1 小时前
IDEA 配置 Git 详解
java·ide·git·后端·intellij-idea
customer082 小时前
【开源免费】基于SpringBoot+Vue.JS洗衣店订单管理系统（JAVA毕业设计）
java·vue.js·spring boot·后端·开源
星浩前进中2 小时前
基于Springboot+VUE的二手奢侈品商城的设计与实现
vue.js·spring boot·后端
沓沓7812 小时前
java解决跨域问题时的403报错
java·后端
赐你岁月如歌2 小时前
如何使用ssm实现政务大厅管理系统+vue
java·后端·ssm
Muroidea6 小时前
spring boot jar 分离自动部署脚本
spring boot·后端·jar
小帅吖11 小时前
浅析Golang的Context
开发语言·后端·golang
2401_8574396912 小时前
春潮涌动：构建“衣依”服装销售平台的Spring Boot之旅
java·spring boot·后端
2401_8543910812 小时前
Spring Boot与足球青训后台系统的协同
java·spring boot·后端
热门推荐
01【经验分享】Ubuntu22.04安装微信(linux官方版)02安卓系列机型永久去除data分区加密 详细步骤解析032024年高教社杯数学建模国赛C题超详细解题思路分析042024CCPC网络预选赛 I. 找行李 【DP】05组基轨迹建模 GBTM的介绍与实现（Stata 或 R）06【2024数模国赛赛题思路公开】国赛B题思路丨附可运行代码丨无偿自提07分享几个惊艳的 Three.js 个人站点08RAG 实践- Ollama+RagFlow 部署本地知识库09【2024高教社杯全国大学生数学建模竞赛】B题 生产过程中的决策问题——解题思路 代码 论文10springer 在线投稿编译踩坑