入口类型参考

Wippy 中所有可用入口类型的完整参考。

入口之间使用 namespace:name 格式相互引用。注册表根据这些引用自动连接依赖关系，确保资源按正确顺序初始化。

参见

• 注册表 - 入口的存储和解析方式
• 配置 - YAML 配置格式

Lua 运行时

- name: handler
  kind: function.lua
  source: file://handler.lua
  method: main
  modules:
    - http
    - json
  imports:
    utils: app.lib:helpers  # 将另一个入口作为模块导入

HTTP 服务

# HTTP 服务器
- name: gateway
  kind: http.service
  addr: ":8080"
  lifecycle:
    auto_start: true

# 带中间件的路由
- name: api
  kind: http.router
  meta:
    server: gateway
  prefix: /api
  middleware:
    - cors
    - ratelimit

# 端点
- name: users_list
  kind: http.endpoint
  meta:
    router: app:api
  method: GET
  path: /users
  func: list_handler

Lua API： 参见 HTTP 模块

local http = require("http")
local req = http.request()
local resp = http.response()

resp:set_status(200)
resp:write_json({users = get_users()})

数据库

SQLite

- name: database
  kind: db.sql.sqlite
  file: "./data/app.db"
  lifecycle:
    auto_start: true

# 用于测试的内存数据库
- name: testdb
  kind: db.sql.sqlite
  file: ":memory:"

PostgreSQL

- name: database
  kind: db.sql.postgres
  host: localhost
  port: 5432
  database: dbname
  username: user
  password: pass
  options:
    sslmode: disable
  pool:
    max_open: 25
    max_idle: 5
    max_lifetime: "30m"
  lifecycle:
    auto_start: true

MySQL

- name: database
  kind: db.sql.mysql
  host: localhost
  port: 3306
  database: dbname
  username: user
  password: pass
  options:
    parseTime: "true"
  lifecycle:
    auto_start: true

参见 Database 了解 ${env:NAME} 密钥引用、TLS 选项和连接池调优。当数据库条目背后由 env 支持的值发生变化时，连接池会实时切换 — 活跃的借用连接会在旧连接设置下完成。

Lua API： 参见 SQL 模块

local sql = require("sql")
local db, err = sql.get("app:database")

local rows, err = db:query("SELECT * FROM users WHERE id = ?", user_id)
db:execute("INSERT INTO logs (msg) VALUES (?)", message)

键值存储

# 内存存储
- name: cache
  kind: store.memory
  lifecycle:
    auto_start: true

# SQL 后端存储
- name: persistent_store
  kind: store.sql
  database: app:database
  table_name: kv_store
  lifecycle:
    auto_start: true

# 集群复制存储（需要启用集群）
- name: deployments
  kind: store.kv.raft
  namespace: deploy

store.kv.* 类型需要启用集群。一致性权衡参见 Store。

Lua API： 参见 Store 模块

local store = require("store")
local s, err = store.get("app:cache")

s:set("user:123", user_data, 3600)  -- TTL 单位为秒
local data = s:get("user:123")

队列

# 驱动
- name: queue_driver
  kind: queue.driver.memory
  lifecycle:
    auto_start: true

# 队列
- name: jobs
  kind: queue.queue
  driver: queue_driver

# 消费者
- name: job_consumer
  kind: queue.consumer
  queue: app:jobs
  func: job_handler
  concurrency: 4
  prefetch: 10
  lifecycle:
    auto_start: true

Lua API： 参见 Queue 模块

local queue = require("queue")

-- 发布消息
queue.publish("app:jobs", {task = "process", id = 123})

-- 在消费者处理函数中：消息体就是处理函数的参数
local function main(data)
    -- 通过当前消息访问投递元数据
    local msg = queue.message()
    local id = msg:id()
    local priority = msg:header("priority")
    msg:ack()
end

进程管理

# 进程宿主（进程运行的地方）
- name: processes
  kind: process.host
  host:
    workers: 32             # 工作 goroutine 数（默认：NumCPU）
    queue_size: 1024        # 全局队列容量
    local_queue_size: 256   # 每个工作线程的队列
  lifecycle:
    auto_start: true

# 进程定义
- name: worker_process
  kind: process.lua
  source: file://worker.lua
  method: main

# 受监督的进程服务
- name: worker
  kind: process.service
  process: app:worker_process
  host: app:processes
  input: ["arg1", "arg2"]
  lifecycle:
    auto_start: true
    restart:
      max_attempts: 10

- name: terminal
  kind: terminal.host
  lifecycle:
    auto_start: true

