11 KiB

Raw Permalink Blame History Unescape Escape

瀏覽器擴充功能專案第 2 部分：呼叫 API，使用本地存儲

課前測驗

簡介

在本課中，您將透過提交瀏覽器擴充功能的表單來呼叫 API，並在擴充功能中顯示結果。此外，您還將學習如何將數據存儲在瀏覽器的本地存儲中，以供未來參考和使用。

✅ 按照適當文件中的編號段落，了解應將程式碼放置在哪裡。

設置擴充功能中需要操作的元素：

到目前為止，您已經為瀏覽器擴充功能建立了表單和結果 <div> 的 HTML。接下來，您需要在 /src/index.js 文件中工作，逐步構建您的擴充功能。請參考上一課以了解如何設置專案和構建過程。

在 index.js 文件中，首先建立一些 const 變數來保存與各個欄位相關的值：

// form fields
const form = document.querySelector('.form-data');
const region = document.querySelector('.region-name');
const apiKey = document.querySelector('.api-key');

// results
const errors = document.querySelector('.errors');
const loading = document.querySelector('.loading');
const results = document.querySelector('.result-container');
const usage = document.querySelector('.carbon-usage');
const fossilfuel = document.querySelector('.fossil-fuel');
const myregion = document.querySelector('.my-region');
const clearBtn = document.querySelector('.clear-btn');

這些欄位都是通過其 CSS 類名來引用的，這是在上一課的 HTML 中設置的。

添加監聽器

接下來，為表單和重置按鈕添加事件監聽器，當使用者提交表單或點擊重置按鈕時，會觸發相應的操作，並在文件底部添加初始化應用程式的調用：

form.addEventListener('submit', (e) => handleSubmit(e));
clearBtn.addEventListener('click', (e) => reset(e));
init();

✅ 注意這裡使用的簡寫方式來監聽提交或點擊事件，以及事件如何被傳遞給 handleSubmit 或 reset 函數。您能否用更長的格式來寫出這個簡寫的等效程式碼？您更喜歡哪種方式？

構建 init() 函數和 reset() 函數：

現在，您將構建初始化擴充功能的函數，該函數名為 init()：

function init() {
	//if anything is in localStorage, pick it up
	const storedApiKey = localStorage.getItem('apiKey');
	const storedRegion = localStorage.getItem('regionName');

	//set icon to be generic green
	//todo

	if (storedApiKey === null || storedRegion === null) {
		//if we don't have the keys, show the form
		form.style.display = 'block';
		results.style.display = 'none';
		loading.style.display = 'none';
		clearBtn.style.display = 'none';
		errors.textContent = '';
	} else {
        //if we have saved keys/regions in localStorage, show results when they load
        displayCarbonUsage(storedApiKey, storedRegion);
		results.style.display = 'none';
		form.style.display = 'none';
		clearBtn.style.display = 'block';
	}
};

function reset(e) {
	e.preventDefault();
	//clear local storage for region only
	localStorage.removeItem('regionName');
	init();
}

在這個函數中，有一些有趣的邏輯。閱讀後，您能看出發生了什麼嗎？

設置了兩個 const 來檢查使用者是否在本地存儲中存儲了 APIKey 和地區代碼。
如果其中任何一個為 null，則通過將表單的樣式更改為 'block' 來顯示表單。
隱藏結果、加載狀態和 clearBtn，並將任何錯誤訊息設置為空字串。
如果存在密鑰和地區，則啟動一個流程來：
- 呼叫 API 獲取碳使用數據。
- 隱藏結果區域。
- 隱藏表單。
- 顯示重置按鈕。

在繼續之前，了解瀏覽器中一個非常重要的概念是很有用的：LocalStorage。LocalStorage 是一種以 key-value 鍵值對形式在瀏覽器中存儲字串的有用方式。這種網頁存儲可以通過 JavaScript 操作來管理瀏覽器中的數據。LocalStorage 不會過期，而另一種網頁存儲 SessionStorage 則會在瀏覽器關閉時清除。這些存儲類型各有優缺點。

注意 - 您的瀏覽器擴充功能有其自己的本地存儲；主瀏覽器窗口是不同的實例，行為獨立。

您可以將 APIKey 設置為一個字串值，例如，您可以通過“檢查”網頁（您可以右鍵點擊瀏覽器進行檢查）並轉到 Applications 標籤來查看存儲。

✅ 思考哪些情況下您不應該將某些數據存儲在 LocalStorage 中。一般來說，將 API 密鑰存儲在 LocalStorage 中是一個壞主意！您能看出原因嗎？在我們的案例中，由於我們的應用程式純粹是為了學習，並且不會部署到應用程式商店，因此我們將使用這種方法。

注意，您可以使用 Web API 操作 LocalStorage，通過 getItem()、setItem() 或 removeItem()。它在各個瀏覽器中都得到了廣泛支持。

在構建 displayCarbonUsage() 函數（在 init() 中調用）之前，讓我們先構建處理初始表單提交的功能。

處理表單提交

