发布共享 Java API

当两个插件必须共享 Java 接口或数据类型时，可以把公共契约放入独立 API 模块。只为单个实现创建 API 模块没有收益；不需要共享类型时，优先使用事件或扩展点。

创建 API 模块

从 create-halo-plugin 1.6.0 开始，可以在已有插件项目的根目录中创建可发布的 Java 模块：

pnpm dlx create-halo-plugin@latest add module api

可以将 api 替换为实际模块名。命令会复用插件项目的 Java、Halo 和发布元数据，创建源码与测试目录、Gradle 发布配置、模块 README 和 .github/workflows/publish.yml，并自动配置模块依赖。

my-plugin

api

build.gradle

README.md

src

main/java/com/example/api/package-info.java

test/java

.github/workflows/publish.yml

src/main/resources/plugin.yaml

build.gradle

settings.gradle

插件实现和 run.halo.plugin.devtools 保留在根项目中，不要将插件开发插件应用到 api 模块。

生成的 api/build.gradle 已经配置 java-library、Halo API 的 compileOnly 依赖、与根项目一致的 Java toolchain，以及 Maven Central 发布和签名。通常只需在模块中添加稳定接口和共享数据类型：

api/src/main/java/com/example/api/MyApi.java

package com.example.api;

public interface MyApi {
    void doSomething();
}

脚手架会在根插件中添加 API 模块依赖：

build.gradle

dependencies {
    implementation project(':api')
}

其他插件通过 Maven artifact 编译，并在 plugin.yaml 中声明运行时插件依赖：

dependencies {
    compileOnly 'com.example:api:1.2.0'
}

spec:
  pluginDependencies:
    MyPlugin: ">=1.2.0 & <2.0.0"

使用 compileOnly 可以避免把同一 API 类型重复打入使用方插件。运行时由被依赖插件提供实现；依赖声明规则见依赖其他插件。

生成的 .github/workflows/publish.yml 会从 main 分支发布 SNAPSHOT 版本，并从 v* 标签发布正式版本。发布前需要配置以下 GitHub Actions 仓库密钥：

账号和签名设置可查阅 Maven Central Portal 发布指南。

发布前检查：