碼上快樂

相關內容    簡體    繁體

使用Docx4j創建word文檔

本文轉載自   查看原文   2017-11-23 18:05   1457    JAVA

原文標題：Creating Word documents with Docx4j

原文鏈接：http://blog.iprofs.nl/2012/09/06/creating-word-documents-with-docx4j/

原文作者：lvdpal

發表時間：2012年9月6日

注：第一次翻譯博客；由於個人水平不高，而且英語僅有四級水平，所以錯誤很多，請大家見諒！！！只是國內關於docx4j的博客極少，感覺這篇入門博客挺不錯，勉強翻譯過來，希望對大家有所幫助。

 

一段時間之前，我為一個想要在word和excel中作報表的客戶提供服務。我以前的項目中生成過PDF文件和CSV文件，但從來沒有處理過docx和xlsx文件。這些天了解到MS Office是基於XML的。我不禁想知道是否有一些庫來幫助我生成這些文件。經過一番在線搜索，結果表明確實有：Docx4j。我開始去試用這個新庫看它能做些什么。

在官方網站上你可以了解到docx4j可以讀取、更新、創建docx、xlsx和pptx文檔。我只需要生成文檔，所以我沒有嘗試讀取和更新文檔，但原理是一樣的。Docx4j已經自帶了不少示例程序，但我發現其中的一些例子同時展示了多樣東西或者沒有完全展示我需要了解的。所以有不少東西我不得不自己解決。幸運的是docx4j嚴格遵循Office Open XML標准，所以還不算太難。總而言這，我對這個庫所提供的功能非常滿意。

在這個博客中我會展示一些我試用docx4j生成docx文檔時創建的例子：

 

一些提示

 

在真正示例開始之前有幾處提示。首先，在使用docx創建文檔的時候，看看你使用word軟件創建文檔時生成的xml。當你使用一個ZIP壓縮工具（例如7zip）打開一個docx文件時會找到這些XML文件。看一下都是些什么樣的文件以及它們包含了哪些信息。通常情況下，如果你想得到什么東西，可以通過查看Word軟件自己生成了什么而從中得到很多幫助。

其次，去看一下 the Office Open Specification。

現在讓我們來看一些代碼。

用一些文本創建文檔

 

最簡單的例子就是創建一個新word文檔並向其中添加一些文本內容。

運行下面代碼：

 

[java]  view plain copy
 
  1. WordprocessingMLPackage wordMLPackage = WordprocessingMLPackage.createPackage();  
  2. wordMLPackage.getMainDocumentPart().addParagraphOfText("Hello Word!");  
  3. wordMLPackage.save(new java.io.File("src/main/files/HelloWord1.docx"));  


結果生成一個如下所示的文件：

 

這里發生的就是一個word文檔由一個帶有文檔部件的包組成。Docx4j提供一個創建包的工具方法（第1行）；然后你可以從這個包中獲取主文檔部件並向其中添加一個文本段落（第2行）；最后將這個包保存（第3行）。就這么簡單，當然，如果你想做不僅僅是向文檔中添加一些文本內容，那么你需要做更多的工作。

 

添加帶樣式的文本

 

然而即使添加帶樣式的文本也並不需要做過多的工作，不是向文檔添加一個普通的文本段落，而是只需要添加一個帶樣式的段落。

 

 
[java]  view plain  copy
 
  1. WordprocessingMLPackage wordMLPackage = WordprocessingMLPackage.createPackage();  
  2. wordMLPackage.getMainDocumentPart().addStyledParagraphOfText("Title", "Hello Word!");  
  3. wordMLPackage.getMainDocumentPart().addStyledParagraphOfText("Subtitle","This is a subtitle!");  
  4. wordMLPackage.save(new java.io.File("src/main/files/HelloWord2.docx"));  




添加表格

 

