FreeMarker文檔生成技術(shù)在畢業(yè)設(shè)計(jì)管理系統(tǒng)中的應(yīng)用

摘 要：FreeMarker是一種使用Java語(yǔ)言編寫的模板引擎框架技術(shù)。使用該技術(shù)構(gòu)建了一種模板樣式與模型數(shù)據(jù)相互分離的Word文檔動(dòng)態(tài)生成方案。該方案應(yīng)用于畢業(yè)設(shè)計(jì)管理信息系統(tǒng)，可以在線生成選題審批表、任務(wù)書(shū)、開(kāi)題報(bào)告、中英文摘要、論文扉頁(yè)等具有固定結(jié)構(gòu)的Word文檔。實(shí)踐證明，該方案代碼量少，文檔內(nèi)容及樣式控制方便，保證了畢業(yè)設(shè)計(jì)相關(guān)文檔格式的高度一致性。

關(guān)鍵詞：FreeMarker；模板技術(shù)；Word自動(dòng)生成；畢業(yè)設(shè)計(jì)管理

DOIDOI：10.11907/rjdk.162232

中圖分類號(hào)：TP319

文獻(xiàn)標(biāo)識(shí)碼：A文章編號(hào)：1672-7800（2016）012-0109-04

0 引言

隨著教育信息化的發(fā)展，眾多高校將計(jì)算機(jī)技術(shù)應(yīng)用于日常教學(xué)管理中[1]。畢業(yè)設(shè)計(jì)（論文）是高校實(shí)現(xiàn)人才培養(yǎng)目標(biāo)的重要實(shí)踐教學(xué)環(huán)節(jié)，應(yīng)充分利用先進(jìn)的信息技術(shù)提高管理效率，從而提高畢業(yè)設(shè)計(jì)質(zhì)量。筆者為天津理工大學(xué)中環(huán)信息學(xué)院設(shè)計(jì)開(kāi)發(fā)了一個(gè)基于B/S架構(gòu)的畢業(yè)設(shè)計(jì)管理信息系統(tǒng)[2]，系統(tǒng)使用Java Web技術(shù)實(shí)現(xiàn)，采用基于組件式開(kāi)發(fā)的MVC（Model View Controller）設(shè)計(jì)模式[3]，高效實(shí)現(xiàn)了畢業(yè)設(shè)計(jì)信息化、規(guī)范化管理。系統(tǒng)中涉及的所有基礎(chǔ)性數(shù)據(jù)（如學(xué)生信息、指導(dǎo)教師信息、題目信息等）以及畢業(yè)設(shè)計(jì)過(guò)程中師生在線填寫的各類文檔都持久化存儲(chǔ)在對(duì)應(yīng)的MySQL數(shù)據(jù)庫(kù)表中。但是，諸如選題審批表、任務(wù)書(shū)、開(kāi)題報(bào)告、提交審核表等文檔仍需要打印紙質(zhì)版后由學(xué)生或指導(dǎo)教師簽字，這些紙質(zhì)版文檔或者要求院系存檔，或者需要裝訂在畢業(yè)設(shè)計(jì)說(shuō)明書(shū)（論文）中。如何將MySQL中的相關(guān)數(shù)據(jù)導(dǎo)出并生成符合格式規(guī)范要求的Word文檔，成為畢業(yè)設(shè)計(jì)管理信息系統(tǒng)必須實(shí)現(xiàn)的一項(xiàng)功能。本文選用基于FreeMarker模板引擎技術(shù)構(gòu)建了一種模板樣式與模型數(shù)據(jù)相互分離的Word文檔動(dòng)態(tài)生成方案，通過(guò)較少的代碼量就可以滿足畢業(yè)設(shè)計(jì)管理信息系統(tǒng)中的文檔導(dǎo)出需求。

1 相關(guān)技術(shù)介紹

1.1 FreeMarker

