这是本节的多页打印视图。 点击此处打印.

返回本页常规视图.

Chrome DevTools 协议

使用 Selenium 操作 Chrome DevTools 协议的示例。 CDP 的支持是临时的，直到 WebDriver BiDi 实现为止。

许多浏览器提供“开发者工具”（DevTools），这是与浏览器集成的一组工具，开发人员可以使用它们来调试网页应用程序并探索网页的性能。Google Chrome 的开发者工具使用一种称为 Chrome DevTools 协议（简称 “CDP”）的协议。顾名思义，该协议并非为测试设计，也没有稳定的 API，因此功能很大程度上取决于浏览器的版本。

Selenium 正在致力于实现一种基于标准的、跨浏览器的、稳定的 CDP 替代方案，称为 [WebDriver BiDi]。在对该新协议的支持完成之前，Selenium 计划在适用的地方提供对 CDP 功能的访问。

在 Selenium 中使用 Chrome DevTools 协议

Chrome 和 Edge 提供了发送基本 CDP 命令的方法。 但对于需要双向通信的功能，这种方法无效。你需要知道在何时启用哪些域，以及域、方法和参数的确切名称和类型。

 Map<String, Object> cookie = new HashMap<>();  cookie.put("name", "cheese");  cookie.put("value", "gouda");  cookie.put("domain", "www.selenium.dev");  cookie.put("secure", true);  ((HasCdp) driver).executeCdpCommand("Network.setCookie", cookie);
 cookie = {'name': 'cheese',  'value': 'gouda',  'domain': 'www.selenium.dev',  'secure': True}   driver.execute_cdp_cmd('Network.setCookie', cookie)
 var cookie = new Dictionary<string, object>  {  { "name", "cheese" },  { "value", "gouda" },  { "domain", "www.selenium.dev" },  { "secure", true }  };  ((ChromeDriver)driver).ExecuteCdpCommand("Network.setCookie", cookie);
 driver.execute_cdp('Network.setCookie',  name: 'cheese',  value: 'gouda',  domain: 'www.selenium.dev',  secure: true)

Add Example

Add Example

为简化 CDP 的使用并提供对更高级功能的访问，Selenium 绑定会自动为最常见的域生成类和方法。
不过，CDP 方法和实现可能会因版本而异，因此你需要确保 Chrome 版本和 DevTools 版本相匹配。
Selenium 在任何时间点支持 Chrome 的最近三个版本，并且尽量同步发布以确保可以访问最新版本。

这种限制给一些绑定带来了额外的挑战，动态生成的 CDP 支持要求用户定期更新代码，以引用正确版本的 CDP。
在某些情况下，已创建了一个理想化的实现，它应该适用于任何版本的 CDP，而无需用户更改代码，但这并非总是可用。

关于如何在 Selenium 测试中使用 CDP 的示例可以在以下页面找到，但我们想提到一些常被引用但实际价值有限的例子：

  • 地理位置 ——几乎所有网站都使用 IP 地址来确定物理位置，因此设置模拟地理位置很少能达到预期效果。
  • 覆盖设备指标 ——Chrome 提供了一个很棒的 API 来在 Options 类中设置移动模拟，这通常比尝试使用 CDP 更优越。

1 - Chrome DevTools Logging Features

Logging features using CDP.

Page being translated from English to Chinese. Do you speak Chinese? Help us to translate it by sending us pull requests!

While Selenium 4 provides direct access to the Chrome DevTools Protocol, these methods will eventually be removed when WebDriver BiDi implemented.

Console Logs

 ((HasLogEvents) driver).onLogEvent(consoleEvent(e -> messages.add(e.getMessages().get(0))));
 async with driver.bidi_connection() as session:  async with Log(driver, session).add_listener(Console.ALL) as messages:
 using IJavaScriptEngine monitor = new JavaScriptEngine(driver);  var messages = new List<string>();  monitor.JavaScriptConsoleApiCalled += (_, e) =>  {  messages.Add(e.MessageContent);  };  await monitor.StartEventMonitoring();
 driver.on_log_event(:console) { |log| logs << log.args.first }

Implementation Missing

Add Example

JavaScript Exceptions

