Trang này được dịch bởi Cloud Translation API.

chrome.debugger

Mô tả

API chrome.debugger đóng vai trò là một phương thức truyền tải thay thế cho giao thức gỡ lỗi từ xa của Chrome. Sử dụng chrome.debugger để đính kèm vào một hoặc nhiều thẻ để đo lường hoạt động tương tác mạng, gỡ lỗi JavaScript, thay đổi DOM và CSS, v.v. Sử dụng thuộc tính Debuggee tabId để nhắm đến các thẻ bằng sendCommand và định tuyến các sự kiện theo tabId từ các lệnh gọi lại onEvent.

Quyền

debugger

Ghi chú bảo mật

Vì lý do bảo mật, API chrome.debugger không cấp quyền truy cập vào tất cả các miền giao thức Chrome DevTools. Các miền có sẵn là: Accessibility (Khả năng hỗ trợ), Audits (Kiểm tra), CacheStorage (Bộ nhớ đệm), Console (Bảng điều khiển), CSS (CSS), Database (Cơ sở dữ liệu), Debugger (Trình gỡ lỗi), DOM (DOM), DOMDebugger (Trình gỡ lỗi DOM), DOMSnapshot (Ảnh chụp nhanh DOM), Emulation (Mô phỏng), Fetch (Tìm nạp), IO (IO), Input (Đầu vào), Inspector (Trình kiểm tra), Log (Nhật ký), Network (Mạng), Overlay (Lớp phủ), Page (Trang), Performance (Hiệu suất), Profiler (Trình phân tích tài nguyên), Runtime (Thời gian chạy), Storage (Bộ nhớ), Target (Mục tiêu), Tracing (Theo dõi), WebAudio (WebAudio) và WebAuthn (WebAuthn).

Tệp kê khai

Bạn phải khai báo quyền "debugger" trong tệp kê khai của tiện ích để sử dụng API này.

{
  "name": "My extension",
  ...
  "permissions": [
    "debugger",
  ],
  ...
}

Ví dụ

Để dùng thử API này, hãy cài đặt ví dụ về API gỡ lỗi trong kho lưu trữ chrome-extension-samples.

Loại

Debuggee

Mã nhận dạng chương trình cần gỡ lỗi. Bạn phải chỉ định tabId, extensionId hoặc targetId

Thuộc tính

extensionId

chuỗi không bắt buộc

Mã nhận dạng của tiện ích mà bạn dự định gỡ lỗi. Bạn chỉ có thể đính kèm vào trang nền của tiện ích khi dùng công tắc dòng lệnh --silent-debugger-extension-api.
tabId

number không bắt buộc

Mã của thẻ mà bạn dự định gỡ lỗi.
targetId

chuỗi không bắt buộc

Mã nhận dạng mờ của mục tiêu gỡ lỗi.

DebuggerSession

Chrome 125 trở lên

Giá trị nhận dạng phiên của trình gỡ lỗi. Bạn phải chỉ định một trong các giá trị tabId, extensionId hoặc targetId. Ngoài ra, bạn có thể cung cấp một sessionId (không bắt buộc). Nếu sessionId được chỉ định cho các đối số được gửi từ onEvent, thì có nghĩa là sự kiện này đến từ một phiên giao thức con trong phiên gỡ lỗi gốc. Nếu sessionId được chỉ định khi truyền đến sendCommand, thì sessionId đó sẽ nhắm đến một phiên giao thức con trong phiên gỡ lỗi gốc.

Thuộc tính

extensionId

chuỗi không bắt buộc

Mã nhận dạng của tiện ích mà bạn dự định gỡ lỗi. Bạn chỉ có thể đính kèm vào trang nền của tiện ích khi dùng công tắc dòng lệnh --silent-debugger-extension-api.
sessionId

chuỗi không bắt buộc

Mã nhận dạng không rõ ràng của phiên Giao thức Chrome DevTools. Xác định một phiên con trong phiên gốc được xác định bằng tabId, extensionId hoặc targetId.
tabId

number không bắt buộc

Mã của thẻ mà bạn dự định gỡ lỗi.
targetId

chuỗi không bắt buộc

Mã nhận dạng mờ của mục tiêu gỡ lỗi.

DetachReason

Chrome 44 trở lên

Lý do chấm dứt kết nối.

Enum

"target_closed"

"canceled_by_user"

TargetInfo

Thông tin gỡ lỗi về mục tiêu

Thuộc tính

được đính kèm

boolean

Đúng nếu trình gỡ lỗi đã được đính kèm.
extensionId

chuỗi không bắt buộc

Mã nhận dạng tiện ích, được xác định nếu type = "background_page".
faviconUrl

chuỗi không bắt buộc

URL biểu tượng trang web mục tiêu.
id

chuỗi

Mã mục tiêu.
tabId

number không bắt buộc

Mã nhận dạng thẻ, được xác định nếu type == 'page'.
tiêu đề

chuỗi

Tiêu đề trang đích.
loại

TargetInfoType

