使用编辑器助手

本页说明

这一页介绍 ApiHug IntelliJ 插件提供的编辑器上下文操作。

当你希望直接在 IDE 中完成 proto 文档创建、结构补全和常见编辑动作，而不是手写所有模板代码时，请使用这些能力。

另请参考：快捷键速查

适用场景

当你需要：

• 快速创建新的 proto 文件
• 为消息、字段、服务、枚举、错误码、实体添加标准结构
• 在 IDE 内持续完成契约设计，不反复切换到外部模板或脚本

就应该使用编辑器助手。

新建 Proto 文件

1. 打开 proto 模块中的 src/main/proto
2. 右键目标目录
3. 选择 Add Proto File
4. 选择正确的 proto 文件类型

编辑 Message 文件

适用于声明了如下类型的文件：

option (hope.domain.kind) = BEAN;

常见操作包括：

• Add Message
• Add Field
• Add Field(Reference)

编辑 Service 文件

适用于声明了如下类型的文件：

option (hope.domain.kind) = IDL;

常见操作包括：

• Add Service
• Add Method

编辑 Enum 文件

适用于声明了如下类型的文件：

option (hope.domain.kind) = ENUM;

常见操作包括：

• Add Enum
• Add Enum Item

编辑 Error 文件

适用于声明了如下类型的文件：

option (hope.domain.kind) = ERROR;

常见操作包括：

• Add Error
• Add Error Item

编辑 Entity 文件

适用于声明了如下类型的文件：

option (hope.domain.kind) = ENTITY;

常见操作包括：

• Add Entity
• Add Column

结果

编辑器助手可以显著减少重复性的 proto 结构输入工作，并帮助团队在契约设计过程中保持更一致的文件形态。

参考

1. ApiHug101-Bilibili
2. ApiHug101-YouTube