OpenXml SDK學習筆記(1):Word的基本結構

bluesky234發表於2021-11-10

能寫多少篇我就不確定了,可能就這一篇就太監了,也有可能會寫不少。

OpenXml SDK 相信很多人都不陌生,這個就是管Office一家的文件格式,Word, Excel, PowerPoint等都用到這個。並且,這個格式主要是給Word 2007以上使用的。如果是用到其中Excel部分,那建議直接使用NPOI這樣的成品類庫就行。

但是,NPOI FOR WORD真的是太難受了。當然,也不是說一定要用NPOI,現在成品的WORD操作庫也不是沒有,比如DocX。這個庫基本算是 Xceed Words for .NET 的簡化版。GitHub https://github.com/xceedsoftware/DocX 。而且,這個庫非常牛逼的地方在於他是直接操作XML的,效率是上去了,可讀性就下去了啊。要讀懂這個,恐怕得對  ISO/IEC 29500 這個標準非常熟悉。那沒救了,我是專精資訊系統開發的,對這個標準的理解非常一般。而且說實話,這個標準裡 95% 以上的內容我根本用不到,我又不用做一個Word,我只需要把我係統裡的東西生成為一個Word顯示出來就行了。

那於是,我痛定思痛,自己讀文件吧:https://docs.microsoft.com/zh-cn/office/open-xml/open-xml-sdk (當然,英文的質量比中文可高多了,不過懶的看英文)。這文件寫的可真是太專業了,想讀懂它恐怕得要點技術水平。所以呢,我打算把這個文件給拆一下,做一個筆記。能寫多少就隨緣了,反正我把需求實現完了就不寫了。恐怕兩三篇就完事了。那第一篇講的就是Word的基本結構。

一、WordprocessingML的理解

在看文件和使用的時候,就可以發現這樣的一個名稱空間:Wordprocessing。也可以看到這樣的名詞WordprocessingML。什麼意思呢,Office家的這個產品叫Word,其作用是處理文字。所以,Wordprocessing翻譯成 文書處理 就行了。對於OpenXml結構的docx檔案那就是一個壓縮包。你把字尾名從docx改成zip就可以用解壓軟體開啟了。在其中,可以看到這樣的結構:

 

 

 

 這個結構裡,第一個資料夾word就是我們要關注的內容,這個資料夾裡是這樣的:

 

 

 有圖片的話會更復雜一點,再多一個media資料夾,裡面存著圖片。不過這個無關緊要,本次我的需求只是簡單的輸出一個純文件的證明檔案。所以,不要管圖片了。

在這裡,重點需要注意注意的xml有兩個,document.xml和styles.xml。他們分別對應著docx檔案的樣式部分和正文部分,大致就是這樣的:

 

也就是說,如果我們需要通過程式碼編輯一個純文字的Word,那就是修改這兩個xml就可以了。甚至於,如果不需要搞樣式的話,只要改docment.xml就行了。這兩個Xml適用的標準就是 ISO/IEC 29500,並且這種Xml就稱為:WordprocessingML。

但是,手寫xml可太刑了。把整個 ISO/IEC 29500:2016 讀完怕不是半條命就要去掉了。再等你把程式碼寫完,恐怕你的工作就已經涼涼了。所以呢,微軟自己出了個 OpenXml SDK 幫助開發者編輯這種Xml檔案。不過呢,這玩意也是真的難用。而且說實話,裡面一大片功能是根本用不著。說實話,日常使用的時候,也就是搞個樣式,然後向裡面新增文字,設定一下字型和段落樣式,頂多插入點圖片和表格。

對於我這種做普通的資訊管理系統的人來說,圖片和表格裡都有大把的功能是完全用不著的。而且對於MIS的絕大部分用例而言,我都是隻需要生成Word,然後由Word程式讀取,而不需要由我來讀一個Word模板,然後再向其中修改。當然,如果你會寫了,讀也不是什麼太難的問題,只不過Word那個鬼程式裡的Run真的是看不懂生成規律,經常會有亂七八糟的東西。所以,如果有碰到讀模板再向裡寫的需求,我另外寫一個筆記。

 

二、建立一個Word檔案

