chrome.debugger

refresh date: 2026-09-25 robots: noindex

คำอธิบาย

chrome.debugger API ทำหน้าที่เป็นตัวส่งข้อมูลสำรองสำหรับโปรโตคอลการแก้ไขข้อบกพร่องระยะไกลของ Chrome ใช้ chrome.debugger เพื่อแนบกับแท็บอย่างน้อย 1 แท็บเพื่อวัดการโต้ตอบของเครือข่าย แก้ไขข้อบกพร่องของ JavaScript, เปลี่ยนแปลง DOM และ CSS และอื่นๆ ใช้พร็อพเพอร์ตี้ Debuggee tabId เพื่อกำหนดเป้าหมายแท็บด้วย sendCommand และกำหนดเส้นทางเหตุการณ์ตาม tabId จาก Callback onEvent

สิทธิ์

debugger

สิทธิ์นี้จะทริกเกอร์คำเตือน

หมายเหตุด้านความปลอดภัย

ด้วยเหตุผลด้านความปลอดภัย API chrome.debugger จึงไม่ให้สิทธิ์เข้าถึงโดเมนโปรโตคอลเครื่องมือสำหรับนักพัฒนาเว็บใน Chrome ทั้งหมด โดเมนที่ใช้ได้ ได้แก่ Accessibility, Audits, CacheStorage, Console, CSS, Database, Debugger, DOM, DOMDebugger, DOMSnapshot, Emulation, Fetch, IO, Input, Inspector, Log, Network, Overlay, Page, Performance, Runtime, Storage, Target, Tracing, WebAudio และ WebAuthn

ไฟล์ Manifest

คุณต้องประกาศสิทธิ์ "debugger" ในไฟล์ Manifest ของส่วนขยายเพื่อใช้ API นี้

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

ตัวอย่าง

หากต้องการลองใช้ API นี้ ให้ติดตั้งตัวอย่าง API ของโปรแกรมแก้ไขข้อบกพร่องจากที่เก็บ chrome-extension-samples

ประเภท

Debuggee

ตัวระบุ Debuggee ต้องระบุ tabId, extensionId หรือ targetId

พร็อพเพอร์ตี้

• extensionId

  สตริง ไม่บังคับ

  รหัสของส่วนขยายที่คุณต้องการแก้ไขข้อบกพร่อง การแนบกับหน้าพื้นหลังของส่วนขยายจะทำได้ก็ต่อเมื่อใช้สวิตช์บรรทัดคำสั่ง --silent-debugger-extension-api เท่านั้น

• tabId

  number ไม่บังคับ

  รหัสของแท็บที่คุณต้องการแก้ไขข้อบกพร่อง

• targetId

  สตริง ไม่บังคับ

  รหัสทึบแสงของเป้าหมายการแก้ไขข้อบกพร่อง

DebuggerSession

Chrome 125 ขึ้นไป

ตัวระบุเซสชันของโปรแกรมแก้ไขข้อบกพร่อง ต้องระบุ tabId, extensionId หรือ targetId อย่างใดอย่างหนึ่ง นอกจากนี้ คุณยังระบุ sessionId (ไม่บังคับ) ได้ด้วย หากมีการระบุ sessionId สำหรับอาร์กิวเมนต์ที่ส่งจาก onEvent หมายความว่าเหตุการณ์มาจากเซสชันโปรโตคอลย่อยภายในเซสชันผู้รับการแก้ไขข้อบกพร่องระดับรูท หากมีการระบุ sessionId เมื่อส่งไปยัง sendCommand ระบบจะกำหนดเป้าหมายเป็นเซสชันโปรโตคอลย่อยภายในเซสชันผู้รับการแก้ไขข้อบกพร่องระดับรูท

พร็อพเพอร์ตี้

• extensionId

  สตริง ไม่บังคับ

  รหัสของส่วนขยายที่คุณต้องการแก้ไขข้อบกพร่อง การแนบกับหน้าพื้นหลังของส่วนขยายจะทำได้ก็ต่อเมื่อใช้สวิตช์บรรทัดคำสั่ง --silent-debugger-extension-api เท่านั้น

• sessionId

  สตริง ไม่บังคับ

  รหัสทึบแสงของเซสชันโปรโตคอลเครื่องมือสำหรับนักพัฒนาเว็บใน Chrome ระบุเซสชันย่อยภายในเซสชันรูทที่ระบุโดย tabId, extensionId หรือ targetId

• tabId

  number ไม่บังคับ

  รหัสของแท็บที่คุณต้องการแก้ไขข้อบกพร่อง

• targetId

  สตริง ไม่บังคับ

  รหัสทึบแสงของเป้าหมายการแก้ไขข้อบกพร่อง

DetachReason

Chrome 44 ขึ้นไป

เหตุผลที่สิ้นสุดการเชื่อมต่อ

ค่าแจกแจง

"target_closed"

"canceled_by_user"

TargetInfo

ข้อมูลเป้าหมายการแก้ไขข้อบกพร่อง

พร็อพเพอร์ตี้

• เชื่อมต่อแล้ว

  บูลีน

  เป็นจริงหากแนบโปรแกรมแก้ไขข้อบกพร่องแล้ว

• extensionId

  สตริง ไม่บังคับ

  รหัสส่วนขยายที่กำหนดไว้หากประเภท = "background_page"

• faviconUrl

  สตริง ไม่บังคับ

  URL ของไอคอน Fav เป้าหมาย