FreeMarker是使用純Java編寫的一款模板引擎，即一種基于模板、用于生成輸出文本（HTML、XML、RTF、Java源代碼等）的通用工具[4]。FreeMarker不是面向最終用戶的，而是一個(gè)Java類庫(kù)，適合作為嵌入其它開(kāi)發(fā)產(chǎn)品中的一個(gè)組件，其最初設(shè)計(jì)被用來(lái)在MVC模式的Web開(kāi)發(fā)框架中生成HTML頁(yè)面，但它不依賴于 Servlet、HTML或Web環(huán)境，僅僅專注于展示數(shù)據(jù)，與具體的程序邏輯相分離。它的核心原理是模板+數(shù)據(jù)模型=輸出。首先，F(xiàn)reeMarker擁有功能強(qiáng)大的模板語(yǔ)言（FreeMarker Template Language，簡(jiǎn)稱FTL），包含了諸如include、if/elseif/else、循環(huán)結(jié)構(gòu)等常用指令，在模板中創(chuàng)建和改變變量，并且能夠在任何地方使用復(fù)雜表達(dá)式來(lái)指定值。其次，F(xiàn)reeMarker具有通用的數(shù)據(jù)模型，它不是直接反射到Java對(duì)象，而是通過(guò)插件式對(duì)象封裝，以變量方式在模板中顯示Java對(duì)象。

1.2 Word對(duì)XML的支持

微軟從Office Word 2003就開(kāi)始針對(duì)XML進(jìn)行了完整設(shè)計(jì)，支持稱為Word 標(biāo)記語(yǔ)言的原生XML詞匯，使Word文檔可以和XML文檔相互轉(zhuǎn)換[5]。開(kāi)發(fā)者可建立這種XML和可編程代碼來(lái)增強(qiáng)Word文檔，并幫助用戶建立和修改文檔。

常見(jiàn)的WordXML格式標(biāo)簽示例如下：表示W(wǎng)ord文檔中的段落，和html中的

標(biāo)簽類似；表示一個(gè)樣式串，指明它包括的文本顯示樣式，如文本屬性加粗、下劃線等；表示W(wǎng)ord里的字符串，即文字內(nèi)容；Word段落屬性包含在標(biāo)簽中；標(biāo)簽中定義文本格式。

2 系統(tǒng)數(shù)據(jù)模型

在畢業(yè)設(shè)計(jì)管理信息系統(tǒng)中，具有固定結(jié)構(gòu)和格式規(guī)范要求的文檔有封皮、扉頁(yè)、選題審批表、任務(wù)書(shū)、開(kāi)題報(bào)告、中期檢查表、中英文摘要、提交審核表和裝訂審批表等。這些文檔結(jié)構(gòu)和格式固定，其中有一部分文檔內(nèi)容由用戶在畢業(yè)設(shè)計(jì)中通過(guò)網(wǎng)絡(luò)在線提交并持久化至系統(tǒng)數(shù)據(jù)庫(kù)。本文簡(jiǎn)要介紹系統(tǒng)數(shù)據(jù)庫(kù)，然后以開(kāi)題報(bào)告為例說(shuō)明如何準(zhǔn)備模型數(shù)據(jù)。

2.1 系統(tǒng)數(shù)據(jù)庫(kù)

系統(tǒng)使用MySQL數(shù)據(jù)庫(kù)，主要涉及的數(shù)據(jù)庫(kù)表有adminuser（管理員表）、teacher（教師表）、stu（學(xué)生表）、syear（學(xué)年表）、dept（部門表）、major（專業(yè)表）、rank（職稱表）、ttask（教師任務(wù)表）、project（題目信息表）等，其中畢業(yè)設(shè)計(jì)相關(guān)文檔數(shù)據(jù)主要來(lái)源于project表，結(jié)構(gòu)如表1所示（限于篇幅，僅列出project表中的部分字段）。

2.2 準(zhǔn)備模型數(shù)據(jù)

