YAML语言

1、简介

  YAML:YAML Ain’t Markup Language,即YAML不是标记语言。不过,在开发的这种语言时,YAML的
意思其实是:“Yet Another Markup Language”(仍是一种标记语言)
  YAML是一个可读性高的用来表达资料序列的格式。YAML参考了其他多种语言,包括:XML、C语言、
Python、Perl以及电子邮件格式RFC2822等。Clark Evans在2001年在首次发表了这种语言

2、YAML 语言特性

YAML的可读性好
YAML和脚本语言的交互性好
YAML使用实现语言的数据类型
YAML有一个一致的信息模型
YAML易于实现
YAML可以基于流来处理
YAML表达能力强,扩展性好

3、YAML语法简介

  • 使用#号注释代码
  • 缩进必须是统一的,不能空格和tab混用
  • 缩进的级别也必须是一致的,同样的缩进代表同样的级别,程序判别配置的级别是通过缩进结合换行来实现的
  • YAML文件内容是区别大小写的,key/value的值均需大小写敏感
  • 多个key/value可同行写也可换行写,同行使用","分隔
  • key后面冒号要加一个空格 比如: key: value
  • value可是个字符串,也可是另一个列表
  • YAML文件扩展名通常为yml或yam

4、支持的数据类型

  1. YAML 支持以下常用几种数据类型:
  2. 标量:单个的、不可再分的值
  3. 对象:键值对的集合,又称为映射(mapping)/ 哈希(hashes) / 字典(dictionary)
  4. 数组:一组按次序排列的值,又称为序列(sequence) / 列表(list)

4.1、scalar 标量

语法:key对应value

name: long
age: 18

使用缩进的方式

name:
long
age:
18

标量是最基本的,不可再分的值,包括:

  • 字符串
  • 布尔值
  • 整数
  • 浮点数
  • Null
  • 时间
  • 日期

4.2、Dictionary 字典

  字典由多个key与value构成,key和value之间用 :分隔, 并且 : 后面有一个空格,所有k/v可以放在一行,或者每个 k/v 分别放在不同行

语法格式:

account: { name: long, age: 30 }

使用缩进方式

account:
name: wang
age: 18

范例:

#不同行
#An employee record
name: Example Developer
job: Developer
skill: Elite(社会精英)

#同一行,也可以将key:value放置于{}中进行表示,用,分隔多个key:value
#An employee record
{name: “Example Developer”, job: “Developer”, skill: “Elite”}

4.3、List 列表

  列表由多个元素组成,每个元素放在不同行,且元素前均使用"-"打头,并且 - 后有一个空格, 或者将所有元素用 [ ] 括起来放在同一行

格式

course: [ linux , golang , python ]

也可以写成以 - 开头的多行

course:

  • linux
  • golang
  • python

数据里面也可以包含字典
course:

  • linux: manjaro
  • golang: gin
  • python: django

范例:

#不同行,行以-开头,后面有一个空格
#A list of tasty fruits

  • Apple
  • Orange
  • Strawberry
  • Mango
    #同一行
    [Apple,Orange,Strawberry,Mango]

范例:YAML 表示一个家庭

name: John Smith
age: 41
gender: Male
spouse: { name: Jane Smith, age: 37, gender: Female } # 写在一行里
name: Jane Smith #也可以写成多行
age: 37
gender: Female
children: [ {name: Jimmy Smith,age: 17, gender: Male}, {name: Jenny Smith, age:
13, gender: Female}, {name: hao Smith, age: 20, gender: Male } ] #写在一行

  • name: Jimmy Smith #写在多行,更为推荐的写法
    age: 17
    gender: Male
  • {name: Jenny Smith, age: 13, gender: Female}
  • {name: hao Smith, age: 20, gender: Male }

5、配置提示[在SpringBoot项目中,自定义的配置类与配置文件绑定开启提示]

自定义的类和配置文件绑定一般没有提示,在pom文件导入以下依赖,就可以开启提示功能。

  <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

 <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.springframework.boot</groupId>
                            <artifactId>spring-boot-configuration-processor</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>
