IntelliJ插件开发-Code Vision Hints

已于 2023-12-13 10:34:39 修改
阅读量1.3k 收藏
点赞数 8
分类专栏： # Intellij插件 文章标签： intellij idea
于 2023-12-12 17:11:10 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/liuzhenghua66/article/details/134952860
版权

简介

Code Vision Hints是idea Inlay提示中的一种类型，它只能提供block类型的inlay，可以把它添加到字段、方法、类等上面，一个元素如果包含多个提示的话，这些inlay会被展示在同一行上。

Code vision hints可以展示在元素的上面、右边、或者行末尾，具体展示的位置可以在IDE中修改：Preferences | Editor | Inlay Hints | Code vision。

目前已经有许多的插件都使用了Inlay，例如：

  • Java代码中，会在链式调用的每行展示返回类型信息
  • 版本控制的项目中，会展示提交者信息

有两个扩展点可以用于实现code vision:

  • DaemonBoundCodeVisionProvider : PSI改变后会得到通知，例如usages，其他文件变动后会继续计算被使用信息
  • CodeVisionProvider : 不依赖PSI改变通知，例如git的提交信息。

目前在2022.2这个版本测试中，发现CodeVisionProvider有很多bug，很多废弃的方法也需要实现，也许在新版本已经解决了这个问题，如果你依赖IDE版本较老，建议还是直接实现DaemonBoundCodeVisionProvider。

代码示例

实现DaemonBoundCodeVisionProvider
  1. 新建VisionProvider的实现类
public class MyCodeVisionProvider implements DaemonBoundCodeVisionProvider {

    public static final String GROUP_ID = "com.demo";
    public static final String ID = "myPlugin";
	public static final String NAME = "my plugin";

    @NotNull
    @Override
    public CodeVisionAnchorKind getDefaultAnchor() {
		// 默认展示在元素的顶部
        return CodeVisionAnchorKind.Top;
    }

    @NotNull
    @Override
    public String getId() {
        return ID;
    }

    @NotNull
    @Override
    public String getGroupId() {
        return GROUP_ID;
    }

    @Nls
    @NotNull
    @Override
    public String getName() {
        return NAME;
    }

    @NotNull
    @Override
    public List<CodeVisionRelativeOrdering> getRelativeOrderings() {
		// 设置展示顺序为第一个
        return List.of(CodeVisionRelativeOrdering.CodeVisionRelativeOrderingFirst.INSTANCE);
    }

	// 设置展示场景：java文件的方法上展示
    @NotNull
    @Override
    public List<Pair<TextRange, CodeVisionEntry>> computeForEditor(@NotNull Editor editor, @NotNull PsiFile file) {
        List<Pair<TextRange, CodeVisionEntry>> lenses = new ArrayList<>();
        String languageId = file.getLanguage().getID();
        if (!"JAVA".equalsIgnoreCase(languageId)) {
            return lenses;
        }
        SyntaxTraverser<PsiElement> traverser = SyntaxTraverser.psiTraverser(file);
        for (PsiElement element : traverser) {
            if (!(element instanceof PsiMethod)) {
                continue;
            }
            if (!InlayHintsUtils.isFirstInLine(element)) {
                continue;
            }
            String hint = getName();
            TextRange range = InlayHintsUtils.INSTANCE.getTextRangeWithoutLeadingCommentsAndWhitespaces(element);
            lenses.add(new Pair(range, new ClickableTextCodeVisionEntry(hint, getId()
                    , new MyClickHandler((PsiMethod) element), null, hint, "", List.of())));
        }
        return lenses;
    }

    @NotNull
    @Override
    @Deprecated
    public List<Pair<TextRange, CodeVisionEntry>> computeForEditor(@NotNull Editor editor) {
		// 过时方法，不用实现
        return List.of();
    }