數(shù)據(jù)模型并不是文本文件，它來(lái)自于Java對(duì)象。圖1為開(kāi)題報(bào)告的一個(gè)Word示例，其中使用矩形方框標(biāo)出的是生成開(kāi)題報(bào)告需要的動(dòng)態(tài)模型數(shù)據(jù)。不難發(fā)現(xiàn)，這些數(shù)據(jù)均來(lái)源于project關(guān)系表，系統(tǒng)與project關(guān)系表對(duì)應(yīng)的JavaBean實(shí)體類為project，對(duì)project關(guān)系表進(jìn)行查詢得到的記錄將通過(guò)ORM（對(duì)象關(guān)系映射）轉(zhuǎn)換為一個(gè)project類的對(duì)象實(shí)例，該對(duì)象的成員變量分別對(duì)應(yīng)project表中各字段。

數(shù)據(jù)模型是樹(shù)形的，可以通過(guò)HashMap類構(gòu)建簡(jiǎn)單的數(shù)據(jù)模型，例如將某個(gè)題目信息對(duì)象project以map映射數(shù)據(jù)（"project"， project）存入數(shù)據(jù)模型，在flt模板中則可以通過(guò)${project.ptitle}獲取畢業(yè)設(shè)計(jì)（論文）標(biāo)題，通過(guò)${project.sname}獲取學(xué)生姓名，其訪問(wèn)模型數(shù)據(jù)方式類似于EL表達(dá)式。

3 FreeMarker模板準(zhǔn)備

在確定了模型數(shù)據(jù)對(duì)象名稱、結(jié)構(gòu)和語(yǔ)義之后，才能準(zhǔn)確無(wú)誤地使用模板語(yǔ)言構(gòu)建動(dòng)態(tài)可變內(nèi)容。下面以創(chuàng)建開(kāi)題報(bào)告模板為例說(shuō)明如何準(zhǔn)備FreeMarker模板。

3.1 準(zhǔn)備Word模板

準(zhǔn)備一個(gè)如圖1所示的Word 2003版本開(kāi)題報(bào)告，需要注意的是開(kāi)題報(bào)告內(nèi)容比較多，可能會(huì)跨頁(yè)，為保證表格跨頁(yè)正常顯示，需要將開(kāi)題報(bào)告內(nèi)容所在的單元格設(shè)置為允許跨頁(yè)斷行。

3.2 轉(zhuǎn)換為XML并保存為ftl文件

將準(zhǔn)備好的開(kāi)題報(bào)告模板另存為Word 2003 XML文檔，然后將其后綴名修改為flt即可。

3.3 修改ftl文件，完成數(shù)據(jù)填充

修改flt文件，將如圖1所示的需要?jiǎng)討B(tài)填充的零散數(shù)據(jù)替換為ftl語(yǔ)言表達(dá)式。文獻(xiàn)[6-8]中通過(guò)類似${project.sname}方式取出模型數(shù)據(jù)，完成對(duì)模板的填充，但在實(shí)際應(yīng)用中有可能產(chǎn)生兩個(gè)問(wèn)題：①當(dāng)模型數(shù)據(jù)對(duì)象為NULL或者不存在的情況下會(huì)拋掉異常；②當(dāng)模型數(shù)據(jù)中含有“<”、“>”、“&”、單引號(hào)、雙引號(hào)這些XML本身的標(biāo)記符號(hào)時(shí)，可能造成XML文件解析錯(cuò)誤，使最終生成的Word文檔打不開(kāi)。為保證程序的健壯性，在應(yīng)用實(shí)踐中采用如下方法解決這兩個(gè)問(wèn)題：

（1）針對(duì)問(wèn)題①，對(duì)可能為NULL的模型數(shù)據(jù)在引用前先使用ftl語(yǔ)言條件表達(dá)式“<#if>”進(jìn)行判斷。

（2）針對(duì)問(wèn)題②，將所有對(duì)模型數(shù)據(jù)的引用置于CDATA區(qū)段，由“<！[CDATA[”開(kāi)始，“]] >”結(jié)束，因?yàn)樘幵贑DATA 區(qū)段中的文本不會(huì)被XML解析器解析。

