整合营销服务商

电脑端+手机端+微信端=数据同步管理

免费咨询热线:

「原生案例」如何在JavaScript中实现实时搜索功能

载说明:原创不易,未经授权,谢绝任何形式的转载

在当今充满活力的网络开发领域中,实现强大的搜索功能是一个关键特性,可以极大地增强用户体验,并使浏览大型数据集变得轻松自如。如果您想要为您的网站或网络应用程序添加实时搜索功能,那么您来对地方了。本篇全面的文章将探讨使用JavaScript实现实时搜索功能的方方面面。

无论您是经验丰富的开发人员还是刚开始编码之旅的新手,本文旨在为您提供一般编码知识和工具,以便将实时搜索功能融入到您的项目中。通过本指南的学习,您将对相关概念和技术有扎实的理解,从而能够创建响应式和交互式的搜索功能,实现用户输入时动态更新的效果。

为了有效地跟随本指南,建议您对HTML、CSS和JavaScript的基本知识有扎实的理解。熟悉DOM操作和事件处理将有助于我们深入了解实现细节。然而,即使您对JavaScript或Web开发相对较新,本指南的结构也旨在提供清晰的解释和逐步的说明,使其适用于不同技能水平的学习者。

现在,为了更好地理解这个功能的重要性和使用方法,我们将创建一个非常基本的项目作为示例;更具体地说,一个如下所示的电影应用程序:

您可以在这里查看实时实施情况。

https://search-movies-live.netlify.app/

在这个项目中,我们将利用实时搜索功能来搜索电影数据库中的电影列表。我知道你迫不及待地想要开始了,我们马上就会开始。但首先,让我们更多地了解一下实时搜索功能及其重要性。

实时搜索功能的重要性

在当今数字化的环境中,实时搜索功能变得至关重要,满足了高效信息检索的需求,提升了整体用户体验。通过在用户输入时实时更新搜索结果,实时搜索提供即时反馈,便于快速获取相关信息。这种动态交互式的搜索功能带来了许多好处,使用户和网站所有者受益。

  • 改进的用户体验:实时搜索通过提供无缝和直观的搜索过程显著提升了用户体验。当用户开始输入查询时,搜索结果会实时更新,提供即时反馈,消除了手动提交或页面刷新的需求。这种互动性节省了用户宝贵的时间和精力,从而实现了更高效和令人满意的搜索体验。
  • 更快的信息检索:通过实时搜索,用户可以快速找到所需的信息,无需浏览多个页面或等待搜索结果加载。随着用户的输入,搜索结果立即缩小范围,显示相关建议,无需输入完整的搜索查询。这种速度和响应能够使用户在传统搜索方法所需时间的一小部分内找到他们想要的内容。
  • 增加参与度和转化率:实时搜索的无缝和响应性特性鼓励用户更积极地与网站或网络应用程序互动。提供即时反馈和相关建议可以保持用户的参与度,减少跳出率和沮丧感的可能性。这种增加的参与度可以提高转化率,因为用户更有可能进一步探索网站并将他们的搜索意图转化为行动。
  • 增强的过滤和细化功能:实时搜索功能通常包括额外的功能,如过滤器、建议和自动完成选项。这些功能帮助用户细化搜索并缩小结果范围,使他们能够找到他们想要的内容。通过提供这些工具,实时搜索不仅改善了搜索体验,还帮助用户发现可能一开始没有考虑到的相关内容或产品。
  • 网站所有者的宝贵见解:实时搜索功能可以为用户行为和偏好提供宝贵的见解。通过分析搜索查询和模式,网站所有者可以更好地了解用户的需求,识别流行趋势或话题,并在内容创作、产品提供或用户界面改进方面做出明智决策。这些见解使网站所有者能够根据用户需求量身定制自己的产品,从而提高客户满意度和业务增长。

设置HTML结构

既然我们已经完全了解了实时搜索功能以及它的重要性,那么让我们深入探讨一下如何在您自己的项目中实现这个功能。

首先,让我们建立项目的结构。对于这个项目,我们只需要三个文件,即HTML、CSS和JavaScript文件。

现在让我们开始设置项目的HTML结构:在HTML文件中,我们首先需要包含我们的标准HTML样板,包括链接和脚本到我们的CSS和JS文件中:

<!doctype html>
<html lang="en">
 <head>
   <meta charset="UTF-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <link rel="stylesheet" href="./live-search.css" />
   <title> </title>
 </head>
 <body>
   <script src="./live-search.js"></script>
 </body>
</html>

现在在 body 标签中,我们包含了 header 和 main 语义标签。在 header 标签内,我们设置了项目的标题部分,这里只包括应用程序的名称和一个视频图标。

<header>
 <ion-icon name="videocam"></ion-icon>
 <h1>Search Movies</h1>
</header>

在我们继续讲解 main 标签之前,在 body 标签的末尾,让我们包含所需的 script 标签,以便能够使用这些图标:

<script
 type="module"
 src="https://unpkg.com/ionicons@7.1.0/dist/ionicons/ionicons.esm.js"
></script>
<script
 nomodule
 src="https://unpkg.com/ionicons@7.1.0/dist/ionicons/ionicons.js"
></script>

您可以在Ionicons网站上找到这些图标。