Implementation Missing

 async with driver.bidi_connection() as session:  async with Log(driver, session).add_js_error_listener() as messages:
 using IJavaScriptEngine monitor = new JavaScriptEngine(driver);  var messages = new List<string>();  monitor.JavaScriptExceptionThrown += (_, e) =>  {  messages.Add(e.Message);  };  await monitor.StartEventMonitoring();
 driver.on_log_event(:exception) { |exception| exceptions << exception }

Implementation Missing

Add Example

2 - Chrome DevTools Network Features

Network features using CDP.

Page being translated from English to Chinese. Do you speak Chinese? Help us to translate it by sending us pull requests!

While Selenium 4 provides direct access to the Chrome DevTools Protocol, these methods will eventually be removed when WebDriver BiDi implemented.

Basic authentication

Some applications make use of browser authentication to secure pages. It used to be common to handle them in the URL, but browsers stopped supporting this. With this code you can insert the credentials into the header when necessary

 Predicate<URI> uriPredicate = uri -> uri.toString().contains("herokuapp.com");  Supplier<Credentials> authentication = UsernameAndPassword.of("admin", "admin");  ((HasAuthentication) driver).register(uriPredicate, authentication);
 credentials = base64.b64encode("admin:admin".encode()).decode()  auth = {'authorization': 'Basic ' + credentials}  await connection.session.execute(connection.devtools.network.set_extra_http_headers(Headers(auth)))
 var handler = new NetworkAuthenticationHandler()  {  UriMatcher = uri => uri.AbsoluteUri.Contains("herokuapp"),  Credentials = new PasswordCredentials("admin", "admin")  };  var networkInterceptor = driver.Manage().Network;  networkInterceptor.AddAuthenticationHandler(handler);  await networkInterceptor.StartMonitoring();
 driver.register(username: 'admin',  password: 'admin',  uri: /herokuapp/)

Implementation Missing

Implementation Missing

Network Interception

Both requests and responses can be recorded or transformed.