	// Inlay被点击后的处理逻辑
    @Override
    public void handleClick(@NotNull Editor editor, @NotNull TextRange textRange, @NotNull CodeVisionEntry entry) {
        if (entry instanceof CodeVisionPredefinedActionEntry) {
            ((CodeVisionPredefinedActionEntry)entry).onClick(editor);
        }
    }

    @RequiredArgsConstructor
    static class MyClickHandler implements Function2<MouseEvent, Editor, Unit> {

        private final PsiMethod psiMethod;

		// 点击inlay后的响应：打开一个popup显示一组菜单
        public Unit invoke(MouseEvent event, Editor editor) {
            TextRange range = InlayHintsUtils.INSTANCE.getTextRangeWithoutLeadingCommentsAndWhitespaces(psiMethod);
            int startOffset = range.getStartOffset();
            int endOffset = range.getEndOffset();
            editor.getSelectionModel().setSelection(startOffset, endOffset);
            AnAction action1 = ActionManager.getInstance().getAction("MyPlugin.Action1");
			AnAction action2 = ActionManager.getInstance().getAction("MyPlugin.Action2");
            DefaultActionGroup actionGroup = new DefaultActionGroup(List.of(action1, action2));
            ListPopup popup = JBPopupFactory.getInstance().createActionGroupPopup(null, actionGroup
                    , EditorUtil.getEditorDataContext(editor), JBPopupFactory.ActionSelectionAid.SPEEDSEARCH, true);
            popup.show(new RelativePoint(event));
            return null;
        }
    }
}
  1. 注册VisionProvider的实现类
<idea-plugin>
	<extensions defaultExtensionNs="com.intellij">
		<codeInsight.daemonBoundCodeVisionProvider implementation="com.demo.MyCodeVisionProvider"/>
	</extensions>
</idea-plugin>
实现CodeVisionProvider
  1. 新建VisionProvider的实现类
public class MyCodeVisionProvider implements CodeVisionProvider<Unit> {

    public static final String GROUP_ID = "com.demo";
    public static final String ID = "myPlugin";
	public static final String NAME = "my plugin";
    private static final Key<Long> MODIFICATION_STAMP_KEY = Key.create("myPlugin.modificationStamp");
    private static final Key<Integer> MODIFICATION_STAMP_COUNT_KEY = KeyWithDefaultValue.create("myPlugin.modificationStampCount", 0);
	// 每次文档事件都会调用2次shouldRecomputeForEditor，这里设置4因为编辑器刚打开的时候，没关闭的文件首次刷新可能导致渲染了宽度为0的Inlay。
    private static final int MAX_MODIFICATION_STAMP_COUNT = 4;

    @NotNull
    @Override
    public CodeVisionAnchorKind getDefaultAnchor() {
        return CodeVisionAnchorKind.Top;
    }

    @NotNull
    @Override
    public String getGroupId() {
        return GROUP_ID;
    }

    @NotNull
    @Override
    public String getId() {
        return ID;
    }

    @Nls
    @NotNull
    @Override
    public String getName() {
        return NAME;
    }

    @NotNull
    @Override
    public List<CodeVisionRelativeOrdering> getRelativeOrderings() {
        return List.of(CodeVisionRelativeOrdering.CodeVisionRelativeOrderingFirst.INSTANCE);
    }

    @NotNull
    @Override
    @Deprecated(message = "use getPlaceholderCollector")
    // 已被废弃，不用实现
    public List<TextRange> collectPlaceholders(@NotNull Editor editor) {
        return List.of();
    }

    @Nullable
    @Override
    // 不需要实现，computeCodeVision做了相同的事情
    public CodeVisionPlaceholderCollector getPlaceholderCollector(@NotNull Editor editor, @Nullable PsiFile psiFile) {
        return null;
    }

    @NotNull
    @Override
    @Deprecated(message = "Use computeCodeVision instead")
    // 已被废弃，不用实现
    public List<Pair<TextRange, CodeVisionEntry>> computeForEditor(@NotNull Editor editor, Unit uiData) {
        return List.of();
    }