當我們想添加一個表格時，情況開始變得復雜一些。直到現在我們的代碼都如此簡單以至於不需要拆分到多個方法中，所以我僅僅只展示了代碼中相關的數行。但這個示例我們需要第二個方法，所以我會展示整個類。

 
[java]  view plain  copy
 
  1. public class AddingATable {  
  2.     private static WordprocessingMLPackage  wordMLPackage;  
  3.     private static ObjectFactory factory;  
  4.    
  5.     public static void main (String[] args) throws Docx4JException {  
  6.     wordMLPackage = WordprocessingMLPackage.createPackage();  
  7.     factory = Context.getWmlObjectFactory();  
  8.    
  9.     Tbl table = factory.createTbl();  
  10.     Tr tableRow = factory.createTr();  
  11.    
  12.     addTableCell(tableRow, "Field 1");  
  13.     addTableCell(tableRow, "Field 2");  
  14.    
  15.     table.getContent().add(tableRow);  
  16.    
  17.     wordMLPackage.getMainDocumentPart().addObject(table);  
  18.    
  19.     wordMLPackage.save(new java.io.File("src/main/files/HelloWord4.docx"));  
  20.     }  
  21.    
  22.     private static void addTableCell(Tr tableRow, String content) {  
  23.     Tc tableCell = factory.createTc();  
  24.     tableCell.getContent().add(  
  25.         wordMLPackage.getMainDocumentPart().createParagraphOfText(content));  
  26.     tableRow.getContent().add(tableCell);  
  27.     }  
  28. }  


我們再一次創建了word包，只是這一次我們將其保存為一個屬性，從而我們可以在第二個方法中訪問它。然后我們同樣創建了一個對象工廠（ObjectFactory），這是一個幫助我們創建本例中所需要的具體對象的工具類，例如表格、表格行及表格列等具體對象。

 

然后我們創建了表格，創建了行並且在行中添加了兩個單元格。最后我們將行添加到表格中，將表格添加到主文檔部件並且將包保存。

 

給表格添加邊框

 

現在我們擁有了一個表格，讓我們給它添加一些邊框。這需要深入研究一下表格的結構。

 

 
[java]  view plain  copy
 
  1. public class TableWithBorders {  
  2.     private static WordprocessingMLPackage  wordMLPackage;  
  3.     private static ObjectFactory factory;  
  4.    
  5.     public static void main (String[] args) throws Docx4JException {  
  6.         wordMLPackage = WordprocessingMLPackage.createPackage();  
  7.         factory = Context.getWmlObjectFactory();  
  8.    
  9.         Tbl table = createTableWithContent();  
  10.    
  11.         addBorders(table);  
  12.    
  13.         wordMLPackage.getMainDocumentPart().addObject(table);  
  14.         wordMLPackage.save(new java.io.File(  
  15.             "src/main/files/HelloWord5.docx") );  
  16.     }  
  17.    
  18.     private static void addBorders(Tbl table) {  
  19.         table.setTblPr(new TblPr());  
  20.         CTBorder border = new CTBorder();  
  21.         border.setColor("auto");  
  22.         tborder.setSz(new BigInteger("4"));  
  23.         border.setSpace(new BigInteger("0"));  
  24.         border.setVal(STBorder.SINGLE);  
  25.    
  26.         TblBorders borders = new TblBorders();  
  27.         borders.setBottom(border);  
  28.         borders.setLeft(border);  
  29.         borders.setRight(border);  
  30.         borders.setTop(border);  
  31.         borders.setInsideH(border);  
  32.         borders.setInsideV(border);  
  33.         table.getTblPr().setTblBorders(borders);  
  34.     }  
  35.    
  36.     private static Tbl createTableWithContent() {  
  37.         Tbl table = factory.createTbl();  
  38.         Tr tableRow = factory.createTr();  
  39.    
  40.         addTableCell(tableRow, "Field 1");  
  41.         addTableCell(tableRow, "Field 2");  
  42.    
  43.         table.getContent().add(tableRow);  
  44.         return table;  
  45.     }  
  46.    
  47.     private static void addTableCell(Tr tableRow, String content) {  
  48.         Tc tableCell = factory.createTc();  
  49.         tableCell.getContent().add(  
  50.         wordMLPackage.getMainDocumentPart().  
  51.             createParagraphOfText(content));  
  52.         tableRow.getContent().add(tableCell);  
  53.     }  
  54. }  