https://ionic.io/ionicons

现在,在 main 标签内,我们将包含我们的第一个 div 标签,这将是我们的搜索栏容器,在其中,我们放置我们的搜索输入标签和一个搜索图标:

<div id="search-container">
 <ion-icon name="search-outline"></ion-icon>
 <input type="search" id="search-bar" placeholder="Search movies..." />
</div>

然后,我们将在这个“div”下面创建另一个 div 标签。这将包含所有电影数据的结果:

<div id="results-container"></div>

我们暂时将其留空,因为其内容将在JavaScript部分生成。

最后,在 main 标签中,我们将包含一个 p 标签。这个标签只是为了在稍后向用户显示错误或空消息的响应。

<p id="movie-unavailable-txt"></p>

这就是HTML文件的全部内容,整体代码应该是这样的:

<!doctype html>
<html lang="en">
 <head>
   <meta charset="UTF-8" />
   <meta http-equiv="X-UA-Compatible" content="IE=edge" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <link rel="stylesheet" href="./live-search.css" />
   <title>Live Search Functionality</title>
 </head>
 <body>
   <header>
     <ion-icon name="videocam"></ion-icon>
     <h1>Search Movies</h1>
   </header>

   <main>
     <div id="search-container">
       <ion-icon name="search-outline"></ion-icon>
       <input type="search" id="search-bar" placeholder="Search movies..." />
     </div>

     <div id="results-container"></div>

     <p id="movie-unavailable-txt"></p>
   </main>

   <script src="./live-search.js"></script>
   <script
     type="module"
     src="https://unpkg.com/ionicons@7.1.0/dist/ionicons/ionicons.esm.js"
   ></script>
   <script
     nomodule
     src="https://unpkg.com/ionicons@7.1.0/dist/ionicons/ionicons.js"
   ></script>
 </body>
</html>

既然我们已经完成了项目的HTML结构的实现,那么让我们给页面添加一些样式。

为页面添加样式

在这个部分,我们将为页面的各个部分添加基本的样式。所以让我们开始吧。首先,让我们为页面的整体部分添加一些常规样式:

html{
 scroll-behavior: smooth;
 background-color: #111;
 color: whitesmoke;
}

*{
 margin: 0;
 padding: 0;
 box-sizing: border-box;
}

现在让我们为头部部分及其内容添加一些样式:

header{
 display: flex;
 justify-content: center;
 padding: 25px;
 letter-spacing: 2px;
 position: sticky;
 top: 0%;
 z-index: 2;
 border-bottom: 2px solid ;
 background-color: black;
 text-shadow: 3px 3px 5px #fd1d6b;   
 box-shadow: 10px 10px 20px -10px #fd1d6b; 
}

header > ion-icon{
 color:#fd1d6b;
 font-size: 60px;
 position: absolute;
 left: 5%;
}

接下来,我们开始对搜索容器及其内容进行样式设置:

#search-container{
 display: flex;
 justify-content: center;
 padding: 20px;
 margin-bottom: 20px;
 position: sticky;
 top: 100px;
}

#search-bar{
 border: none;
 width: 60%;
 padding: 15px;
 padding-left: 40px;
 border-radius: 15px;
 font-size: 15px;
}

#search-container>ion-icon{
 color: gray;
 position: relative;
 left: 30px;
 top: 13px;
 z-index: 3;
 font-size: 19px;
}

之后,我们继续设计将来从电影数据库中获取的所有电影的 results-container 的样式

#results-container{
 border-right: 5px solid #fd1d6b;
 border-left: 5px solid #fd1d6b;     
 border-radius: 25px;
 display: flex;
 justify-content: center;
 flex-wrap: wrap;
 width: 90vw;
}

接下来,我们在 movie-unavailable-txt 中添加样式,同时将 display 设置为 none ,因为我们暂时不希望它可见

#movie-unavailable-txt{
 text-align: center;
 letter-spacing: 2px;
 display: none;
 margin-top: 15%;
 text-shadow: 3px 3px 5px #fd1d6b;
}

接下来,我们将为一些尚未声明但将通过JavaScript创建的元素添加一些样式。这是电影卡片,将显示电影的详细信息,包括电影图片和标题:

.movie-cards{
 padding: 25px;
 max-width: 250px;
 border-radius: 15px;
 display: grid;
 place-items: center;
 box-shadow: 1px 1px 20px -1px #fd1d6b ;
 margin: 50px;
}

.title{
 margin: 20px auto;
 text-align: center;
 font-size: 1.2rem;
 text-shadow: 3px 3px 5px #fd1d6b;  
}

.date{
 margin-top: 15px;
 font-size: 0.8rem;
 text-shadow: 3px 3px 5px #fd1d6b;  
}

.movie-image{
 width: 90%;
 max-width: 400px;
 object-fit: contain;
 border-radius: 5px;
}

既然我们已经完成了页面的样式,那么让我们继续进行最有趣和最重要的部分,即Javascript的实现。

向电影数据库API发送异步搜索请求

在本节中,我们将调用我们选择的电影数据库API来填充我们的页面,展示各种电影。在这种情况下,我将使用RapidAPI Hub中的IMDb Top 100 Movies免费电影API。在API页面中,我们选择要使用的特定数据,然后复制页面右侧提供的javascript(fetch)代码,如下所示:

https://rapidapi.com/rapihub-rapihub-default/api/imdb-top-100-movies

首先,在您使用API之前,请先订阅它(无需信用卡),以便为您生成一个API密钥。您可以在API的定价页面上进行订阅。

继续,我们进入我们的空的JavaScript文件,并将我们复制的代码粘贴进去:

const url = "https://imdb-top-100-movies.p.rapidapi.com/";
const options = {
 method: "GET",
 headers: {
   "X-RapidAPI-Key": "YOUR GENERATED API KEY",
   "X-RapidAPI-Host": "imdb-top-100-movies.p.rapidapi.com",
 },
};

try {
 const response = await fetch(url, options);
 const result = await response.text();
 console.log(result);
} catch (error) {
 console.error(error);
}

既然我们已经将电影数据库的API引入到我们的项目中,我们可以使用它的数据了。接下来,我们将声明一些我们需要的变量,并将它们放在我们复制的代码中 try 块的上方。

const searchBar = document.getElementById("search-bar");
const resultsContainer = document.getElementById("results-container");
const movieUnavailableTxt = document.getElementById("movie-unavailable-txt");
let movieList;
let searchValue;
let searchedMovies;

我们正在接近刚刚创建的这些变量的目的,坚持住。

接下来,我们对复制的代码中的 try 块进行一些更改,因为我们希望将其与我们的项目完全集成。所以首先,我们需要创建一个异步函数:

const fetchMovies = async () => {
 // try catch block goes in here.
};

在这个函数内部,我们将放置从我们复制的代码中的整个 try catch 块,以便我们可以进行异步API调用。

在 try 块内,我们将删除 console.log(result) 行,并将 result 变量更改为先前声明的 movieList 变量,并将同一行中的 response.text() 更改为 response.json() 。这样,我们从API调用中接收到的数据将以 JSON 格式呈现,这是我们所需的。因此,该行现在应该是这样的

movieList = await response.json();

现在我们已经成功从API中获取了电影并返回了我们的数据集,我们需要将这些数据填充到我们的页面中。为此,我们将调用 renderMovies() 函数,并将参数设置为从API调用中获取的数据。不用担心,我们很快就会创建这个函数:

renderMovies(movieList);

现在让我们创建 renderMovies 函数,这个函数刚刚在 fetchMovies() 函数中调用过,这个函数将用于创建动态电影卡片模板,我们之前在CSS文件中设置了样式,模板中的每个元素的内容都将设置为从API获取的数据,这样我们就可以使用相同的模板渲染不同的电影。然后,我们将把电影卡片放在 resultsContainer 元素中。每次调用函数时,我们需要清除 resultsContainer ,并将 moviesUnavailableTxt 设置为 display="none" ,因为我们希望在渲染电影到页面时文本不可见,同时清除 moviesReturnedOnSearch 数组,然后将从搜索输入字段返回的新数据设置到其中。

const renderMovies = (movies) => {
 resultsContainer.innerHTML = ""; // Clear the existing movies
 movieUnavailableTxt.style.display = "none"; // Hide the "No movies found" message
 moviesReturnedOnSearch = []; // Clear the movies returned on search array

 movies.forEach((movie) => {
   resultsContainer.innerHTML += `
     <div class="movie-cards">
       <img src="${movie.image}" alt="movie image" class="movie-image" />
       <h2 class="title">${movie.title}</h2>
       <p class="plot">${movie.description}</p>
       <p class="date">${movie.year}</p>
     </div>
   `;

   moviesReturnedOnSearch.push(movie); // Add the movies that are a result to the search input value
 });
};

捕捉用户输入并实时显示电影搜索结果

现在我们已经将所有电影数据加载到我们的页面上,接下来是真正有趣的部分,我们要实现实时搜索功能,所以,不浪费时间,让我们开始吧。

为了捕获用户输入,我们将使用 input 事件监听器,并将其链接到 searchBar 元素。我们使用这个特定的事件监听器,因为它可以捕获搜索框内的每一个活动,包括输入、清除和粘贴,这正是我们想要的。所以让我们继续创建它:

searchBar.addEventListener("input", (event) => {
 // live functionality code
});

好的,现在我们已经将事件监听器链接到搜索栏,以便监听用户的任何输入。在第二个参数中,我们添加了事件处理程序,这是每当搜索栏有输入时将被调用的函数。现在,在该函数内部,我们将编写处理实时搜索的代码。

在搜索功能中,我们需要做的第一件事是编辑从用户那里获取到的输入值,并将其转换为全小写,同时去除任何不必要的空格:

searchValue = event.target.value.trim().toLowerCase();

在那之后,我们继续根据用户的搜索输入,通过检查用户输入的电影标题是否包含在 movieList 数据中的任何电影标题中,并将电影标题设置为小写以与用户输入匹配,来在页面上按标题筛选电影

const filteredMovies = movieList.filter( (movie) => movie.title.toLowerCase().includes(searchValue) );

接下来,我们将通过再次调用 renderMovies() 函数,并将参数设置为 filtered Movies 变量的值,来显示与用户在搜索栏中输入的字符匹配的电影标题的实时搜索结果。

