com.ruiyun.jvppeteer.api.core

类 Browser

java.lang.Object

com.ruiyun.jvppeteer.api.core.EventEmitter<BrowserEvents>

com.ruiyun.jvppeteer.api.core.Browser

所有已实现的接口:

AutoCloseable

直接已知子类:

BidiBrowser, CdpBrowser

public abstract class Browser
extends EventEmitter<BrowserEvents>
implements AutoCloseable

字段概要

字段

限定符和类型	字段和说明
boolean	autoClose 主动调用 browser.close时候为true 当 connection 断开，浏览器进程未关闭时候，杀死浏览器进程

构造器概要

构造器

构造器和说明
Browser()

方法概要

限定符和类型	方法和说明
abstract List<BrowserContext>	browserContexts() 获取打开的 浏览器上下文 列表。
abstract void	cancelDownload(String key, String id)
abstract boolean	connected() Jvppeteer 是否连接到此 browser。
List<Cookie>	cookies() 获取当前默认浏览器上下文中的所有Cookie 此方法用于收集默认浏览器上下文中所有的Cookie信息，以便于后续处理或分析 它调用了defaultBrowserContext()方法获取默认浏览器上下文，然后调用该上下文的cookies()方法来获取Cookie列表
BrowserContext	createBrowserContext() 创建一个新的 浏览器上下文。
abstract BrowserContext	createBrowserContext(BrowserContextOptions options) 创建一个新的 浏览器上下文。
abstract DebugInfo	debugInfo() 从 Jvppeteer 获取 debug 信息 目前，信息包括待处理的协议调用。
abstract BrowserContext	defaultBrowserContext() 获取默认 浏览器上下文。
abstract void	disconnect() 断开 Jvppeteer 与该 browser 的连接，但保持进程运行。
void	disposeSymbol() 释放所有监听器
abstract boolean	isNetworkEnabled()
abstract Page	newPage() 在 默认浏览器上下文 中创建新的 page。
List<Page>	pages() 获取此 Browser 内所有打开的 pages 的列表。
abstract Process	process() 获取关联的 Process。
void	setCookie(CookieData... cookies) 设置Cookie信息 此方法允许将一个或多个CookieData对象设置到默认浏览器上下文中 利用可变参数的功能，允许调用者以灵活的方式传递任意数量的CookieData对象
abstract void	setDownloadBehavior(DownloadOptions downloadOptions)
abstract Target	target() 获取与 默认浏览器上下文 关联的 target。
abstract <T extends Target> List<T>	targets() 获取所有活动的 targets。
abstract String	userAgent() 获取此 浏览器的 原始用户代理。
abstract String	version() 获取表示此 浏览器的 名称和版本的字符串。
Target	waitForTarget(Predicate<Target> predicate) 等待直到出现与给定 predicate 匹配的 target 并返回它.
Target	waitForTarget(Predicate<Target> predicate, int timeout) 等待直到出现与给定 predicate 匹配的 target 并返回它.
abstract String	wsEndpoint() 获取用于连接到此 browser 的 WebSocket URL。

从类继承的方法 com.ruiyun.jvppeteer.api.core.EventEmitter

emit, listenerCount, off, on, once, removeAllListeners, removeListener

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

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

从接口继承的方法 java.lang.AutoCloseable

close

字段详细资料

autoClose

public volatile boolean autoClose

主动调用 browser.close时候为true 当 connection 断开，浏览器进程未关闭时候，杀死浏览器进程

构造器详细资料

Browser

public Browser()

方法详细资料

process

public abstract Process process()

获取关联的 Process。

返回:

浏览器进程对象

createBrowserContext

public BrowserContext createBrowserContext()

创建一个新的 浏览器上下文。

这不会与其他 浏览器上下文 共享 cookie/缓存

返回:

返回创建的浏览器上下文对象

createBrowserContext

public abstract BrowserContext createBrowserContext(BrowserContextOptions options)

创建一个新的 浏览器上下文。

这不会与其他 浏览器上下文 共享 cookie/缓存

参数:

options - 浏览器上下文选项，包含代理服务器设置等

返回:

返回创建的浏览器上下文对象

browserContexts

public abstract List<BrowserContext> browserContexts()

获取打开的 浏览器上下文 列表。

在新创建的 browser 中，这将返回 BrowserContext 的单个实例。

返回:

打开的 浏览器上下文 列表

defaultBrowserContext