建立一個名為 handleSubmit 的函數，接受一個事件參數 (e)。阻止事件傳播（在這種情況下，我們希望阻止瀏覽器刷新），並調用一個新函數 setUpUser，傳遞 apiKey.value 和 region.value 作為參數。通過這種方式，您可以使用初始表單中填寫的兩個值。

function handleSubmit(e) {
	e.preventDefault();
	setUpUser(apiKey.value, region.value);
}

✅ 回顧一下 - 您在上一課中設置的 HTML 包含兩個輸入欄位，其 values 是通過您在文件頂部設置的 const 捕獲的，並且它們都是 required，因此瀏覽器會阻止使用者輸入空值。

設置使用者

接下來是 setUpUser 函數，這裡您將為 apiKey 和 regionName 設置本地存儲值。新增一個新函數：

function setUpUser(apiKey, regionName) {
	localStorage.setItem('apiKey', apiKey);
	localStorage.setItem('regionName', regionName);
	loading.style.display = 'block';
	errors.textContent = '';
	clearBtn.style.display = 'block';
	//make initial call
	displayCarbonUsage(apiKey, regionName);
}

此函數設置了一條加載訊息，以便在呼叫 API 時顯示。到這裡，您已經來到了這個瀏覽器擴充功能中最重要的函數！

顯示碳使用量

最後，是時候查詢 API 了！

在進一步操作之前，我們應該討論一下 API。API，即應用程式編程介面，是網頁開發人員工具箱中的關鍵元素。它們為程式之間的互動和介面提供了標準方式。例如，如果您正在建立一個需要查詢資料庫的網站，可能有人已經為您建立了一個 API。雖然有許多類型的 API，但其中一種最受歡迎的是 REST API。

✅ “REST” 代表“表現層狀態轉移”，其特點是使用各種配置的 URL 來獲取數據。請稍作研究，了解開發人員可用的各種 API 類型。哪種格式最吸引您？

這個函數有一些重要的注意事項。首先，注意 async 關鍵字。將函數編寫為異步運行意味著它會等待某個操作（例如數據返回）完成後再繼續。

這裡有一個關於 async 的簡短影片：

🎥 點擊上方圖片觀看有關 async/await 的影片。

建立一個新函數來查詢 C02Signal API：

import axios from '../node_modules/axios';

async function displayCarbonUsage(apiKey, region) {
	try {
		await axios
			.get('https://api.co2signal.com/v1/latest', {
				params: {
					countryCode: region,
				},
				headers: {
					'auth-token': apiKey,
				},
			})
			.then((response) => {
				let CO2 = Math.floor(response.data.data.carbonIntensity);

				//calculateColor(CO2);

				loading.style.display = 'none';
				form.style.display = 'none';
				myregion.textContent = region;
				usage.textContent =
					Math.round(response.data.data.carbonIntensity) + ' grams (grams C02 emitted per kilowatt hour)';
				fossilfuel.textContent =
					response.data.data.fossilFuelPercentage.toFixed(2) +
					'% (percentage of fossil fuels used to generate electricity)';
				results.style.display = 'block';
			});
	} catch (error) {
		console.log(error);
		loading.style.display = 'none';
		results.style.display = 'none';
		errors.textContent = 'Sorry, we have no data for the region you have requested.';
	}
}

這是一個較大的函數。這裡發生了什麼？

遵循最佳實踐，您使用 async 關鍵字使此函數異步運行。該函數包含一個 try/catch 區塊，因為當 API 返回數據時，它會返回一個 Promise。由於您無法控制 API 回應的速度（它可能根本不回應！），因此需要通過異步方式處理這種不確定性。
您正在查詢 co2signal API 以獲取您地區的數據，使用您的 API 密鑰。要使用該密鑰，您需要在標頭參數中使用一種類型的身份驗證。
一旦 API 回應，您將其回應數據的各個元素分配給您設置的螢幕部分以顯示這些數據。
如果出現錯誤或沒有結果，則顯示錯誤訊息。

✅ 使用異步編程模式是您工具箱中另一個非常有用的工具。閱讀有關各種方式配置此類程式碼的資訊。

恭喜！如果您構建了擴充功能（npm run build）並在擴充功能面板中刷新它，您就擁有了一個可運行的擴充功能！唯一尚未運行的是圖示，您將在下一課中修復它。

🚀 挑戰

我們在這些課程中已經討論了幾種類型的 API。選擇一個網頁 API，深入研究它提供的功能。例如，查看瀏覽器中可用的 API，例如 HTML 拖放 API。在您看來，什麼樣的 API 是出色的？

課後測驗

回顧與自學

在本課中，您學習了 LocalStorage 和 API，這兩者對專業網頁開發人員都非常有用。您能想到這兩者如何協同工作嗎？思考一下，您將如何設計一個網站來存儲供 API 使用的項目。

作業

採用一個 API

免責聲明：
本文件已使用 AI 翻譯服務 Co-op Translator 進行翻譯。雖然我們致力於提供準確的翻譯，但請注意，自動翻譯可能包含錯誤或不準確之處。原始文件的母語版本應被視為權威來源。對於關鍵資訊，建議使用專業人工翻譯。我們對因使用此翻譯而引起的任何誤解或誤釋不承擔責任。

11 KiB Raw Permalink Blame History Unescape Escape