Jvppeteer
本库的灵感来自 Puppeteer(Node.js), API 也与其基本上保持一致,做这个库是为了方便使用 Java 操控 Chrome 或 Chromium
Jvppeteer 通过 DevTools 控制 Chromium 或 Chrome。
默认情况下,以 headless 模式运行,也可以通过配置运行'有头'模式。
你可以在浏览器中手动执行的绝大多数操作都可以使用 Jvppeteer 来完成! 下面是一些示例:
生成页面 PDF。
抓取 SPA(单页应用)并生成预渲染内容(即“SSR”(服务器端渲染))。
自动提交表单,进行 UI 测试,键盘输入等。
创建一个时时更新的自动化测试环境。 使用最新的 JavaScript 和浏览器功能直接在最新版本的 Chrome 中执行测试。
捕获网站的 timeline trace,用来帮助分析性能问题。
测试浏览器扩展。
开始使用
以下是使用依赖管理工具(如 maven 或 gradle)的简要指南。
Maven
要使用 maven,请将此依赖添加到pom.xml文件中:
io.github.fanyong920
jvppeteer
1.0.4
Gradle
要使用 Gradle,请将 Maven 中央存储库添加到您的存储库列表中:
mavenCentral()
然后,您可以将最新版本添加到您的构建中。
compile "io.github.fanyong920:jvppeteer:1.0.4"
Logging
该库使用 SLF4J 进行日志记录,并且不附带任何默认日志记录实现。
调试程序将日志级别设置为 TRACE。
独立 jar
如果您不使用任何依赖项管理工具,则可以在此处找到最新的独立 jar 。
快速开始
1、启动浏览器
//设置基本的启动配置,这里选择了‘有头’模式启动
ArrayList argList = new ArrayList<>();
String path = "D:\\develop\\project\\toString\\chrome-win\\chrome.exe";
LaunchOptions options = new LaunchOptionsBuilder().withArgs(argList).withHeadless(false).withPipe(true).withExecutablePath(path).build();
argList.add("--no-sandbox");
argList.add("--disable-setuid-sandbox");
//启动
Puppeteer.launch(options);
在这个例子中,我们明确指明了启动路径,程序就会根据指明的路径启动对应的浏览器,如果没有明确指明路径,那么程序会尝试启动默认安装路径下的 Chrome 浏览器
2、导航至某个页面
String path ="D:\\develop\\project\\toString\\chrome-win\\chrome.exe";
ArrayList argList = new ArrayList<>();
LaunchOptions options = new LaunchOptionsBuilder().withArgs(argList).withHeadless(false).withExecutablePath(path).build();
argList.add("--no-sandbox");
argList.add("--disable-setuid-sandbox");
Browser browser = Puppeteer.launch(options);
Page page = browser.newPage();
page.goTo("https://www.taobao.com/about/");
browser.close();
这个例子中,浏览器导航到具体某个页面后关闭。在这里并没有指明启动路径。argList是放一些额外的命令行启动参数的,在下面资源章节中我会给出相关资料。
3、生成页面的 PDF
ArrayList argList = new ArrayList<>();
String path = "D:\\develop\\project\\toString\\chrome-win\\chrome.exe";
//生成pdf必须在无厘头模式下才能生效
LaunchOptions options = new LaunchOptionsBuilder().withArgs(argList).withHeadless(true).withExecutablePath(path).build();
argList.add("--no-sandbox");
argList.add("--disable-setuid-sandbox");
Browser browser = Puppeteer.launch(options);
Page page = browser.newPage();
page.goTo("https://www.baidu.com/?tn=98012088_10_dg&ch=3");
page.pdf("test.pdf");
在这个例子中,导航到某个页面后,将整个页面截图,并写成PDF文件。注意,生成PDF必须在headless模式下才能生效
4、TRACING 性能分析
ArrayList argList = new ArrayList<>();
String path = "D:\\develop\\project\\toString\\chrome-win\\chrome.exe";
LaunchOptions options = new LaunchOptionsBuilder().withArgs(argList).withHeadless(true).withExecutablePath(path).build();
argList.add("--no-sandbox");
argList.add("--disable-setuid-sandbox");
Browser browser = Puppeteer.launch(options);
Page page = browser.newPage();
//开启追踪
page.tracing().start("C:\\Users\\howay\\Desktop\\trace.json");
page.goTo("https://www.baidu.com/?tn=98012088_10_dg&ch=3");
page.tracing().stop();
//waifor tracingComplete
在这个例子中,将在页面导航完成后,生成一个 json 格式的文件,里面包含页面性能的具体数据,可以用 Chrome 浏览器开发者工具打开该 json 文件,并分析性能。
5、页面截图
ArrayList arrayList = new ArrayList<>();
String path = "D:\\develop\\project\\toString\\chrome-win\\chrome.exe";
LaunchOptions options = new LaunchOptionsBuilder().withArgs(arrayList).withHeadless(true).withExecutablePath(path).build();
arrayList.add("--no-sandbox");
arrayList.add("--disable-setuid-sandbox");
Browser browser = Puppeteer.launch(options);
Page page = browser.newPage();
page.goTo("https://www.baidu.com/?tn=98012088_10_dg&ch=3");
ScreenshotOptions screenshotOptions = new ScreenshotOptions();
//设置截图范围
Clip clip = new Clip(1.0,1.56,400,400);
screenshotOptions.setClip(clip);
//设置存放的路径
screenshotOptions.setPath("test.png");
page.screenshot(screenshotOptions);
页面导航完成后,设置截图范围以及图片保存路径,即可开始截图。
更多的例子请看这里
资源
执照
此仓库中找到的所有内容均已获得 Apache 许可。有关详细信息,请参见LICENSE文件