npm 包 jsbrowser 使用教程

阅读时长 6 分钟读完

在前端开发中,我们经常需要在网页中通过 JavaScript 代码来模拟浏览器行为,实现一些自动化的操作,例如爬虫、表单自动填充、页面截图等。而 jsbrowser 就是一个能够使用 JavaScript 代码来模拟浏览器行为的 npm 包。

本篇文章将为您详细介绍 jsbrowser 的使用方法,包括安装、环境配置、API 结构和实例演示等。

安装和环境配置

在开始使用 jsbrowser 前,我们需要先安装 npm 包并配置环境变量。使用下方指令安装 jsbrowser:

然后在您的代码中引入 jsbrowser:

Browser 类的 API 结构

Browser 类是 jsbrowser 中最重要的一个类,该类的实例可以模拟浏览器的行为。下面是 Browser 类的主要 API:

构造函数

new Browser(options: Object): Browser

该构造函数返回一个 Browser 实例。options 参数中包含浏览器的配置,可以使用下面的属性:

  • width: 浏览器的宽度,默认值为 800。
  • height: 浏览器的高度,默认值为 600。
  • headless: 是否允许无头模式,默认值为 true
  • args: 传递给浏览器的启动参数。
  • slowMo: 调成该值会使每个操作之间加一定的延迟,以避免某些问题。
  • devtools: 是否开启开发人员工具。

goto 方法

async goto(url: string, options?: Object): Promise<void>

该方法用来访问网页,url 参数表示要访问的网址,options 参数可以包含以下属性:

  • waitUntil: 等待直到页面加载完成,可选值有 loaddomcontentloadednetworkidle0,默认值为 load
  • timeout: 页面加载的最长时间,默认值为 30000。
  • referer: 设置 HTTP 请求中的 Referer 字段。
  • headers: 为 HTTP 请求添加一些自定义的头信息。

screenshot 方法

async screenshot(options?: Object): Promise<Buffer>

该方法用来截取浏览器的屏幕截图,返回一个 Buffer 对象。

setCookie 方法

async setCookie(cookie: Object): Promise<void>

该方法用来设置 cookie,cookie 参数为 cookie 数据对象,包含以下属性:

  • name:cookie 名称。
  • value:cookie 值。
  • domain:cookie 域名。
  • path:cookie 路径。
  • expires:cookie 到期时间(Date 对象)。
  • httpOnly:是否是 httpOnly 的 cookie。
  • secure:是否是 HTTPS 的 cookie。

注意:如果您想要使用该方法,您需要在 Browser 的构造函数中添加 args 参数:

eval 方法

async eval(fn: Function, ...args: any[]): Promise<any>

该方法用来在页面上执行 JavaScript 代码。fn 参数是一个要在页面上执行的函数,该函数对象的字面量必须返回可序列化的对象。第二个参数以后是传递给函数的参数,该方法返回一个 Promise 对象,Promise 对象的解析值就是函数的返回值。

type 方法

async type(selector: string, text: string): Promise<void>

该方法用来将文本输入到一个表单元素中。selector 是一个页面元素的选择器,text 是要输入的文本。

click 方法

async click(selector: string, options?: Object): Promise<void>

该方法用来模拟单击操作,selector 是一个页面元素的选择器,options 参数可以用来配置如下属性:

  • button: 点击使用的按钮编号,默认为 0(表示左键)。
  • clickCount: 该属性用来设置点击次数,默认为 1。
  • delay: 该属性用来设置单击的延迟时间,默认为 0。

实例演示

下面是一个简单的演示,该示例使用 jsbrowser 来搜索 Google 并截图:

-- -------------------- ---- -------
----- - ------- - - ---------------------

----- -------- ------------------ -
  ----- ------- - --- ---------
    ------ -----
    ------- ----
    --------- ----
  ---

  ----- ---------------------------------------
  ----- -------------------------- --------------
  ----- -------------------------------
  ----- ----------------------------------
  ----- ----- - ----- ---------------------

  ----- ----------------
  ------ ------
-

----------------------------- -- -
  ---------------- ---------- ---- ----- ---------------- ---------
---

上述演示代码中,我们首先创建了一个 Browser 的实例,并使用 goto 方法访问了 https://www.google.com 网站。接着,使用 type 方法在页面上填写了“javascript”关键字并通过 click 方法模拟在“Google 搜索”按钮上点击。

在搜索按钮被单击后,我们使用 waitUntil 方法等待页面的加载完成,随后执行 screenshot 方法来对浏览器当前的页面进行截图。最后通过 close 方法提交并关闭该页面。

总结

本篇文章详细介绍了 npm 包 jsbrowser 的使用方法,包括安装和环境配置、Browser 类的 API 结构和实例演示。相信在掌握了这些信息后,您可以更灵活地使用 jsbrowser,实现自动化的操作,提升开发效率。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055f0d81e8991b448dca41

纠错
反馈