開啟VS,然後建立一個命令列程式,向裡面新增一個名為“DocumentFormat.OpenXml”的Nuget包,這樣專案的引用關係就做完了。然後新增以下程式碼:

 1 if (File.Exists("newDocx.docx"))
 2 {
 3     File.Delete("newDocx.docx");
 4 }
 5 
 6 using (WordprocessingDocument doc = WordprocessingDocument.Create("newDocx.docx", DocumentFormat.OpenXml.WordprocessingDocumentType.Document))
 7 {
 8     var main = doc.MainDocumentPart;
 9     if (doc.MainDocumentPart == null)
10     {
11         doc.AddMainDocumentPart();
12     }
13 
14     if (doc.MainDocumentPart.Document == null)
15     {
16         doc.MainDocumentPart.Document = new Document();
17     }
18     var body = doc.MainDocumentPart.Document;
19 
20     Paragraph para = new Paragraph();
21     Run r = new Run();
22     Text t = new Text();
23     t.Text = "Hello World";
24     r.Append(t);
25     para.Append(r);
26     body.Append(para);
27 
28     doc.Save();
29 }

執行一下,就可以發現在執行目錄下,出現了一個名為 newDocx.docx 的檔案。這個檔案開啟,裡面就一行 Hello World 文字。雖然,這個Hello World程式簡單,但是要理解這個東西就 特!別!麻!煩!

首先,using語句塊裡,“WordprocessingDocument”物件 就是一個docx文件物件,也就是上文所述的那個壓縮包。宣告這個物件通常使用兩種方法:Open和Create。非常好區別,一個是開啟,一個是建立。

之後,“MainDocumentPart”這個屬性就相當於壓縮包裡的“word”資料夾,非常的真實。

接著,“MainDocumentPart.Document”這個屬性就相當於“word”資料夾下的“document.xml”檔案,更真實了。

再下,“Paragraph”是一個段落。一份Word是由多個段落或者表格組成的。所以,在Word文件裡,看到回車符,就可以認為是一個“Paragraph”物件的結束。

 

 

 在“段落”裡,有多個連續文字,也就是“Run”。一個Run就相當於Html裡的span標籤。比如,上文中,Hello World整個文字都是一樣的格式。所以,就應當在一個Run裡。寫成Html大致是這樣的感覺:

1 <p>
2     <span>Hello World</span>
3 </p>

但是,並不是所有情況都是這樣的。在很多時候,一個段落的文字也是有不同的格式的。比如說,中文和英文的字型不一樣,或者其它情況。比如,下文這樣:

 

 

 

 那這時,就需要對段落內的文字再進行拆分。上圖的格式,寫成Html大致是這樣的感覺:

 1 <p>
 2      <span></span>
 3      <span></span>
 4      <span></span>
 5      <span></span>
 6      <span></span>
 7      <span></span>
 8      <span></span>
 9      <span></span>
10 </p>

所以呢,這裡每一個字都是一個Run。在Run裡,則是正式的文字,相當於span的#innerText。但是,WordprocessingML要求你將這些文字放在名為Text的段落裡。

至此,整個Word的基本結構就看懂了。Document裡面有若干個Paragraph。每個Paragraph裡,前後格式完全一樣的文字放在一個Run裡。前後格式不一樣的文字放在不同的Run裡。每一個Run裡面再有若干個Text。那麼,練習一下,下面的Word有幾個Paragraph,幾個Run?

 

 這個就是我需求的一部分,我也沒有截全。但是看的出來,是有兩個段落。所以,兩個Paragraph安排上。第一個Paragraph裡,“茲證明”的格式是一樣的,但是後面的下劃線的文字是“空格符”,文字格式是“下劃線”。他們的格式與前面的“茲證明”不一樣。所以,哪怕再後續的“學院教師”與“茲證明”的格式相同,這裡也得分成三個Run。再之後,又是一個下劃線,再一個Run。再後,根據需求,這個括號也是三號宋體和文字的格式一樣,所以“(教工號:”是一個Run。下劃線再一個Run。“)指導專案如下:”一個Run。所以,第一段裡就有7個Run。

第二段,就留給大家做練習了。在我截出來的部分,所有數字符號都是三號宋體,和文字一樣。算一下多少個Run?具體過程我就略了,答案是5個。

相關文章