<think>好的,我现在要帮助用户解决在自定义YAML语言中使用PsiElement的问题。首先,我需要回忆一下用户之前的对话。用户之前遇到了无法下载JetBrains Java Runtime的问题,我给出了手动下载、配置镜像源、检查网络代理等解决方案。现在用户的新问题是关于如何在自定义YAML语言中正确使用PsiElement进行解析或处理,并且参考了之前提到的RenameInputValidator和YAMLAnchor的例子。 首先,我需要确定用户的具体需求。用户提到想正确使用PsiElement,这可能涉及到自定义语言的支持,比如创建语法高亮、代码补全、引用解析等功能。他们可能正在开发一个基于IntelliJ平台的YAML相关插件,或者扩展现有的YAML支持,添加自定义元素,比如YAML锚点(YAMLAnchor)。根据用户提供的代码示例,他们可能已经在尝试实现一个重命名验证器,但需要更深入的指导。 接下来,我需要考虑IntelliJ平台中处理自定义语言的基本流程。通常,这涉及到定义Parser和PSI元素,创建BNF语法文件,生成解析器代码,然后实现相关的PSI元素类。用户的问题可能集中在如何正确解析YAML文件中的特定元素,并利用PsiElement进行后续处理,比如验证、重构或导航。 用户提供的代码示例是一个YAMLAnchorRenameInputValidator,它实现了RenameInputValidator接口,并通过getPattern方法指定了要验证的元素类型(YAMLAnchor.class),以及isInputValid方法检查新名称是否符合正则表达式。这说明用户可能正在处理YAML锚点的重命名验证,但可能遇到解析或PSI元素定义的问题。 接下来,我需要整理解决这个问题的步骤。首先,用户需要正确解析YAML文件中的自定义元素,这需要定义语法和生成PSI元素。然后,可能需要实现相关的PsiElement子类,如YAMLAnchor,以便在后续的处理中使用。此外,用户可能需要确保他们的自定义元素被正确识别,并且在重命名等操作时能够应用验证规则。 可能的步骤包括: 1. 定义YAML的自定义语法,特别是锚点的结构。 2. 生成对应的PSI元素类,如YAMLAnchor。 3. 实现解析器,将文本转换为PSI树。 4. 注册自定义语言到IntelliJ平台。 5. 实现验证器,如RenameInputValidator,使用这些PSI元素。 在解释这些步骤时,我需要确保用户理解如何将PsiElement集成到他们的自定义语言插件中,并处理常见的陷阱,比如语法定义错误、PSI元素未正确生成或注册问题。同时,需要提供具体的代码示例,如BNF语法规则、PsiElement实现类,以及如何与IntelliJ的API交互。 此外,用户可能遇到的挑战包括正确使用Grammar Kit生成解析器代码,处理PSI元素的层次结构,以及确保自定义元素在IDE中的各种功能(如重命名、查找引用)正常工作。我需要强调测试的重要性,比如使用PsiViewer插件检查PSI结构,或者编写测试用例验证解析结果。 最后,要确保回答结构清晰,分步骤说明,并提供示例代码和配置,帮助用户逐步实现他们的需求。同时,引用之前提到的引用[^1]中的内容,说明如何将RenameInputValidator应用到自定义的PsiElement上,确保输入验证的正确性。</think>### 在自定义 YAML 语言中使用 `PsiElement` 的完整指南 #### 核心目标 通过自定义 `PsiElement` 实现对 YAML 文件中特定语法结构(如锚点、别名)的解析、验证和操作。以下是分步实现方案: --- ### 一、定义语法结构与 Parser 1. **创建 BNF 语法文件** 在 IntelliJ 插件项目中,通过 `Grammar-Kit` 插件定义 YAML 语法规则。例如,在 `YAML.bnf` 文件中声明锚点语法: ```bnf { tokens=[ anchor='&' alias='*' ] } yamlFile ::= (anchor_def | alias_ref)* private anchor_def ::= anchor name { pin=1 // 锚点符号 & 是语法关键点 implements="com.your.plugin.psi.YAMLPsiElement" } private alias_ref ::= alias name { pin=1 implements="com.your.plugin.psi.YAMLPsiElement" } ``` 2. **生成 Parser 和 PsiElement 类** - 使用 `Generate Parser Code` 生成 `YAMLParser` 和 `YAMLPSI` 接口 - 实现自定义 `YAMLAnchor` 和 `YAMLAlias` 类: ```java public class YAMLAnchorImpl extends ASTWrapperPsiElement implements YAMLAnchor { public YAMLAnchorImpl(@NotNull ASTNode node) { super(node); } // 可添加锚点专用方法,如获取名称 public String getName() { return getText().substring(1); // 去除 & 符号 } } ``` --- ### 二、PSI 元素与语言注册 1. **语言注册** 在 `plugin.xml` 中声明自定义语言: ```xml <extensions defaultExtensionNs="com.intellij"> <language id="YAML_CUSTOM" implementationClass="com.your.plugin.YAMLLanguage" /> </extensions> ``` 2. **文件类型关联** 创建 `YAMLFileType` 并绑定至 `.yaml` 扩展名: ```java public class YAMLFileType extends LanguageFileType { public static final YAMLFileType INSTANCE = new YAMLFileType(); private YAMLFileType() { super(YAMLLanguage.INSTANCE); } @Override public String getDefaultExtension() { return "yaml"; } } ``` --- ### 三、实现自定义验证逻辑 1. **名称校验规则(基于引用示例[^1])** 扩展 `RenameInputValidator` 实现锚点名称格式检查: ```java public class YAMLAnchorRenameValidator implements RenameInputValidator { @Override public @NotNull ElementPattern<? extends PsiElement> getPattern() { return PlatformPatterns.psiElement(YAMLAnchor.class); } @Override public boolean isInputValid( @NotNull String newName, @NotNull PsiElement element, @NotNull ProcessingContext context ) { // 禁止包含特殊字符 return newName.matches("[^,\\[\\]{}\\n\\t ]+"); } } ``` 2. **注册验证器** 在 `plugin.xml` 中添加扩展: ```xml <extensions defaultExtensionNs="com.intellij"> <rename.inputValidator implementation="com.your.plugin.YAMLAnchorRenameValidator"/> </extensions> ``` --- ### 四、解析与 PSI 树操作 1. **解析锚点引用关系** 通过 `PsiReferenceContributor` 实现锚点与别名的关联: ```java public class YAMLReferenceContributor extends PsiReferenceContributor { @Override public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar) { registrar.registerReferenceProvider( PlatformPatterns.psiElement(YAMLAlias.class), new PsiReferenceProvider() { @Override public PsiReference @NotNull [] getReferencesByElement( @NotNull PsiElement element, @NotNull ProcessingContext context ) { String aliasName = ((YAMLAlias) element).getName(); return new PsiReference[]{new YAMLAnchorReference(element, aliasName)}; } }); } } ``` 2. **实现引用解析** 自定义 `YAMLAnchorReference` 完成查找锚点的逻辑: ```java public class YAMLAnchorReference extends PsiReferenceBase<PsiElement> { public YAMLAnchorReference(@NotNull PsiElement element, String alias) { super(element, new TextRange(1, element.getTextLength())); } @Override public @Nullable PsiElement resolve() { return YamlUtil.findAnchorInScope(myElement, getValue()); } } ``` --- ### 五、调试与验证 1. **使用 PsiViewer 插件** 安装 IntelliJ 的 `PsiViewer` 插件,查看解析后的 PSI 树结构是否符合预期(例如锚点是否被正确识别为 `YAMLAnchor` 节点)。 2. **单元测试** 编写解析测试用例验证语法规则: ```java public void testAnchorParsing() { PsiFile file = PsiFileFactory.getInstance(project) .createFileFromText("test.yaml", YAMLFileType.INSTANCE, "&valid_anchor"); YAMLAnchor anchor = PsiTreeUtil.findChildOfType(file, YAMLAnchor.class); assertNotNull(anchor); assertEquals("valid_anchor", anchor.getName()); } ``` --- ### 常见问题与解决方案 | 问题现象 | 排查方向 | |-----------------------------------|--------------------------------------------------------------------------| | PSI 元素未被识别 | 检查 BNF 语法中的 `implements` 是否正确绑定到自定义类 | | 重命名验证器未生效 | 确认 `getPattern()` 返回的 ElementPattern 是否匹配目标 PSI 元素类型 | | 解析时出现 "Cannot resolve symbol" | 检查 `PsiReferenceContributor` 的注册和 `resolve()` 方法实现逻辑 | --- ### 进阶应用 1. **代码格式化** 通过 `Block` 接口实现自定义缩进规则: ```java public class YAMLBlock extends AbstractBlock { protected YAMLBlock(@NotNull ASTNode node) { super(node, Wrap.createWrap(WrapType.NONE, false), null); } @Override protected Indent getIndent() { if (myNode.getElementType() == YAMLTokenTypes.ANCHOR_DEF) { return Indent.getNormalIndent(); } return Indent.getNoneIndent(); } } ``` 2. **语法高亮** 实现 `SyntaxHighlighter` 为锚点添加颜色标记: ```java public class YAMLSyntaxHighlighter implements SyntaxHighlighter { private static final TextAttributesKey ANCHOR_KEY = TextAttributesKey.createTextAttributesKey("YAML_ANCHOR", DefaultLanguageHighlighterColors.KEYWORD); @Override public TextAttributesKey @NotNull [] getTokenHighlights(IElementType tokenType) { if (tokenType == YAMLTokenTypes.ANCHOR) { return new TextAttributesKey[]{ANCHOR_KEY}; } return EMPTY; } } ``` --- ### 总结 在自定义 YAML 语言中操作 `PsiElement` 的核心步骤包括:**语法定义 → PSI 元素实现 → 解析器生成 → 功能扩展(验证/引用)**。通过结合 `RenameInputValidator` 等扩展点,可实现针对特定语法元素的精细化控制[^1]。建议通过单元测试和 `PsiViewer` 工具逐步验证各阶段结果。
评论 1
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值