renderMovies(filteredMovies);

通过调用此函数,它仅将与搜索栏中键入的字符匹配的电影渲染到页面上,使用函数中提供的电影卡片模板,同时将每个匹配的电影添加到 moviesReturnedOnSearch 数组中,以便我们可以跟踪每个字符输入的匹配搜索值的电影数量。在处理空响应错误时,这将非常有用,现在我们将进入这个部分。

处理空或错误响应

在任何应用程序中,有效处理空或错误的响应至关重要。在这种情况下,这些情景可能发生在搜索查询没有结果或API请求存在问题时。

处理错误或空响应时,向用户提供清晰的反馈是至关重要的。话虽如此,由于这是一个相对简单的应用程序,我们不必过多担心错误,因为我们只需要处理由API引起的错误。例如,API服务可能暂时不可用,或者应用程序可能刚刚超过了请求限制。为了处理这个错误,我们只需要将 movieUnavailableTxt 元素的 display 设置为 block ,并将 innerHTML 设置为向用户显示错误消息,并将其放置在 fetchMovies() 函数的 catch 块中。因此,现在 catch 块的代码如下所示:

catch (error) {
 movieUnavailableTxt.innerHTML = 'An error occurred while fetching movies. <br /> Please try again later.';
 movieUnavailableTxt.style.display = "block";
 console.error(error);
}

现在我们已经处理完错误响应,接下来我们要处理空响应。如果用户搜索的电影与页面上的任何电影都不匹配,我们需要向用户提示所搜索的电影不可用。为了做到这一点,首先我们需要检查之前声明的 moviesReturnedOnSearch 数组的内容,如果数组的长度小于或等于0,我们将设置 movieUnavailableTxt 元素的 display 为 block ,并将 innerHTML 设置为空响应消息,如下所示:

if (moviesReturnedOnSearch.length <= 0) {
 movieUnavailableTxt.innerHTML = "OOPS! <br/><br/> Movie not available";
 movieUnavailableTxt.style.display = "block"; // Show the "No movies found" message if no movies match the search
}

我们将把这个 if 块放在 searchBar 事件处理程序的闭合括号之前。

通过缓存提高搜索性能

在使用API实现实时搜索功能时,提高性能的一种有效技术是缓存。缓存涉及存储先前获取的搜索结果,并在再次请求相同的搜索查询时重复使用它们。这可以显著减少API调用的次数,有助于防止超过API的请求限制,并改善搜索功能的响应速度以及网站的加载时间。

要在我们的项目中实现缓存,首先,我们需要确定哪些项目需要被缓存,而在这种情况下,那将是 movieList 变量的值,它是我们从 fetch API请求中得到的 JSON 格式的数据。通过缓存这个项目,我们将能够在页面重新加载时使用API的数据,而无需进行额外的 fetch 请求。但是对于这个项目,我们将为我们的缓存数据设置一个过期时间,为6小时,这意味着页面每6小时只会进行一次API请求,而不是在每次页面重新加载时都进行请求。这样做是为了保持页面的数据新鲜和最新,同时将API请求保持在最低限度。

回到我们的代码中,现在我们需要将数据存储在浏览器的本地存储中,但为了做到这一点,我们需要首先将其转换为一个 string ,并设置一个键名,用于在本地存储中标识数据。让我们将其设置为 movieData ,如下所示:

localStorage.setItem("moviedata", JSON.stringify(movieList));

接下来我们需要将当前日期和时间存储在本地存储中:

localStorage.setItem("cacheTimestamp", Date.now());

这将当前日期和时间以毫秒为单位存储,键名为 cacheTimeStamp 。

我们将把这两行代码放在 try 块的 fetchMovies() 函数中,就在 movieList 变量的下方。

接下来,在 fetchMovies() 函数之外,紧接着 renderMovies() 函数的下方,我们将把缓存数据的过期时间设置为6小时(以毫秒为单位)

const expirationDuration = 21600000; // 6 hours in milliseconds

之后,我们需要取回之前在本地存储中设置的 cacheTimestamp

const cacheTimestamp = localStorage.getItem("cacheTimestamp");

现在,我们将检查缓存数据是否已过期或不可用,这意味着它尚未被存储。如果是这种情况,我们将通过调用 fetch 函数向API发出新的请求。另一方面,如果缓存数据存在且尚未过期,我们将使用它来渲染页面上的电影,而不是再次发出新的 fetch 请求。我们通过检索缓存的电影数据并将其解析回 JSON 格式来使用,然后将参数设置为从缓存中获取的数据,调用 render 函数来实现这一点。

// Check if cache has expired or data is not available
if (
 !cacheTimestamp ||
 Date.now() - parseInt(cacheTimestamp) > expirationDuration
) {
 // Cache expired or data not available, fetch movies again
 fetchMovies();
} else {
 // Use cached movie data
 movieList = JSON.parse(localStorage.getItem("moviedata"));
 renderMovies(movieList);
}