首先我們創建了一個默認顏色（黑色）、粗細尺寸為4、間距為0的單線邊框的邊框組件（Border component），然后邊框被應用到表格的四周以及表格內部水平和垂直的邊框。隨后我們將邊框應用到表格；所有其它的代碼與前面的示例一樣。

 

 

給表格添加樣式

 

接下來的問題--給表格添加樣式讓我忙活了一陣子，我們的客戶想要在表格中使用粗體文本並且需要多種大小的字體。

這個示例程序有點復雜，注釋和代碼交織在一起。

 

 
[java]  view plain  copy
 
  1. public class TableWithStyledContent {  
  2.     private static WordprocessingMLPackage  wordMLPackage;  
  3.     private static ObjectFactory factory;  
  4.    
  5.     /** 
  6.       *  跟前面的做的一樣, 我們再一次創建了一個表格, 並添加了三個單元格, 其中有兩個 
  7.       *  單元帶有樣式. 在新方法中我們傳進表格行, 單元格內容, 是否為粗體及字體大小作 
  8.       *  為參數. 你需要注意, 因為the Office Open specification規范定義這個屬性是半個 
  9.       *  點(half-point)大小, 因此字體大小需要是你想在Word中顯示大小的兩倍,  
  10.      */  
  11.     public static void main (String[] args) throws Docx4JException {  
  12.         wordMLPackage = WordprocessingMLPackage.createPackage();  
  13.         factory = Context.getWmlObjectFactory();  
  14.    
  15.         Tbl table = factory.createTbl();  
  16.         Tr tableRow = factory.createTr();  
  17.    
  18.         addRegularTableCell(tableRow, "Normal text");  
  19.         addStyledTableCell(tableRow, "Bold text", true, null);  
  20.         addStyledTableCell(tableRow, "Bold large text", true, "40");  
  21.    
  22.         table.getContent().add(tableRow);  
  23.         addBorders(table);  
  24.    
  25.         wordMLPackage.getMainDocumentPart().addObject(table);  
  26.         wordMLPackage.save(new java.io.File("src/main/files/HelloWord6.docx") );  
  27.     }  
  28.    
  29.     /** 
  30.      *  本方法創建單元格, 添加樣式后添加到表格行中 
  31.      */  
  32.     private static void addStyledTableCell(Tr tableRow, String content,  
  33.                         boolean bold, String fontSize) {  
  34.         Tc tableCell = factory.createTc();  
  35.         addStyling(tableCell, content, bold, fontSize);  
  36.         tableRow.getContent().add(tableCell);  
  37.     }  
  38.    
  39.     /** 
  40.      *  這里我們添加實際的樣式信息, 首先創建一個段落, 然后創建以單元格內容作為值的文本對象;  
  41.      *  第三步, 創建一個被稱為運行塊的對象, 它是一塊或多塊擁有共同屬性的文本的容器, 並將文本對象添加 
  42.      *  到其中. 隨后我們將運行塊R添加到段落內容中. 
  43.      *  直到現在我們所做的還沒有添加任何樣式, 為了達到目標, 我們創建運行塊屬性對象並給它添加各種樣式. 
  44.      *  這些運行塊的屬性隨后被添加到運行塊. 最后段落被添加到表格的單元格中. 
  45.      */  
  46.     private static void addStyling(Tc tableCell, String content, boolean bold, String fontSize) {  
  47.         P paragraph = factory.createP();  
  48.    
  49.         Text text = factory.createText();  
  50.         text.setValue(content);  
  51.    
  52.         R run = factory.createR();  
  53.         run.getContent().add(text);  
  54.    
  55.         paragraph.getContent().add(run);  
  56.    
  57.         RPr runProperties = factory.createRPr();  
  58.         if (bold) {  
  59.             addBoldStyle(runProperties);  
  60.         }  
  61.    
  62.         if (fontSize != null && !fontSize.isEmpty()) {  
  63.             setFontSize(runProperties, fontSize);  
  64.         }  
  65.    
  66.         run.setRPr(runProperties);  
  67.    
  68.         tableCell.getContent().add(paragraph);  
  69.     }  
  70.    
  71.     /** 
  72.      *  本方法為可運行塊添加字體大小信息. 首先創建一個"半點"尺碼對象, 然后設置fontSize 
  73.      *  參數作為該對象的值, 最后我們分別設置sz和szCs的字體大小. 
  74.      *  Finally we'll set the non-complex and complex script font sizes, sz and szCs respectively. 
  75.      */  
  76.     private static void setFontSize(RPr runProperties, String fontSize) {  
  77.         HpsMeasure size = new HpsMeasure();  
  78.         size.setVal(new BigInteger(fontSize));  
  79.         runProperties.setSz(size);  
  80.         runProperties.setSzCs(size);  
  81.     }  
  82.    
  83.     /** 
  84.      *  本方法給可運行塊屬性添加粗體屬性. BooleanDefaultTrue是設置b屬性的Docx4j對象, 嚴格 
  85.      *  來說我們不需要將值設置為true, 因為這是它的默認值. 
  86.      */  
  87.     private static void addBoldStyle(RPr runProperties) {  
  88.         BooleanDefaultTrue b = new BooleanDefaultTrue();  
  89.         b.setVal(true);  
  90.         runProperties.setB(b);  
  91.     }  
  92.    
  93.     /** 
  94.      *  本方法像前面例子中一樣再一次創建了普通的單元格 
  95.      */  
  96.     private static void addRegularTableCell(Tr tableRow, String content) {  
  97.         Tc tableCell = factory.createTc();  
  98.         tableCell.getContent().add(  
  99.             wordMLPackage.getMainDocumentPart().createParagraphOfText(  
  100.                 content));  
  101.         tableRow.getContent().add(tableCell);  
  102.     }  
  103.    
  104.     /** 
  105.      *  本方法給表格添加邊框 
  106.      */  
  107.     private static void addBorders(Tbl table) {  
  108.         table.setTblPr(new TblPr());  
  109.         CTBorder border = new CTBorder();  
  110.         border.setColor("auto");  
  111.         border.setSz(new BigInteger("4"));  
  112.         border.setSpace(new BigInteger("0"));  
  113.         border.setVal(STBorder.SINGLE);  
  114.    
  115.         TblBorders borders = new TblBorders();  
  116.         borders.setBottom(border);  
  117.         borders.setLeft(border);  
  118.         borders.setRight(border);  
  119.         borders.setTop(border);  
  120.         borders.setInsideH(border);  
  121.         borders.setInsideV(border);  
  122.         table.getTblPr().setTblBorders(borders);  
  123.     }  
  124. }  

 

