当前位置:   article > 正文

JavaSE基础:Properties属性类

paserint属性

Properties

在Java中属性操作类是一个很重要的类,而要想明白属性操作类的作用,就必须先要清楚什么是属性文件,在属性文件中含有多个属性,每个属性就是直接用字符串表示出来的"key=value 键/值对", 而如果要想轻松操作这些属性需要使用Properties类完成.

1.简单认识Properties

  1. public class Properties extends Hashtable<Object,Object>
  2. 复制代码
编号方法名称类型描述
1public Properties()构造创建一个无默认值的空属性类
2public Properties(Properties props)构造创建一个带有指定默认值的空属性类
3public String getProperty(String key)普通方法根据属性的key取得属性的value,如果没有,将放回null
4public String getProperty(String key, String defaultValue)普通方法根据属性的key取得属性的value,如果没有,将返回defaultValue
5public Object setProperty(String key, String value)普通方法设置属性
6public void list(PrintStream out)普通方法属性打印
7public void load(InputStream inStream)普通方法将输入流中取出全部的属性内容
8public void loadFromXML(InputStream in)普通方法从XML文件格式中读取内容
9public void store(OutputStream out, String comments)普通方法将属性内容通过输出流输出,同时声明属性的注释内容
10public void storeToXML(OutputStream os, String comment)普通方法以XML文件格式输出属性,默认编码
11public void storeToXML(OutputStream os, String comment, String encoding)普通方法以XML文件格式输出属性,用户指定默认编码

实际开发中我们使用Properties的功能类似于存储的数据为Map<String,String>都是字符串的形式

2.Properties的操作实例

示例1:设置和取得属性

主要使用setProperty()和getProperty()方法设置和获取属性,存储的数据类型都是String

  1. package com.shxt.demo06;
  2. import java.util.Properties;
  3. public class Demo01 {
  4. public static void main(String[] args) {
  5. Properties props = new Properties(); //创建Properties对象
  6. //设置属性
  7. props.setProperty("title","胖先森博客");
  8. props.setProperty("version","v1.0");
  9. props.setProperty("db","MySQL 5.7");
  10. //获取属性
  11. System.out.println("1.title属性存在:"+props.getProperty("title"));
  12. System.out.println("2.name属性不存在:"+props.getProperty("name"));
  13. System.out.println("3.name属性不存在,显示默认值:"+props.getProperty("name","胖先森"));
  14. }
  15. }
  16. /*
  17. 运行结果:
  18. 1.title属性存在:胖先森博客
  19. 2.name属性不存在:null
  20. 3.name属性不存在,显示默认值:胖先森
  21. */
  22. 复制代码

示例2:保存属性到普通的属性文件

  1. package com.shxt.demo06;
  2. import java.io.File;
  3. import java.io.FileOutputStream;
  4. import java.io.IOException;
  5. import java.util.Properties;
  6. public class Demo02 {
  7. public static void main(String[] args) {
  8. Properties props = new Properties(); //创建Properties对象
  9. //设置属性
  10. props.setProperty("title","胖先森博客");
  11. props.setProperty("version","v1.0");
  12. props.setProperty("db","MySQL 5.7");
  13. //设置属性文件的保存路径,使用绝对路径
  14. //关于文件的操作,我们在后面J2EE文件上传的时候会再次说明
  15. File file = new File("D:/sys.properties");
  16. try {
  17. props.store(new FileOutputStream(file),"system config");
  18. } catch (IOException e) {
  19. e.printStackTrace();
  20. }
  21. }
  22. }
  23. 复制代码

运行结果:

说明:如果是中文会使用Unicode进行转换

示例3:从属性文件中读取内容

  1. package com.shxt.demo06;
  2. import java.io.File;
  3. import java.io.FileInputStream;
  4. import java.io.IOException;
  5. import java.util.Properties;
  6. public class Demo03 {
  7. public static void main(String[] args) {
  8. Properties props = new Properties(); //创建Properties对象
  9. //跟磁盘中的文件建立联系
  10. File file = new File("D:/sys.properties");
  11. try {
  12. //读取属性文件
  13. props.load(new FileInputStream(file));
  14. //获取属性
  15. System.out.println("getProperty():"+props.getProperty("title"));
  16. } catch (IOException e) {
  17. e.printStackTrace();
  18. }
  19. }
  20. }
  21. /*
  22. 运行结果:
  23. getProperty():胖先森博客
  24. */
  25. 复制代码