    @NotNull
    @Override
    public CodeVisionState computeCodeVision(@NotNull Editor editor, Unit uiData) {
        List<PsiMethod> psiMethods = getPsiMethods(editor);
        List<Pair<TextRange, CodeVisionEntry>> lenses = new ArrayList<>();
        for (PsiMethod psiMethod : psiMethods) {
            TextRange range = InlayHintsUtils.INSTANCE.getTextRangeWithoutLeadingCommentsAndWhitespaces(psiMethod);
            MyClickHandler handler = new MyClickHandler(psiMethod);
            CodeVisionEntry entry = new ClickableTextCodeVisionEntry(getName(), getId()
                    , handler, null, getName(), getName(), List.of());
            lenses.add(new Pair<>(range, entry));
        }
        return new CodeVisionState.Ready(lenses);
    }

    private List<PsiMethod> getPsiMethods(Editor editor) {
        return ApplicationManager.getApplication().runReadAction((Computable<List<PsiMethod>>) () -> {
            List<PsiMethod> psiMethods = new ArrayList<>();
            PsiFile psiFile = PsiDocumentManager.getInstance(Objects.requireNonNull(editor.getProject()))
                    .getPsiFile(editor.getDocument());
            if (psiFile == null) {
                return psiMethods;
            }

            List<Pair<TextRange, CodeVisionEntry>> lenses = new ArrayList<>();
            SyntaxTraverser<PsiElement> traverser = SyntaxTraverser.psiTraverser(psiFile);
            for (PsiElement element : traverser) {
                if (!(element instanceof PsiMethod)) {
                    continue;
                }
                if (!InlayHintsUtils.isFirstInLine(element)) {
                    continue;
                }
                psiMethods.add((PsiMethod)element);
            }
            return psiMethods;
        });
    }

    @Override
    public void handleClick(@NotNull Editor editor, @NotNull TextRange textRange, @NotNull CodeVisionEntry entry) {
        if (entry instanceof CodeVisionPredefinedActionEntry) {
            ((CodeVisionPredefinedActionEntry)entry).onClick(editor);
        }
    }

    @Override
    public void handleExtraAction(@NotNull Editor editor, @NotNull TextRange textRange, @NotNull String s) {}

    @Override
    public Unit precomputeOnUiThread(@NotNull Editor editor) {
        return null;
    }

    @Override
    public boolean shouldRecomputeForEditor(@NotNull Editor editor, @Nullable Unit uiData) {
        return ApplicationManager.getApplication().runReadAction((Computable<Boolean>) () -> {
            if (editor.isDisposed() || !editor.isInsertMode()) {
                return false;
            }
            Project project = editor.getProject();
            if (project == null) {
                return false;
            }
            Document document = editor.getDocument();
            PsiFile psiFile = PsiDocumentManager.getInstance(project).getPsiFile(document);
            if (psiFile == null) {
                return false;
            }
            String languageId = psiFile.getLanguage().getID();
            if (!"JAVA".equalsIgnoreCase(languageId)) {
                return false;
            }

            Long prevStamp = MODIFICATION_STAMP_KEY.get(editor);
            long nowStamp = getDocumentStamp(editor.getDocument());
            if (prevStamp == null || prevStamp != nowStamp) {
                Integer count = MODIFICATION_STAMP_COUNT_KEY.get(editor);
                if (count + 1 < MAX_MODIFICATION_STAMP_COUNT) {
                    MODIFICATION_STAMP_COUNT_KEY.set(editor, count + 1);
                    return true;
                } else {
                    MODIFICATION_STAMP_COUNT_KEY.set(editor, 0);
                    MODIFICATION_STAMP_KEY.set(editor, nowStamp);
                    return true;
                }
            }
            return false;
        });
    }

    private static long getDocumentStamp(@NotNull Document document) {
        if (document instanceof DocumentEx) {
            return ((DocumentEx)document).getModificationSequence();
        }
        return document.getModificationStamp();
    }

