在 Python 中,你可以使用內建的 xml.etree.ElementTree 模組搭配一個小型遞迴輔助函式來將 XML 轉換為 JSON,也可以用第三方的 xmltodict 函式庫一行搞定——或者,如果你完全不想寫程式,基於瀏覽器的 XML 轉 JSON 轉換器 可以在本機執行相同的轉換,不需要安裝任何東西。標準函式庫的做法讓你能完全掌控輸出的形狀,第三方函式庫讓你享有速度,而瀏覽器工具則提供一個不上傳的選項,這對 API 範例、設定檔檢視以及測試資料非常有幫助。這三種方式都能產生合法的 JSON,但產出的 JSON 都不會完全相同,因為 XML 與 JSON 之間並不存在通用的逐一對應關係。

how to convert xml to json in python
在 Python 中以及在瀏覽器中將 XML 轉換為 JSON

Python 內建方案:xml.etree.ElementTree 搭配 json

標準函式庫已經內建了解析 XML 與輸出 JSON 所需的一切,這使得 xml.etree.ElementTree 成為無法安裝第三方套件時的預設選擇。ElementTree.parse() 會回傳一個由 Element 物件組成的樹狀結構,其中 element.tag 保存本地的標籤名稱,element.text 保存直接文字內容,而 element.attrib 則是一個包含屬性的字典。由於這個樹狀結構並不會自動對應到 JSON,你必須撰寫一個小型遞迴輔助函式,將每個 Element 轉成一般的 dict,然後再把結果傳給 json.dumps()。

你要產生什麼樣的形狀完全由你決定。常見的慣例是把屬性包進一個 @attributes 鍵底下,在元素同時擁有子元素或屬性時把文字內容放在 #text 鍵底下,並把重複的同層標籤轉成 JSON 陣列。這些慣例都不是標準函式庫強制要求的,這也是為什麼兩段寫得很棒的 Python 程式碼可以從同一份 XML 產出差異極大的 JSON。這種自由度對於消費者有嚴格要求的正式 ETL 流程很實用,但也代表你必須自行負責對應規則並加以測試。

第三方捷徑:xmltodict

如果你不想自己撰寫遞迴邏輯,xmltodict 是最常被引用、以單一呼叫就能在 Python 中將 XML 轉換為 JSON 的做法。在執行 pip install xmltodict 之後,轉換只需要兩行程式碼:xmltodict.parse(xml_string) 會回傳一個對應文件結構的 OrderedDict,而 json.dumps(dict_data, indent=2) 則負責將它序列化。

xmltodict 預設會用 @ 前綴表示屬性(因此 id 屬性會變成 @id),並在字元資料與屬性或子元素並存時使用 #text 鍵來儲存。重複的同層元素會自動變成清單。這些預設值很方便,但也會把你綁死在一種特定的輸出形狀上,這種形狀未必符合你消費者所預期的結構。為了建立更嚴謹的下游契約,你可以在轉換之後,根據 JSON 範例在 Python 中從 JSON 範例產生 JSON Schema並用它來驗證結果。

如何在不寫 Python 的情況下將 XML 轉換為 JSON

當目的只是快速檢視或分享單一 XML 文件時,安裝 Python 並寫程式就太殺雞用牛刀了。XML 轉 JSON 轉換器在瀏覽器中接受一份格式正確的 XML 文件,使用 DOMParser API 在本機進行解析,並套用工具頁面上所說明的、已記載清楚的對應規則。不會上傳任何文件,也不會發出任何網路請求,這對於不想離開本機的設定檔與 API 回應來說非常重要。

  1. 將一份格式正確的 XML 文件貼到輸入區域。如果你的文件以 <!DOCTYPE ...> 宣告開頭,請先刪除該行——轉換器刻意拒絕 DOCTYPE,以避免被誘騙去擷取外部實體、DTD 或遠端資源。
  2. 選擇縮排樣式:精簡(無空白)、兩個空格或四個空格。這個選擇只影響 JSON 的序列化方式,不會影響底層結構。
  3. 選擇「轉換為 JSON」。瀏覽器會使用標準的 XML 1.0 規則集來解析文件。如果解析失敗,系統會顯示明確的剖析器錯誤,而不是輸出部分結果。
  4. 使用下方說明的 @attributes 與 #text 慣例檢視結果,然後從輸出面板複製它。

轉換器每次貼上最多接受 200,000 個字元,這對大多數 API 範例、設定檔以及小型資料遷移來說已經足夠。更大的內容應該拆分處理,或是在版本控管的應用程式中以串流剖析器處理,而不是單次貼上完成。

轉換器如何塑造輸出

XML 轉 JSON 轉換器採用的是明確且有書面記載的對應規則,而不是聲稱遵循某個官方的轉換標準——因為 XML 與 JSON 之間根本不存在這種通用標準。了解這些規則,才能讓輸出變得可預測。

  • 根元素會成為最上層唯一的 JSON 鍵。
  • 屬性會被歸入父元素下的 @attributes 物件中。它們絕不會以裸字串鍵的形式出現在與子元素同一層的位置。
  • 純文字元素會成為 JSON 字串。只有當元素同時擁有屬性或子元素時,文字才會被放在 #text 鍵底下。
  • 重複的同層名稱會按照文件順序成為 JSON 陣列。單一子元素則維持單一值。
  • 命名空間前綴在元素名稱與屬性名稱中都會保留(例如 soap:Body 在輸出中仍會是 soap:Body)。
  • CDATA 區段會將其文字內容貢獻給 #text 或是元素的字串值。
  • 註解與處理指令不會被複製到 JSON 輸出中。
  • 混合內容會把直接文字保留在 #text 鍵底下,子元素則按名稱保留,但文字與子元素之間的精確交錯順序不會被表示出來。

所有數值都不會被轉換成數字、布林值或 null。這是刻意的設計:像是 007 或 true 這類詞法上的 XML 文字,不該在下游消費 JSON 時被悄悄地改變語意。如果你的應用程式需要帶型別的值,請在轉換之後自行強制轉型。

比較 Python 輸出與轉換器輸出

要看出不同做法之間的差異,最清楚的方式就是看同一段簡短的 XML 片段,以及它可能對應到的三種 JSON 結果。想像一份文件,其中的 order 帶有兩個屬性、兩個重複的 item 子元素,以及一段 note:

元素或屬性Python xmltodict瀏覽器轉換器
根元素最上層鍵 order最上層鍵 order
屬性使用 @ 前綴扁平化,例如 @id歸入 @attributes 物件
重複的子元素依來源順序組成的 JSON 陣列依來源順序組成的 JSON 陣列
與子元素並存的混合文字儲存在 #text 底下儲存在 #text 底下
命名空間前綴保留保留

執行 xmltodict 會產生形如 {"order": {"@id": "42", "@status": "paid", "item": ["Book", "Pen"], "note": "Gift wrap"}} 的 OrderedDict。瀏覽器轉換器會產生相同的結構形狀,但會把屬性搬進 @attributes:{"order": {"@attributes": {"id": "42", "status": "paid"}, "item": ["Book", "Pen"], "note": "Gift wrap"}}。這個差異小卻真實存在,這也是為什麼你絕不該在沒有契約檢查的情況下,把某個工具的輸出直接餵給預期另一個工具形狀的消費者。

在 Python 與瀏覽器工具之間做選擇

當你需要自訂對應規則、需要在腳本中批次處理多個檔案、串流處理很重要,或是轉換必須在自動化管線中執行時,就選擇 Python。當你手上只有一份文件、想要一致且易於檢視的形狀,並且不想撰寫或除錯遞迴輔助函式時,就選擇瀏覽器轉換器。這兩種做法涵蓋的是同一個工作流程上的不同節點,而不是彼此競爭的方案。

無論選哪一種,請先比對你的應用程式所要求的輸出契約,再決定採用哪一個。另一個函式庫可能一律為子元素輸出陣列、保留註解、強制轉型數字與布林值,或是把命名空間拆成獨立物件——這些差異會默默地破壞那些預期你所選工具或函式庫特定形狀的消費者。

延伸閱讀:如何使用卸離的 XML 文件在 Firefox 中測試 XPath。