实时更新 process.host 条目会就地重设 host.workers 的规模 — 运行中的进程、PID 和队列都会保留。host.queue_size、host.local_queue_size 和 lifecycle 在构造时固定：实时更新更改它们会被拒绝；对 worker 采用亲和性管理的宿主调整 worker 数量同样会被拒绝。

进程安全

process.lua 和 process.lua.bc 条目接受一个顶层 security: 块。它属于条目本身，因此对该进程的每次 spawn 都生效，在 process.host 和 terminal.host 上都是如此：

- name: worker_process
  kind: process.lua
  source: file://worker.lua
  method: main
  security:
    actor:
      id: system.worker
      meta:
        tenant: acme
    policies:
      - app.security:worker_policy
    groups:
      - app.security:background_jobs

解析在进程启动时进行且是原子的：只要所列的任一策略或组无法解析，spawn 就会失败，并且不会安装任何不完整的上下文。省略 actor 会继承 spawn 发起方的主体；同时省略 policies 和 groups 会继承 spawn 发起方的作用域。function.lua、function.lua.bc、process.lua 和 process.lua.bc 都接受该块。

命令条目还可以额外声明 meta.command.security，它只在该条目作为 CLI 命令启动时生效——参见命令安全。它不影响普通的 spawn。

参见 安全。

Temporal（工作流）

- name: temporal_client
  kind: temporal.client
  address: "localhost:7233"
  namespace: "default"
  auth:
    type: none  # none, api_key, mtls
  lifecycle:
    auto_start: true

- name: temporal_worker
  kind: temporal.worker
  client: temporal_client
  task_queue: "main-queue"
  lifecycle:
    auto_start: true

云存储

- name: aws
  kind: config.aws
  region: "us-east-1"
  access_key_id: ${env:AWS_ACCESS_KEY_ID}
  secret_access_key: ${env:AWS_SECRET_ACCESS_KEY}

- name: uploads
  kind: cloudstorage.s3
  config: app:aws
  bucket: "my-uploads"
  endpoint: ""  # 可选，用于 S3 兼容服务

Lua API： 参见 Cloud Storage 模块

local cloudstorage = require("cloudstorage")
local storage, err = cloudstorage.get("app:uploads")

storage:upload_object("files/doc.pdf", file_content)
local url = storage:presigned_get_url("files/doc.pdf", {expiration = 3600})  -- 单位为秒，默认 3600

文件系统

- name: data_dir
  kind: fs.directory
  directory: "./data"
  auto_init: true   # 不存在时创建
  mode: "0755"      # 权限

Lua API： 参见 Filesystem 模块

local fs = require("fs")
local filesystem, err = fs.get("app:data_dir")

local file = filesystem:open("output.txt", "w")
file:write("Hello, World!")
file:close()

环境

- name: os_env
  kind: env.storage.os

- name: file_env
  kind: env.storage.file
  file_path: ".env"
  auto_create: true

- name: defaults
  kind: env.storage.static
  values:
    PUBLIC_API_HOST: "https://api.example.com"
    APP_ENV: "production"

- name: app_env
  kind: env.storage.router
  storages:
    - app:os_env
    - app:file_env
    - app:defaults

Lua API： 参见 Env 模块

local env = require("env")

local api_key = env.get("API_KEY")
env.set("CACHE_TTL", "3600")

模板

# 带引擎配置的模板集
- name: templates
  kind: template.set
  engine:
    development_mode: false
    extensions:
      - ".jet"
      - ".html.jet"

# 单个模板
- name: email_template
  kind: template.jet
  source: file://templates/email.jet
  set: app:templates

Lua API： 参见 Template 模块

local templates = require("templates")
local set, err = templates.get("app:templates")

local html = set:render("email", {
    user = "Alice",
    message = "Welcome!"
})

安全

# 基于条件的策略
- name: admin_policy
  kind: security.policy
  policy:
    actions: "*"
    resources: "*"
    effect: allow
    conditions:
      - field: "actor.meta.role"
        operator: eq
        value: "admin"

# 基于表达式的策略
- name: owner_policy
  kind: security.policy.expr
  policy:
    actions: "*"
    resources: "*"
    effect: allow
    expression: 'actor.id == meta.owner_id || actor.meta.role == "admin"'
  groups:
    - operators

策略组由策略自身构成：策略在 groups: 下列出它所属的组 ID，而一个组就是指定了该组的策略集合。不存在单独的组条目类型。组 ID 是注册表 ID——裸名称在声明该策略的命名空间中解析，因此上面的 operators 在命名空间 app.security 中声明时就是 app.security:operators。条目通过完整的 namespace:name 引用组。