以畢業(yè)設(shè)計(jì)（論文）題目為例，題目不可能為NULL，但子標(biāo)題可能為NULL。另外，題目和子標(biāo)題中可能存在XML本身使用的標(biāo)記符號(hào)，在模板中對(duì)畢業(yè)設(shè)計(jì)（論文）題目可按照以下ftl語(yǔ)言表達(dá)式進(jìn)行替換：<！[CDATA[${project.ptitle}]] ><#if project.psubtitle？？> <！[CDATA[——${project.psubtitle}]] >。

3.4 對(duì)多個(gè)段落內(nèi)容的特殊處理

以開(kāi)題報(bào)告內(nèi)容為例說(shuō)明。開(kāi)題報(bào)告內(nèi)容由許多段落組成，由學(xué)生在頁(yè)面中通過(guò)textarea文本域填寫并提交。學(xué)生在填寫開(kāi)題報(bào)告內(nèi)容時(shí)通過(guò)回車換行進(jìn)行分段，可能會(huì)在換行后輸入多個(gè)空格來(lái)實(shí)現(xiàn)類似Word段落首行縮進(jìn)的效果。最終開(kāi)題報(bào)告內(nèi)容被提交并存儲(chǔ)至數(shù)據(jù)庫(kù)project表ktbgnr字段中，其中的回車換行被保存為不可見(jiàn)字符“＼＼r＼＼n”（或者“＼＼n”，或者“＼＼r”，由不同的操作系統(tǒng)而定）。如果按照前述方法使用<！[CDATA[${project.ktbgnr}]] >進(jìn)行數(shù)據(jù)填充，只能生成一個(gè)段落。為保證能夠生成多個(gè)格式統(tǒng)一段落，可按下述方法分析符合指定格式要求的段落在XML中如何表示。

在一個(gè)空白的Word文檔中按照論文段落格式要求（宋體、小四號(hào)、多倍行距1.25、段落首行縮進(jìn)2字符）編寫一段內(nèi)容，然后將其另存為Word 2003 XML格式文檔，打開(kāi)該文檔并找到對(duì)應(yīng)段落的XML代碼，如圖2所示。為敘述方便，將圖2中陰影部分對(duì)應(yīng)的XML字符串簡(jiǎn)記為，矩形方框內(nèi)對(duì)應(yīng)的XML字符串簡(jiǎn)記為，那么在ftl模板文件中對(duì)應(yīng)一個(gè)指定格式要求的完整段落就由+段落內(nèi)容+組成。 根據(jù)多個(gè)段落內(nèi)容存儲(chǔ)特點(diǎn)以及固定格式Word段落的xml結(jié)構(gòu)，設(shè)計(jì)對(duì)多個(gè)段落內(nèi)容的特殊處理方案：

（1）將回車換行符（“＼＼r＼＼n”、 “＼＼n”或“＼＼r”）替換為統(tǒng)一的分隔字符串，生成一個(gè)uuid作為分隔字符串，保證分隔字符串在開(kāi)題報(bào)告內(nèi)容中不會(huì)出現(xiàn)，否則會(huì)產(chǎn)生錯(cuò)誤的分段信息。

（2）去除分隔字符串前后所有連續(xù)的空白字符。

（3）多段內(nèi)容替換填充，采用如下兩種策略：①按照分隔字符串將多個(gè)段落內(nèi)容分隔為一個(gè)字符串?dāng)?shù)組，數(shù)組元素表示一個(gè)個(gè)段落，按照?qǐng)D2所示格式使用ftl循環(huán)指令依次輸出每個(gè)段落，段落內(nèi)容置于CDATA 區(qū)段中；②將分隔字符串替換為“]] ><！[CDATA[”，替換后的內(nèi)容以map映射數(shù)據(jù)（"ktbknr"， ktbknr）存入數(shù)據(jù)模型，然后按圖2所示代碼格式在ftl模板中完成數(shù)據(jù)填充：<！[CDATA[${ktbknr}]] >。該方法利用了CDATA區(qū)段不被解析特性以及ftl模板中的段落組成方式，將開(kāi)題報(bào)告內(nèi)容中的多個(gè)段落巧妙地拼接構(gòu)造出來(lái)，最終生成格式一致的多段內(nèi)容。

4 程序?qū)崿F(xiàn)

4.1 創(chuàng)建工具類并初始化FreeMarker配置實(shí)例

首先導(dǎo)入版本號(hào)為2.3.24的freemarker.jar包，并在com.bs.util包下創(chuàng)建WordUtil.java工具類。使用FreeMarker的第一步是創(chuàng)建配置實(shí)例，由于FreeMarker的configuration配置對(duì)象全局只需要維護(hù)一個(gè)，因此在WordUtil.java類中將configuration定義為靜態(tài)變量并通過(guò)靜態(tài)代碼初始化：

private static Configuration configuration；

static {

configuration = new Configuration（Configuration.getVersion（））；

configuration.setDefaultEncoding（"UTF-8"）；

}

接著在該類中封裝對(duì)多個(gè)段落進(jìn)行預(yù)處理的stringFilter（）方法和生成Word文檔的creatWord（）方法，下面分別對(duì)這兩個(gè)方法進(jìn)行介紹。

4.2 對(duì)多個(gè)段落內(nèi)容的預(yù)處理

對(duì)多個(gè)段落內(nèi)容的處理采用前述的替換填充策略。在生成選題理由、開(kāi)題報(bào)告內(nèi)容等包含多個(gè)段落內(nèi)容文檔時(shí)，需要使用該方法對(duì)數(shù)據(jù)進(jìn)行預(yù)處理，代碼如下：

public static String stringFilte（String source） {

String uuid = UUID.randomUUID（）.toString（）；

return source.replaceAll（"＼＼r＼＼n"， uuid） //

.replaceAll（"＼＼r|＼＼n"， uuid） //

.replaceAll（"＼＼s*"+uuid+"＼＼s*"， uuid） //

.replace（uuid， "]] ><！[CDATA["）；

}

4.3 生成Word文檔方法

生成Word的方法封裝如下，其中省略了try…catch語(yǔ)句塊。

public static void createWord（ServletContext servletContext， Map dataMap， String templateName， String filePath， String fileName）{

configuration.setServletContextForTemplateLoading（servletContext， "/templates/"）；

Template template = configuration.getTemplate（templateName）；

File outFile = new File（filePath + fileName）；

if （！outFile.getParentFile（）.exists（）） {

outFile.getParentFile（）.mkdirs（）；

}

Writer out = new BufferedWriter（new OutputStreamWriter（new FileOutputStream（outFile）， "UTF-8"））；

template.process（dataMap， out）；

out.flush（）；

out.close（）；

}

需要說(shuō)明的是，ftl模板文件設(shè)置為統(tǒng)一存放在站點(diǎn)根目錄的“/templates/”路徑下，方法調(diào)用時(shí)需要提供參數(shù)為：當(dāng)前的servletContext上下文、模型數(shù)據(jù)Map、使用的模板名稱、生成Word文檔的存放目錄以及Word文檔名稱。若指定的Word文檔存放目錄不存在，程序會(huì)自動(dòng)創(chuàng)建該目錄。

4.4 應(yīng)用示例

畢業(yè)設(shè)計(jì)各類文檔內(nèi)容提交時(shí)間不同，生成對(duì)應(yīng)Word文檔的時(shí)機(jī)也不同。以生成開(kāi)題報(bào)告Word為例，按照系統(tǒng)設(shè)計(jì)，學(xué)生提交開(kāi)題報(bào)告內(nèi)容后，由指導(dǎo)教師填寫審批意見(jiàn)，當(dāng)提交審批意見(jiàn)成功后自動(dòng)生成開(kāi)題報(bào)告Word，此后只有指導(dǎo)教師可以修改開(kāi)題報(bào)告相關(guān)內(nèi)容。指導(dǎo)教師在線修改開(kāi)題報(bào)告內(nèi)容并提交成功后自動(dòng)重新生成開(kāi)題報(bào)告Word。生成開(kāi)題報(bào)告Word文檔的核心代碼如下：

String basepath = this.getServletContext（）.getRealPath（"/"）；

dataMap.put（"project"， project）；

dataMap.put（"ktbgnr"， WordUtil.stringFilte（project.getKtbgnr（）））；

dataMap.put（"ktbgyj"， WordUtil.stringFilte（project.getKtbgyj（）））；

WordUtil.createWord（this.getServletContext（）， dataMap， "ktbg.ftl"， basepath + stu.getFpath（）， stu.getSno（） + "_KaiTiBaoGao.doc"）；

代碼說(shuō)明：①當(dāng)前題目project對(duì)象和對(duì)應(yīng)學(xué)生stu對(duì)象已經(jīng)通過(guò)查詢得到；②開(kāi)題報(bào)告內(nèi)容（ktbgnr字段）和開(kāi)題報(bào)告意見(jiàn)（ktbgyj字段）包含多個(gè)段落內(nèi)容，需要進(jìn)行預(yù)處理；③系統(tǒng)最初導(dǎo)入學(xué)生信息時(shí)，會(huì)根據(jù)一定的規(guī)則自動(dòng)生成一個(gè)唯一的服務(wù)器相對(duì)路徑并保存在fpath字段，此路徑下對(duì)應(yīng)存儲(chǔ)該學(xué)生的所有相關(guān)文檔，因此生成的Word文檔路徑由服務(wù)器絕對(duì)路徑basepath + stu.getFpath（）指定。

5 結(jié)語(yǔ)

本文基于FreeMarker模板引擎構(gòu)建了Word文檔動(dòng)態(tài)生成方案，不僅代碼量非常少，而且解決了零散數(shù)據(jù)填充時(shí)容易被忽略的兩個(gè)問(wèn)題，增強(qiáng)了程序的健壯性。與此同時(shí)，對(duì)應(yīng)用中可能出現(xiàn)的多個(gè)段落內(nèi)容數(shù)據(jù)填充問(wèn)題提出了有效的解決方案。在畢業(yè)設(shè)計(jì)管理信息系統(tǒng)的應(yīng)用實(shí)踐中，實(shí)現(xiàn)了數(shù)據(jù)導(dǎo)出并生成完全符合特定格式要求的Word文檔功能，滿足了具有統(tǒng)一格式規(guī)范的各類文檔導(dǎo)出需求。

參考文獻(xiàn)：

[1] 夏松竹.基于B/S結(jié)構(gòu)的本科畢業(yè)設(shè)計(jì)管理信息系統(tǒng)設(shè)計(jì)與實(shí)現(xiàn)[J].工業(yè)和信息化教育，2016（1）：82-86.

[2] 周建鋒，付延友.畢業(yè)設(shè)計(jì)管理信息系統(tǒng)的設(shè)計(jì)與實(shí)現(xiàn)[J].軟件導(dǎo)刊， 2016（8）：96-98.

[3] ROD JOHNSON.J2EE設(shè)計(jì)開(kāi)發(fā)編程指南[M].魏海萍，于曉菲，毛選，譯.北京：電子工業(yè)出版社，2003.

[4] 劉全飛，周相兵.基于FreeMarker的站群系統(tǒng)模板設(shè)計(jì)實(shí)現(xiàn)[J].信息技術(shù)， 2015（7）：36-39.

[5] 肖斌，李超，汪敏.基于C#快速生成Word報(bào)告[J].計(jì)算機(jī)系統(tǒng)應(yīng)用，2012，21（7）：232-235.

[6] 王慶喜，李源.基于freemarker和XML技術(shù)的Word生成方案[J].電腦與信息技術(shù)，2012，20（2）：31-33.

[7] 曾玉林.FreeMarker在JSP項(xiàng)目中Word報(bào)表應(yīng)用研究[J].電腦開(kāi)發(fā)與應(yīng)用，2013，26（12）：59-61.

[8] 王正敏，張?zhí)t，李永可，等.FreeMarker模板引擎在線動(dòng)態(tài)生成Excel和Word文檔技術(shù)[J].計(jì)算機(jī)與現(xiàn)代化， 2016（4）：109-113.

（責(zé)任編輯：杜能鋼）