OML Pipe Functions 函数索引

本文档列出了 WP-Motor OML 语言中所有可用的 pipe function（管道函数）。

字段访问函数 (Field Accessors)

字符串匹配函数 (String Matching)

值转换函数 (Value Transformation)

编码/解码函数 (Encoding/Decoding)

时间转换函数 (Time Conversion)

网络函数 (Network)

URL/路径解析函数 (URL/Path Parsing)

控制流函数 (Control Flow)

函数分类总览

按功能分类

1. 数据提取函数

从输入数据或嵌套结构中提取字段。

• take(field): 提取顶层字段
• get(key): 提取嵌套字段
• nth(index): 提取数组元素

2. 条件过滤函数

检查条件，不满足时转换为 ignore。

• starts_with(prefix): 前缀匹配

3. 值映射函数

修改字段值或类型。

• map_to(value): 通用值映射
• to_str: 转字符串
• to_json: 转 JSON

4. 编码转换函数

在不同编码格式之间转换。

• Base64: base64_encode, base64_decode
• HTML: html_escape, html_unescape
• JSON: json_escape, json_unescape

5. 时间处理函数

处理时间相关的转换。

• 时间戳转换: Time::to_ts*
• 时区转换: Time::to_ts_zone

6. 网络处理函数

处理网络相关数据。

• IP 地址: ip4_to_int
• URL 解析: url(type)
• 路径解析: path(type)

使用示例

基本管道

name : basic_pipeline
---
# 1. 提取字段
result = pipe take(message)
    # 2. 过滤条件
    | starts_with('ERROR')
    # 3. 值映射
    | map_to('error_type');

复杂转换

name : complex_transformation
---
# 提取并转换时间
timestamp_ms = pipe take(time_str)
    | Time::to_ts_ms;

# Base64 编码
encoded = pipe take(message)
    | base64_encode;

# URL 解析
host = pipe take(url)
    | url(host);

条件分类

name : conditional_classification
---
# 根据 URL 前缀分类安全级别
high_security = pipe take(url)
    | starts_with('https://')
    | map_to(3);

low_security = pipe take(url)
    | starts_with('http://')
    | map_to(1);

数据清洗

name : data_cleaning
---
# 提取并清理数据
clean_message = pipe take(raw_message)
    | html_unescape
    | json_unescape
    | skip_empty;

性能参考

最佳实践

1. 合理使用管道链

# ✅ 推荐：按逻辑顺序组织管道
result = pipe take(field)
    | starts_with('prefix')  # 先过滤
    | map_to('value');      # 再映射

# ⚠️ 避免：不必要的长管道
result = pipe take(field)
    | to_str
    | to_json
    | to_str  # 冗余操作

2. 利用 ignore 传播

# ✅ 推荐：利用 ignore 跳过后续处理
secure_flag = pipe take(url)
    | starts_with('https://')  # 失败返回 ignore
    | map_to(true);           # ignore 会跳过此步

# 这样可以安全地处理条件逻辑

3. 选择合适的函数

# ✅ 推荐：使用专用函数
result = pipe take(field) | map_to(123);  # 自动推断为整数

# ⚠️ 不推荐：手动转换
result = pipe take(field) | to_str | map_to('123');  # 额外开销

4. 避免重复提取

# ✅ 推荐：一次提取，多次使用
url_field = pipe take(url);
host = pipe take(url) | url(host);
path = pipe take(url) | url(path);

# ⚠️ 避免：每次都提取同一字段（性能影响小但不够清晰）

函数对比

starts_with vs 正则表达式

map_to vs to_str

相关文档

• 开发指南: OML Pipe Function 开发指南
• 语法参考: OML 语法指南

版本历史

• 1.13.4 (2026-02-03)

  • 新增 starts_with 函数
  • 新增 map_to 函数，支持多种类型自动推断
  • 完善文档体系

• 1.13.3 (2026-02-03)

  • 修复编译错误

• 1.13.2 (2026-02-03)

  • 完善 pipe 函数支持

提示: OML pipe 函数设计用于数据转换和映射。合理使用 ignore 机制可以实现灵活的条件逻辑。