下面的简单了解就好

示例4:将属性文件保存到XML文件中

  1. package com.shxt.demo06;
  2. import java.io.File;
  3. import java.io.FileOutputStream;
  4. import java.io.IOException;
  5. import java.util.Properties;
  6. public class Demo04 {
  7. public static void main(String[] args) {
  8. Properties props = new Properties(); //创建Properties对象
  9. //设置属性
  10. props.setProperty("title","胖先森博客");
  11. props.setProperty("version","v1.0");
  12. props.setProperty("db","MySQL 5.7");
  13. //跟磁盘中的文件建立联系,文件的后缀名必须为.xml
  14. File file = new File("D:/sys.xml");
  15. try {
  16. props.storeToXML(new FileOutputStream(file),"system config");
  17. } catch (IOException e) {
  18. e.printStackTrace();
  19. }
  20. }
  21. }
  22. 复制代码

运行结果:

示例5:从XML文件中读取属性

  1. package com.shxt.demo06;
  2. import java.io.File;
  3. import java.io.FileInputStream;
  4. import java.io.IOException;
  5. import java.util.Properties;
  6. public class Demo05 {
  7. public static void main(String[] args) {
  8. Properties props = new Properties(); //创建Properties对象
  9. //跟磁盘中的文件建立联系
  10. File file = new File("D:/sys.xml");
  11. try {
  12. //读取XML文件
  13. props.loadFromXML(new FileInputStream(file));
  14. //获取属性
  15. System.out.println("getProperty():"+props.getProperty("title"));
  16. } catch (IOException e) {
  17. e.printStackTrace();
  18. }
  19. }
  20. }
  21. /*
  22. 运行结果:
  23. getProperty():胖先森博客
  24. */
  25. 复制代码

3.认识Properties文件

  • properties文件是一个文本文件
  • properties文件的语法有两种,一种是注释,一种属性配置。
    • 注释:前面加上#号
    • 属性配置:以"键=值"的方式书写一个属性的配置信息,都是字符串。
  • properties文件的一个属性配置信息值可以换行,但键不可以换行。值换行用“\”表示。
  • properties的属性配置键值前后的空格在解析时候会被忽略。
  • properties文件可以只有键而没有值。也可以仅有键和等号而没有值,但无论如何一个属性配置不能没有键。

不推荐的写法

  1. #正确的properties配置文件
  2. aaa=wu\
  3. kong
  4. b
  5. bb = bajie
  6. 复制代码

推荐的写法

  1. #格式良好的properties文件
  2. aaa=wukong
  3. bbb=bajie
  4. 复制代码

4.读取Properties文件的方法

(1) 使用java.util.Properties类的load()方法

你需要提供一共绝对路径读取数据,"D:/sys.properties"类似的路径,我个人不怎么推荐使用

  1. package com.shxt.demo06;
  2. import java.io.FileInputStream;
  3. import java.io.IOException;
  4. import java.util.Properties;
  5. public class Demo06 {
  6. public static void main(String[] args) {
  7. Properties props = new Properties();
  8. try {
  9. props.load(new FileInputStream("D:/sys.properties"));
  10. //获取属性
  11. System.out.println("title属性的值:"+props.getProperty("title"));
  12. } catch (IOException e) {
  13. e.printStackTrace();
  14. }
  15. }
  16. }
  17. 复制代码

(2) 使用java.util.ResourceBunld类的getBundle()方法[掌握]

通过ResourceBundle.getBundle()静态方法来获取(ResourceBundle是一个抽象类),这种方式来获取properties属性文件不需要加.properties后缀名,只需要文件名即可.

  • 属性文件在src的根目录下
  1. package com.shxt.demo06;
  2. import java.util.ResourceBundle;
  3. public class Demo07 {
  4. public static void main(String[] args) {
  5. ResourceBundle resouce = ResourceBundle.getBundle("sys");
  6. //获取属性
  7. System.out.println("title属性的值:"+resouce.getString("title"));
  8. }
  9. }
  10. 复制代码
  • 属性文件在包com.shxt.demo06
  1. package com.shxt.demo06;
  2. import java.util.ResourceBundle;
  3. public class Demo08 {
  4. public static void main(String[] args) {
  5. //sys为属性文件名,放在包com.shxt.demo06下,如果是放在src下,直接用sys即可
  6. ResourceBundle resouce = ResourceBundle.getBundle("com/shxt/demo06/sys");
  7. //获取属性
  8. System.out.println("title属性的值:"+resouce.getString("title"));
  9. }
  10. }
  11. 复制代码

