获取properties配置

小程序：扫一扫查出行
【扫一扫了解最新限行尾号】
复制小程序

1. 使用@Value

@Value("${swagger.enable}")

使用Spring的PropertyPlaceholderConfigurer关联 @Value

方法一：使用xml配置PropertyPlaceholderConfigurer，使用@ContextConfiguration导入配置文件

package com.properties.value;import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Value; import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;import lombok.extern.slf4j.Slf4j;//方法一：使用xml配置PropertyPlaceholderConfigurer，使用@ContextConfiguration导入配置文件 @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration("classpath:applicationCtx.xml") @Slf4j public class ValueUsage1 { @Value("${username}") private String uname; @Value("${password}") private String pwd; @Test public void test(){ log.info("username:"+uname); log.info("password:"+pwd); } }

<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 class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">  <property name="location" value="classpath:cfg.properties"></property>   </bean> </beans>

username=jay password=123env=${pom.env} ver=${pom.ver}

方法二：使用@Bean实例化PropertySourcesPlaceholderConfigurer，@PropertySources导入资源

package com.properties.value;import org.springframework.context.annotation.AnnotationConfigApplicationContext;//方法二：使用@Bean实例化PropertySourcesPlaceholderConfigurer，@PropertySources导入资源 public class ValueUsage2 { public static void main(String[] args) { AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext(PropertiesWithJavaConfig.class); FileService service = (FileService) annotationConfigApplicationContext.getBean("fileService"); service.readValues(); annotationConfigApplicationContext.close(); } }

package com.properties.value;import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.PropertySource; import org.springframework.context.annotation.PropertySources; import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;@Configuration @PropertySources({ @PropertySource(value = "classpath:cfg.properties", ignoreResourceNotFound = true), @PropertySource(value = "classpath:application.properties", ignoreResourceNotFound = true) })//==> @PropertySource("file:${app.home}/app.properties")file指向绝对路径@ComponentScan(basePackages = "com.properties.value") public class PropertiesWithJavaConfig { //要想使用@Value 用${}占位符注入属性，这个bean是必须的，这个就是占位bean,另一种方式是不用value直接用Envirment变量直接getProperty('key') @Bean public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() { return new PropertySourcesPlaceholderConfigurer(); } }

#springfox.documentation.swagger.v2.path=/api-docs #server.contextPath=/v2 server.port=8080swagger.enable=truejdbc.driverClassName = com.mysql.jdbc.Driver jdbc.url = jdbc:mysql://localhost:3306/websystique jdbc.username = myuser jdbc.password = mypassword hibernate.dialect = org.hibernate.dialect.MySQLDialect hibernate.show_sql = false hibernate.format_sql = false sourceLocation =/dev/input destination =c\:/temp/output

username=jay password=123env=${pom.env} ver=${pom.ver}

2. 使用Environment

@Autowired

private Environment environment;

environment.getProperty("swagger.enable")

方法一：@Inject或者@Autowired一个Environment对象

package com.properties.environment;import org.springframework.context.annotation.AnnotationConfigApplicationContext;//方法一：@Inject或者@Autowired一个Environment对象 public class EnvironmentUsage1 { public static void main(String[] args) { AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext(PropertiesWithJavaConfig.class); FileService service = (FileService) annotationConfigApplicationContext.getBean("fileService"); service.readValues(); annotationConfigApplicationContext.close(); } }

package com.properties.environment;import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.PropertySource;@Configuration @PropertySource(value = { "classpath:cfg.properties", "classpath:application.properties" }) @ComponentScan(basePackages = "com.properties.environment") public class PropertiesWithJavaConfig {}

package com.properties.environment;public interface FileService { public void readValues(); }

package com.properties.environment;import org.springframework.beans.factory.annotation.Autowired; import org.springframework.core.env.Environment; import org.springframework.stereotype.Service;@Service("fileService") public class FileServiceImpl implements FileService { @Autowired private Environment environment;public void readValues() { System.out.println("Getting property via Spring Environment :" + environment.getProperty("jdbc.driverClassName"));System.out.println("Source Location : " + environment.getProperty("sourceLocation")); System.out.println("Destination Location : " + environment.getProperty("destination")); } }