Loại mục tiêu.
url

chuỗi

URL mục tiêu.

TargetInfoType

Chrome 44 trở lên

Loại mục tiêu.

Enum

"page"

"background_page"

"worker"

"other"

Phương thức

attach()

Promise

chrome.debugger.attach(
  target: Debuggee,
  requiredVersion: string,
  callback?: function,
): Promise<void>

Đính kèm trình gỡ lỗi vào mục tiêu đã cho.

Thông số

mục tiêu

Debuggee

Mục tiêu gỡ lỗi mà bạn muốn đính kèm.
requiredVersion

chuỗi

Phiên bản giao thức gỡ lỗi bắt buộc ("0.1"). Bạn chỉ có thể đính kèm vào chương trình cần gỡ lỗi có phiên bản chính trùng khớp và phiên bản phụ lớn hơn hoặc bằng. Bạn có thể xem danh sách các phiên bản giao thức tại đây.
callback

hàm không bắt buộc

Tham số callback có dạng như sau:
```
() => void
```

Giá trị trả về

Promise<void>

Chrome 96 trở lên

Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

detach()

Promise

chrome.debugger.detach(
  target: Debuggee,
  callback?: function,
): Promise<void>

Tách trình gỡ lỗi khỏi mục tiêu đã cho.

Thông số

mục tiêu

Debuggee

Mục tiêu gỡ lỗi mà bạn muốn tách.
callback

hàm không bắt buộc

Tham số callback có dạng như sau:
```
() => void
```

Giá trị trả về

Promise<void>

Chrome 96 trở lên

Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getTargets()

Promise

chrome.debugger.getTargets(
  callback?: function,
): Promise<TargetInfo[]>

Trả về danh sách các mục tiêu gỡ lỗi có sẵn.

Thông số

callback

hàm không bắt buộc

Tham số callback có dạng như sau:
```
(result: TargetInfo[]) => void
```
- kết quả
  
  TargetInfo[]
  
  Mảng các đối tượng TargetInfo tương ứng với các mục tiêu gỡ lỗi có sẵn.

Giá trị trả về

Promise<TargetInfo[]>

Chrome 96 trở lên

Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

sendCommand()

Promise

chrome.debugger.sendCommand(
  target: DebuggerSession,
  method: string,
  commandParams?: object,
  callback?: function,
): Promise<object | undefined>

Gửi lệnh đã cho đến mục tiêu gỡ lỗi.

Thông số

mục tiêu

DebuggerSession

Mục tiêu gỡ lỗi mà bạn muốn gửi lệnh đến.
method

chuỗi

Tên phương thức. Phải là một trong những phương thức do giao thức gỡ lỗi từ xa xác định.
commandParams

đối tượng không bắt buộc

Đối tượng JSON có các tham số yêu cầu. Đối tượng này phải tuân thủ sơ đồ tham số gỡ lỗi từ xa cho phương thức đã cho.
callback

hàm không bắt buộc

Tham số callback có dạng như sau:
```
(result?: object) => void
```
- kết quả
  
  đối tượng không bắt buộc
  
  Đối tượng JSON có phản hồi. Cấu trúc của phản hồi sẽ khác nhau tuỳ thuộc vào tên phương thức và được xác định bằng thuộc tính "returns" (trả về) trong phần mô tả lệnh của giao thức gỡ lỗi từ xa.

Giá trị trả về

Promise<object | undefined>

Chrome 96 trở lên

Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

Sự kiện

onDetach

chrome.debugger.onDetach.addListener(
  callback: function,
)

Được kích hoạt khi trình duyệt kết thúc phiên gỡ lỗi cho thẻ. Điều này xảy ra khi thẻ đang đóng hoặc Chrome DevTools đang được gọi cho thẻ đính kèm.

Thông số

callback

hàm

Tham số callback có dạng như sau:
```
(source: Debuggee, reason: DetachReason) => void
```
- source
  
  Debuggee
- lý do
  
  DetachReason

onEvent

chrome.debugger.onEvent.addListener(
  callback: function,
)

Được kích hoạt bất cứ khi nào sự kiện đo lường vấn đề về mục tiêu gỡ lỗi.

Thông số

callback

hàm

Tham số callback có dạng như sau:
```
(source: DebuggerSession, method: string, params?: object) => void
```
- source
  
  DebuggerSession
- method
  
  chuỗi
- params
  
  đối tượng không bắt buộc

chrome.debugger Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

Mô tả

Quyền

Ghi chú bảo mật

Tệp kê khai

Ví dụ

Loại

Debuggee

Thuộc tính

DebuggerSession

Thuộc tính

DetachReason

Enum

TargetInfo

Thuộc tính

TargetInfoType

Enum

Phương thức

attach()

Thông số

Giá trị trả về

detach()

Thông số

Giá trị trả về

getTargets()

Thông số

Giá trị trả về

sendCommand()

Thông số

Giá trị trả về

Sự kiện

onDetach

Thông số

onEvent

Thông số

chrome.debugger