Python改寫maven的pom.xml檔案

weixin_33724059發表於2018-04-29
PythonMavenXML

前陣子工作中用Python對xml格式的配置檔案的內容進行修改，使用的模組是Python內建的xml.etree.cElementTree。然後修改maven的pom.xml的時候遇到2個問題，在這裡分享下遇到的坑。
以改下面中的pom.xml為例：

<?xml version='1.0' encoding='utf-8'?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>javaTest</groupId>
    <artifactId>javatest</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.9</version>
        </dependency>
        <dependency>
            <groupId>org.testng</groupId>
            <artifactId>testng</artifactId>
            <version>6.9</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

現在需要改檔案中的testng的版本號，因為pom.xml中的標籤均沒有屬性，所以只能通過標籤的內容來定位標籤。思想是：首先先定位內容為testng的artifactId標籤，那麼該標籤的後繼兄弟標籤即為version標籤，其中的內容即為我們要改掉的版本號。
python程式碼如下：

# coding: utf-8
import xml.etree.cElementTree as ET
import re

class ConfigXMLFile(object):

    def __init__(self, file):
        self.config = file  # 配置檔案path
        self.tree = None

    def readXML(self, type):
        '''
        讀取並解析xml檔案
        return: ElementTree
        '''
        self.tree = ET.ElementTree()
        self.tree.parse(self.config)

    def writeXML(self, out_path):
        '''
        將xml檔案寫出
        out_path: 寫出路徑
        '''
        self.tree.write(out_path, encoding="utf-8", xml_declaration=True)

    def configPOMVer(self, artifactId, version, out_path):
        '''
        修改pom中的依賴包的version
        :param artifactId: artifactId
        :param version: version
        :param out_path: 修改後的配置檔案路徑
        :return:
        '''
        pre_sibling = None
        root = self.tree.getroot()  # 根node
        for child in root.iter("dependency"):
            for sub_child in child:
                if sub_child.text == artifactId:
                    pre_sibling = sub_child
                if sub_child.tag == "version" and pre_sibling is not None:
                    sub_child.text = version
                    self.writeXML(out_path)  # 修改version
                    print("修改" + str(artifactId) + "的version為:" + str(version))
                    return

        if pre_sibling is None:
            print("Error: 沒找到對應結點!\n")
            print(" ")

if __name__ == "__main__":
    pom_config = r"E:\llf_test\llf_java\pom.xml"
    artifactId = "testng"
    version = "6.10"
    # 修改pom.xml
    pom_xml = ConfigXMLFile(pom_config)
    pom_xml.readXML("pom")
    pom_xml.configPOMVer(artifactId, version, pom_config)
    print("修改pom.xml完成！")

執行程式碼後報錯，提示找不到標籤。找原因找了好久，後來網上搜答案，看到一個老外在stack overflow上同樣提出了這個問題，後來他自己找到了答案。我們回頭再看pom.xml，根標籤為project。我們在程式碼裡看下根標籤是不是project。

def getRootTag(self):
        root = self.tree.getroot()  # 根node
        print(root.tag)

執行結果為：