(3) 使用PropertyResourceBundle

  1. package com.shxt.demo06;
  2. import java.io.FileInputStream;
  3. import java.io.IOException;
  4. import java.util.PropertyResourceBundle;
  5. import java.util.ResourceBundle;
  6. public class Demo09 {
  7. public static void main(String[] args) {
  8. try {
  9. ResourceBundle resource = new PropertyResourceBundle(new FileInputStream("D:/sys.properties"));
  10. //获取属性
  11. System.out.println("title属性的值:"+resource.getString("title"));
  12. } catch (IOException e) {
  13. e.printStackTrace();
  14. }
  15. }
  16. }
  17. 复制代码

(4) 使用class变量的getResourceAsStream()方法

  1. package com.shxt.demo06;
  2. import java.io.IOException;
  3. import java.io.InputStream;
  4. import java.util.Properties;
  5. public class Demo11 {
  6. public static void main(String[] args) {
  7. // /config/sys.properties 从src的根目录开始查找,记住这个"/"
  8. // 如果没有这个斜线,那么会报空指针异常
  9. InputStream in = Demo11.class.getResourceAsStream("/config/sys.properties");
  10. Properties props = new Properties();
  11. try {
  12. props.load(in);
  13. //获取属性
  14. System.out.println("title属性的值:"+props.getProperty("db"));
  15. } catch (IOException e) {
  16. e.printStackTrace();
  17. }
  18. }
  19. }
  20. 复制代码

(5) 使用class.getClassLoader()所得到的java.lang.ClassLoader的getResourceAsStream()方法

  1. package com.shxt.demo06;
  2. import java.io.IOException;
  3. import java.io.InputStream;
  4. import java.util.Properties;
  5. public class Demo12 {
  6. public static void main(String[] args) {
  7. InputStream in = Demo12.class.getClassLoader().getResourceAsStream("config/sys.properties");
  8. Properties props = new Properties();
  9. try {
  10. props.load(in);
  11. //获取属性
  12. System.out.println("title属性的值:"+props.getProperty("db"));
  13. } catch (IOException e) {
  14. e.printStackTrace();
  15. }
  16. }
  17. }
  18. 复制代码

感觉上就是少了一个斜线而已

(6) 使用java.lang.ClassLoader类的getSystemResourceAsStream()静态方法[推荐]

  1. package com.shxt.demo06;
  2. import java.io.IOException;
  3. import java.io.InputStream;
  4. import java.util.Properties;
  5. public class Demo13 {
  6. public static void main(String[] args) {
  7. InputStream in = ClassLoader.getSystemResourceAsStream("config/sys.properties");
  8. Properties props = new Properties();
  9. try {
  10. props.load(in);
  11. //获取属性
  12. System.out.println("title属性的值:"+props.getProperty("db"));
  13. } catch (IOException e) {
  14. e.printStackTrace();
  15. }
  16. }
  17. }
  18. 复制代码

7.补充:Servlet中可以使用javax.servlet.ServletContext的getResourceAsStream()方法

  1. InputStream in = context.getResourceAsStream(path);
  2. Properties p = new Properties();
  3. p.load(in);
  4. 复制代码

5.技术穿越

