Spring：在外部添加属性文件

Question

我正在开发一个 Spring-MVC 应用程序，我们正准备在不同的服务器上设置应用程序。由于每个服务器都可以有自己的数据库相关配置，我们希望使用一个可以在项目启动时读取的外部属性文件（war 文件之外）。我该如何处理这种方法？ 为了让它工作，我已经将应用程序初始化代码移到了 Java 中，这样就不需要我们之前的静态 XML 读取了。 但是，我们不确定如何动态创建和添加至少具有这 3 个值（包含 DB 名称、用户名、密码的 JDBC URL）的属性文件。所有表，其他数据将自动创建。

这是初始化应用程序的类：

WebConfig.java：

@Configuration
@EnableWebMvc
@ComponentScan(basePackages = {"com.ourapp.spring"})
@EnableTransactionManagement
@EnableCaching
public class WebConfig extends WebMvcConfigurerAdapter {

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
    }


    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    }

    @Bean
    public ReloadableResourceBundleMessageSource messageSource(){
        ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource();
        messageSource.setBasename("../resources/locale/messages.properties");
        messageSource.setDefaultEncoding("UTF-8");
        return messageSource;
    }

    @Bean
    public LocaleChangeInterceptor localeInterceptor(){
        LocaleChangeInterceptor interceptor = new LocaleChangeInterceptor();
        interceptor.setParamName("lang");
        return interceptor;
    }

    @Bean
    public MappingJackson2HttpMessageConverter converter() {
        return new MappingJackson2HttpMessageConverter();
    }

    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/css/**").addResourceLocations("/css/");
        registry.addResourceHandler("/img/**").addResourceLocations("/img/");
        registry.addResourceHandler("/js/**").addResourceLocations("/js/");
    }

    @Bean
    public InternalResourceViewResolver getInternalResourceViewResolver() {
        InternalResourceViewResolver resolver = new InternalResourceViewResolver();
        resolver.setPrefix("../webapp/WEB-INF/views/");
        resolver.setSuffix(".jsp");
        return resolver;
    }

    @Bean
    public DoNotTruncateMyUrls doNotTruncate(){
       return new DoNotTruncateMyUrls();
    }

    @Bean
    public MultipartResolver multipartResolver() {
        return new StandardServletMultipartResolver();
    }

    @Bean
    @Qualifier("primary_tx")
    public HibernateTransactionManager getPrimaryTransactionManager() throws IOException {
        HibernateTransactionManager txName= new HibernateTransactionManager();
        txName.setSessionFactory(sessionFactory().getObject());
        return txName;
    }

    @Bean
    @Qualifier("extended_tx")
    public HibernateTransactionManager txName() throws IOException {
        HibernateTransactionManager txName= new HibernateTransactionManager();
        txName.setSessionFactory(getExtendedSessionFactory().getObject());
        return txName;
    }

    @Bean
    @Qualifier("sessionFactory_origin")
    public LocalSessionFactoryBean sessionFactory() {
        LocalSessionFactoryBean sessionFactory = new LocalSessionFactoryBean();
        sessionFactory.setDataSource(new DataSourceConfig().primaryDataSource());
        sessionFactory.setPackagesToScan("com.ourapp.spring");
        return sessionFactory;
    }

    @Bean
    @Qualifier("sessionFactory_extended")
    public LocalSessionFactoryBean getExtendedSessionFactory() {
        LocalSessionFactoryBean sessionFactory = new LocalSessionFactoryBean();
        sessionFactory.setDataSource(new DataSourceConfig_Extended().secondaryDataSource());
        sessionFactory.setPackagesToScan("com.ourapp.spring");
        return sessionFactory;
    }

}

谢谢。 :-)

Answer 1

您可能正在寻找的是 Profiles(@Profile or @Conditional)

第 1 步：创建个人资料。以下是产品配置文件的示例。同样，您可以为dev 和qa 创建一个

import javax.activation.DataSource;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.jndi.JndiObjectFactoryBean;

@Configuration
@Profile("prod")
@PropertySource("classpath:/com/<SomePath>/app.properties")
public class ProductionProfileConfig {

    @Autowired Environment env;

    @Bean
    public DataSource dataSource() {
        JndiObjectFactoryBean jndiObjectFactoryBean = new JndiObjectFactoryBean();
        jndiObjectFactoryBean.setJndiName(env.getProperty("dbName"));
        jndiObjectFactoryBean.setResourceRef(true);
        jndiObjectFactoryBean.setProxyInterface(javax.sql.DataSource.class);
        return (DataSource) jndiObjectFactoryBean.getObject();
    }
}

第 2 步激活配置文件

Spring 在确定哪些配置文件时遵循两个独立的属性 处于活动状态：spring.profiles.active 和 spring.profiles.default。如果 spring.profiles.active 被设置，那么它的值决定了哪个 配置文件处于活动状态。但是如果 spring .profiles.active 没有设置，那么 Spring 看起来是 spring.profiles.default。如果两者都没有 spring.profiles.active 也没有 spring.profiles.default 设置，然后有 没有活动配置文件，只有那些未定义为的 bean 在配置文件中创建

更新

如果文件位于打包的战争之外，请使用PropertyConfigurator.configure(Loader.getResource(<your-file-path>));。稍后您可以使用 @Value or SPel 简单地注入值

Answer 2

编写一个配置管理器，它将根据属性文件的名称创建配置对象。例如，

Configuration config = ConfigurationManager.getConfig("dbConfig");

所以，现在您的配置对象将包含与 db.xml 相关的所有属性。当您实例化配置对象时，将所有属性读入该对象。

假设您的属性文件包含以下字段：

user.name = "Tom" user.password = "pass"

下次需要“user.name”时，只需config.getString("user.name")

Answer 3

您可以使用PropertySourcesPlaceholderConfigurer 来做到这一点

像这样创建一个 bean

@Bean
public static PropertySourcesPlaceholderConfigurer devPropertyPlaceholderConfigurer() throws IOException {
   PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
   configurer.setLocations(new PathMatchingResourcePatternResolver().getResources("file:pathtToFile"));
   configurer.setIgnoreUnresolvablePlaceholders(true);
   return configurer;
}

例如，如果您编写 file:/tmp/dev/*.properties 。它将加载 /tmp/dev 下的所有属性文件。

如果您想根据不同的环境（开发、测试、生产）对其进行自定义。那么你可以使用@Profile 并创建多个bean。

@Bean
@Profile("dev")
public static PropertySourcesPlaceholderConfigurer devPropertyPlaceholderConfigurer() throws IOException {
   ..... // give dev properties file path
}


@Bean
@Profile("testing")
public static PropertySourcesPlaceholderConfigurer testPropertyPlaceholderConfigurer() throws IOException {
.....// give test properties file path
}

@Bean
@Profile("prod")
public static PropertySourcesPlaceholderConfigurer prodPropertyPlaceholderConfigurer() throws IOException {
.....// give prod properties file path
}