IDEA支持erlang的protobuffer定义的结构体直接跳转到proto文件

简介

erlang的protobuffer使用无论是使用erlang_protobuffs还是gpb，一般都是将proto转成erlang的record，然后编码的时候使用record来进行编写。当然gpb也支持将proto转换成maps格式，但是maps格式在IDE上的提示无法做的很完善。因此本文还是基于gpb转换的record形式的proto来做介绍

依赖

• 测试环境基于IDEA 2020.1，需要提前安装好erlang插件
• 之后便是关键的proto插件，proto插件在Google开源后有人进行了维护proto插件，现在已经支持，java，python，golang的直接跳转；
• erlang的跳转是我在插件版本的基础上扩展的，目前还没有PR到主线上，可以直接下载打包好的插件;
  提取码: p6g5
• 不放心的话可以自己去下载分支进行编译，项目用了bazel，bazel目前对windows的支持很弱，因此可能需要在mac或者linux下进行编译

使用

插件安装后，就可以直接使用。（proto插件可能会需要手动添加自建的include目录用来解决proto的依赖，但是不影响跳转逻辑）

接下来以proto_test为例展示插件的功能
创建proto_test.proto，文件名不参与逻辑，不一定是proto_test
内容如下:

message proto_test{
    optional uint64 field1 =1;  //第1行注释
    optional uint64 field2 =2;  //第2行注释
    optional uint64 field3 =3;  //第3行注释
    optional uint64 field4 =4;  //第4行注释
}

创建test_proto.erl,内容如下:

-module(test_proto).

%% API
-export([test/0]).

-record(proto_test, {
    field1,
    field2,
    field3,
    field4
}).


test() ->
    #proto_test{
        field1 = 1,
        field2 = 2,
        field3 = 3,
        field4 = 4
    }.

选中test函数中的任意proto字段，使用跳转会自动跳转到proto的定义，查看文档会出现以下内容：

文档分为三个部分：

1. 字段具体的描述
2. 字段的完整文本
3. 完整的proto消息内容

实现逻辑

proto插件会将项目中所有的proto消息以消息的短名（不带包名）为键值进行缓存，插件定位字段或者reocrd所在的record名，如果record名字在proto缓存中出现，则会定位到proto的对应位置处。

当前没有实现的太复杂，如果找到多个实现，是取的第一个，如果有多个packge下有同名的proto，当前的逻辑跳转会出问题，如果确实需要，可以自己修改下PbErlangGotoDeclarationHandler::erlangToProto，使其返回多个proto文件，将所有的proto文件查找结果进行合并后返回，当然也可以进行更精准的筛选

字段冲突

如果项目中使用了proto中间件，会生成proto的中间文件，则需要将生成的或者不想要链接的目标标记为ExInclude，这样就不会跳转到过程文件中