public abstract BrowserContext defaultBrowserContext()

获取默认 浏览器上下文。

默认 浏览器上下文 无法关闭。

返回:

默认 浏览器上下文

wsEndpoint

public abstract String wsEndpoint()

获取用于连接到此 browser 的 WebSocket URL。

这通常与 Puppeteer.connect() 一起使用。

你可以从 http://HOST:PORT/json/version 找到调试器 URL (webSocketDebuggerUrl)。

请参阅 浏览器端点 了解更多信息。

返回:

WebSocket URL

newPage

public abstract Page newPage()

在 默认浏览器上下文 中创建新的 page。

返回:

新创建的页面对象

targets

public abstract <T extends Target> List<T> targets()

获取所有活动的 targets。

如果有多个 浏览器上下文，则返回所有 浏览器上下文 中的所有 targets。

返回:

所有活动的 targets

target

public abstract Target target()

获取与 默认浏览器上下文 关联的 target。

返回:

默认浏览器上下文 关联的 target

waitForTarget

public Target waitForTarget(Predicate<Target> predicate,
                            int timeout)

等待直到出现与给定 predicate 匹配的 target 并返回它. 此方法用于在一定超时时间内，持续检查是否出现符合特定条件的目标对象.

参数:

predicate - 用于筛选目标对象的条件，符合条件的目标将被返回.

timeout - 等待的最大时间（以毫秒为单位），超过此时间将抛出异常.

返回:

返回符合 predicate 条件的目标对象.

waitForTarget

public Target waitForTarget(Predicate<Target> predicate)

等待直到出现与给定 predicate 匹配的 target 并返回它.

默认等待时间是30s

参数:

predicate - 用于筛选目标对象的条件，符合条件的目标将被返回.

返回:

返回符合 predicate 条件的目标对象.

pages

public List<Page> pages()

获取此 Browser 内所有打开的 pages 的列表。

如果有多个 浏览器上下文，则返回所有 浏览器上下文 中的所有 pages。

返回:

所有打开的 pages

version

public abstract String version()
                        throws com.fasterxml.jackson.core.JsonProcessingException

获取表示此 浏览器的 名称和版本的字符串。

对于无头浏览器，这与 "HeadlessChrome/61.0.3153.0" 类似。对于非无头或新无头，这与 "Chrome/61.0.3153.0" 类似。

对于火狐浏览器，这与 "Firefox/116.0a1"类似

Browser.version() 的格式可能会随着浏览器的未来版本而改变。

返回:

浏览器版本

抛出:

com.fasterxml.jackson.core.JsonProcessingException - 序列化错误

userAgent

public abstract String userAgent()

获取此 浏览器的 原始用户代理。

Pages 可以使用 Page.setUserAgent() 覆盖用户代理。e

返回:

原始用户代理

disconnect

public abstract void disconnect()

断开 Jvppeteer 与该 browser 的连接，但保持进程运行。

cookies

public List<Cookie> cookies()

获取当前默认浏览器上下文中的所有Cookie

此方法用于收集默认浏览器上下文中所有的Cookie信息，以便于后续处理或分析 它调用了defaultBrowserContext()方法获取默认浏览器上下文，然后调用该上下文的cookies()方法来获取Cookie列表

返回:

List 返回一个Cookie对象列表，包含了当前默认浏览器上下文中的所有Cookie

setCookie

public void setCookie(CookieData... cookies)

设置Cookie信息 此方法允许将一个或多个CookieData对象设置到默认浏览器上下文中 利用可变参数的功能，允许调用者以灵活的方式传递任意数量的CookieData对象

参数:

cookies - 一个或多个CookieData对象，代表要设置的Cookie信息

connected

public abstract boolean connected()

Jvppeteer 是否连接到此 browser。

返回:

连接返回true, 不连接返回false

disposeSymbol

public void disposeSymbol()

从类复制的说明: EventEmitter

释放所有监听器

覆盖:

disposeSymbol 在类中 EventEmitter<BrowserEvents>

debugInfo

public abstract DebugInfo debugInfo()

从 Jvppeteer 获取 debug 信息

目前，信息包括待处理的协议调用。将来，我们可能会添加更多信息。

返回:

debug 信息

setDownloadBehavior

public abstract void setDownloadBehavior(DownloadOptions downloadOptions)

cancelDownload

public abstract void cancelDownload(String key,
                                    String id)

isNetworkEnabled

public abstract boolean isNetworkEnabled()