在 if 语句中, !cacheTimestamp 检查 cacheTimestamp 变量是否为假值,意味着它可以是 null 、 undefined 、0、 false 或空字符串。如果 cacheTimestamp 为假,表示没有存储现有缓存时间戳。 Date.now() - parseInt(cacheTimestamp) 计算当前时间戳与解析的 cacheTimestamp 的整数值之间的时间差。简单来说,这就是说:“当前时间的值减去我们之前存储在缓存中的时间的值,是否大于我们设置的过期时间?如果是,就从API中重新获取电影数据;如果不是,就使用缓存的数据。”

就是这样,这就是我们如何将数据缓存起来以便重复使用,而不是在每次用户输入或每次页面重新加载时发起请求。正如你所看到的,这将极大地优化应用程序的性能,因为它可以防止由于网络慢而导致的电影渲染缓慢。

我们已经完成了我们的小电影应用程序中展示实时搜索功能的所有特性的实现。以下是该应用程序的整体JavaScript代码:

const url = "https://imdb-top-100-movies.p.rapidapi.com/";
const options = {
 method: "GET",
 headers: {
   "X-RapidAPI-Key": "Your Generated API Key",
   "X-RapidAPI-Host": "imdb-top-100-movies.p.rapidapi.com",
 },
};

const searchBar = document.getElementById("search-bar");
const resultsContainer = document.getElementById("results-container");
const movieUnavailableTxt = document.getElementById("movie-unavailable-txt");
let movieList;
let searchValue;
let moviesReturnedOnSearch;

// Function to fetch movies from the API
const fetchMovies = async () => {
 try {
   const response = await fetch(url, options);
   movieList = await response.json();

   // Storing the Movie Data in browser storage
   localStorage.setItem("moviedata", JSON.stringify(movieList));
   localStorage.setItem("cacheTimestamp", Date.now()); // Update cache timestamp

   // Render the movies on the page
   renderMovies(movieList);
 } catch (error) {
   movieUnavailableTxt.innerHTML =
     "An error occurred while fetching movies. <br /> Please try again later.";
   movieUnavailableTxt.style.display = "block";
   console.error(error);
 }
};

// Function to render movies on the page
const renderMovies = (movies) => {
 resultsContainer.innerHTML = ""; // Clear the existing movies
 movieUnavailableTxt.style.display = "none"; // Hide the "No movies found" message
 moviesReturnedOnSearch = []; // Clear the movies returned on search array

 movies.forEach((movie) => {
   resultsContainer.innerHTML += `
     <div class="movie-cards">
       <img src="${movie.image}" alt="movie image" class="movie-image" />
       <h2 class="title">${movie.title}</h2>
       <p class="plot">${movie.description}</p>
       <p class="date">${movie.year}</p>
     </div>
   `;

   moviesReturnedOnSearch.push(movie); // Add the movies that are a result to the search input value
 });
};

const cacheTimestamp = localStorage.getItem("cacheTimestamp");
const expirationDuration = 21600000; // 6 hours in milliseconds

// Check if cache has expired or data is not available
if (
 !cacheTimestamp ||
 Date.now() - parseInt(cacheTimestamp) > expirationDuration
) {
 // Cache expired or data not available, fetch movies again
 fetchMovies();
} else {
 // Use cached movie data
 movieList = JSON.parse(localStorage.getItem("moviedata"));
 renderMovies(movieList);
}

// Event listener and handler for search bar input
searchBar.addEventListener("input", (event) => {
 searchValue = event.target.value.trim().toLowerCase();

 // Filter movies based on search input
 const filteredMovies = movieList.filter((movie) =>
   movie.title.toLowerCase().includes(searchValue),
 );

 // Render the filtered movies on the page
 renderMovies(filteredMovies);

 if (moviesReturnedOnSearch.length <= 0) {
   movieUnavailableTxt.style.display = "block"; // Show the "No movies found" message if no movies match the search
 }
});

结论

在本指南中,我们探讨了使用API在JavaScript中实现实时搜索功能的方法。按照所述步骤,您可以创建一个动态搜索体验,当用户在搜索栏中输入时,可以提供实时结果。

通过在您的网站上实现实时搜索功能,您可以增强用户参与度,提高您的网站或应用程序的可用性。用户将欣赏能够快速方便地找到相关信息,而无需重新加载页面。

通过这个指南所获得的知识,您已经具备了在JavaScript中有效实现实时搜索功能的能力。拥抱动态搜索的力量,创造一个无缝的用户体验,给人留下深刻的印象。

由于文章内容篇幅有限,今天的内容就分享到这里,文章结尾,我想提醒您,文章的创作不易,如果您喜欢我的分享,请别忘了点赞和转发,让更多有需要的人看到。同时,如果您想获取更多前端技术的知识,欢迎关注我,您的支持将是我分享最大的动力。我会持续输出更多内容,敬请期待。

来了~欢迎转发、收藏,记得点个赞呗。^_^

无论当前 JavaScript 代码是内嵌还是在外链文件中,页面的下载和渲染都必须停下来等待脚本执行完成。JavaScript 执行过程耗时越久,浏览器等待响应用户输入的时间就越长。浏览器在下载和执行脚本时出现阻塞的原因在于,脚本可能会改变页面或 JavaScript 的命名空间,它们对后面页面内容造成影响。一个典型的例子就是在页面中使用document.write()。例如清单 1。

清单 1 JavaScript 代码内嵌示例