这里分享一个简单的封装的工具类

  1. package com.pangsir.helper.properties;
  2. import org.slf4j.Logger;
  3. import org.slf4j.LoggerFactory;
  4. import java.io.*;
  5. import java.util.Properties;
  6. /**
  7. * 加载属性文件
  8. *
  9. * @author 刘文铭
  10. * @see com.pangsir.helper.properties.PropertiesConfigHelper
  11. * @since 1.0
  12. */
  13. public class PropertiesConfigHelper {
  14. private PropertiesConfigHelper(){}
  15. //使用日志输出
  16. private final static Logger logger = LoggerFactory.getLogger(PropertiesConfigHelper.class);
  17. //设置后缀名
  18. private final static String EXT = ".properties";
  19. //实例化Properties对象
  20. private static Properties configProperties = null;
  21. /**
  22. * 加载properties文件
  23. *
  24. * @param filepaths properties文件路径
  25. */
  26. public static void load(String... filepaths) {
  27. logger.debug("开始读取properties文件 开始时间" + System.currentTimeMillis());
  28. if(configProperties==null){
  29. configProperties = new Properties();
  30. }
  31. //配置文件路径
  32. String configFilePath;
  33. InputStream inputStream = null;
  34. //遍历filepathke数组
  35. for (int i = 0; i < filepaths.length; i++) {
  36. configFilePath = filepaths[i];
  37. //读取属性文件后缀名为.properties
  38. try {
  39. if (configFilePath.toLowerCase().endsWith(EXT)) {
  40. inputStream = PropertiesConfigHelper.class.getClassLoader().getResourceAsStream(configFilePath);
  41. configProperties.load(inputStream);
  42. } else {
  43. throw new RuntimeException("无法读取该文件: " + configFilePath);
  44. }
  45. logger.debug("文件 \"" + configFilePath + "\" 读取 成功! 时间为:" + System.currentTimeMillis());
  46. } catch (Exception e) {
  47. logger.debug("文件 \"" + configFilePath + "\" 读取 失败, 失败异常信息:\\n" + e.getMessage());
  48. throw new RuntimeException("文件 \"" + configFilePath + "\" 加载失败", e);
  49. } finally {
  50. if (inputStream != null) {
  51. try {
  52. inputStream.close();
  53. } catch (IOException e) {
  54. logger.debug("所有配置文件读取完毕,当关闭文件FileInputStream时,异常信息 :\\n" + e.getMessage());
  55. }
  56. }
  57. }
  58. }
  59. }
  60. /**
  61. * 获取 int 类型的配置属性的value
  62. *
  63. * @param key 配置属性的key
  64. * @param defaultValue 默认值
  65. * @return 对应的配置属性value,如果配置属性的value不为short类型或不存在对应的配置属性,则返回 defaultValue
  66. */
  67. public static Short getShortValue(String key, Short defaultValue) {
  68. try {
  69. return getShortValue(key);
  70. } catch (NumberFormatException e) {
  71. return defaultValue;
  72. }
  73. }
  74. /**
  75. * 获取 short 类型的配置属性的value
  76. *
  77. * @param key 配置属性的key
  78. * @return 对应的配置属性value
  79. */
  80. public static Short getShortValue(String key) {
  81. return Short.parseShort(configProperties.getProperty(key));
  82. }
  83. /**
  84. * 获取 int 类型的配置属性的value
  85. *
  86. * @param key 配置属性的key
  87. * @param defaultValue 默认值
  88. * @return 对应的配置属性value,如果配置属性的value不为int类型或不存在对应的配置属性,则返回 defaultValue
  89. */
  90. public static int getIntegerValue(String key, Integer defaultValue) {
  91. try {
  92. return getIntegerValue(key);
  93. } catch (NumberFormatException e) {
  94. return defaultValue;
  95. }
  96. }
  97. /**
  98. * 获取 int 类型的配置属性的value
  99. *
  100. * @param key 配置属性的key
  101. * @return 对应的配置属性value
  102. */
  103. public static Integer getIntegerValue(String key) {
  104. return Integer.parseInt(configProperties.getProperty(key));
  105. }
  106. /**
  107. * 获取 float 类型的配置属性的value
  108. *
  109. * @param key 配置属性的key
  110. * @param defaultValue 默认值
  111. * @return 对应的配置属性value,如果配置属性的value不为float类型或不存在对应的配置属性,则返回 defaultValue
  112. */
  113. public static Float getFloatValue(String key, float defaultValue) {
  114. try {
  115. return getFloatValue(key);
  116. } catch (NumberFormatException e) {
  117. return defaultValue;
  118. }
  119. }
  120. /**
  121. * 获取 float 类型的配置属性的value
  122. *
  123. * @param key 配置属性的key
  124. * @return 对应的配置属性value
  125. */
  126. public static Float getFloatValue(String key) {
  127. return Float.parseFloat(configProperties.getProperty(key));
  128. }
  129. /**
  130. * 获取 double 类型的配置属性的value
  131. *
  132. * @param key 配置属性的key
  133. * @param defaultValue 默认值
  134. * @return 对应的配置属性value,如果配置属性的value不为double类型或不存在对应的配置属性,则返回 defaultValue
  135. */
  136. public static Double getDoubleValue(String key, double defaultValue) {
  137. try {
  138. return getDoubleValue(key);
  139. } catch (NumberFormatException e) {
  140. return defaultValue;
  141. }
  142. }
  143. /**
  144. * 获取 Double 类型的配置属性的value
  145. *
  146. * @param key 配置属性的key
  147. * @return 对应的配置属性value
  148. */
  149. public static Double getDoubleValue(String key) {
  150. return Double.parseDouble(configProperties.getProperty(key));
  151. }
  152. /**
  153. * 获取 long 类型的配置属性的value
  154. *
  155. * @param key 配置属性的key
  156. * @param defaultValue 默认值
  157. * @return 对应的配置属性value,如果配置属性的value不为long类型或不存在对应的配置属性,则返回 defaultValue
  158. */
  159. public static Long getLongValue(String key, long defaultValue) {
  160. try {
  161. return getLongValue(key);
  162. } catch (NumberFormatException e) {
  163. return defaultValue;
  164. }
  165. }
  166. /**
  167. * 获取 Long 类型的配置属性的value
  168. *
  169. * @param key 配置属性的key
  170. * @return 对应的配置属性value
  171. */
  172. public static Long getLongValue(String key) {
  173. return Long.parseLong(configProperties.getProperty(key));
  174. }
  175. /**
  176. * 获取 String 类型的配置属性的value
  177. *
  178. * @param key 配置属性的key
  179. * @param defaultValue 默认值
  180. * @return 对应的配置属性value,如果配置属性的value为""或不存在对应的配置属性,则返回 defaultValue
  181. */
  182. public static String getStringValue(String key, String defaultValue) {
  183. String value = configProperties.getProperty(key);
  184. return (value == null) ? defaultValue : getStringValue(key);
  185. }
  186. /**
  187. * 获取 String 类型的配置属性的value
  188. *
  189. * @param key 配置属性的key
  190. * @return 对应的配置属性value
  191. */
  192. public static String getStringValue(String key) {
  193. return configProperties.getProperty(key);
  194. }
  195. /**
  196. * 获取 boolean 类型的配置属性的value
  197. *
  198. * @param key 配置属性的key
  199. * @param defaultValue 默认值
  200. * @return 如果在配置文件中没有定义此属性,则返回 defaultValue;
  201. * 如果 value 为y、on、yes 、true 或非 0 数值(均不区分大小写) 则返回 true, 否则返回 false
  202. */
  203. public static boolean getBooleanValue(String key, Boolean defaultValue) {
  204. String value = configProperties.getProperty(key);
  205. return (value == null) ? defaultValue : getBooleanValue(key);
  206. }
  207. /**
  208. * 获取 boolean 类型的配置属性的value
  209. *
  210. * @param key 配置属性的key
  211. * @return 对应的配置属性value
  212. */
  213. public static Boolean getBooleanValue(String key) {
  214. String value = configProperties.getProperty(key);
  215. return ("y".equalsIgnoreCase(value)) || ("on".equalsIgnoreCase(value)) || ("yes".equalsIgnoreCase(value))
  216. || ("true".equalsIgnoreCase(value)) || (getIntegerValue(key, 0) != 0);
  217. }
  218. /**
  219. * 加载properties文件
  220. *
  221. * @param filepath properties文件路径
  222. */
  223. public static void write(String key, String value,String filepath){
  224. if(configProperties==null){
  225. configProperties = new Properties();
  226. }
  227. OutputStream outputStream = null;
  228. try{
  229. String base = PropertiesConfigHelper.class.getResource("/"+filepath).getPath();
  230. java.net.URL url = PropertiesConfigHelper.class.getResource("/"+filepath);
  231. File file = new File(url.toURI());
  232. //判断文件是否存在
  233. if(!file.exists()){
  234. file.createNewFile();
  235. }
  236. load(filepath);//加载文件
  237. outputStream = new FileOutputStream(file);
  238. configProperties.setProperty(key,value);
  239. configProperties.store(outputStream,"");
  240. }catch (Exception e){
  241. throw new RuntimeException("文件 \"" + filepath + "\" 加载失败", e);
  242. }finally {
  243. if (outputStream != null) {
  244. try {
  245. outputStream.close();
  246. } catch (IOException e) {
  247. logger.debug("所有配置文件修改完毕,FileOutputStream异常信息 :\\n" + e.getMessage());
  248. }
  249. }
  250. }
  251. }
  252. }
  253. 复制代码