    @RequiredArgsConstructor
    static class MyClickHandler implements Function2<MouseEvent, Editor, Unit> {

        private final PsiMethod psiMethod;

        public Unit invoke(MouseEvent event, Editor editor) {
            TextRange range = InlayHintsUtils.INSTANCE.getTextRangeWithoutLeadingCommentsAndWhitespaces(psiMethod);
            int startOffset = range.getStartOffset();
            int endOffset = range.getEndOffset();
            editor.getSelectionModel().setSelection(startOffset, endOffset);
            AnAction action1 = ActionManager.getInstance().getAction("MyPlugin.Action1");
			AnAction action2 = ActionManager.getInstance().getAction("MyPlugin.Action2");
            DefaultActionGroup actionGroup = new DefaultActionGroup(List.of(action1, action2));
            ListPopup popup = JBPopupFactory.getInstance().createActionGroupPopup(null, actionGroup
                    , EditorUtil.getEditorDataContext(editor), JBPopupFactory.ActionSelectionAid.SPEEDSEARCH, true);
            popup.show(new RelativePoint(event));
            return null;
        }
    }
}
  1. 注册CodeVisionProviders实现类
<idea-plugin>
	<extensions defaultExtensionNs="com.intellij">
		<codeInsight.codeVisionProvider implementation="com.demo.MyCodeVisionProvider"/>
	</extensions>
</idea-plugin>

参考文献

Code Vision Provider

liuzhenghua66
关注
  • 8
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 7
    评论
