快捷導(dǎo)航

關(guān)于通用xml報(bào)文創(chuàng)建和解析方式

更新時(shí)間：2025年08月28日 10:42:41 作者：Winson.J

文章介紹簡(jiǎn)單XML報(bào)文的結(jié)構(gòu)特點(diǎn)（3-4層節(jié)點(diǎn)）及使用Freemarker生成的方法,包括創(chuàng)建Maven項(xiàng)目、配置依賴、模板文件位置（resource目錄）和測(cè)試代碼示例,并預(yù)告后續(xù)將講解Freemarker模板語(yǔ)法

簡(jiǎn)單XML報(bào)文

簡(jiǎn)單XML是指結(jié)構(gòu)簡(jiǎn)單，沒(méi)有很多節(jié)點(diǎn)層次的報(bào)文。通常只有3到4層子節(jié)點(diǎn)。這種結(jié)構(gòu)很方便創(chuàng)建和解析。

示例如下

<?xml version="1.0" encoding="UTF-8"?>
<Message>
	<Head>
		<Element>10</Element>
		.........
	</Head>
	<Body>
		<Element>00</Element>
		.........
	</Body>
</Message>

如上圖，根節(jié)點(diǎn)一層，head,body一層，具體業(yè)務(wù)要素一層。

Freemarker，強(qiáng)烈推薦組xml的工具

maven依賴

	<!-- freemarker jar -->
	<dependency>
		<groupId>org.freemarker</groupId>
		<artifactId>freemarker</artifactId>
		<version>2.3.20</version>
	</dependency>
	<!-- logback 日志工具 -->
	<dependency>
    	<groupId>org.slf4j</groupId>
	    <artifactId>slf4j-api</artifactId>
	    <version>1.7.7</version>
	</dependency>
	<dependency>
	    <groupId>ch.qos.logback</groupId>
	    <artifactId>logback-core</artifactId>
	    <version>1.1.7</version>
	</dependency>
	<dependency>
	    <groupId>ch.qos.logback</groupId>
	    <artifactId>logback-access</artifactId>
	    <version>1.1.7</version>
	</dependency>
	<dependency>
	    <groupId>ch.qos.logback</groupId>
	    <artifactId>logback-classic</artifactId>
	    <version>1.1.7</version>
	</dependency>

建一個(gè)簡(jiǎn)單maven項(xiàng)目，引入依賴，創(chuàng)建工具類

package com.xml.create.utils;

import java.io.File;
import java.io.IOException;
import java.io.StringWriter;
import java.util.Map;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import freemarker.template.Configuration;
import freemarker.template.DefaultObjectWrapper;
import freemarker.template.Template;
import freemarker.template.TemplateException;

public class FreeMarkerUtil {
	private static Logger logger = LoggerFactory.getLogger(FreeMarkerUtil.class);
	public final static String TEMPLATE_SUFFIX = ".ftl";
	
	private static Configuration tplConfig;
	//模板文件存放目錄
	private static String tplDir = "./config/templates";
	private static String encoding = "UTF-8";
	
	/**
	 * 加載所有模板文件
	 * @param tplFileName	模板文件的名稱
	 * @param dataMap		數(shù)據(jù)
	 * @return
	 */
	public static void loadTemplates() {
		tplConfig = new Configuration();
		try {
			//加載文件系統(tǒng)下的模板，推薦
			tplConfig.setDirectoryForTemplateLoading(new File(tplDir));
			//加載類路徑下的模板，如果模板放在resource目錄下，使用這種方式
			//這種方式不推薦，因?yàn)榇虬鼤r(shí)，會(huì)打到j(luò)ar里，不方便修改模板
//			tplConfig.setClassForTemplateLoading(FreeMarkerUtil.class, "/templates");
			tplConfig.setObjectWrapper(new DefaultObjectWrapper());
			tplConfig.setDefaultEncoding(encoding);
			
		} catch (Exception e) {
			logger.info("初始化FreeMarkerUtil: ", e);
		}
	}
	/**
	 * 數(shù)據(jù)放在map里
	 * @param tplFileName	模板文件的名稱
	 * @param dataMap		數(shù)據(jù)
	 * @return
	 */
	public static String createXml(String tplFileName, Map<String, Object> dataMap) {
		StringWriter out = null;
		 try {
			Template template = tplConfig.getTemplate(tplFileName);
			out = new StringWriter();
			template.process(dataMap, out);
			out.flush();
			
			return out.toString();
		} catch (IOException e) {
			logger.info("IOException,組報(bào)文失敗: ", e);
		} catch (TemplateException e) {
			logger.info("TemplateException,組報(bào)文失敗: ", e);
		}finally {
			if (out != null) {
				try {
					out.close();
				} catch (IOException e) {
				}
			}
		}
		 
		 return null;
	}
	/**
	 * 數(shù)據(jù)放在對(duì)象里
	 * @param tplFileName	模板文件的名稱
	 * @param dataMap		數(shù)據(jù)
	 * @return
	 */
	public static String createXml(String tplFileName, Object data) {
		StringWriter out = null;
		 try {
			Template template = tplConfig.getTemplate(tplFileName);
			out = new StringWriter();
			template.process(data, out);
			out.flush();
			
			return out.toString();
		} catch (IOException e) {
			logger.info("IOException,組報(bào)文失敗: ", e);
		} catch (TemplateException e) {
			logger.info("TemplateException,組報(bào)文失敗: ", e);
		}finally {
			if (out != null) {
				try {
					out.close();
				} catch (IOException e) {
				}
			}
		}
		 
		 return null;
	}
}

模板在resource下

模板文件test.ftl內(nèi)容

<?xml version="1.0" encoding="UTF-8"?>
<Message>
	<Head>
		<Test>${test}</Test>
	</Head>
	<Body>
		<Test1>${test1}</Test1>
	</Body>
</Message>

測(cè)試代碼

package com.xml.create;

import java.util.HashMap;
import java.util.Map;

import com.xml.create.utils.FreeMarkerUtil;

public class Test {

	public static void main(String[] args) {
		//加載模板
		FreeMarkerUtil.loadTemplates();
		
		String ftlName = "test.ftl";
		//測(cè)試數(shù)據(jù)
		Map<String, Object> dataMap = new HashMap<String, Object>();
		dataMap.put("test", "aaaa");
		dataMap.put("test1", "bbb");
		//按模板配置生成字符串
		String xml = FreeMarkerUtil.createXml(ftlName, dataMap);
		System.out.println(xml);
	}
}