縱向合並單元格

 

有時你想要一個三列的表格，其中第一列將多行組合在一起。

 

 
[java]  view plain  copy
 
  1. package com.zyh.sample.docx4j;  
  2.   
  3. public class TableWithMergedCells {  
  4.     private static WordprocessingMLPackage  wordMLPackage;  
  5.     private static ObjectFactory factory;  
  6.    
  7.     /** 
  8.      *  創建一個帶邊框的表格並添加四個帶內容的行, 然后將表格添加到文檔並保存 
  9.      */  
  10.     public static void main (String[] args) throws Docx4JException {  
  11.         wordMLPackage = WordprocessingMLPackage.createPackage();  
  12.         factory = Context.getWmlObjectFactory();  
  13.    
  14.         Tbl table = factory.createTbl();  
  15.         addBorders(table);  
  16.    
  17.         addTableRowWithMergedCells("Heading 1", "Heading 1.1",  
  18.             "Field 1", table);  
  19.         addTableRowWithMergedCells(null, "Heading 1.2", "Field 2", table);  
  20.    
  21.         addTableRowWithMergedCells("Heading 2", "Heading 2.1",  
  22.             "Field 3", table);  
  23.         addTableRowWithMergedCells(null, "Heading 2.2", "Field 4", table);  
  24.    
  25.         wordMLPackage.getMainDocumentPart().addObject(table);  
  26.         wordMLPackage.save(new java.io.File(  
  27.             "src/main/files/HelloWord9.docx") );  
  28.     }  
  29.    
  30.     /** 
  31.      *  本方法創建一行, 並向其中添加合並列, 然后添加再兩個普通的單元格. 隨后將該行添加到表格 
  32.      */  
  33.     private static void addTableRowWithMergedCells(String mergedContent,  
  34.             String field1Content, String field2Content, Tbl table) {  
  35.         Tr tableRow1 = factory.createTr();  
  36.    
  37.         addMergedColumn(tableRow1, mergedContent);  
  38.    
  39.         addTableCell(tableRow1, field1Content);  
  40.         addTableCell(tableRow1, field2Content);  
  41.    
  42.         table.getContent().add(tableRow1);  
  43.     }  
  44.    
  45.     /** 
  46.      *  本方法添加一個合並了其它行單元格的列單元格. 如果傳進來的內容是null, 傳空字符串和一個為null的合並值. 
  47.      */  
  48.     private static void addMergedColumn(Tr row, String content) {  
  49.         if (content == null) {  
  50.             addMergedCell(row, "", null);  
  51.         } else {  
  52.             addMergedCell(row, content, "restart");  
  53.         }  
  54.     }  
  55.    
  56.     /** 
  57.      *  我們創建一個單元格和單元格屬性對象. 
  58.      *  也創建了一個縱向合並對象. 如果合並值不為null, 將它設置到合並對象中. 然后將該對象添加到 
  59.      *  單元格屬性並將屬性添加到單元格中. 最后設置單元格內容並將單元格添加到行中. 
  60.      *   
  61.      *  如果合並值為'restart', 表明要開始一個新行. 如果為null, 繼續按前面的行處理, 也就是合並單元格. 
  62.      */  
  63.     private static void addMergedCell(Tr row, String content, String vMergeVal) {  
  64.         Tc tableCell = factory.createTc();  
  65.         TcPr tableCellProperties = new TcPr();  
  66.    
  67.         VMerge merge = new VMerge();  
  68.         if(vMergeVal != null){  
  69.             merge.setVal(vMergeVal);  
  70.         }  
  71.         tableCellProperties.setVMerge(merge);  
  72.    
  73.         tableCell.setTcPr(tableCellProperties);  
  74.         if(content != null) {  
  75.                 tableCell.getContent().add(  
  76.                 wordMLPackage.getMainDocumentPart().  
  77.                     createParagraphOfText(content));  
  78.         }  
  79.    
  80.         row.getContent().add(tableCell);  
  81.     }  
  82.    
  83.     /** 
  84.      *  本方法為給定的行添加一個單元格, 並以給定的段落作為內容 
  85.      */  
  86.     private static void addTableCell(Tr tr, String content) {  
  87.         Tc tc1 = factory.createTc();  
  88.         tc1.getContent().add(  
  89.             wordMLPackage.getMainDocumentPart().createParagraphOfText(content));  
  90.         tr.getContent().add(tc1);  
  91.     }  
  92.    
  93.     /** 
  94.      *  本方法為表格添加邊框 
  95.      */  
  96.     private static void addBorders(Tbl table) {  
  97.         table.setTblPr(new TblPr());  
  98.         CTBorder border = new CTBorder();  
  99.         border.setColor("auto");  
  100.         border.setSz(new BigInteger("4"));  
  101.         border.setSpace(new BigInteger("0"));  
  102.         border.setVal(STBorder.SINGLE);  
  103.    
  104.         TblBorders borders = new TblBorders();  
  105.         borders.setBottom(border);  
  106.         borders.setLeft(border);  
  107.         borders.setRight(border);  
  108.         borders.setTop(border);  
  109.         borders.setInsideH(border);  
  110.         borders.setInsideV(border);  
  111.         table.getTblPr().setTblBorders(borders);  
  112.     }  
  113. }  

 

 