当浏览器遇到<script>标签时,当前 HTML 页面无从获知 JavaScript 是否会向<p> 标签添加内容,或引入其他元素,或甚至移除该标签。因此,这时浏览器会停止处理页面,先执行 JavaScript代码,然后再继续解析和渲染页面。同样的情况也发生在使用 src 属性加载 JavaScript的过程中,浏览器必须先花时间下载外链文件中的代码,然后解析并执行它。在这个过程中,页面渲染和用户交互完全被阻塞了。

1.脚本位置

HTML 4 规范指出 <script> 标签可以放在 HTML 文档的<head>或<body>中,并允许出现多次。Web 开发人员一般习惯在 <head> 中加载外链的 JavaScript,接着用 <link> 标签用来加载外链的 CSS 文件或者其他页面信息。例如清单 2。

清单 2 低效率脚本位置示例

然而这种常规的做法却隐藏着严重的性能问题。在清单 2 的示例中,当浏览器解析到 <script> 标签(第 4 行)时,浏览器会停止解析其后的内容,而优先下载脚本文件,并执行其中的代码,这意味着,其后的 styles.css 样式文件和<body>标签都无法被加载,由于<body>标签无法被加载,那么页面自然就无法渲染了。因此在该 JavaScript 代码完全执行完之前,页面都是一片空白。图 1 描述了页面加载过程中脚本和样式文件的下载过程。

图 1 JavaScript 文件的加载和执行阻塞其他文件的下载

我们可以发现一个有趣的现象:第一个 JavaScript 文件开始下载,与此同时阻塞了页面其他文件的下载。此外,从 script1.js 下载完成到 script2.js 开始下载前存在一个延时,这段时间正好是 script1.js 文件的执行过程。每个文件必须等到前一个文件下载并执行完成才会开始下载。在这些文件逐个下载过程中,用户看到的是一片空白的页面。

从 IE 8、Firefox 3.5、Safari 4 和 Chrome 2 开始都允许并行下载 JavaScript 文件。这是个好消息,因为<script>标签在下载外部资源时不会阻塞其他<script>标签。遗憾的是,JavaScript 下载过程仍然会阻塞其他资源的下载,比如样式文件和图片。尽管脚本的下载过程不会互相影响,但页面仍然必须等待所有 JavaScript 代码下载并执行完成才能继续。因此,尽管最新的浏览器通过允许并行下载提高了性能,但问题尚未完全解决,脚本阻塞仍然是一个问题。

由于脚本会阻塞页面其他资源的下载,因此推荐将所有<script>标签尽可能放到<body>标签的底部,以尽量减少对整个页面下载的影响。例如清单 3

清单 3 推荐的代码放置位置示例

这段代码展示了在 HTML 文档中放置<script>标签的推荐位置。尽管脚本下载会阻塞另一个脚本,但是页面的大部分内容都已经下载完成并显示给了用户,因此页面下载不会显得太慢。

这是优化 JavaScript 的首要规则:将脚本放在底部。

2.组织脚本

由于每个<script>标签初始下载时都会阻塞页面渲染,所以减少页面包含的<script>标签数量有助于改善这一情况。这不仅针对外链脚本,内嵌脚本的数量同样也要限制。浏览器在解析 HTML 页面的过程中每遇到一个<script>标签,都会因执行脚本而导致一定的延时,因此最小化延迟时间将会明显改善页面的总体性能。

这个问题在处理外链 JavaScript 文件时略有不同。考虑到 HTTP 请求会带来额外的性能开销,因此下载单个 100Kb 的文件将比下载 5 个 20Kb 的文件更快。也就是说,减少页面中外链脚本的数量将会改善性能

通常一个大型网站或应用需要依赖数个 JavaScript 文件。您可以把多个文件合并成一个,这样只需要引用一个<script>标签,就可以减少性能消耗。文件合并的工作可通过离线的打包工具或者一些实时的在线服务来实现。

需要特别提醒的是,把一段内嵌脚本放在引用外链样式表的<link>之后会导致页面阻塞去等待样式表的下载。这样做是为了确保内嵌脚本在执行时能获得最精确的样式信息。因此,建议不要把内嵌脚本紧跟在<link>标签后面。

3.无阻塞的脚本

减少 JavaScript 文件大小并限制 HTTP 请求数在功能丰富的 Web 应用或大型网站上并不总是可行。Web 应用的功能越丰富,所需要的 JavaScript 代码就越多,尽管下载单个较大的 JavaScript 文件只产生一次 HTTP 请求,却会锁死浏览器的一大段时间。为避免这种情况,需要通过一些特定的技术向页面中逐步加载 JavaScript 文件,这样做在某种程度上来说不会阻塞浏览器。

无阻塞脚本的秘诀在于,在页面加载完成后才加载 JavaScript 代码。这就意味着在 window 对象的 onload事件触发后再下载脚本。有多种方式可以实现这一效果。

3.1延迟加载脚本

HTML 4 为<script>标签定义了一个扩展属性:defer。Defer 属性指明本元素所含的脚本不会修改 DOM,因此代码能安全地延迟执行。defer 属性只被 IE 4 和 Firefox 3.5 更高版本的浏览器所支持,所以它不是一个理想的跨浏览器解决方案。在其他浏览器中,defer 属性会被直接忽略,因此<script>标签会以默认的方式处理,也就是说会造成阻塞。然而,如果您的目标浏览器支持的话,这仍然是个有用的解决方案。清单 4 是一个例子

