java调用microsoft office（如word、excel）的宏

亦凉 2021-10-13 01:33 542阅读 0赞

最近的一个工作任务中，需要在后台将客户上传的文档（合同文档）进行只读保护（严格意义上的只读保护，既加密锁定，确保不能自行解锁，而不是文件本身只读或者简单锁定），因此想到了调用word宏来操作文档的方式。  经过研究，这种方式是完全可行的，而且已经实现，由于这类资料网络上比较难找，因此特将自己的研究心得总结分享一下。   
     java需要通过调用com来和office交互，这个可以自己编写jni来实现，不过目前已有三个开源项目支持java对com的调用，它们分别是：com4j、j-Interop和Jacob。下面先对这三个项目做个简单介绍。   
   com4j，项目地址是：http://java.net/projects/com4j/ ，很久没更新了，要使用这个库，需要下载相关的源代码（也可以通过http://download.java.net/maven/2/org/jvnet/com4j/ 这个地址去查找相关编译好的包）编译或者通过maven获取maven-com4j-plugin插件，然后运行tlbimp.jar（可以在http://download.java.net/maven/2/org/jvnet/com4j/tlbimp/ 里找到）或者maven-com4j-plugin插件去生成相关com组件的模型接口代码（当然前提是要先找到com组件的承载文件所在，这个是有些难度的），然后再使用这些代码去调用相关的com组件，使用起来还是比较麻烦的，而且还存在一些严重的bug。   
    j-Interop，项目地址是：http://www.j-interop.org/ ，一个纯粹的java库，没有使用jni方式去调用com组件。但是它的问题是只能调用dcom（分布式com），是通过CIFS协议去调用dcom的，因此要使用它，首先得给机器配置好dcom服务，同时还有一点比较麻烦，就是你要自己去寻找dcom组件的ID（可以通过运行dcomcnfg去查看）。   
    Jacob，项目地址是：http://sourceforge.net/projects/jacob-project/ ，目前最新的更新是2011年2月份的，本文将着重介绍如何通过这个项目去调用宏。   
    项目介绍完毕，现在正式开始介绍如何通过Jacob去调用宏。首先，需要下载Jacob的发布包，里面应该包含一个jar包：jacob.jar（放在项目的classpath下），两个dll文件：jacob-1.15-M4-x64.dll、jacob-1.15-M4-x86.dll，两个dll文件请根据系统架构属性选择其中一个，然后放在path路径下（也可以直接放在C:\\WINDOWS\\system32下面）。这样就可以开始编写调用宏的java程序了。   
    调用word宏   
    第一步，录制宏   
    在d盘根目录下（文档存放在哪里没有要求）新建一个word文档，名为test1.doc，打开，然后录制一段宏（具体录制哪类宏自便，调用时无需传参数即可，但是宏的保存方式要选择“所有文档（Normal）”，这样任何文档都可以调用这个宏了），宏名为macro1。   
    第二步，将test1.doc中宏macro1产生的影响撤销（比如那段宏是输入一段文字，那么就把这段文字删除）并保存，以便观察测试。   
    第三步，编写java调用代码

Java代码

![收藏代码][aHR0cHM6Ly92c3NxLml0ZXllLmNvbS9pbWFnZXMvaWNvbl9zdGFyLnBuZw]

1.  ActiveXComponent word=new ActiveXComponent("Word.Application");  
2.  Dispatch documents = word.getProperty("Documents").toDispatch();  
3.  Dispatch document = Dispatch.call(documents, "Open", "d:/test1.doc").toDispatch();//指定要打开的文档并且打开它  
4.  Dispatch.call(word, "Run", new Variant("macro1"));//在这个文档上运行宏

第四步，执行这段java代码   
    执行完成之后，可以发现被撤销的宏影响又回来了，说明宏调用成功。   
    第五步，高级特性   
    在相同目录下（文档存放目录没有规定）新建一个空白的word文档test2.doc，然后将以上代码修改为：

Java代码

![收藏代码][aHR0cHM6Ly92c3NxLml0ZXllLmNvbS9pbWFnZXMvaWNvbl9zdGFyLnBuZw]

1.  ActiveXComponent word=new ActiveXComponent("Word.Application");  
2.  Dispatch documents = word.getProperty("Documents").toDispatch();  
3.  Dispatch document = Dispatch.call(documents, "Open", "d:/test2.doc").toDispatch();//指定要打开的文档并且打开它  
4.  Dispatch.call(word, "Run", new Variant("macro1"));//在这个文档上运行宏

执行以上代码，可以发现，我们在test1.doc上录制的宏也可以在test2.doc上运行成功（当然选择宏保存时必须要保存到“所有文档（Normal）”中）。   
    深入探索   
    以上的例子只是一个很简单的没有参数的宏调用，如果有参数又该如何调用呢？其实有参数的情况也不是很复杂，只需将以上调用的java代码稍微修改下即可实现：

Java代码

![收藏代码][aHR0cHM6Ly92c3NxLml0ZXllLmNvbS9pbWFnZXMvaWNvbl9zdGFyLnBuZw]

调用excel宏   
    调用excel宏和调用word宏有点区别，因为excel不能将宏保存到“所有文档（Normal）”上，因此在调用宏的时候需要指明宏所在的具体文档，最后一条语句需要这么写：

Java代码

![收藏代码][aHR0cHM6Ly92c3NxLml0ZXllLmNvbS9pbWFnZXMvaWNvbl9zdGFyLnBuZw]

1.  Variant result = Dispatch.call(excel, "Run", new Variant("test.xls!Module1.test"),//这里需要说明宏所在的文档  
2.                                          new Variant(arg1),  
3.                                          new Variant(arg2));

总结   
    利用java直接调用office宏的应用场景非常广泛，比如在对文档进行加密、解密和其它保护时特别有用。带参数的宏调用甚至可以灵活的编写成模版宏然后将业务数据注入到相关文档中，而且因为是通过office自己操作自己，所以office文档绝不会出现其它的用java操作office文档时可能出现的文档变异问题，在某些重要文档的操作上非常有用（比如文档格式要求非常严格的合同文档上）。另外，Jacob本身就可以通过调用com来直接操作office（包括编辑），而且office文档不会有任何变异，只是编码难度可能比较大，具体的操作方式这里就不赘述了，可以参考相关api

[aHR0cHM6Ly92c3NxLml0ZXllLmNvbS9pbWFnZXMvaWNvbl9zdGFyLnBuZw]: /images/20211013/dae37ad1ec1044a79ee05aeb9157f969.png