Feign-Helper 是一个支持 Spring 框架的 IDEA 免费插件,它可以帮助开发者快速查找源码中的 URL,快速复制 Spring Web Controller 中的 Path。其最强大的功能是实现了 Spring Cloud 框架中 Feign 到 Controller 接口的导航。
功能介绍
Spring Web URL 任意搜索
项目中 Web 接口很多,前端报错了发一个 URL 过来,查找定位代码位置就用 Feign-Helper 的 URL 搜索功能。IDEA 中双击 Shift 键,输入URL,例如http://192.168.1.3:8080/upms/role
,即可快速检索到 URL,点击进入代码位置。
任意搜索框中 All 选项卡会进行综合搜索,切换到URL选项卡,可以仅搜索 URL 接口,且可以点击右上角过滤器图标,筛选URL请求方法。
搜索功能不仅仅支持 URL,还支持类名、方法名以及 swagger 描述说明进行全文检索,URL 本身也不需要精准,多余内容不会影响检索相关性。
一键复制 Spring Web Controller Path
有时候调试接口需要填写接口路径,但在 Spring Web Controller 中,接口路径一般分为两部分,一部分写在类上的注解,一部分写在方法注解中,复制粘贴需要两次。此功能就是自动把两部分路径连接到一起,在源码方法前的装订线上出现一个复制按钮图标,点击一键复制。
Feign 与 Controller 接口互相导航
Spring Cloud 开发中,服务间调用最常使用的就是 OpenFeign。在使用 OpenFeign 时,需要定义 Feign 接口,映射对应的 Controller 接口。在调试追踪代码时,我们有时候需要追踪 Feign 接口到对应的 Controller 接口,一般依靠方法名和URL来查找和辨认对应关系,非常低效和繁琐。Feign-Helper 自动将项目中Feign 与 Controller 接口进行映射,并在IDEA中进行标注。打开一个feign接口类,在左侧方法装订线上会出现胡萝卜图标,类名装订线上则会出现一个兔子图标,点击图标则跳转到对应的 Controller 接口源码中。
同样在Controller 接口源码中,如果有对应的 Feign 接口,则在左侧方法装订线上出现大白菜图标,类名装订线上同样会出现一个兔子图标,点击图标则导航的对应的 Feign 接口源码。
设置与使用技巧
在 IDEA 设置中,Tools 目录下有 Feign Helper 设置界面,打开有三个勾选框,对应三个功能的开启与关闭,此配置与项目关联。如果您当前项目不需要 Feign Helper 插件功能,则可以全部取消勾选,同样需要部分功能,则可以自定义勾选相应功能。其中【自动扫描】功能与性能相关,勾选后每次源码发生变化时,插件会自动分析变化并更新接口信息。
如果需要手动强制扫描项目全部接口信息,点击 IDEA 底部右下角工具栏的兔子图标,将强制扫描项目全部接口信息,并显示扫描结果。
结尾
Feign-Helper 插件已上架 jetbrains 插件市场,可在插件市场中搜索安装。