
本文旨在指导如何使用 php 的 `domdocument` 类生成 `sitemap.xml` 文件。教程将重点解决一个常见问题:在尝试为 xml 元素添加属性,特别是命名空间声明(如 `xmlns:xsi`)时,属性未能正确显示。我们将详细解释 `setattributenode()` 与 `setattribute()` 的区别,并提供正确的属性添加方法及完整的代码示例,确保生成的 sitemap 符合预期。
在网站优化和搜索引擎索引中,Sitemap(站点地图)扮演着至关重要的角色。它能帮助搜索引擎更高效地抓取和理解网站内容。PHP 的 DOMDocument 库提供了一套强大的工具来创建和操作 XML 文档,非常适合用于动态生成 Sitemap。
一个标准的 Sitemap XML 文件通常以 <urlset> 根元素开始,其中包含一个或多个 <url> 元素,每个 <url> 元素又包含 <loc>(页面URL)和可选的 <lastmod>(最后修改时间)等子元素。
首先,我们需要初始化 DOMDocument 对象,并设置基本的 XML 声明和格式化选项:
<?php
// 初始化 DOMDocument
$dom = new \DOMDocument('1.0', 'utf-8');
$dom->formatOutput = true; // 启用格式化输出,使XML文件更易读
// 创建 <urlset> 根元素
$urlset = $dom->createElement('urlset');
// 创建一个 <url> 元素
$url_node = $dom->createElement('url');
// 创建 <loc> 元素并设置其内容
$url_node_loc = $dom->createElement('loc', 'http://localhost/index.html');
$url_node->appendChild($url_node_loc);
// 创建 <lastmod> 元素并设置其内容
$url_node_lastmod = $dom->createElement('lastmod', '2021-08-03T22:17:47+04:30');
$url_node->appendChild($url_node_lastmod);
// 将 <url> 元素添加到 <urlset>
$urlset->appendChild($url_node);
// 将 <urlset> 元素添加到 DOM 文档
$dom->appendChild($urlset);
// 保存 XML 文件
$xml_file_name = './sitemap.xml';
$dom->save($xml_file_name);
echo "Sitemap.xml 生成成功!";
?>运行上述代码,将生成一个基础的 sitemap.xml 文件,其内容类似:
立即学习“PHP免费学习笔记(深入)”;
<?xml version="1.0" encoding="utf-8"?>
<urlset>
<url>
<loc>http://localhost/index.html</loc>
<lastmod>2021-08-03T22:17:47+04:30</lastmod>
</url>
</urlset>在标准的 Sitemap 协议中,<urlset> 元素通常需要包含一些命名空间声明,例如 xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" 和 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"。初学者在尝试添加这些属性时,可能会遇到属性未显示的问题。
一个常见的错误是使用 new DOMAttr() 创建属性节点,然后通过 setAttributeNode() 方法将其添加到元素中,尤其是在处理命名空间属性时。例如:
// 错误的属性添加方式示例
$attr_xsi = new \DOMAttr('xmlns:xsi', "http://www.w3.org/2001/XMLSchema-instance");
$urlset->setAttributeNode($attr_xsi);尽管 DOMAttr 和 setAttributeNode() 在某些场景下是有效的,但在处理简单的属性或 XML 命名空间声明时,它们可能不会像预期那样工作,或者会导致属性无法正确序列化到最终的 XML 输出中。特别是在 DOMDocument 的默认行为下,直接通过 setAttributeNode() 添加的命名空间属性可能不会被正确识别和输出。
解决上述问题的直接且推荐的方法是使用 DOMElement 类的 setAttribute() 方法。这个方法能够更简洁、更可靠地为元素添加属性,包括命名空间声明。
setAttribute() 方法的语法是 setAttribute(string $name, string $value),它直接将指定名称和值的属性添加到元素中。
以下是正确为 <urlset> 元素添加 xmlns 和 xmlns:xsi 属性的示例:
// 正确的属性添加方式
$urlset->setAttribute('xmlns', 'http://www.sitemaps.org/schemas/sitemap/0.9');
$urlset->setAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
$urlset->setAttribute('xsi:schemaLocation', 'http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd');结合上述正确属性添加方法,以下是一个完整的 PHP 代码示例,用于生成包含必要属性的 sitemap.xml 文件:
<?php
/**
* 使用 DOMDocument 生成 sitemap.xml
*/
// 1. 初始化 DOMDocument
$dom = new \DOMDocument('1.0', 'utf-8');
$dom->formatOutput = true; // 启用格式化输出,使XML文件更易读
// 2. 创建 <urlset> 根元素
$urlset = $dom->createElement('urlset');
// 3. 为 <urlset> 元素添加必要的命名空间属性
// 使用 setAttribute() 方法是推荐且可靠的方式
$urlset->setAttribute('xmlns', 'http://www.sitemaps.org/schemas/sitemap/0.9');
$urlset->setAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
$urlset->setAttribute('xsi:schemaLocation', 'http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd');
// 4. 创建并添加 <url> 元素及其子元素
// 示例:添加第一个 URL
$url_node_1 = $dom->createElement('url');
$url_node_loc_1 = $dom->createElement('loc', 'http://localhost/');
$url_node_1->appendChild($url_node_loc_1);
$url_node_lastmod_1 = $dom->createElement('lastmod', '2021-08-03T22:17:47+04:30');
$url_node_1->appendChild($url_node_lastmod_1);
$url_node_changefreq_1 = $dom->createElement('changefreq', 'daily'); // 可选:更新频率
$url_node_1->appendChild($url_node_changefreq_1);
$url_node_priority_1 = $dom->createElement('priority', '1.0'); // 可选:优先级
$url_node_1->appendChild($url_node_priority_1);
$urlset->appendChild($url_node_1);
// 示例:添加第二个 URL
$url_node_2 = $dom->createElement('url');
$url_node_loc_2 = $dom->createElement('loc', 'http://localhost/about.html');
$url_node_2->appendChild($url_node_loc_2);
$url_node_lastmod_2 = $dom->createElement('lastmod', '2021-07-20T10:00:00+04:30');
$url_node_2->appendChild($url_node_lastmod_2);
$url_node_changefreq_2 = $dom->createElement('changefreq', 'weekly');
$url_node_2->appendChild($url_node_changefreq_2);
$url_node_priority_2 = $dom->createElement('priority', '0.8');
$url_node_2->appendChild($url_node_priority_2);
$urlset->appendChild($url_node_2);
// 5. 将 <urlset> 元素添加到 DOM 文档
$dom->appendChild($urlset);
// 6. 保存 XML 文件
$xml_file_name = './sitemap.xml';
try {
$dom->save($xml_file_name);
echo "Sitemap.xml 生成成功!文件路径: " . realpath($xml_file_name) . "\n";
} catch (\Exception $e) {
echo "Sitemap.xml 生成失败: " . $e->getMessage() . "\n";
}
?>运行此代码后,生成的 sitemap.xml 文件将包含所有预期的命名空间属性,其内容应如下所示:
<?xml version="1.0" encoding="utf-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">
<url>
<loc>http://localhost/</loc>
<lastmod>2021-08-03T22:17:47+04:30</lastmod>
<changefreq>daily</changefreq>
<priority>1.0</priority>
</url>
<url>
<loc>http://localhost/about.html</loc>
<lastmod>2021-07-20T10:00:00+04:30</lastmod>
<changefreq>weekly</changefreq>
<priority>0.8</priority>
</url>
</urlset>通过本教程,我们详细探讨了使用 PHP DOMDocument 类生成 sitemap.xml 的过程,并重点解决了在为 XML 元素添加属性,特别是命名空间声明时遇到的常见问题。核心要点是,在大多数情况下,应优先使用 DOMElement::setAttribute() 方法来添加属性,因为它提供了一种简洁且可靠的方式来确保属性正确地包含在最终的 XML 输出中。掌握这一技巧,将使您能够更有效地利用 DOMDocument 构建符合搜索引擎要求的 Sitemap 文件。
以上就是使用 PHP DOMDocument 构建 Sitemap:属性添加方法详解的详细内容,更多请关注php中文网其它相关文章!
PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号