• id

  สตริง

  รหัสเป้าหมาย

• tabId

  number ไม่บังคับ

  รหัสแท็บ ซึ่งกำหนดไว้หากประเภท == 'page'

• title

  สตริง

  ชื่อหน้าเป้าหมาย

• ประเภท

  TargetInfoType

  ประเภทเป้าหมาย

• URL

  สตริง

  URL เป้าหมาย

TargetInfoType

Chrome 44 ขึ้นไป

ประเภทเป้าหมาย

ค่าแจกแจง

"page"

"background_page"

"worker"

"other"

เมธอด

attach()

Promise

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

แนบโปรแกรมแก้ไขข้อบกพร่องกับเป้าหมายที่ระบุ

พารามิเตอร์

• เป้าหมาย

  Debuggee

  เป้าหมายการแก้ไขข้อบกพร่องที่คุณต้องการแนบ

• requiredVersion

  สตริง

  ต้องใช้เวอร์ชันโปรโตคอลการแก้ไขข้อบกพร่อง ("0.1") คุณจะแนบกับผู้แก้ไขข้อบกพร่องได้ก็ต่อเมื่อมีเวอร์ชันหลักที่ตรงกันและเวอร์ชันย่อยที่มากกว่าหรือเท่ากัน ดูรายการเวอร์ชันของโปรโตคอลได้ที่นี่

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  () => void

การคืนสินค้า

• Promise<void>

  Chrome 96 ขึ้นไป

  แก้ไขเมื่อการดำเนินการแนบสำเร็จหรือล้มเหลว Promise จะได้รับการแก้ไขโดยไม่มีค่า หากแนบไม่สำเร็จ ระบบจะปฏิเสธสัญญา

  ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

detach()

Promise

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

แยกโปรแกรมแก้ไขข้อบกพร่องออกจากเป้าหมายที่ระบุ

พารามิเตอร์

• เป้าหมาย

  Debuggee

  เป้าหมายการแก้ไขข้อบกพร่องที่คุณต้องการแยกออก

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  () => void

การคืนสินค้า

• Promise<void>

  Chrome 96 ขึ้นไป

  แก้ไขเมื่อการดำเนินการแยกสำเร็จหรือล้มเหลว Promise จะได้รับการแก้ไขโดยไม่มีค่า หากการแยกไม่สำเร็จ ระบบจะปฏิเสธ Promise

  ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

getTargets()

Promise

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

แสดงรายการเป้าหมายการแก้ไขข้อบกพร่องที่ใช้ได้

พารามิเตอร์

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (result: TargetInfo[]) => void

  • ผลลัพธ์

    TargetInfo[]

    อาร์เรย์ของออบเจ็กต์ TargetInfo ที่สอดคล้องกับเป้าหมายการแก้ไขข้อบกพร่องที่พร้อมใช้งาน

การคืนสินค้า

• Promise<TargetInfo[]>

  Chrome 96 ขึ้นไป

  ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

sendCommand()

Promise

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

ส่งคำสั่งที่ระบุไปยังเป้าหมายการแก้ไขข้อบกพร่อง

พารามิเตอร์

• เป้าหมาย

  DebuggerSession

  เป้าหมายการแก้ไขข้อบกพร่องที่คุณต้องการส่งคำสั่ง

• method

  สตริง

  ชื่อเมธอด ควรเป็นหนึ่งในวิธีการที่กำหนดโดยโปรโตคอลการแก้ไขข้อบกพร่องระยะไกล

• commandParams

  object ไม่บังคับ

  ออบเจ็กต์ JSON ที่มีพารามิเตอร์คำขอ ออบเจ็กต์นี้ต้องเป็นไปตามรูปแบบพารามิเตอร์การแก้ไขข้อบกพร่องระยะไกลสำหรับเมธอดที่ระบุ

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (result?: object) => void

  • ผลลัพธ์

    object ไม่บังคับ

    ออบเจ็กต์ JSON พร้อมการตอบกลับ โครงสร้างของการตอบกลับจะแตกต่างกันไปตามชื่อเมธอด และกำหนดโดยแอตทริบิวต์ "returns" ของคำอธิบายคำสั่งในโปรโตคอลการแก้ไขข้อบกพร่องระยะไกล

การคืนสินค้า

• Promise<object | undefined>

  Chrome 96 ขึ้นไป

  เนื้อหาการตอบกลับ หากเกิดข้อผิดพลาดขณะโพสต์ข้อความ ระบบจะปฏิเสธ Promise

  ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

กิจกรรม

onDetach

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

เริ่มทำงานเมื่อเบราว์เซอร์สิ้นสุดเซสชันการแก้ไขข้อบกพร่องสำหรับแท็บ กรณีนี้จะเกิดขึ้นเมื่อปิดแท็บหรือเรียกใช้เครื่องมือสำหรับนักพัฒนาเว็บใน Chrome สำหรับแท็บที่แนบมา

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (source: Debuggee, reason: DetachReason) => void

  • source

    Debuggee

  • เหตุผล

    DetachReason

onEvent

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

เริ่มทำงานเมื่อใดก็ตามที่เป้าหมายการแก้ไขข้อบกพร่องทำให้เกิดเหตุการณ์การวัดผล

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (source: DebuggerSession, method: string, params?: object) => void

  • source

    DebuggerSession

  • method

    สตริง

  • params

    object ไม่บังคับ