username=jay password=123env=${pom.env} ver=${pom.ver}

方法二：实现EnvironmentAware接口

package com.properties.environment;import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.AnnotationConfigApplicationContext; import org.springframework.context.annotation.ComponentScan; import org.springframework.core.env.Environment;//方法二：实现EnvironmentAware接口 @ComponentScan(basePackages = "com.properties.environment") @SpringBootApplication public class EnvironmentUsage2 { public static void main(String[] args) { AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext(); annotationConfigApplicationContext.register(EnvironmentBean.class); annotationConfigApplicationContext.refresh();Environment environment = annotationConfigApplicationContext.getBean("environment2",Environment.class);System.out.println("Getting property via Spring Environment :" + environment.getProperty("jdbc.driverClassName")); System.out.println("Source Location : " + environment.getProperty("sourceLocation")); System.out.println("Destination Location : " + environment.getProperty("destination"));annotationConfigApplicationContext.close(); } }

package com.properties.environment;import org.springframework.context.EnvironmentAware; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.PropertySource; import org.springframework.core.env.Environment;@Configuration @PropertySource(value = { "classpath:cfg.properties", "classpath:application.properties" }) public class EnvironmentBean implements EnvironmentAware { private Environment environment2;@Override public void setEnvironment(Environment environment) { this.environment2=environment; }@Bean(name="environment2") public Environment readEnvironment() { return environment2; } }

username=jay password=123env=${pom.env} ver=${pom.ver}

3. pom中

<springfox.version>2.8.0</springfox.version>

</properties>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>

<version>${springfox.version}</version>

</dependency>

4. 使用system.load properties

java.util.Properties

package com.properties.util;import java.io.InputStream; import java.io.InputStreamReader; import java.util.Properties;public class PropertiesUsage { public static void main(String[] args) throws Exception { Properties properties = new Properties(); try (InputStream resourceAsStream = PropertiesUsage.class.getClassLoader().getResourceAsStream("application.properties"); InputStreamReader inputStreamReader = new InputStreamReader(resourceAsStream,"UTF-8");){properties.load(inputStreamReader);System.out.println(properties.getProperty("hibernate.dialect")); } } }

5. commons-configuration

