com.ruiyun.jvppeteer.cdp.core

类 Puppeteer

java.lang.Object

com.ruiyun.jvppeteer.cdp.core.Puppeteer

public class Puppeteer
extends Object

Puppeteer 也可以用来控制 Chrome 浏览器， 但它与绑定的 Chrome for Testing 版本在一起使用效果最好。不能保证它可以与任何其他版本一起使用。谨慎地使用 executablePath 选项。 如果 Google Chrome（而不是Chromium）是首选，一个 Chrome Canary 或 Dev Channel 版本是建议的

作者:

fff

构造器概要

构造器

构造器和说明
Puppeteer()
Puppeteer(String cacheDir, Product product)

方法概要

限定符和类型	方法和说明
static Browser	connect(ConnectOptions options) 建立与浏览器的连接 该方法使用给定的连接选项，通过Puppeteer实例来启动和管理浏览器的连接 browserWSEndpoint、browserURL或者ConnectionTransport至少有一个配置 此外还要指定连接协议 protocol,如果不指定，默认通过cdp连接 browserWSEndpoint的形式是 ws:http://host:port，可通过Browser.wsEndpoint()获取 browserURL: 类似 localhost:8080 firefox浏览器连接协议 webdriver bidi,chrome浏览器连接协议 cdp
static RevisionInfo	downloadBrowser() 下载默认版本的浏览器，默认下载 chrome 浏览器，默认版本配置在 BrowserRevision 本方法负责下载用于自动化测试的浏览器该方法使用Puppeteer类来初始化浏览器Fetcher对象， 并通过该对象下载浏览器到指定的项目根目录下
static RevisionInfo	downloadBrowser(FetcherOptions options) 通过自定义配置选项下载浏览器 根据提供的选项下载浏览器此方法首先检查选项中提供的安装路径是否为空如果为空， 则将其默认设置为当前用户目录然后，创建一个BrowserFetcher对象并使用指定的路径和选项 开始下载过程最后，返回下载的浏览器信息
static RevisionInfo	downloadBrowser(String version) 下载Product#CHROME的某个版本的浏览器 本方法用于下载指定版本的浏览器它首先验证版本号是否有效，然后使用 FetcherOptions 配置下载过程， 最后通过 BrowserFetcher 执行实际的下载操作
String	getCacheDir()
Product	getProduct()
static Browser	launch() 以默认参数启动浏览器 launch Browser by default options
static Browser	launch(boolean headless)
static Browser	launch(LaunchOptions options)
static Browser	rawLaunch(LaunchOptions options, Puppeteer puppeteer) The method launches a browser instance with given arguments.
void	setCacheDir(String cacheDir)
void	setProduct(Product product)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Puppeteer

public Puppeteer()

Puppeteer

public Puppeteer(String cacheDir,
                 Product product)

方法详细资料

launch

public static Browser launch()
                      throws IOException

以默认参数启动浏览器 launch Browser by default options

返回:

浏览器

抛出:

IOException - IO异常

launch

public static Browser launch(boolean headless)
                      throws IOException

抛出:

IOException

launch

public static Browser launch(LaunchOptions options)
                      throws IOException

抛出:

IOException

rawLaunch

public static Browser rawLaunch(LaunchOptions options,
                                Puppeteer puppeteer)
                         throws IOException

The method launches a browser instance with given arguments. The browser will be closed when the parent java process is closed.

参数:

options - launch options browserWSEndpoint、browserURL、transport三者至少选一个

puppeteer - puppeteer实例

返回:

浏览器实例

抛出:

IOException - IO异常

connect

public static Browser connect(ConnectOptions options)
                       throws Exception

建立与浏览器的连接 该方法使用给定的连接选项，通过Puppeteer实例来启动和管理浏览器的连接

browserWSEndpoint、browserURL或者ConnectionTransport至少有一个配置 此外还要指定连接协议 protocol,如果不指定，默认通过cdp连接

browserWSEndpoint的形式是 ws:http://host:port，可通过Browser.wsEndpoint()获取

browserURL: 类似 localhost:8080

firefox浏览器连接协议 webdriver bidi,chrome浏览器连接协议 cdp

参数:

options - 连接到浏览器所需的配置选项，例如浏览器的browserWSEndpoint、browserURL或者ConnectionTransport等

返回:

返回一个Browser对象，表示与浏览器的连接

抛出:

Exception - 如果连接过程中出现错误，将抛出异常

downloadBrowser

public static RevisionInfo downloadBrowser()
                                    throws IOException,
                                           InterruptedException

下载默认版本的浏览器，默认下载 chrome 浏览器，默认版本配置在 BrowserRevision

本方法负责下载用于自动化测试的浏览器该方法使用Puppeteer类来初始化浏览器Fetcher对象， 并通过该对象下载浏览器到指定的项目根目录下

返回:

返回一个RevisionInfo对象，包含下载浏览器的版本信息

抛出:

IOException - 如果在下载过程中发生I/O错误

InterruptedException - 如果在下载过程中线程被中断

downloadBrowser

public static RevisionInfo downloadBrowser(FetcherOptions options)
                                    throws IOException,
                                           InterruptedException

通过自定义配置选项下载浏览器

根据提供的选项下载浏览器此方法首先检查选项中提供的安装路径是否为空如果为空， 则将其默认设置为当前用户目录然后，创建一个BrowserFetcher对象并使用指定的路径和选项 开始下载过程最后，返回下载的浏览器信息

参数:

options - FetcherOptions对象，包含浏览器下载的配置选项

返回:

RevisionInfo对象，包含下载的浏览器的信息

抛出:

IOException - 如果在下载过程中发生I/O错误

InterruptedException - 如果在下载过程中线程被中断

downloadBrowser

public static RevisionInfo downloadBrowser(String version)
                                    throws IOException,
                                           InterruptedException

下载Product#CHROME的某个版本的浏览器

本方法用于下载指定版本的浏览器它首先验证版本号是否有效，然后使用 FetcherOptions 配置下载过程， 最后通过 BrowserFetcher 执行实际的下载操作

参数:

version - 要下载的浏览器版本号版本号不能为空

返回:

返回一个 RevisionInfo 对象，包含下载浏览器的版本信息

抛出:

IOException - 如果在下载过程中发生 I/O 错误

InterruptedException - 如果在下载过程中线程被中断

getCacheDir

public String getCacheDir()

setCacheDir

public void setCacheDir(String cacheDir)

getProduct

public Product getProduct()

setProduct

public void setProduct(Product product)