清单 4 defer 属性使用方法示例

<script type="text/javascript" src="script1.js" defer></script>

带有 defer 属性的<script>标签可以放置在文档的任何位置。对应的 JavaScript 文件将在页面解析到<script>标签时开始下载,但不会执行,直到 DOM 加载完成,即onload事件触发前才会被执行。当一个带有 defer 属性的 JavaScript 文件下载时,它不会阻塞浏览器的其他进程,因此这类文件可以与其他资源文件一起并行下载。

任何带有 defer 属性的<script>元素在 DOM 完成加载之前都不会被执行,无论内嵌或者是外链脚本都是如此。清单 5 的例子展示了defer属性如何影响脚本行为:

清单 5 defer 属性对脚本行为的影响

这段代码在页面处理过程中弹出三次对话框。不支持 defer 属性的浏览器的弹出顺序是:"defer"、"script"、"load"。而在支持 defer 属性的浏览器上,弹出的顺序则是:"script"、"defer"、"load"。请注意,带有 defer 属性的<script>元素不是跟在第二个后面执行,而是在 onload 事件被触发前被调用。

如果您的目标浏览器只包括 Internet Explorer 和 Firefox 3.5,那么 defer 脚本确实有用。如果您需要支持跨领域的多种浏览器,那么还有更一致的实现方式。

HTML 5 为<script>标签定义了一个新的扩展属性:async。它的作用和 defer 一样,能够异步地加载和执行脚本,不因为加载脚本而阻塞页面的加载。但是有一点需要注意,在有 async 的情况下,JavaScript 脚本一旦下载好了就会执行,所以很有可能不是按照原本的顺序来执行的。如果 JavaScript 脚本前后有依赖性,使用 async 就很有可能出现错误。

3.2动态脚本元素

文档对象模型(DOM)允许您使用 JavaScript 动态创建 HTML 的几乎全部文档内容。<script>元素与页面其他元素一样,可以非常容易地通过标准 DOM 函数创建:

清单 6 通过标准 DOM 函数创建<script>元素

新的<script>元素加载 script1.js 源文件。此文件当元素添加到页面之后立刻开始下载。此技术的重点在于:无论在何处启动下载,文件的下载和运行都不会阻塞其他页面处理过程。您甚至可以将这些代码放在<head>部分而不会对其余部分的页面代码造成影响(除了用于下载文件的 HTTP 连接)。

当文件使用动态脚本节点下载时,返回的代码通常立即执行(除了 Firefox 和 Opera,他们将等待此前的所有动态脚本节点执行完毕)。当脚本是"自运行"类型时,这一机制运行正常,但是如果脚本只包含供页面其他脚本调用调用的接口,则会带来问题。这种情况下,您需要跟踪脚本下载完成并是否准备妥善。可以使用动态 <script> 节点发出事件得到相关信息。

Firefox、Opera, Chorme 和 Safari 3+会在<script>节点接收完成之后发出一个 onload 事件。您可以监听这一事件,以得到脚本准备好的通知:

清单 7 通过监听 onload 事件加载 JavaScript 脚本

Internet Explorer 支持另一种实现方式,它发出一个 readystatechange 事件。<script>元素有一个 readyState 属性,它的值随着下载外部文件的过程而改变。readyState 有五种取值:

&middot; "uninitialized":默认状态

&middot; "loading":下载开始

&middot; "loaded":下载完成

&middot; "interactive":下载完成但尚不可用

&middot; "complete":所有数据已经准备好

微软文档上说,在<script>元素的生命周期中,readyState 的这些取值不一定全部出现,但并没有指出哪些取值总会被用到。实践中,我们最感兴趣的是"loaded"和"complete"状态。Internet Explorer 对这两个 readyState 值所表示的最终状态并不一致,有时<script>元素会得到"loader"却从不出现"complete",但另外一些情况下出现"complete"而用不到"loaded"。最安全的办法就是在 readystatechange 事件中检查这两种状态,并且当其中一种状态出现时,删除 readystatechange 事件句柄(保证事件不会被处理两次):

清单 8 通过检查 readyState 状态加载 JavaScript 脚本

大多数情况下,您希望调用一个函数就可以实现 JavaScript 文件的动态加载。下面的函数封装了标准实现和 IE 实现所需的功能:

清单 9 通过函数进行封装

此函数接收两个参数:JavaScript 文件的 URL,和一个当 JavaScript 接收完成时触发的回调函数。属性检查用于决定监视哪种事件。最后一步,设置 src 属性,并将<script>元素添加至页面。此 loadScript() 函数使用方法如下:

清单 10 loadScript()函数使用方法

您可以在页面中动态加载很多 JavaScript 文件,但要注意,浏览器不保证文件加载的顺序。所有主流浏览器之中,只有 Firefox 和 Opera 保证脚本按照您指定的顺序执行。其他浏览器将按照服务器返回它们的次序下载并运行不同的代码文件。您可以将下载操作串联在一起以保证他们的次序,如下:

清单 11 通过 loadScript()函数加载多个 JavaScript 脚本

