脚本基础
权限限制
本页面仅对开发者权限用户可见。
了解 Orina 自动化脚本的基本结构和组成。
脚本文件结构
每个脚本文件包含以下部分:
javascript
// =====================================================
// 文件头注释(必需)
// =====================================================
// 脚本名称: [脚本名称]
// 入口URL: [默认入口URL]
// 版本: [当前版本]
// 作者: [作者信息]
// effixwork-generated-by: orina-designer
// =====================================================
// 导入部分
import { chromium } from 'playwright';
import someModule from '@modules/some-module';
// 主函数
export default async function ({ page, context, params }) {
// 自动化逻辑
}文件头注释
文件头注释是必需的,包含:
| 字段 | 必需 | 说明 |
|---|---|---|
| 脚本名称 | 是 | 显示在运行器中的名称 |
| 入口URL | 是 | 默认运行的起始页面 |
| 版本 | 否 | 当前版本号 |
| 作者 | 否 | 作者信息 |
| effixwork-generated-by | 是 | 标识 Orina 生成 |
主函数签名
javascript
export default async function (runtime) {
// runtime 包含:
// - page: Playwright Page 对象
// - context: Playwright BrowserContext
// - params: 用户配置的参数
// - browser: Browser 对象
// - log: 日志函数
}runtime 对象
| 属性 | 类型 | 说明 |
|---|---|---|
| page | Page | 当前页面对象 |
| context | BrowserContext | 浏览器上下文 |
| params | Object | 脚本参数 |
| browser | Browser | 浏览器实例 |
| log | Function | 日志输出函数 |
参数系统
参数类型
| 类型 | 说明 | 示例 |
|---|---|---|
| text | 文本输入 | 用户名、URL |
| number | 数字输入 | 数量、延迟时间 |
| textarea | 多行文本 | JSON 数据 |
| select | 下拉选择 | 平台选择 |
| radio | 单选按钮 | 模式选择 |
| checkbox | 复选框 | 功能开关 |
| json | JSON 编辑器 | 复杂配置 |
使用参数
javascript
export default async function ({ page, params }) {
// params 包含用户配置的所有参数
const username = params.username;
const platform = params.platform; // select 类型
const features = params.features; // checkbox 类型,数组
await page.fill('#username', username);
}脚本状态
脚本执行过程中有不同状态:
| 状态 | 说明 |
|---|---|
| idle | 空闲,未运行 |
| running | 正在执行 |
| paused | 已暂停 |
| stopping | 正在停止 |
| success | 执行成功 |
| error | 执行出错 |
错误处理
javascript
export default async function ({ page, params, log }) {
try {
await page.click('#submit');
log('info', '点击提交成功');
} catch (error) {
log('error', `点击失败: ${error.message}`);
// 可以选择继续或抛出错误
}
}日志输出
javascript
export default async function ({ page, log }) {
log('info', '开始执行任务');
log('debug', '详细信息,调试时可见');
log('warn', '警告信息');
log('error', '错误信息');
// 或使用 console.log
console.log('标准输出');
}下一步
- Playwright API - Playwright 详细用法
- 参数配置 - 参数配置详解
- 版本管理 - 版本管理