Response information

 try (NetworkInterceptor ignored =  new NetworkInterceptor(  driver,  (Filter)  next ->  req -> {  HttpResponse res = next.execute(req);  contentType.add(res.getHeader("Content-Type"));  return res;  })) {

Implementation Missing

 INetwork networkInterceptor = driver.Manage().Network;  networkInterceptor.NetworkResponseReceived += (_, e) =>  {  contentType.Add(e.ResponseHeaders["content-type"]);  };  await networkInterceptor.StartMonitoring();
 driver.intercept do |request, &continue|  continue.call(request) do |response|  content_type << response.headers['content-type']  end  end

Implementation Missing

Add Example

Response transformation

 try (NetworkInterceptor ignored =  new NetworkInterceptor(  driver,  Route.matching(req -> true)  .to(  () ->  req ->  new HttpResponse()  .setStatus(200)  .addHeader("Content-Type", MediaType.HTML_UTF_8.toString())  .setContent(Contents.utf8String("Creamy, delicious cheese!"))))) {

Implementation Missing

 var handler = new NetworkResponseHandler()  {  ResponseMatcher = _ => true,  ResponseTransformer = _ => new HttpResponseData  {  StatusCode = 200,  Body = "Creamy, delicious cheese!"  }  };  INetwork networkInterceptor = driver.Manage().Network;  networkInterceptor.AddResponseHandler(handler);  await networkInterceptor.StartMonitoring();
 driver.intercept do |request, &continue|  continue.call(request) do |response|  response.body = 'Creamy, delicious cheese!' if request.url.include?('blank')  end  end

Implementation Missing

Add Example

Request interception

 try (NetworkInterceptor ignored =  new NetworkInterceptor(  driver,  (Filter)  next ->  req -> {  if (req.getUri().contains("one.js")) {  req =  new HttpRequest(  HttpMethod.GET, req.getUri().replace("one.js", "two.js"));  }  completed.set(true);  return next.execute(req);  })) {

Implementation Missing

 var handler = new NetworkRequestHandler  {  RequestMatcher = request => request.Url.Contains("one.js"),  RequestTransformer = request =>  {  request.Url = request.Url.Replace("one", "two");   return request;  }  };  INetwork networkInterceptor = driver.Manage().Network;  networkInterceptor.AddRequestHandler(handler);  await networkInterceptor.StartMonitoring();
 driver.intercept do |request, &continue|  uri = URI(request.url)  request.url = uri.to_s.gsub('one', 'two') if uri.path&.end_with?('one.js')  continue.call(request)  end

Implementation Missing

Add Example

Performance Metrics

 devTools.send(Performance.enable(Optional.empty()));  List<Metric> metricList = devTools.send(Performance.getMetrics());
 async with driver.bidi_connection() as connection:  await connection.session.execute(connection.devtools.performance.enable())  metric_list = await connection.session.execute(connection.devtools.performance.get_metrics())
 await domains.Performance.Enable(new OpenQA.Selenium.DevTools.V137.Performance.EnableCommandSettings());  var metricsResponse =  await session.SendCommand<GetMetricsCommandSettings, GetMetricsCommandResponse>(  new GetMetricsCommandSettings()  );
 driver.devtools.performance.enable  metric_list = driver.devtools.performance.get_metrics.dig('result', 'metrics')

Implementation Missing

Add Example

Setting Cookies

 devTools.send(  Network.setCookie(  "cheese",  "gouda",  Optional.empty(),  Optional.of("www.selenium.dev"),  Optional.empty(),  Optional.of(true),  Optional.empty(),  Optional.empty(),  Optional.empty(),  Optional.empty(),  Optional.empty(),  Optional.empty(),  Optional.empty(),  Optional.empty()));
 async with driver.bidi_connection() as connection:  execution = connection.devtools.network.set_cookie(  name="cheese",  value="gouda",  domain="www.selenium.dev",  secure=True  )  await connection.session.execute(execution)
 var cookieCommandSettings = new SetCookieCommandSettings  {  Name = "cheese",  Value = "gouda",  Domain = "www.selenium.dev",  Secure = true  };  await domains.Network.SetCookie(cookieCommandSettings);
 driver.devtools.network.set_cookie(name: 'cheese',  value: 'gouda',  domain: 'www.selenium.dev',  secure: true)

Implementation Missing

Add Example

Waiting for Downloads

 devTools.send(  Browser.setDownloadBehavior(  Browser.SetDownloadBehaviorBehavior.ALLOWANDNAME,  Optional.empty(),  Optional.of(""),  Optional.of(true)));

Implementation Missing

Implementation Missing

 driver.devtools.browser.set_download_behavior(behavior: 'allow',  download_path: '',  events_enabled: true)   driver.devtools.browser.on(:download_progress) do |progress|  @completed = progress['state'] == 'completed'  end

Implementation Missing

Add Example

3 - Chrome DevTools Script Features

Script features using CDP.

Page being translated from English to Chinese. Do you speak Chinese? Help us to translate it by sending us pull requests!

While Selenium 4 provides direct access to the Chrome DevTools Protocol, these methods will eventually be removed when WebDriver BiDi implemented.

Script Pinning

 ScriptKey key = ((JavascriptExecutor) driver).pin("return arguments;");  List<Object> arguments =  (List<Object>) ((JavascriptExecutor) driver).executeScript(key, 1, true, element);

Implementation Missing

 var key = await new JavaScriptEngine(driver).PinScript("return arguments;");  var arguments = ((WebDriver)driver).ExecuteScript(key, 1, true, element);
 key = driver.pin_script('return arguments;')  arguments = driver.execute_script(key, 1, true, element)

Implementation Missing

Add Example

DOM Mutation Handlers

 async with driver.bidi_connection() as session:  async with Log(driver, session).mutation_events() as event:
 using IJavaScriptEngine monitor = new JavaScriptEngine(driver);  monitor.DomMutated += (_, e) =>  {  var locator = By.CssSelector($"*[data-__webdriver_id='{e.AttributeData.TargetId}']");  mutations.Add(driver.FindElement(locator));  };  await monitor.StartEventMonitoring();  await monitor.EnableDomMutationMonitoring();
 driver.on_log_event(:mutation) { |mutation| mutations << mutation.element }

Implementation Missing

Add Example