Lua API： 参见 Security 模块

local security = require("security")

-- 操作前检查权限
if security.can("delete", "users", {user_id = id}) then
    delete_user(id)
end

-- 获取当前角色
local actor = security.actor()

契约（依赖注入）

# 定义契约接口
- name: greeter
  kind: contract.definition
  methods:
    - name: greet
      description: Returns a greeting message
    - name: greet_with_name
      description: Returns a personalized greeting
      input_schemas:
        - format: "application/schema+json"
          definition: {"type": "string"}
      output_schemas:
        - format: "application/schema+json"
          definition: {"type": "string"}

# 实现函数
- name: greeter_greet
  kind: function.lua
  source: file://greeter_greet.lua
  method: main

- name: greeter_greet_name
  kind: function.lua
  source: file://greeter_greet_name.lua
  method: main

# 将契约方法绑定到实现
- name: greeter_impl
  kind: contract.binding
  contracts:
    - contract: app:greeter
      default: true
      methods:
        greet: app:greeter_greet
        greet_with_name: app:greeter_greet_name

在 Lua 中使用：

local contract = require("contract")

-- 通过 ID 打开绑定
local greeter, err = contract.open("app:greeter_impl")

-- 调用方法
local result = greeter:greet()
local personalized = greeter:greet_with_name("Alice")

-- 检查实例是否实现了契约
local is_greeter = contract.is(greeter, "app:greeter")

Lua API： 参见 Contract 模块

执行

- name: native_exec
  kind: exec.native
  default_work_dir: "/app"
  command_whitelist:
    - "ls"
    - "cat"

- name: docker_exec
  kind: exec.docker
  image: "python:3.11-slim"
  default_work_dir: "/workspace"
  auto_remove: true
  memory_limit: 536870912  # 512MB
  command_whitelist:
    - "python"

WASM 运行时

# WAT 文本作为内联源码
- name: sum_wat
  kind: function.wat
  source: file://sum.wat
  method: sum
  transport: payload   # 或 wasi-http

# 二进制 WASM 从文件系统条目加载，并通过哈希校验
- name: sum
  kind: function.wasm
  fs: app:modules
  path: sum.wasm
  hash: sha256:2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae
  method: sum
  transport: payload

function.wasm 和 process.wasm 接受 fs、path 和 hash——二进制条目上没有 source 字段；source 只属于 function.wat。hash 是必填的，且必须为 sha256:<hex>；字节不匹配时模块会被拒绝。

参见 WASM 概述。

网络

由 http.service 通过 network: 引用，由 funcs/process 通过 network 选项引用，由 http_client 通过 overlay_network 选项引用。参见 网络。

注册表原语

ns.* 类型和其他条目一样由作者编写：组件声明 ns.definition 和 ns.requirement，宿主声明 ns.dependency。参见构建组件。

生命周期配置

大多数入口支持生命周期配置：

- name: service
  kind: some.kind
  lifecycle:
    auto_start: true          # 自动启动
    start_timeout: 10s        # 最大启动时间
    stop_timeout: 10s         # 最大关闭时间
    stable_threshold: 5s      # 视为稳定的运行时间
    depends_on:
      - app:database
    restart:                  # 重试策略
      initial_delay: 1s
      max_delay: 90s
      backoff_factor: 2.0
      max_attempts: 0         # 0 = 无限

入口引用格式

入口使用 namespace:name 格式引用：

# 定义
namespace: app.users
entries:
  - name: handler
    kind: function.lua

# 从另一个入口引用
func: app.users:handler

覆盖入口 {id="overriding-entries"}

任何入口的字段——包括其 kind——都可以在启动时覆盖，无需编辑源 YAML，使用 override: 配置区段或 -o CLI 参数。键采用 namespace:entry:path 格式：

override:
  app:gateway:addr: ":9090"        # data field (a bare path targets data.*)
  app:worker:meta.priority: high    # meta field
  app:db:kind: db.sql.postgres      # the entry's typed kind
  app:db:data.kind: custom          # a payload field literally named "kind"

同样的覆盖也可从 CLI 应用：

wippy run -o app:db:kind=db.sql.postgres -o app:gateway:addr=:9090

CLI（-o）值按形态强制转换（true/false 转为 bool，数字转为数字，其他转为 string）；override: 区段的值保留其 YAML 类型。如需覆盖全局配置区段而非入口，请使用 --set。