Cập nhật mã

Thông tin cập nhật không liên quan đến các vấn đề khác

Đây là phần đầu trong 3 phần mô tả các thay đổi cần thiết đối với mã không thuộc trình chạy dịch vụ tiện ích. Phần này dành cho những thay đổi bắt buộc về mã mà không liên quan đến các vấn đề khác. Hai phần tiếp theo đề cập đến việc thay thế việc chặn các yêu cầu web và cải thiện bảo mật.

Thay thế tab.executeScript() bằng script.executeScript()

Trong Manifest V3, executeScript() chuyển từ API tabs sang API scripting. Việc này đòi hỏi phải thay đổi quyền trong tệp kê khai, ngoài những thay đổi thực tế về mã.

Đối với phương thức executeScript(), bạn cần:

  • Quyền "scripting".
  • Quyền của máy chủ hoặc quyền "activeTab".

Phương thức scripting.executeScript() tương tự như cách hoạt động với tabs.executeScript(). Có một số khác biệt.

  • Mặc dù phương thức cũ chỉ có thể lấy một tệp, nhưng phương thức mới có thể lấy một mảng tệp.
  • Bạn cũng truyền một đối tượng ScriptInjection thay vì InjectDetails. Có nhiều điểm khác biệt giữa hai công cụ này. Ví dụ: tabId hiện được truyền dưới dạng một thành phần của ScriptInjection.target thay vì một đối số phương thức.

Ví dụ cho thấy cách thực hiện việc này.

Tệp kê khai phiên bản 2
async function getCurrentTab() {/* ... */}
let tab = await getCurrentTab();

chrome.tabs.executeScript(
  tab.id,
  {
    file: 'content-script.js'
  }
);

Trong một tệp tập lệnh nền.

Manifest V3 (Tệp kê khai)
async function getCurrentTab()
let tab = await getCurrentTab();

chrome.scripting.executeScript({
  target: {tabId: tab.id},
  files: ['content-script.js']
});

Trong trình chạy dịch vụ tiện ích.

Thay thế tab.insertCSS() và tab.removeCSS() bằng tập lệnh.insertCSS() và viết tập lệnh.removeCSS()

Trong Manifest V3, insertCSS() và removeCSS() sẽ di chuyển từ API tabs sang scripting API. Ngoài việc thay đổi mã, bạn còn phải thay đổi quyền trong tệp kê khai:

  • Quyền "scripting".
  • Quyền của máy chủ hoặc quyền "activeTab".

Các hàm trên API scripting tương tự như các hàm trên tabs. Có một số khác biệt.

  • Khi gọi các phương thức này, bạn sẽ truyền một đối tượng CSSInjection thay vì InjectDetails.
  • tabId hiện được truyền dưới dạng một thành phần của CSSInjection.target thay vì dưới dạng đối số phương thức.

Ví dụ minh hoạ cách thực hiện việc này cho insertCSS(). Quy trình cho removeCSS() giống nhau.

Tệp kê khai phiên bản 2
chrome.tabs.insertCSS(tabId, injectDetails, () => {
  // callback code
});

Trong một tệp tập lệnh nền.

Manifest V3 (Tệp kê khai)
const insertPromise = await chrome.scripting.insertCSS({
  files: ["style.css"],
  target: { tabId: tab.id }
});
// Remaining code.

Trong trình chạy dịch vụ tiện ích.

Thay thế Thao tác trên trình duyệt và Thao tác trên trang bằng Thao tác

Thao tác trên trình duyệt và thao tác trên trang là hai khái niệm riêng biệt trong Manifest V2. Mặc dù họ bắt đầu với những vai trò riêng biệt, nhưng sự khác biệt giữa hai vai trò này đã giảm dần theo thời gian. Trong Manifest V3, các khái niệm này được hợp nhất thành Action API. Điều này yêu cầu bạn phải thay đổi trong manifest.json và mã tiện ích khác với những gì bạn đã đặt vào tập lệnh nền Manifest V2.

Các thao tác trong Manifest V3 gần giống nhất với các thao tác trên trình duyệt; tuy nhiên, API action không cung cấp hide() và show() như pageAction đã cung cấp. Nếu vẫn cần các thao tác trên trang, bạn có thể mô phỏng các thao tác đó bằng nội dung khai báo hoặc gọi enable() hay disable() bằng mã thẻ.

Thay thế "browser_action" và "page_action" có "hành động"

Trong manifest.json, hãy thay thế các trường "browser_action" và "page_action" bằng trường "action". Hãy tham khảo tài liệu tham khảo để biết thông tin về trường "action".

Tệp kê khai phiên bản 2
{
  ...
  "page_action": { ... },
  "browser_action": {
    "default_popup": "popup.html"
   }
  ...
}
Manifest V3 (Tệp kê khai)
{
  ...
  "action": {
    "default_popup": "popup.html"
  }

  ...
}

Thay thế browserAction và pageAction bằng API hành động

Trong trường hợp Manifest V2 sử dụng các API browserAction và pageAction, thì bây giờ bạn nên sử dụng API action.

Tệp kê khai phiên bản 2
chrome.browserAction.onClicked.addListener(tab => { ... });
chrome.pageAction.onClicked.addListener(tab => { ... });
Manifest V3 (Tệp kê khai)
chrome.action.onClicked.addListener(tab => { ... });