重点:将properties文件的配置设置为整个Web应用的全局变量实现方法,学到J2EE阶段再使用下面的方式

WEB域的简单说明:

Web应用中的变量存放在不同的jsp对象中,会有不一样的作用域,四种不同的作用域排序是 pageContext < request < session < application;

  • pageContext:页面域,仅当前页面有效,离开页面后,不论重定向还是转向(即无论是redirect还是forward),pageContext的属性值都失效;
  • request:请求域,在一次请求中有效,如果用forward转向,则下一次请求还可以保留上一次request中的属性值,而redirect重定向跳转到另一个页面则会使上一次request中的属性值失效;
  • session:会话域,在一次会话过程中(从浏览器打开到浏览器关闭这个过程),session对象的属性值都保持有效,在这次会话过程,session中的值可以在任何页面获取;
  • application:应用域,只要应用不关闭,该对象中的属性值一直有效,并且为所有会话所共享

思路说明:

利用ServletContextListener监听器,一旦应用加载,就将properties的值存储到application当中.

现在需要在所有的jsp中都能通过EL表达式读取到properties中的属性,并且是针对所有的会话,故这里利用application作用域,那么什么时候将properties中的属性存储到application呢?因为是将properties的属性值作为全局的变量以方便任何一次EL的获取,所以在web应用加载的时候就将值存储到application当中.

