chromiumoxide

chromiumoxide 提供了一个高级和异步 API，通过 DevTools Protocol 控制 Chrome 或 Chromium。它支持所有类型的 Chrome DevTools Protocol，并可以启动一个 无头 或全功能（非无头）Chrome 或 Chromium 实例，或连接到一个已运行的实例。

用法

use futures::StreamExt;

use chromiumoxide::browser::{Browser, BrowserConfig};

#[async_std::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    
   // create a `Browser` that spawns a `chromium` process running with UI (`with_head()`, headless is default) 
   // and the handler that drives the websocket etc.
    let (mut browser, mut handler) =
        Browser::launch(BrowserConfig::builder().with_head().build()?).await?;
    
   // spawn a new task that continuously polls the handler
    let handle = async_std::task::spawn(async move {
        while let Some(h) = handler.next().await {
            if h.is_err() {
                break;
            }
        }
    });
    
   // create a new browser page and navigate to the url
    let page = browser.new_page("https://en.wikipedia.org").await?;
    
   // find the search bar type into the search field and hit `Enter`,
   // this triggers a new navigation to the search result page
   page.find_element("input#searchInput")
           .await?
           .click()
           .await?
           .type_str("Rust programming language")
           .await?
           .press_key("Enter")
           .await?;

   let html = page.wait_for_navigation().await?.content().await?;
   
    browser.close().await?;
    handle.await;
    Ok(())
}

当前的 API 还缺少一些功能，但 Page::execute 函数允许发送所有 chromiumoxide_types::Command 类型（参见 生成代码）。大多数 Element 和 Page 函数基本上只是简化的命令构造和组合，例如 Page::pdf

pub async fn pdf(&self, params: PrintToPdfParams) -> Result<Vec<u8>> {
     let res = self.execute(params).await?;
     Ok(base64::decode(&res.data)?)
 }

如果您需要其他功能，Page::execute 函数允许编写您自己的命令包装器。如果您认为缺少一个有意义的命令函数，PR 非常受欢迎。

将 chromiumoxide 添加到您的项目中

chromiumoxide 随带 async-std 和 tokio 运行时支持。

默认情况下，chromiumoxide 配置为使用 async-std。

使用 chromiumoxide 与 async-std 运行时

chromiumoxide = { git = "https://github.com/mattsse/chromiumoxide", branch = "main"}

要使用 tokio 运行时，请添加 features = ["tokio-runtime"] 并将 default-features = false 设置为禁用默认运行时（async-std）

chromiumoxide = { git = "https://github.com/mattsse/chromiumoxide", features = ["tokio-runtime"], default-features = false, branch = "main"}

这种配置主要是由我们选择的websocket库实现的：async-tungstenite。

生成代码

chromiumoxide_pdl 库包含一个 PDL 解析器，这是对铬源树中一个 python 脚本 的 Rust 重写，以及一个 Generator，它将解析的 PDL 文件转换为 Rust 代码。chromiumoxide_cdp 库的唯一目的是在其 构建过程中调用生成器 并 包含生成的输出，然后再编译该库本身。这种分离仅仅是因为生成的输出是大约 60K 行的 Rust 代码（不包括所有 proc 宏展开）。因此，请预期编译会花费一些时间。生成器可以独立配置和使用，请参阅 chromiumoxide_cdp/build.rs。

每个 Chrome PDL 域都放在自己的 Rust 模块中，浏览器协议页面域的类型在 chromiumoxide_cdp::cdp::browser_protocol::page，js_protocol 的运行时域在 chromiumoxide_cdp::cdp::js_protocol::runtime 等。

vanilla.aslushnikov.com 是浏览在 PDL 文件中定义的所有类型的绝佳资源。该网站将 PDL 文件中定义的 Command 类型显示为 Method。chromiumoxid 保留 Command 命名法。因此，对于在 PDL 中定义为命令类型的一切（在 vanilla.aslushnikov.com 上标记为 Method），chromiumoxide 包含一个命令类型和一个指定的返回类型。对于每个命令，都有一个具有构建支持的 <命令名称>Params 类型（<命令名称>Params::builder()）及其对应的返回类型：<命令名称>。所有命令共享 chromiumoxide_types::Command 特性的实现。所有事件都打包在单个枚举中（CdpEvent）

use std::path::Path;

use futures::StreamExt;

use chromiumoxide::browser::{BrowserConfig};
use chromiumoxide::fetcher::{BrowserFetcher, BrowserFetcherOptions};

#[async_std::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let download_path = Path::new("./download");
    async_std::fs::create_dir_all(&download_path).await?;
    let fetcher = BrowserFetcher::new(
        BrowserFetcherOptions::builder()
            .with_path(&download_path)
            .build()?,
    );
    let info = fetcher.fetch().await?;

    let config = BrowserConfig::builder()
        .chrome_executable(info.executable_path)
        .build()?,
}