ITPub博客
首页 博客 专栏 学院 社区 IT新媒体评选
发博

首页 > 应用开发 > Java > 使用dom4j读取xml配置文件

使用dom4j读取xml配置文件

原创 Java 作者：vensins 时间：2017-07-28 13:54:54 0 删除 编辑

文章来源： 乐窝小站 ( https://www.mrven.top/archives/19.html )


实现步骤以及源码：
1、 写xml文件读取类 读取xml文档内容返回Document对象，此处作为公共xml操作类，用于读取和操作xml文档内容。

            点击( 此处 )折叠或打开

  1. package util ;

  3. import java . io . File ;
  4. import java . io . FileWriter ;
  5. import java . io . IOException ;
  6. import java . io . InputStream ;
  7. import java . io . StringReader ;
  8. import java . net . URL ;

  10. import org . apache . log4j . Logger ;
  11. import org . dom4j . Document ;
  12. import org . dom4j . DocumentException ;
  13. import org . dom4j . io . OutputFormat ;
  14. import org . dom4j . io . SAXReader ;
  15. import org . dom4j . io . XMLWriter ;

  17. public class XMLHelper {
  18.                      private static Logger logger = Logger . getLogger ( XMLHelper . class ) ;
  19.                     
  20.                      /**
  21.                      * 描述：读取xml文件返回Docment对象
  22.                      * @author vensins
  23.                      * @created 2017年7月27日 下午5:22:17
  24.                      * @since
  25.                      * @param xmlFile
  26.                      *         xml文件file对象
  27.                      * @return
  28.                      */
  29.                      public static Document getDocument ( File xmlFile ) {
  30.                          try {
  31.                             SAXReader saxReader = new SAXReader ( ) ;
  32.                              return saxReader . read ( xmlFile ) ;
  33.                          } catch ( DocumentException e ) {
  34.                              logger . error ( "读取xml文件出错,返回nulll" , e ) ;
  35.                              return null ;
  36.                          }
  37.                      }
  38.                      /**
  39.                      * 描述：读取xml文档返回Document对象
  40.                      * @author vensins
  41.                      * @created 2017年7月27日 下午5:26:03
  42.                      * @since
  43.                      * @param xmlString
  44.                      *         xml文档路径
  45.                      * @return
  46.                      */
  47.                      public static Document getDocument ( String xmlString ) {
  48.                          try {
  49.                              if ( xmlString = = null | | xmlString . equals ( "" ) )
  50.                                  return null ;
  51.                             SAXReader saxReader = new SAXReader ( ) ;
  52.                              File file = new File ( xmlString ) ;
  53.                              return saxReader . read ( file ) ;
  54.                          } catch ( DocumentException e ) {
  55.                              logger . error ( "读取xml文件失败！" , e ) ;
  56.                              return null ;
  57.                          }
  58.                      }
  59.                      /**
  60.                      * 描述：读取xml文档内容返回Document对象
  61.                      * @author vensins
  62.                      * @created 2017年7月27日 下午5:36:02
  63.                      * @since
  64.                      * @param xmlString
  65.                      * @return
  66.                      */
  67.                      public static Document getDocumentFromString ( String xmlString ) {
  68.                          try {
  69.                              if ( xmlString = = null | | xmlString . equals ( "" ) )
  70.                                  return null ;
  71.                             SAXReader saxReader = new SAXReader ( ) ;
  72.                              return saxReader . read ( new StringReader ( xmlString ) ) ;
  73.                          } catch ( DocumentException e ) {
  74.                              // TODO Auto-generated catch block
  75.                             e . printStackTrace ( ) ;
  76.                          }
  77.                          return null ;
  78.                      }
  79.                     
  80.                      /**
  81.                      * 描述：保存Document文档到文件
  82.                      * @author vensins
  83.                      * @created 2017年7月27日 下午5:41:24
  84.                      * @since
  85.                      * @param document
  86.                      *         Document对象
  87.                      * @param filePath
  88.                      *         保存文件的路径
  89.                      * @param outputFormat
  90.                      *         保存文件的格式（GBK,UTF-8）
  91.                      * @return
  92.                      */
  93.                      public static boolean saveToFile ( Document document , String filePath , OutputFormat outputFormat ) {
  94.                          XMLWriter writer ;
  95.                          File file = new File ( filePath ) ;
  96.                          if ( ! file . exists ( ) ) {
  97.                              try {
  98.                                  file . createNewFile ( ) ;
  99.                                  if ( ! file . isDirectory ( ) )
  100.                                      return false ;
  101.                              } catch ( IOException e ) {
  102.                                  logger . error ( "创建文件'" + filePath + "'失败" , e ) ;
  103.                                  return false ;
  104.                              }
  105.                          }
  106.                          try {
  107.                              writer = new XMLWriter ( new FileWriter ( new File ( filePath ) ) ) ;
  108.                              writer . write ( document ) ;
  109.                              writer . close ( ) ;
  110.                              return true ;
  111.                          } catch ( IOException e ) {
  112.                              logger . error ( "写文件" + filePath + "'出错" , e ) ;
  113.                          }
  114.                          return false ;
  115.                         
  116.                      }
  117.                      /**
  118.                      * 描述：写入DOcument对象到xml
  119.                      * @author vensins
  120.                      * @created 2017年7月27日 下午5:38:10
  121.                      * @since
  122.                      * @param filePath
  123.                      * @param doc
  124.                      * @return
  125.                      */
  126.                      public static boolean writeToXml ( String filePath , Document doc ) {
  127.                         OutputFormat format = new OutputFormat ( ) ;
  128.                          format . setEncoding ( "GBK" ) ;
  129.                          if ( saveToFile ( doc , filePath , format ) )
  130.                              return true ;
  131.                          return false ;
  132.                      }
  133.                     
  134.                      /**
  135.                      * 描述：指定位置读取xml文件
  136.                      * @author vensins
  137.                      * @created 2017年7月27日 下午5:58:13
  138.                      * @since
  139.                      * @param cls
  140.                      * @param XmlFile
  141.                      * @return
  142.                      */
  143.                      public static Document getDocument ( Class cls , String XmlFile ) {
  144.                          Document document = null ;
  145.                          ClassLoader loader = cls . getClassLoader ( ) ;
  146.                          // 先从当前类所处路径的根目录中寻找属性文件
  147.                          File f ;
  148.                          URL url = loader . getResource ( XmlFile ) ;
  149.                          if ( url ! = null )
  150.                          {
  151.                             f = new File ( url . getPath ( ) ) ;
  152.                          if ( f ! = null & & f . exists ( ) & & f . isFile ( ) )
  153.                          {
  154.                                  document = XMLHelper . getDocument ( f ) ;
  155.                          } else {
  156.                                  InputStream ins = null ;
  157.                                  try {
  158.                                      if ( loader!=null ) {
  159.                                         ins = loader . getResourceAsStream ( XmlFile ) ;
  160.                                      }
  161.                                      if ( ins!=null ) {
  162.                                         SAXReader saxReader = new SAXReader ( ) ;
  163.                                              document = saxReader . read ( ins ) ;
  164.                                      }
  165.                                  } catch ( DocumentException e ) {
  166.                                      logger . error ( "读取xml文件'" + XmlFile + "'失败" , e ) ;
  167.                                  } finally {
  168.                                      try {
  169.                                          if ( ins!=null ) {
  170.                                             ins . close ( ) ;
  171.                                             ins = null ;
  172.                                          }
  173.                                      } catch ( IOException e ) {
  174.                                          logger . error ( "" , e ) ;
  175.                                      }
  176.                                  }
  177.                          }
  178.                          }
  179.                          return document ;
  180.                         
  181.                      }
  182. }

2、 写配置文件公共操作类 ，用于取配置文件中的配置信息
实现思路：对读取的xml的document对象进行解析，以键值对的形式存入map对象，取配置值时通过键值对(父级配置项目.子级配置项)的形式取出对应的配置信息

            点击( 此处 )折叠或打开

  1. package util ;

  3. import java . util . HashMap ;
  4. import java . util . Iterator ;
  5. import java . util . List ;
  6. import java . util . Map ;

  8. import org . apache . log4j . Logger ;
  9. import org . dom4j . Document ;
  10. import org . dom4j . Element ;

  12. public class Configuration {
  13.                     
  14.                      private static Logger logger = Logger . getLogger ( Configuration . class ) ;
  15.                      private static String CONFIG_FILE_NAME = "conf/configuration.xml" ;
  16.                     
  17.                      private static Map itemMap = new HashMap ( ) ;
  18.                      static {
  19.                         load_config ( ) ;
  20.                      }
  21.                      private static void load_config ( ) {
  22.                          try {
  23.                              Document document = XMLHelper . getDocument ( Configuration . class , CONFIG_FILE_NAME ) ;
  24.                              if ( document!=null ) {
  25.                                  Element element = document . getRootElement ( ) ;
  26.                                  List catList = element . elements ( "category" ) ;
  27.                                  for ( Iterator catIter = catList . iterator ( ) ; catIter . hasNext ( ) ; ) {
  28.                                      Element catElement = ( Element ) catIter . next ( ) ;
  29.                                      String catName = catElement . attributeValue ( "name" ) ;
  30.                                      if ( catName = = null | | catName . equals ( "" ) )
  31.                                          continue ;
  32.                                      List itemList = catElement . elements ( "item" ) ;
  33.                                      for ( Iterator itemIter = itemList . iterator ( ) ; itemIter . hasNext ( ) ; ) {
  34.                                          Element itemElement = ( Element ) itemIter . next ( ) ;
  35.                                          String itemName = itemElement . attributeValue ( "name" ) ;
  36.                                          String value = itemElement . attributeValue ( "value" ) ;
  37.                                          if ( itemName = = null | | itemName . equals ( "" ) )
  38.                                              continue ;
  39.                                         itemMap . put ( catName + "." + itemName , value ) ;
  40.                                      }
  41.                                  }
  42.                              }
  43.                          } catch ( Exception ex ) {
  44.                              logger . error ( "读取配置文件错误" , ex ) ;
  45.                          }
  46.                      }
  47.                      /**
  48.                      * 描述：获取字符串配置值
  49.                      * @author vensins
  50.                      * @created 2017年7月28日 上午9:33:39
  51.                      * @since
  52.                      * @param name
  53.                      * @return
  54.                      */
  55.                      public static String getString ( String name ) {
  56.                          String value = ( String ) itemMap . get ( name ) ;
  57.                          return value = = null ? "" : value ;
  58.                      }
  59.                      /**
  60.                      * 描述：获取字符串配置值，为空时取默认值
  61.                      * @author vensins
  62.                      * @created 2017年7月28日 上午9:36:47
  63.                      * @since
  64.                      * @param name
  65.                      * @param defaultValue
  66.                      * @return
  67.                      */
  68.                      public static String getString ( String name , String defaultValue ) {
  69.                          String value = ( String ) itemMap . get ( name ) ;
  70.                          return value = = null | | value . equals ( "" ) ? defaultValue : value ;
  71.                      }
  72.                      /**
  73.                      * 描述：获取配置文件中的整数项配置
  74.                      * @author vensins
  75.                      * @created 2017年7月28日 上午9:41:49
  76.                      * @since
  77.                      * @param name
  78.                      * @return
  79.                      */
  80.                      public static int getInt ( String name ) {
  81.                          String value = ( String ) itemMap . get ( name ) ;
  82.                          try {
  83.                              return Integer . parseInt ( value ) ;
  84.                          } catch ( Exception e ) {
  85.                              logger . error ( "配置文件key[" + name + "]配置错误，return 0" , e ) ;
  86.                              return 0 ;
  87.                          }
  88.                      }
  89.                      /**
  90.                      * 描述：获取配置文件中的整数项配置,错误是返回默认值
  91.                      * @author vensins
  92.                      * @created 2017年7月28日 上午9:43:12
  93.                      * @since
  94.                      * @param name
  95.                      * @param defaultValue
  96.                      * @return
  97.                      */
  98.                      public static int getInt ( String name , int defaultValue ) {
  99.                          String value = ( String ) itemMap . get ( name ) ;
  100.                          try {
  101.                              return Integer . parseInt ( value ) ;
  102.                          } catch ( Exception e ) {
  103.                              logger . error ( "配置文件key[" + name + "]配置错误，返回默认值" + defaultValue , e ) ;
  104.                              return defaultValue ;
  105.                          }
  106.                      }
  107.                      /**
  108.                      * 描述：获取配置文件中的boolean值
  109.                      * @author vensins
  110.                      * @created 2017年7月28日 上午9:46:29
  111.                      * @since
  112.                      * @param name
  113.                      * @return
  114.                      */
  115.                      public static boolean getBoolean ( String name ) {
  116.                          String value = ( String ) itemMap . get ( name ) ;
  117.                          return Boolean . valueOf ( value ) . booleanValue ( ) ;
  118.                      }
  119.                      /**
  120.                      * 描述：获取配置文件中的Double值
  121.                      * @author vensins
  122.                      * @created 2017年7月28日 上午9:51:24
  123.                      * @since
  124.                      * @param name
  125.                      * @param defaultValue
  126.                      * @return
  127.                      */
  128.                      public static Double getDouble ( String name , Double defaultValue ) {
  129.                          String value = ( String ) itemMap . get ( name ) ;
  130.                          try {
  131.                              return Double . parseDouble ( value ) ;
  132.                          } catch ( Exception e ) {
  133.                              logger . error ( "配置文件key[" + name + "]配置错误，返回默认值" + defaultValue , e ) ;
  134.                              return defaultValue ;
  135.                          }
  136.                      }
  137.                     
  138.                      public static Map getItems ( ) {
  139.                          return itemMap ;
  140.                      }
  141. }

以下内容为xml文件的内容模板以及使用样例

            点击( 此处 )折叠或打开

  1. < ? xml version = "1.0" encoding = "GBK" ? >
  2. < system >
  3.                      < category name = "test1" description = "配置信息二" >
  4.                          < item name = "test1-1" value = "1" description = "" / >
  5.                      < / category >
  6.                     
  7.                      < category name = "test2" description = "配置信息二" >
  8.                          < item name = "test2-1" value = "0" description = "" / >
  9.                          < item name = "test2-2" value = "12.4" description = "" / >
  10.                          < item name = "test2-3" value = "啊啊啊" description = "" / >
  11.                      < / category >
  12. < / system >

读取时使用 Configuration.getString ("test1.test1-1")获取 到配置值"1"
读取时使用 Configuration.getString ("test2.test1-3")获取 到配置值"啊啊啊"


文章来源： 乐窝小站 ( https://www.mrven.top/archives/19.html )

来自 “ ITPUB博客 ” ，链接：https://blog.itpub.net/29732554/viewspace-2142722/ ，如需转载，请注明出处，否则将追究法律责任。

0
0
上一篇： win7优化方案
下一篇： 没有了~
请登录后发表评论 登录
全部评论
vensins

注册时间：2014-07-01

  • 博文量
    8
  • 访问量
    4036

最新文章

支持我们 作者招募 用户协议 FAQ Contact Us

北京盛拓优讯信息技术有限公司. 版权所有  京ICP备16024965号-8 北京市公安局海淀分局网监中心备案编号：11010802021510 niuxiaotong@pcpop.com 17352615567 未成年人举报专区

广播电视节目制作经营许可证(京) 字第1234号 中国互联网协会会员

违法和不良信息举报电话:18101376593