萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

PHP XML 解析器類:SimpleXML 封裝、格式驗證、對象轉數組

一、設計目標

提供統一的 XML 解析介面,支持文件與字符串輸入,內建格式驗證,自動將 SimpleXMLElement 對象轉換為純數組,便於業務邏輯處理。

二、XMLParser 類實現

<?php
/**
 * XMLParser - XML 文件/字符串解析類
 * 依賴:SimpleXML, libxml (PHP 內建)
 */
class XMLParser {
    /** 從文件載入並解析
     * @param string $xmlfile XML 文件路徑
     * @return array [bool $success, array $data]
     */
    public function loadXmlFile($xmlfile) {
        $xmlstring = file_exists($xmlfile) ? file_get_contents($xmlfile) : '';
        list($flag, $data) = $this->parser($xmlstring);
        return $this->response($flag, $data);
    }

    /** 從字符串載入並解析
     * @param string $xmlstring XML 內容
     * @return array [bool $success, array $data]
     */
    public function loadXmlString($xmlstring) {
        list($flag, $data) = $this->parser($xmlstring);
        return $this->response($flag, $data);
    }

    /** 核心解析邏輯 */
    private function parser($xmlstring) {
        $flag = false;
        $data = [];
        
        if ($this->checkXmlFormat($xmlstring)) {
            $flag = true;
            // LIBXML_NOCDATA: 將 CDATA 節點作為文本節點處理
            $obj = simplexml_load_string($xmlstring, 'SimpleXMLElement', LIBXML_NOCDATA);
            if ($obj !== false) {
                $this->objectToArray($obj);
                $data = (array)$obj;
            }
        }
        return [$flag, $data];
    }

    /** XML 格式驗證(基於 XMLParser) */
    private function checkXmlFormat($xmlstring) {
        if ($xmlstring === '') return false;
        
        $parser = xml_parser_create();
        // xml_parse_into_struct 返回 1 成功、0 失敗
        $result = xml_parse_into_struct($parser, $xmlstring, $vals, $indexs);
        xml_parser_free($parser);
        
        return $result === 1;
    }

    /** SimpleXMLElement 遞歸轉數組(引用傳遞) */
    private function objectToArray(&$object) {
        $object = (array)$object;
        foreach ($object as $key => &$value) {
            if ($value === '') {
                $value = '';
            } elseif (is_object($value) || is_array($value)) {
                $this->objectToArray($value);
                $object[$key] = $value;
            }
        }
    }

    /** 統一響應格式 */
    private function response($flag = false, $data = []) {
        return [$flag, $data];
    }
}
?>

三、使用示例

1. 解析 XML 文件

<?php
require 'XMLParser.class.php';

$parser = new XMLParser();
// 假設 data.xml 內容:
// 
// 
//   
//     
//     zhang@example.com
//     
//       admin
//       editor
//     
//   
// 

list($success, $data) = $parser->loadXmlFile('data.xml');

if ($success) {
    print_r($data);
    /* 輸出:
    Array
    (
        [user] => Array
            (
                [@attributes] => Array ( [id] => 1 )
                [name] => 張三
                [email] => zhang@example.com
                [roles] => Array
                    (
                        [role] => Array ( [0] => admin, [1] => editor )
                    )
            )
    )
    */
} else {
    echo "XML 格式錯誤或文件不存在";
}
?>

2. 解析 XML 字符串(API 響應處理)

<?php
$xmlString = '200成功';
list($ok, $data) = $parser->loadXmlString($xmlString);
if ($ok) {
    echo $data['code']; // 200
}
?>

四、關鍵特性與注意事項

特性實現細節注意點
CDATA 處理LIBXML_NOCDATA 選項CDATA 內容直接作為文本值,無 標記
屬性保留@attributes 鍵存儲同名子元素與屬性不衝突
同名元素自動轉為數值索引數組單個元素也是數組,需判斷 count()
命名空間SimpleXML 原生支持需用 children('ns', true) 訪問
編碼處理依賴 XML 聲明 encoding無聲明默認 UTF-8,異常編碼需預轉換
大文件SimpleXML 全量載入內存大文件改用 XMLReader (SAX 流式)

五、進階:XMLReader 流式解析(大文件)

<?php
function parseLargeXml($file) {
    $reader = new XMLReader();
    $reader->open($file);
    
    $data = [];
    while ($reader->read()) {
        if ($reader->nodeType === XMLReader::ELEMENT && $reader->localName === 'user') {
            // 展開當前節點為 SimpleXMLElement
            $userXml = $reader->expand();
            $user = [];
            $user['id'] = (string)$userXml['id'];
            $user['name'] = (string)$userXml->name;
            $data[] = $user;
        }
    }
    $reader->close();
    return $data;
}
?>

六、XML 生成對應:ArrayToXml

<?php
function arrayToXml(array $data, $root = 'xml', $xml = null) {
    if ($xml === null) {
        $xml = new SimpleXMLElement("<$root/>");
    }
    foreach ($data as $key => $value) {
        if (is_array($value)) {
            $child = $xml->addChild($key);
            arrayToXml($value, $key, $child);
        } else {
            $xml->addChild($key, $value);
        }
    }
    return $xml->asXML();
}

// 使用
$arr = ['user' => ['id' => 1, 'name' => '李四']];
echo arrayToXml($arr, 'response');
?>

七、現代替代方案

  • symfony/serializer:支持 XML/JSON/YAML 雙向轉換、規範化、類型轉換
  • jms/serializer:註解驅動、版本控制、排除策略
  • laminas/laminas-xml2json:XML ↔ JSON 無損轉換

XMLParser 類封裝了驗證、解析、轉換的標準流程,適合中小型 XML 數據交換場景;大文件、高併發、複雜 Schema 驗證場景請選用 XMLReader 或專業序列化庫。

copyright © 萬盛學電腦網 all rights reserved