工具链

Gradle Wire

使用 ApiHug wire 任务校验 proto 模块,并生成中立契约输出。

wire 是 ApiHug Gradle 工具链里偏 proto 侧的生成任务。

它是什么

它会编译并校验 protobuf 契约模块,然后生成下游模块所需的中立构建输出。

为什么重要

wire 是契约真正进入构建体系的那一步。proto 层出错,后续生成与应用层都会跟着出错。

它如何融入整体流程

基础插件配置

Groovy
plugins {
  id "java-library"
  alias(libs.plugins.hopeWire)
}

hopeWire {
  keepProto = false
  verbose = false
}

常用 hopeWire 选项

选项说明
verbose输出详细执行日志
keepProto是否随产物一起打包 proto 编译结果
generatedVersion@Generated 中写入插件版本
generatedTime@Generated 中写入生成时间
restrict控制部分隐式转换行为

hope-wire.json 关键字段

字段说明
packageName模块的 Java 包根
nameproto 模块名
application对应的应用模块名
module运行时 service locator 标识
domain领域标识
persistence.identifyType主标识字段策略
persistence.tenantType租户字段策略
authority.enumClass模块使用的权限枚举
authority.codePrefix权限编码区间前缀

如何执行

构建整个工程:

Terminal
gradlew clean build -x test -x wireTest -x stubTest

只构建一个 proto 模块:

Terminal
gradlew {YOUR_MODULE}:clean wire build -x test -x wireTest

下一步

wire 成功后,继续看 Gradle Stub,生成应用侧脚手架。

Copyright © 2026 ApiHug·AI-native Enterprise Architecture Factory