為表格設置列寬

 

作為本博客的最后一個示例, 我會展示怎樣為表格設置列寬。

 

 
[java]  view plain  copy
 
  1. public class SettingColumnWidthForTable {  
  2.     private static WordprocessingMLPackage  wordMLPackage;  
  3.     private static ObjectFactory factory;  
  4.    
  5.     /** 
  6.      *  創建一個帶邊框的表格並添加一行. 然后添加兩個帶內容的單元格並給定寬度. 
  7.      */  
  8.     public static void main (String[] args) throws Docx4JException {  
  9.         wordMLPackage = WordprocessingMLPackage.createPackage();  
  10.         factory = Context.getWmlObjectFactory();  
  11.    
  12.         Tbl table = factory.createTbl();  
  13.         addBorders(table);  
  14.    
  15.         Tr tr = factory.createTr();  
  16.    
  17.         addTableCellWithWidth(tr, "Field 1", 2500);  
  18.         addTableCellWithWidth(tr, "Field 2", 0);  
  19.    
  20.         table.getContent().add(tr);  
  21.    
  22.         wordMLPackage.getMainDocumentPart().addObject(table);  
  23.         wordMLPackage.save(new java.io.File(  
  24.             "src/main/files/HelloWord13.docx") );  
  25.     }  
  26.    
  27.     /** 
  28.      *  本方法創建一個單元格並將給定的內容添加進去. 
  29.      *  如果給定的寬度大於0, 將這個寬度設置到單元格. 
  30.      *  最后, 將單元格添加到行中. 
  31.      */  
  32.     private static void addTableCellWithWidth(Tr row, String content, int width){  
  33.         Tc tableCell = factory.createTc();  
  34.         tableCell.getContent().add(  
  35.             wordMLPackage.getMainDocumentPart().createParagraphOfText(  
  36.                 content));  
  37.    
  38.         if (width > 0) {  
  39.             setCellWidth(tableCell, width);  
  40.         }  
  41.         row.getContent().add(tableCell);  
  42.     }  
  43.    
  44.     /** 
  45.      *  本方法創建一個單元格屬性集對象和一個表格寬度對象. 將給定的寬度設置到寬度對象然后將其添加到 
  46.      *  屬性集對象. 最后將屬性集對象設置到單元格中. 
  47.      */  
  48.     private static void setCellWidth(Tc tableCell, int width) {  
  49.         TcPr tableCellProperties = new TcPr();  
  50.         TblWidth tableWidth = new TblWidth();  
  51.         tableWidth.setW(BigInteger.valueOf(width));  
  52.         tableCellProperties.setTcW(tableWidth);  
  53.         tableCell.setTcPr(tableCellProperties);  
  54.     }  
  55.    
  56.     /** 
  57.      *  本方法為表格添加邊框 
  58.      */  
  59.     private static void addBorders(Tbl table) {  
  60.         table.setTblPr(new TblPr());  
  61.         CTBorder border = new CTBorder();  
  62.         border.setColor("auto");  
  63.         border.setSz(new BigInteger("4"));  
  64.         border.setSpace(new BigInteger("0"));  
  65.         border.setVal(STBorder.SINGLE);  
  66.    
  67.         TblBorders borders = new TblBorders();  
  68.         borders.setBottom(border);  
  69.         borders.setLeft(border);  
  70.         borders.setRight(border);  
  71.         borders.setTop(border);  
  72.         borders.setInsideH(border);  
  73.         borders.setInsideV(border);  
  74.         table.getTblPr().setTblBorders(borders);  
  75.     }  
  76. }  

 

 

總結

 

在這篇文章中，我展示了如何創建一個文檔、如何為其應用樣式以及添加帶樣式的表格。以后的文章我會展示更多的關於docx文檔的示例（比如添加目錄、添加圖片、添加頁眉和頁腳等）以及一些關於xlsx文檔的示例。


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 使用docx4j編程式地創建復雜的Word(.docx)文檔 使用Docx4J將Word轉PDF java合並多個word 2007 文檔 基於docx4j java 操作word(docx4j) 分別使用docx4j,jacob將文字與圖片插入word中書簽位置 docx4j基本操作 docx4j docx轉html 使用docx4j實現docx轉pdf（解決linux環境下中文亂碼問題） Docx4j將html轉成word時，br標簽為軟回車的問題修改 【docx4j】docx4j操作docx，實現替換內容、轉換pdf、html等操作
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM