文档导出模块

           一. 功能描述

 

    文档导出模块提供一种通用的文档导出解决方案，通过事先订制好的模板，结合模板引擎和输出引擎的应用，简化文档导出的工作、完成复杂报表格式文件的生成。本版提供输出到Word和Excel的服务。

 

二. 用户使用流程

 

    流程图如下所示：

图1. 用户使用流程图

 

    对很多业务模块来说，复杂报表的输出向来是件麻烦的事情，文档导出模块的主要设计思想就是“模板+数据”，将具有复杂格式的文件通过办公软件事先制作好模板，提交到服务器上；其他业务模块通过调用打印服务接口，即可导出相应格式的文件。

 

三. 模块设计

 

    文档导出模块部署的上下文关系图如下所示。大多数业务系统部署在Linux应用服务器上，文档导出模块需要部署在基于Windows的服务器上。

 

 

图2. 上下文关系图

 

    业务系统的报表等文件如要输出，首先通过HttpClient封装请求，将参数传递到文档导出模块，文档导出模块调用事先服务器端的模板文件，结合获取的页面请求参数，输出到Word或Excel文件。 

 

 

     文档导出模块的设计如下图所示： 

 

图3. 功能结构图

 

 

    主要分为模板引擎和输出引擎。这里说明了GenerateDoc的操作是如何完成的。模板引擎采用Velocity，其首先接收输入的数据是打印请求的参数（包括报表所需输出的Data和模板文件的名称TemplateName），首先根据获取的参数计算MD5值，和服务器端缓存文件的相应MD5值进行对比，如果相同则读取缓存的文件，不同则继续执行通常的处理流程，根据TemplateName查找并载入模板文件（模板文件是Word或Excel 的xml格式，通过Office Word 或 Excel 2003版本以上打开编辑并另存为此格式）。Velocity模板引擎对数据和模板文件进行处理，将数据填充到模板的相应位置，Merge生成完整的待输出的文件（xml格式），再经由输出引擎，输出Word或者Excel文件。

     Java对word的操作不易处理，此处的输出引擎主要是采用Jacob来完成xml文件到 Doc 或者 Xls 格式的转换。（Jacob 是Java-COM Bridge的缩写，它在Java与微软的COM组件之间构建一座桥梁。使用Jacob自带的DLL动态链接库，并通过JNI的方式实现了在Java平台上对COM程序的调用。）

 

 

图4. 处理时序图

 

 

具体步骤解释如下：

1. 页面点击打印“提交”按钮后，系统先用HttpClient对请求的数据进行封装。此时提交请求的页面显示系统提示信息如“文件正在生成中，请稍等”；
2.  HttpClient使用Post方法将封装后的请求发送到文档导出模块，Post的参数包括报表数据&模板文件名称；
3. 当文档导出模块接收到HttpClient Post过来的请求后，首先计算参数的MD5值，和缓存中文具的MD5值比对，如有相同则返回相应缓存文件，否则解析参数并存储到数据库（队列）。数据库表会保存请求数据参数及计算的MD5值，同时获取该条记录的主键作为下载码（SeedID）返回。GetSeedID（）就是执行这样的操作；
4. 下载码生成后返回给所发送请求的页面；
5. 文档导出模块执行核心的生成文件操作GenerateDoc（）；
6. 当提交请求的页面收到返回的下载码后，定时发送查询消息，看文件是否已经生成完毕 IsGenerateOK(SeedID)；
7. 如果文件已经生成完毕，返回查询结果为True，请求页面随即将等待生成的提示消息取消，显示下载文件的链接；
8. 点击下载链接，发送下载文件请求；
9. 文档导出模块收到请求后，将文件以流的方式输出。

四. 设计要点：

1.  客户端封装  

    采用HttpClient来对客户端进行封装处理。

• 表单参数的命名需要和模板文件中的变量值对应起来，这个工作是由有文档导出应用的业务模块来提供的，文档导出模块只负责对模板和获取到的参数进行处理，生成一定格式的文件。
• 客户端在用HttpClient封装时，除了需要填入要输出的表单域参数外，还有一个必要的参数是使用模板的名称（TemplateName），以便服务器端能够根据该请求参数选择模板文件进行处理；

    2.  缓存文件生成

 

    缓存文件的目的是为了避免相同文件的重复生成操作。解决办法是文档导出模块在接收到打印请求的参数后，计算其MD5值，同缓存文件的MD5值比对，如有相同，并且其对应的文件还存在于缓存中，就可以跳过生成文件的操作，直接从缓存中读取数据返回给客户端。

• 服务器端在获取到输入参数后，需要对参数进行排序（固定的排序算法）再作MD5运算，目的是确保同样一个表单请求参数的MD5值是一样的；
• 缓存文件放到硬盘上，将文件名称及起对应的参数MD5值存储到数据库，以便对比和提取。缓存文件需定期清除，可以考虑Quartz定时任务来执行。

      3. Office应用对象池

输出引擎会调用Office Word 或者Excel应用程序来处理事件，这些应用程序都是比较消耗资源的，所以文档导出模块在初始化时会建立一个Office的应用对象池，来提供相应的服务，以免因为请求打印服务的数量过于集中而导致服务器性能下降乃至崩溃。

      4. 清除残留进程

 

    Excel程序打开后，在关闭时会有个20多兆的进程驻留在内存中。所以在应用服务重新启动会存在残留进程的问题，久而久之会对服务器的性能造成影响。解决的思路是每次在文档导出模块停止服务时（而非启动时），对残留的进程进行清理的操作。用C++做成动态链接库由Java通过JNI调用。