{http://maven.apache.org/POM/4.0.0}project

好奇怪，根元素是“{http://maven.apache.org/POM/4.0.0}project”。
我們再來看下檔案中根元素的孩子元素的標籤是什麼？

def getChildrenOfRoot(self):
        root = self.tree.getroot()
        for child in root:
            print(child.tag)

執行結果為：

{http://maven.apache.org/POM/4.0.0}modelVersion
{http://maven.apache.org/POM/4.0.0}groupId
{http://maven.apache.org/POM/4.0.0}artifactId
{http://maven.apache.org/POM/4.0.0}version
{http://maven.apache.org/POM/4.0.0}dependencies

同樣，所有標籤都有字首“{http://maven.apache.org/POM/4.0.0}”。回過頭再看pom.xml，發現根元素project標籤有一些屬性：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

這個xmlns是xml檔案的名稱空間的概念，搜了下概念引用如下：

XML Namespace (xmlns) 屬性
XML 名稱空間屬性被放置於元素的開始標籤之中，並使用以下的語法：
xmlns:namespace-prefix="namespaceURI"
當名稱空間被定義在元素的開始標籤中時，所有帶有相同字首的子元素都會與同一個名稱空間相關聯。
預設的名稱空間（Default Namespaces）
為元素定義預設的名稱空間可以讓我們省去在所有的子元素中使用字首的工作。使用語法如下：
xmlns="namespaceURI"

所以，pom.xml裡每個元素的字首{http://maven.apache.org/POM/4.0.0}即為namespaceURI，我們看pom中project的屬性xmlns="http://maven.apache.org/POM/4.0.0"，從這裡可以知道，namespace-prefix是沒有的。
因為我們的目的是改掉檔案的內容，現在找不到標籤，發現所有標籤都有namespaceURI，那我們就把程式碼中我們要定位的標籤名前加上namespaceURI就好了。程式碼如下：

def configPOMVer(self, artifactId, version, out_path):
        '''
        修改pom中的依賴包的version
        :param name: 服務名
        :param host: 服務host
        :param out_path: 修改後的配置檔案路徑
        :return:
        '''
        pre_sibling = None
        root = self.tree.getroot()  # 根node
        pre = (re.split('project', root.tag))[0]  # 獲取pom元素tag的pre

        for child in root.iter(pre + "dependency"):
            for sub_child in child:
                if sub_child.text == artifactId:
                    pre_sibling = sub_child
                if sub_child.tag == (pre + "version") and pre_sibling is not None:
                    sub_child.text = version
                    self.writeXML(out_path)  # 修改version
                    print("修改" + str(artifactId) + "的version為:" + str(version))
                    return

        if pre_sibling is None:
            print("Error: 沒找到對應結點!\n")
            print(" ")

執行程式，輸出結果：

修改testng的version為:6.10
修改pom.xml完成！

看來是ok了，我們去瞄一眼改過的pom.xml檔案。

<?xml version='1.0' encoding='utf-8'?>
<ns0:project xmlns:ns0="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <ns0:modelVersion>4.0.0</ns0:modelVersion>

    <ns0:groupId>javaTest</ns0:groupId>
    <ns0:artifactId>javatest</ns0:artifactId>
    <ns0:version>1.0-SNAPSHOT</ns0:version>
    <ns0:dependencies>
        <ns0:dependency>
            <ns0:groupId>com.alibaba</ns0:groupId>
            <ns0:artifactId>fastjson</ns0:artifactId>
            <ns0:version>1.2.9</ns0:version>
        </ns0:dependency>
        <ns0:dependency>
            <ns0:groupId>org.testng</ns0:groupId>
            <ns0:artifactId>testng</ns0:artifactId>
            <ns0:version>6.10</ns0:version>
            <ns0:scope>test</ns0:scope>
        </ns0:dependency>
    </ns0:dependencies>

</ns0:project>

尼瑪！檔案中所有標籤都加了個字首ns0，這個ns0就是namespace-prefix。為什麼會這裡會出現ns0，這跟xml.etree.cElementTree模組本身有關。解決方法是使用xml.etree.ElementTree.register_namespace(prefix,uri)方法，去重新定義我們的namespace-prefix，否則的話會預設將namespace-prefix設定為ns0。我們看下該方法的官方說明：

"""Register a namespace prefix.

    The registry is global, and any existing mapping for either the
    given prefix or the namespace URI will be removed.

    *prefix* is the namespace prefix, *uri* is a namespace uri. Tags and
    attributes in this namespace will be serialized with prefix if possible.

    ValueError is raised if prefix is reserved or is invalid.

    """

這裡的prefix即為namespace-prefix，url即為namespaceURI。
這裡我們試驗一下，設定這2個變數的值如下：

def readXML(self, type):
        '''
        讀取並解析xml檔案
        return: ElementTree
        '''
        self.tree = ET.ElementTree()
        if type == "pom":
            XML_NS_NAME = "hello"
            XML_NS_VALUE = "http://maven.apache.org/POM/4.0.0"
            ET.register_namespace(XML_NS_NAME, XML_NS_VALUE)
        self.tree.parse(self.config)

執行後，檢視pom.xml檔案內容：

<?xml version='1.0' encoding='utf-8'?>
<hello:project xmlns:hello="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <hello:modelVersion>4.0.0</hello:modelVersion>

    <hello:groupId>javaTest</hello:groupId>
    <hello:artifactId>javatest</hello:artifactId>
    <hello:version>1.0-SNAPSHOT</hello:version>
    <hello:dependencies>
        <hello:dependency>
            <hello:groupId>com.alibaba</hello:groupId>
            <hello:artifactId>fastjson</hello:artifactId>
            <hello:version>1.2.9</hello:version>
        </hello:dependency>
        <hello:dependency>
            <hello:groupId>org.testng</hello:groupId>
            <hello:artifactId>testng</hello:artifactId>
            <hello:version>6.10</hello:version>
            <hello:scope>test</hello:scope>
        </hello:dependency>
    </hello:dependencies>

</hello:project>

哈哈，看到沒，標籤前的ns0換為hello了。前面提到，pom.xml中project的屬性xmlns="http://maven.apache.org/POM/4.0.0"是沒有設定namespace-prefix的
，所以這裡就將XML_NS_NAME賦值為空字串就好，如下：

def readXML(self, type):
    '''
    讀取並解析xml檔案
    return: ElementTree
    '''
    self.tree = ET.ElementTree()
    if type == "pom":
        XML_NS_NAME = ""
        XML_NS_VALUE = "http://maven.apache.org/POM/4.0.0"
        ET.register_namespace(XML_NS_NAME, XML_NS_VALUE)
    self.tree.parse(self.config)

執行後，檢視pom.xml：

<?xml version='1.0' encoding='utf-8'?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>javaTest</groupId>
    <artifactId>javatest</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.9</version>
        </dependency>
        <dependency>
            <groupId>org.testng</groupId>
            <artifactId>testng</artifactId>
            <version>6.10</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

ok，這下標籤沒有字首了。
最後總結下，因為pom.xml有名稱空間，所以改該類檔案需要注意兩點，
1、遍歷標籤時，標籤名前要加字首。
2、解析檔案時，記得設定環境變數XML_NS_NAME和XML_NS_VALUE，這裡pom.xml的namespace-prefix沒有，所以XML_NS_NAME設定為“”。
希望我遇到的這2個坑，對相關同學有所幫助。

相關文章