此代码等待 script1.js 可用之后才开始加载 script2.js,等 script2.js 可用之后才开始加载 script3.js。虽然此方法可行,但如果要下载和执行的文件很多,还是有些麻烦。如果多个文件的次序十分重要,更好的办法是将这些文件按照正确的次序连接成一个文件。独立文件可以一次性下载所有代码(由于这是异步进行的,使用一个大文件并没有什么损失)。

动态脚本加载是非阻塞 JavaScript 下载中最常用的模式,因为它可以跨浏览器,而且简单易用。

3.3使用 XMLHttpRequest(XHR)对象

此技术首先创建一个 XHR 对象,然后下载 JavaScript 文件,接着用一个动态 <script> 元素将 JavaScript 代码注入页面。清单 12 是一个简单的例子:

清单 12 通过 XHR 对象加载 JavaScript 脚本

此代码向服务器发送一个获取 script1.js 文件的 GET 请求。onreadystatechange 事件处理函数检查 readyState 是不是 4,然后检查 HTTP 状态码是不是有效(2XX 表示有效的回应,304 表示一个缓存响应)。如果收到了一个有效的响应,那么就创建一个新的<script>元素,将它的文本属性设置为从服务器接收到的 responseText 字符串。这样做实际上会创建一个带有内联代码的<script>元素。一旦新<script>元素被添加到文档,代码将被执行,并准备使用。

这种方法的主要优点是,您可以下载不立即执行的 JavaScript 代码。由于代码返回在<script>标签之外(换句话说不受<script>标签约束),它下载后不会自动执行,这使得您可以推迟执行,直到一切都准备好了。另一个优点是,同样的代码在所有现代浏览器中都不会引发异常。

此方法最主要的限制是:JavaScript 文件必须与页面放置在同一个域内,不能从 CDN 下载(CDN 指"内容投递网络(Content Delivery Network)",所以大型网页通常不采用 XHR 脚本注入技术。

4.总结

一般而言,减少 JavaScript 对性能的影响有以下几种方法:

&middot; A.将所有的<script>标签放到页面底部,也就是</body>闭合标签之前,这能确保在脚本执行前页面已经完成了渲染。

&middot; B.尽可能地合并脚本。页面中的<script>标签越少,加载也就越快,响应也越迅速。无论是外链脚本还是内嵌脚本都是如此。

&middot; C.采用无阻塞下载 JavaScript 脚本的方法:

&middot; a-使用<script>标签的 defer 属性(仅适用于 IE 和 Firefox 3.5 以上版本);

&middot; b-使用动态创建的<script>元素来下载并执行代码;

&middot; c-使用 XHR 对象下载 JavaScript 代码并注入页面中。

通过以上策略,可以在很大程度上提高那些需要使用大量 JavaScript 的 Web 网站和应用的实际性能。


看完了,别忘了收藏、转发、点个赞,更别忘了要关注本号!^_^

SS加载确实有可能阻塞页面加载,但这并非绝对,具体取决于CSS的加载方式、应用位置以及浏览器的渲染机制。在了解CSS加载如何影响页面加载之前,我们先要明白浏览器渲染页面的基本流程。

浏览器在加载网页时,会按照从上到下的顺序解析HTML文档。当浏览器遇到`<link>`标签引用外部CSS文件时,它会停止HTML的解析,转而加载并应用这个CSS文件。这个过程被称为CSS阻塞。因此,如果这个CSS文件很大或者加载速度很慢,用户可能会看到一个空白页面,直到CSS文件完全加载并应用。

然而,有几种方法可以避免或减轻CSS加载对页面加载的阻塞:

  1. 异步加载CSS:通过将CSS文件的加载设置为异步,可以确保HTML解析不会被阻塞。这可以通过在`<link>`标签中添加`rel="async"`属性来实现。这样,浏览器会在后台加载CSS文件,而不会停止HTML的解析。
  2. 内联CSS:将CSS代码直接写在HTML文件中,而不是通过外部文件引用,可以避免网络请求造成的延迟。但是,这会增加HTML文件的大小,可能导致其他性能问题。
  3. 使用CSS-in-JS库:一些库,如Styled Components或Emotion,允许你在JavaScript中编写CSS。这种方法可以动态生成样式,但也可能增加JavaScript的复杂性。
  4. 分割CSS:将CSS文件分割成多个小文件,每个文件只包含一部分样式。这样,即使某个文件加载较慢,也不会阻塞整个页面的渲染。
  5. 利用媒体查询:通过媒体查询,你可以根据设备的特性(如屏幕大小、分辨率等)加载不同的CSS文件。这样,用户只会下载并应用他们真正需要的样式。
  6. 预加载和预获取:使用`<link rel="preload">`和`<link rel="prefetch">`可以告诉浏览器提前加载CSS文件。虽然这并不能阻止CSS阻塞,但它可以确保文件在需要时立即可用。

此外,值得注意的是,现代浏览器通常具有一些优化机制,如并行下载、缓存等,这些都可以帮助减少CSS加载对页面加载的影响。

总的来说,CSS加载确实有可能阻塞页面加载,但通过一些优化策略和技术,我们可以减轻或避免这种阻塞。选择哪种策略取决于你的具体需求和约束。