这里就要利用ServletContextListener:

  • ServletContextListener是Servlet API 中的一个接口,它能够监听 ServletContext 对象的生命周期,实际上就是监听 Web 应用的生命周期。
  • 当Servlet 容器启动或终止Web 应用时,会触发ServletContextEvent 事件,该事件由ServletContextListener 来处理。

具体步骤:

  • (1) 新建一个类PropertyListenter实现 ServletContextListener接口的contextInitialized方法;
  • (2) 读取properties配置文件,转存到Map当中;
  • (3) 使用ServletContext对象将Map存储到application作用域中;
  1. /**
  2. * 设值全局变量
  3. */
  4. public class PropertyListenter implements ServletContextListener {
  5. private static final Logger logger = (Logger) LoggerFactory.getLogger(PropertyListenter.class);
  6. @Override
  7. public void contextDestroyed(ServletContextEvent context) {}
  8. @Override
  9. public void contextInitialized(ServletContextEvent sce) {
  10. /**
  11. * 读取properties文件
  12. */
  13. Properties properties = new Properties();
  14. InputStream in = null;
  15. try {
  16. //通过类加载器进行获取properties文件流
  17. in = PropertiesUtil.class.getClassLoader().getResourceAsStream("sys.properties");
  18. properties.load(in);
  19. } catch (FileNotFoundException e) {
  20. logger.error("未找到properties文件");
  21. } catch (IOException e) {
  22. logger.error("发生IOException异常");
  23. } finally {
  24. try {
  25. if(null != in) {
  26. in.close();
  27. }
  28. } catch (IOException e) {
  29. logger.error("properties文件流关闭出现异常");
  30. }
  31. }
  32. /**
  33. * 将properties文件转存到map.关键步骤
  34. */
  35. Map<String, String> pros = new HashMap<String,String>((Map)properties);
  36. /**
  37. * 将Map通过ServletContext存储到全局作用域中
  38. */
  39. ServletContext sct=sce.getServletContext();
  40. sct.setAttribute("pros", pros);
  41. }
  42. }
  43. 复制代码
声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/weixin_40725706/article/detail/260666
推荐阅读
相关标签
  

闽ICP备14008679号