插件开发

┌────────────────────────────────────────────┐
│ 安知鱼主程序                                │
│  ┌──────────────┐    RPC     ┌───────────┐ │
│  │ 插件管理器    │◄──────────►│ 插件进程 A │ │
│  │ （发现/加载/  │            └───────────┘ │
│  │  热重载/健康） │    RPC     ┌───────────┐ │
│  │              │◄──────────►│ 插件进程 B │ │
│  └──────────────┘            └───────────┘ │
└────────────────────────────────────────────┘

mkdir my-notifier && cd my-notifier
go mod init github.com/yourname/my-notifier
go get github.com/anzhiyu-c/anheyu-app@latest

package main

import (
	"context"
	"log"

	"github.com/anzhiyu-c/anheyu-app/pkg/plugin"
	"github.com/anzhiyu-c/anheyu-app/pkg/plugin/sdk"
)

// MyHook 实现 plugin.EventHook 接口
type MyHook struct{}

// Subscriptions 声明订阅的事件，"*" 表示全部事件
func (h *MyHook) Subscriptions() []string {
	return []string{plugin.EventArticlePublished}
}

// OnEvent 处理事件；返回的错误只会被记录日志，不影响主程序业务
func (h *MyHook) OnEvent(ctx context.Context, event plugin.Event) error {
	log.Printf("收到事件 %s，负载: %s", event.Name, string(event.Payload))
	return nil
}

func main() {
	sdk.Serve(sdk.Options{
		Metadata: plugin.Metadata{
			ID:          "my-notifier",
			Name:        "我的通知插件",
			Version:     "1.0.0",
			Description: "文章发布时打印日志",
			Author:      "你的名字",
		},
		EventHook: &MyHook{},
	})
}

{
  "manifest_version": 1,
  "id": "my-notifier",
  "name": "我的通知插件",
  "version": "1.0.0",
  "description": "文章发布时打印日志",
  "author": "你的名字",
  "types": ["eventhook"],
  "entry": {
    "linux-amd64": "bin/my-notifier-linux-amd64",
    "darwin-arm64": "bin/my-notifier-darwin-arm64",
    "windows-amd64": "bin/my-notifier-windows-amd64.exe"
  }
}

# 按目标平台交叉编译（至少提供站点服务器对应平台的二进制）
GOOS=linux GOARCH=amd64 go build -o bin/my-notifier-linux-amd64 .
GOOS=darwin GOARCH=arm64 go build -o bin/my-notifier-darwin-arm64 .
GOOS=windows GOARCH=amd64 go build -o bin/my-notifier-windows-amd64.exe .

# 打包为插件安装包（plugin.json 必须位于 zip 根目录）
zip -r my-notifier.zip plugin.json bin/

{
  "config_schema": [
    {
      "key": "webhook_url",
      "label": "Webhook 地址",
      "type": "string",
      "required": true,
      "secret": false,
      "default": "",
      "description": "接收事件 POST 请求的完整 URL"
    },
    {
      "key": "mode",
      "label": "推送模式",
      "type": "select",
      "options": ["all", "digest"],
      "default": "all"
    }
  ]
}

cfg := sdk.LoadConfig()

url := cfg.String("webhook_url")                  // 字符串，缺失返回 ""
mode := cfg.StringDefault("mode", "all")          // 带默认值
limit := cfg.Int("limit", 10)                     // 整数，解析失败返回默认值
enabled := cfg.Bool("enabled", true)              // 布尔（true/1/yes/on）

{
  "name": "article.published",
  "occurred_at": "2026-08-13T14:00:00+08:00",
  "payload": {}
}

{
  "id": "文章公共 ID",
  "slug": "文章缩略名（可能为空）",
  "title": "文章标题",
  "url": "/posts/文章缩略名或ID"
}

{
  "id": 123,
  "target_path": "/posts/example",
  "target_title": "示例文章",
  "nickname": "评论者昵称",
  "content": "评论内容",
  "is_published": true,
  "is_admin": false
}

type Searcher interface {
	Search(ctx context.Context, query string, page int, size int) (*SearchResult, error)
	IndexArticle(ctx context.Context, article *Article) error
	DeleteArticle(ctx context.Context, articleID string) error
	ClearAllDocuments(ctx context.Context) error
	HealthCheck(ctx context.Context) error
}

sdk.Serve(sdk.Options{
	Metadata: plugin.Metadata{ID: "my-search", Name: "我的搜索引擎", Version: "1.0.0"},
	Searcher: mySearcher, // 实现 model.Searcher
})

type Options struct {
	Metadata  plugin.Metadata  // 必填：ID、Name、Version
	Searcher  model.Searcher   // 可选：搜索引擎能力
	EventHook plugin.EventHook // 可选：事件钩子能力
}

type Metadata struct {
	ID          string // 插件唯一标识（与 plugin.json 的 id 保持一致）
	Name        string // 显示名称
	Version     string // 版本
	Description string // 描述
	Author      string // 作者
	Homepage    string // 主页
}

type EventHook interface {
	Subscriptions() []string
	OnEvent(ctx context.Context, event plugin.Event) error
}

sdk.Serve(sdk.Options{
	Metadata:  meta,
	EventHook: sdk.EventHandlerFunc(func(ctx context.Context, e plugin.Event) error {
		// 处理事件
		return nil
	}),
})

my-plugin.zip
├── plugin.json                       # manifest（必需，位于根目录）
├── bin/
│   ├── my-plugin-linux-amd64         # 各平台二进制（至少一个）
│   ├── my-plugin-darwin-arm64
│   └── my-plugin-windows-amd64.exe
└── README.md                         # 说明文档（推荐）