如何为自定义注解配置IntelliJ IDEA预设可选值提示

自定义注解实现固定值补全的两种方法 #

IDEA不会自动识别普通自定义注解的属性允许值，要实现和Spring原生@Scope注解一致的下拉补全效果，有两种可落地的方案：

• 方案1：轻量无插件方案，使用IDEA内置识别的@MagicConstant注解标记
  这是成本最低的实现方式，只需要引入JetBrains提供的注解依赖，给对应注解属性标记允许的字符串值集合即可，IDEA会自动识别并给出补全，同时会对不在列表内的输入给出校验警告。
  以提供的@MyRealName注解为例，修改后的代码如下：

  package ru.max.mypacktest;
  
  import org.intellij.lang.annotations.MagicConstant;
  import java.lang.annotation.ElementType;
  import java.lang.annotation.Retention;
  import java.lang.annotation.RetentionPolicy;
  import java.lang.annotation.Target;
  
  @Target(ElementType.TYPE)
  @Retention(RetentionPolicy.RUNTIME)
  public @interface MyRealName {
      
      // 在stringValues中配置所有需要提示的预设值
      @MagicConstant(stringValues = {"admin", "user", "guest", "test"})
      String value() default "";
  
  }
  

  如果不想修改注解源码、也不想引入额外依赖，可以用IDEA的**外部注解（External Annotations）**功能，通过IDEA的可视化配置给目标注解属性附加同样的元数据，效果完全一致。
• 方案2：IDEA插件扩展方案（Spring原生注解采用的实现方式）
  Spring自带注解的补全效果，本质是IDEA旗舰版内置的Spring插件，通过实现IDEA平台的CompletionContributor扩展点完成的：插件会在代码补全触发时，检测当前光标位置是否在指定注解的属性位置，如果匹配就注入预定义的补全项。
  这种方案不需要修改业务注解的源码，还可以实现更复杂的动态补全逻辑（比如扫描项目内的配置、类信息生成补全项），缺点是需要额外开发IDEA插件，成本较高。

关于@Value注解的补全来源 #

@Value注解的补全属于IDEA Spring插件的专属优化，不是IDEA平台的通用功能：

• 补全值不是硬编码的固定列表，是Spring插件实时扫描项目上下文动态生成的，来源包括：项目配置文件（application.yml/properties等）中定义的配置项、系统环境变量、Spring内置占位符、容器内注册的Bean名称等。
• 如果禁用IDEA的Spring插件，@Value注解的所有专属补全、校验功能都会消失，和普通自定义注解表现一致。

内容的提问来源于stack exchange，提问作者Alex