package com.properties.util;import java.util.HashMap; import java.util.Iterator; import java.util.List; import java.util.Map; import java.util.concurrent.ConcurrentHashMap;import org.apache.commons.configuration.ConfigurationException; import org.apache.commons.configuration.PropertiesConfiguration; import org.apache.commons.configuration.reloading.FileChangedReloadingStrategy; import org.apache.commons.lang.StringUtils;import lombok.extern.slf4j.Slf4j;@Slf4j public class PropertiesConfigUtil { public static final String PROPS_SUFFIX = ".properties"; private static Map<String, PropertiesConfiguration> configMap = new ConcurrentHashMap<String, PropertiesConfiguration>();private static PropertiesConfiguration getConfig(String configName) { // 去除空格 configName = configName.trim(); // 有后缀使用后缀没后缀添加后缀 String configSig = StringUtils.endsWith(configName, PROPS_SUFFIX) ? configName : configName + PROPS_SUFFIX; if (configMap.containsKey(configSig)) { return configMap.get(configSig); } PropertiesConfiguration config = null; try { config = new PropertiesConfiguration(); config.setEncoding("UTF-8"); config.load(configSig);// 默认五秒检查一次 config.setReloadingStrategy(new FileChangedReloadingStrategy()); config.setThrowExceptionOnMissing(true);configMap.put(configSig, config); } catch (ConfigurationException e) { e.printStackTrace(); }return config; }public static Map<String, String> getKeyValuePairs(String configSig) { PropertiesConfiguration config = getConfig(configSig); if (config == null) { return null; } Iterator<String> iters = config.getKeys(); Map<String, String> retMap = new HashMap<String, String>(); while (iters.hasNext()) { String beforeKey = iters.next(); if (retMap.containsKey(beforeKey)) { log.warn(configSig + " configKey:" + beforeKey + " repeated!!"); } retMap.put(beforeKey, config.getString(beforeKey)); } return retMap; }/** * 通过PropertiesConfiguration取得参数的方法 * <p> * * @return 。 */ static public String getString(String configSig, String key) { return getConfig(configSig).getString(key); }static public String getString(String configSig, String key, String defaultValue) { return getConfig(configSig).getString(key, defaultValue); }static public int getInt(String configSig, String key) { return getConfig(configSig).getInt(key); }static public int getInt(String configSig, String key, int defaultValue) { return getConfig(configSig).getInt(key, defaultValue); }static public boolean getBoolean(String configSig, String key) { return getConfig(configSig).getBoolean(key); }static public boolean getBoolean(String configSig, String key, boolean defaultValue) { return getConfig(configSig).getBoolean(key, defaultValue); }static public double getDouble(String configSig, String key) { return getConfig(configSig).getDouble(key); }static public double getDouble(String configSig, String key, double defaultValue) { return getConfig(configSig).getDouble(key, defaultValue); }static public float getFloat(String configSig, String key) { return getConfig(configSig).getFloat(key); }static public float getFloat(String configSig, String key, float defaultValue) { return getConfig(configSig).getFloat(key, defaultValue); }static public long getLong(String configSig, String key) { return getConfig(configSig).getLong(key); }static public long getLong(String configSig, String key, long defaultValue) { return getConfig(configSig).getLong(key, defaultValue); }static public short getShort(String configSig, String key) { return getConfig(configSig).getShort(key); }static public short getShort(String configSig, String key, short defaultValue) { return getConfig(configSig).getShort(key, defaultValue); }static public List<Object> getList(String configSig, String key) { return getConfig(configSig).getList(key); }static public List<Object> getList(String configSig, String key, List<Object> defaultValue) { return getConfig(configSig).getList(key, defaultValue); }static public byte getByte(String configSig, String key) { return getConfig(configSig).getByte(key); }static public byte getByte(String configSig, String key, byte defaultValue) { return getConfig(configSig).getByte(key, defaultValue); }static public String[] getStringArray(String configSig, String key) { return getConfig(configSig).getStringArray(key); } }

package com.properties.util;public class PropertiesConfigurationTest { public static void main(String[] args) { System.out.println(PropertiesConfigUtil.getString("application.properties", "hibernate.dialect")); } }

6. @ConfigurationProperties将properties导入到类中

package com.properties.configurationProperties;import org.apache.commons.lang.builder.ReflectionToStringBuilder; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.ConfigurableApplicationContext;/*@EnableConfigurationProperties注解是用来开启对@ConfigurationProperties注解配置Bean的支持。也就是@EnableConfigurationProperties注解告诉Spring Boot 使能支持@ConfigurationProperties*/ /*@ConfigurationProperties注解和@EnableConfigurationProperties配合使用*/@SpringBootApplication @EnableConfigurationProperties public class DemoApplication {public static void main(String[] args) { try(ConfigurableApplicationContext configurableApplicationContext = SpringApplication.run(DemoApplication.class, args);){ RedisProps redisProps = configurableApplicationContext.getBean(RedisProps.class);System.out.println(ReflectionToStringBuilder.toString(redisProps)); } } }

package com.properties.configurationProperties;import java.util.List; import java.util.Map;import javax.validation.constraints.NotNull;import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.PropertySource; import org.springframework.stereotype.Component;import lombok.Data;@Component @PropertySource("classpath:application.yml") @Configuration @ConfigurationProperties(prefix = "spring.redis") @Data public class RedisProps { private int dbIndex; @NotNull private String hostname; private String password; @NotNull private int port; private long timeout; private List<Map<String, String>> poolConfig; }

spring: redis: dbIndex: 0 hostName: 192.168.58.133 password: nmamtf port: 6379 timeout: 0 poolConfig: - maxIdle: 8 - minIdle: 0 - maxActive: 8 - maxWait: -1

7. 使用第三方jar，比如Archaius