17370845950

使用Fetch API在HTML中动态获取并渲染表格数据

本教程详细介绍了如何使用JavaScript的Fetch API从远程接口获取数据,并将其动态渲染到HTML表格中。文章首先强调了理解API响应数据结构的重要性,随后对比了两种数据渲染方法:传统的DOM操作和更高效的字符串模板结合`innerHTML`,并提供了完整的代码示例和最佳实践,旨在帮助开发者高效地实现前端数据展示。

引言:理解Fetch API与数据获取

在现代Web开发中,从远程API获取数据并将其展示在网页上是一项核心任务。JavaScript的Fetch API提供了一种强大且灵活的方式来执行网络请求。它基于Promise,使得处理异步操作更加简洁。本教程将通过一个具体的例子,演示如何使用Fetch API获取数据,并将其动态渲染到一个HTML表格中。

我们将使用以下API端点作为示例:https://www.sponsorkliks.com/api/?club=11592&call=webshops_club_extension。

API数据结构解析

在开始编写代码之前,理解API返回的数据结构至关重要。一个常见的错误是直接假设API返回的数据就是我们需要的数组,而忽略了它可能被包裹在一个对象中。

对于我们示例中的API,其响应是一个JSON对象,其中包含一个名为webshops的数组。每个webshop对象都包含name_short、link、orig_url和logo_120x60等字段。

错误的初始假设(常见误区):

// 假设数据直接是数组
[
  { "name": "...", "url": "...", "logo": "..." },
  // ...
]

正确的API响应结构:

{
  "webshops": [
    {
      "id": "...",
      "name_short": "Webshop A",
      "link": "https://link.to/webshopA",
      "orig_url": "https://original.url/webshopA",
      "logo_120x60": "https://logo.url/webshopA.png",
      // ...其他字段
    },
    {
      "id": "...",
      "name_short": "Webshop B",
      "link": "https://link.to/webshopB",
      "orig_url": "https://original.url/webshopB",
      "logo_120x60": "https://logo.url/webshopB.png",
      // ...其他字段
    }
    // ...
  ]
}

因此,在处理fetch返回的JSON数据时,我们需要通过data.webshops来访问实际的列表数据,并且使用正确的字段名,如item.name_short而不是item.name。

方法一:基于DOM操作的传统渲染

这种方法通过JavaScript的document.createElement和appendChild等DOM操作方法,逐个创建HTML元素并将其添加到DOM树中。

fetch('https://www.sponsorkliks.com/api/?club=11592&call=webshops_club_extension')
  .then(response => response.json())
  .then(({ webshops }) => { // 使用解构赋值直接获取webshops数组
    const tableBody = document.querySelector('#api-table tbody');
    webshops.forEach(item => {
      const row = document.createElement('tr');

      const nameCell = document.createElement('td');
      nameCell.textContent = item.name_short; // 使用正确的字段名
      row.appendChild(nameCell);

      const urlCell = document.createElement('td');
      const urlLink = document.createElement('a');
      urlLink.href = item.link; // 使用正确的字段名
      urlLink.textContent = item.orig_url; // 使用正确的字段名
      urlCell.appendChild(urlLink);
      row.appendChild(urlCell);

      const logoCell = document.createElement('td');
      const logoImg = document.createElement('img');
      logoImg.src = item.logo_120x60; // 使用正确的字段名
      logoImg.alt = item.name_short;
      logoImg.style.maxWidth = '100px';
      logoCell.appendChild(logoImg);
      row.appendChild(logoCell);

      tableBody.appendChild(row);
    });
  })
  .catch(error => console.error('获取数据失败:', error));

优点:

  • 直观,易于理解和调试。
  • 适用于少量DOM元素的动态添加。

缺点:

  • 当需要添加大量元素时,频繁的DOM操作会导致性能问题,因为每次appendChild都可能触发浏览器重绘和回流。

方法二:利用字符串模板优化渲染性能

为了提高性能,尤其是处理大量数据时,推荐使用字符串模板(Template Literals)构建完整的HTML字符串,然后一次性通过innerHTML属性插入到DOM中。这种方法减少了与DOM的交互次数。

fetch('https://www.sponsorkliks.com/api/?club=11592&call=webshops_club_extension')
  .then(response => response.json())
  .then(({ webshops }) => { // 同样使用解构赋值
    const tableBody = document.querySelector('#api-table tbody');
    tableBody.innerHTML = webshops.map(item =>
      `
        ${item.name_short}
        ${item.orig_url}
        
          @@##@@
        
      `
    ).join(''); // 将数组中的HTML字符串拼接成一个大字符串
  })
  .catch(error => console.error('获取数据失败:', error));

优点:

  • 性能更优: 减少了DOM操作的次数,只进行一次innerHTML赋值,大大提高了渲染效率。
  • 代码简洁: 使用字符串模板使得HTML结构更清晰,更易于阅读和维护。

缺点:

  • 如果字符串拼接不当,可能存在XSS(跨站脚本攻击)风险,尤其是在渲染用户输入的内容时。务必对非信任数据进行适当的净化(sanitization)。

完整的HTML与CSS结构

为了使上述JavaScript代码能够正常运行,我们需要一个基本的HTML结构来承载表格,以及一些CSS样式来美化表格。




  
  
  API数据动态表格
  


  

API数据动态展示

名称 链接 Logo

注意事项与最佳实践

  1. 错误处理: 始终在fetch链中包含.catch()块来捕获网络错误或JSON解析错误。同时,检查response.ok状态可以捕获HTTP协议层面的错误(如404, 500)。
  2. API响应结构: 在编写代码之前,通过浏览器开发者工具或Postman等工具检查API的实际响应结构,确保正确访问数据字段。
  3. 异步操作: fetch是异步的。这意味着它不会立即返回数据,而是返回一个Promise。所有依赖于API数据的操作都应该放在.then()回调中。
  4. DOM操作性能: 当处理大量数据时,尽量减少直接的DOM操作。使用字符串模板结合innerHTML通常是更高效的选择。
  5. 安全性: 如果API返回的数据可能包含用户生成的内容,并且您使用innerHTML来渲染,请务必对内容进行适当的净化处理,以防止XSS攻击。
  6. 用户体验: 在数据加载过程中,可以显示加载指示器(如“加载中...”文本或旋转图标),提高用户体验。当数据加载失败时,也应提供友好的错误提示。
  7. CSS样式: 适当的CSS样式可以使表格更具可读性和专业性。

总结

通过本教程,我们学习了如何使用JavaScript的Fetch API从远程接口获取JSON数据,并将其动态渲染到HTML表格中。我们强调了理解API响应结构的重要性,并对比了两种数据渲染方法:传统的DOM操作和更高效的字符串模板结合innerHTML。在实际开发中,推荐使用后者来优化性能,并始终牢记错误处理和安全性等最佳实践,以构建健壮且用户友好的Web应用。