专栏目录
Code Vision AVR 3.04
06-29
Code Vision fow AVR ver:3.04 Cracked
CodeVisionAVR3.12 最强AVR单片机开发工具
02-27
CodeVisionAVR 扩充了flash和eeprom两个关键词，使用flash将const定义的常量分配进Flash存器，以节省RAM的使用。而eeprom关键词限定的变量则被分配进片内 CodeVisionAVR 是一款非常适合 AVR 初学者的编译工具，有何特点大家可在网上看看
IDEA设置
Visionqlhs的博客
01-01 197
IDEA设置
Intelij开发idea插件从开发到发布的完整详细教程附带源码demo
最新发布
任聪聪的博客
01-21 7349
说明：此处的代码是直接写上即可，无需通过devkit进行创建，如果你通过devkit进行创建，记得什么都不要选择，之后再回到这个配置文件配置你想设置的快捷键，如图中的first-key…=“你的快捷键多个用空格隔开”
2022版的IntelliJ IDEA取消函数参数等提示
09-22 3617
2022版的IntelliJ IDEA取消函数参数等提示
Intellij 插件 ja-netfilter-all
04-14
MybatisCodeHelperPro是另一个针对IntelliJ IDEA的插件，专为Mybatis框架的开发而设计。Mybatis是一个轻量级的持久层框架，它简化了数据库操作，通过SQL映射文件将SQL语句与Java代码分离。MybatisCodeHelperPro提供...
intellij-visual-studio-code-dark-plus:用于JetBrains IDE的Visual Studio Code Dark Plus主题
05-15
用于JetBrains IDE的Visual Studio ...通过设置→插件→市场安装“ Visual Studio Code Dark Plus Theme”插件 在设置中选择主题→外观和行为→外观→主题 截屏 这就是IDEA中的Fira Code字体的外观： 这里是PhpStorm：
最新版intellij IDEA插件intellij-spring-helper
09-25
`intellij-spring-helper`是一款专门为IntelliJ IDEA设计的插件，专为提升Spring框架和Spring Boot应用的开发体验。这款插件尤其适合那些使用社区版IntelliJ IDEA的开发者，因为它弥补了社区版在某些高级特性上的...
用于Android代码生成的Intellij插件。-Android开发
05-26
用于Android代码生成的Android Studio / ...核心库此插件基于一个库：android-codegenerator-library。 该库负责：从XML文件中提取重要信息，并基于提取的信息和模板生成Java代码。JetBrains存储库您可以安装插件f
IntelliJ-Forge-Mapping-Hints：IntelliJ IDEA插件，显示用于SRG映射开发的镶嵌提示
03-02
此IntelliJ IDEA插件根据CSV文件中的建议在SRG名称（ field_... ， func_... ， p_... ）旁边添加提示。 CSV必须遵循以下规则： 需要标题行列： validated （ TRUE / FALSE ） class name （字符串） unmapped name ...
＞＞开发工具：IntelliJ IDEA 2022.1 的新功能
Lycos
07-11 1161
新引入的Dependency Analyzer提供项目和子项目中使用的所有 Maven 和 Gradle 依赖项的广泛信息。可以帮助检测和解决冲突的依赖项，过滤掉相同的依赖项并检查它们是否存在于不同的库中，轻松地跨依赖项导航以正确构建配置。...
Webstorm 加载vue项目时，特别卡顿，完美解决。觉得有用加好友打赏
qq_40820382的博客
06-14 2865
webtorm卡顿解决
visualStudio Intellisense 代码提示慢 正在等待Intellisense完成。解决方法
qq_44695769的博客
05-21 6713
软件一直提示正在等待Intellisense完成点开就绪，会有个正在加载的进度条。
IDEA设置方法形参提示
Algernonm的博客
01-28 3031
IDEA设置方法形参提示 在调用方法时，想要提示形参列表，效果如下： 设置方法 setting—>Inlay Hints—>Java—>如图按需勾选。我就全部勾选了。 适用版本 我是2019.3 2019.3以上应该适用。 初级菜鸟简单记录，欢迎指正。 ...
IntelliJ IDEA 如何设置author头注解
Liu_wen_wen的博客
06-25 2898
IntelliJ IDEA设置author头注释
IDEA提示Usages
weixin_70799420的博客
01-24 4588
开启\关闭：Setting->Editor->Inlay Hints->Code vision->Usages，选择方框可选择开启或关闭。作用：版本高的idea有时变量方法会有usages提示，它会提示此方法、变量在哪里被使用了。
Idea必备插件、必要配置
拾一二的博客
01-17 1万+
一键生成xml、实体等与Free MyBatis plugin同类型的，但是没得Free MyBatis plugin好用，二选一就行将 mybatis sql 日志恢复为原始的整个可执行 sql。开发的项目一般都少不了日志系统，而我们在书写mysql语句的时候，参数的对应，往往有时候会忽略，mybatis自己控制的参数编译对应，个人感觉有点反人类，我们可以使用这个插件变成自己比较直观的对应。支持可配置的、类似。............
idea 编译速度慢的解决办法
热门推荐
康康的博客
07-02 1万+
1、关闭kotlin插件 高版本idea自动开启kotlin插件，在编译java 项目时，会出现Kotlin: connecting to daemon File —> settings —> plugins —> 搜索kotlin 选择禁用框 https://blog.csdn.net/yulin_g/article/details/107778430 2、打开自动编译 File —> Settings—> Build,Execution,Deployment—..
Python开发工具PyCharm 2023.1发布，这些新功能都值得期待！
需要界面开发、IDE工具研发中文教程资料的小伙伴，记得私信我~
06-25 1009
PyCharm 2023.1日前已正式发布，今天一起来看今年第一主要版本都带来了哪些改变。
intellij插件开发
10-13
IntelliJ IDEA 是一款非常强大的 Java 集成开发环境，支持插件开发。插件可以为 IntelliJ IDEA 增加新的功能或者修改现有功能的行为。如果你想要开发一个 IntelliJ IDEA 插件，可以按照以下步骤进行： 1. 下载 IntelliJ IDEA Community Edition 或 Ultimate Edition。 2. 安装 IntelliJ IDEA 插件开发工具包（Plugin Development Kit，简称 PDK）。 3. 创建一个新的 IntelliJ IDEA 插件项目。 4. 开发插件功能并进行测试。 5. 打包插件并发布到 JetBrains 插件市场或者本地仓库。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 7
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值