Thay thế lệnh gọi lại bằng lời hứa

Trong Manifest V3, nhiều phương thức API tiện ích trả về hứa hẹn. Promise là một proxy hoặc phần giữ chỗ cho một giá trị mà phương thức không đồng bộ trả về. Nếu chưa từng dùng Lời hứa, bạn có thể đọc về Lời hứa trên MDN. Trang này mô tả những điều bạn cần biết để sử dụng tiện ích trong tiện ích của Chrome.

Để có khả năng tương thích ngược, nhiều phương thức tiếp tục hỗ trợ lệnh gọi lại sau khi chức năng hỗ trợ lời hứa được thêm vào. Lưu ý rằng bạn không thể sử dụng cả hai trong cùng một lệnh gọi hàm. Nếu bạn truyền một lệnh gọi lại, thì hàm sẽ không trả về một lời hứa và nếu bạn muốn một lời hứa được trả về, thì đừng truyền lệnh gọi lại. Một số tính năng API, chẳng hạn như trình nghe sự kiện, sẽ tiếp tục yêu cầu gọi lại. Để kiểm tra xem một phương thức có hỗ trợ lời hứa hay không, hãy tìm thuộc tính "Promise" (Lời hứa) trong tham chiếu API của nhãn đó.

Để chuyển đổi từ lệnh gọi lại thành lời hứa, hãy xoá lệnh gọi lại và xử lý lời hứa được trả về. Ví dụ bên dưới được lấy từ mẫu về quyền không bắt buộc, cụ thể là newtab.js. Phiên bản gọi lại cho thấy lệnh gọi của mẫu đến request() sẽ như thế nào với lệnh gọi lại. Lưu ý rằng phiên bản lời hứa có thể được viết lại bằng chế độ không đồng bộ và đang chờ.

Số nhận cuộc gọi lại
chrome.permissions.request(newPerms, (granted) => {
  if (granted) {
    console.log('granted');
  } else {
    console.log('not granted');
  }
});
Lời hứa
const newPerms = { permissions: ['topSites'] };
chrome.permissions.request(newPerms)
.then((granted) => {
  if (granted) {
    console.log('granted');
  } else {
    console.log('not granted');
  }
});

Thay thế các hàm cần có ngữ cảnh nền Manifest V2

Các bối cảnh khác của tiện ích chỉ có thể tương tác với trình chạy dịch vụ tiện ích bằng cách sử dụng tính năng truyền tin nhắn. Do đó, bạn sẽ cần thay thế các lệnh gọi yêu cầu bối cảnh nền, cụ thể là:

  • chrome.runtime.getBackgroundPage()
  • chrome.extension.getBackgroundPage()
  • chrome.extension.getExtensionTabs()

Các tập lệnh tiện ích phải sử dụng tính năng truyền thông báo để giao tiếp giữa một trình chạy dịch vụ và các phần khác của tiện ích. Hiện tại, bạn có thể thực hiện việc này bằng cách sử dụng sendMessage() và triển khai chrome.runtime.onMessage trong trình chạy dịch vụ tiện ích. Về lâu dài, bạn nên lên kế hoạch thay thế các lệnh gọi này bằng postMessage() và trình xử lý sự kiện thông báo của trình chạy dịch vụ.

Thay thế các API không được hỗ trợ

Các phương thức và thuộc tính được liệt kê dưới đây cần thay đổi trong Manifest V3.

Phương thức hoặc thuộc tính của tệp kê khai V2 Thay thế bằng
chrome.extension.connect() chrome.runtime.connect()
chrome.extension.connectNative() chrome.runtime.connectNative()
chrome.extension.getExtensionTabs() chrome.extension.getViews()
chrome.extension.getURL() chrome.runtime.getURL()
chrome.extension.lastError Trong trường hợp các phương thức trả về hứa hẹn, hãy sử dụng promise.catch()
chrome.extension.onConnect chrome.runtime.onConnect
chrome.extension.onConnectExternal chrome.runtime.onConnectExternal
chrome.extension.onMessage chrome.runtime.onMessage
chrome.extension.onRequest chrome.runtime.onMessage
chrome.extension.onRequestExternal chrome.runtime.onMessageExternal
chrome.extension.sendMessage() chrome.runtime.sendMessage()
chrome.extension.sendNativeMessage() chrome.runtime.sendNativeMessage()
chrome.extension.sendRequest() chrome.runtime.sendMessage()
chrome.runtime.onSuspend (tập lệnh nền) Không được hỗ trợ trong trình chạy dịch vụ tiện ích. Thay vào đó, hãy sử dụng sự kiện tài liệu beforeunload.
chrome.tabs.getAllInWindow() chrome.tabs.query()
chrome.tabs.getSelected() chrome.tabs.query()
chrome.tabs.onActiveChanged chrome.tabs.onActivated
chrome.tabs.onHighlightChanged chrome.tabs.onHighlighted
chrome.tabs.onSelectionChanged chrome.tabs.onActivated
chrome.tabs.sendRequest() chrome.runtime.sendMessage()
chrome.tabs.Tab.selected chrome.tabs.Tab.highlighted