将Scala / Circe中的YAML解析为具有联合类型的案例类

时间:2019-06-19 18:50:26

标签: json scala parsing yaml circe

我有一个YAML文件,其中包含以下示例中定义的3种类型的字段。本质上,我希望能够将其解析为代表那些数据模型的通用案例类。

此YAML文件会经常更改,包括字段名称,值等。唯一不变的是每种数据类型的高级格式(如下所示)

最大的问题是,如何定义一个在同一字段中接受多个类型的case类并将YAML解析为它们?

在线上的大多数示例在这个问题上似乎都没有太多,因此我尝试了几项不同的事情,但最终都失败了。似乎在使用circe库时使用诸如Either之类的求和类型存在问题,因为出现以下错误。我也尝试使用sealed trait和联合类型无济于事。

示例YAML文件:

name: ExampleYamlMapping
version: 0.0
mappings:

  # Single Value Field
  - name: fieldtype1
    value: "singlevalue"

  # Multivalue Fields, Unformatted
  - name: fieldtype2
    value:
      - "multivalue"
      - "multivalue1"

  # Formatted Multivalue field
  - name: fieldtype3
    content_type: "formatted multivalue"
    format: "key1 | key2"
    mappings:
      - name: key1 # Single Value Field
        value: "singlevalue"

      - name: key2 # Multivalue Field, Unformatted
        value:
          - "multivalue1"
          - "multivalue2"

案例分类示例:


case class UnorderedField(name: String, value: Either[String, List[String]])

case class OrderedMultiValueField(content_type: String,
                                  format: String,
                                  mappings: List[Either[UnorderedField, OrderedMultiValueField]])

case class ContentMappingExample(
                           name: String,
                           version: String,
                           mappings: List[Either[UnorderedField, OrderedMultiValueField]]
                           )

解析逻辑:

import io.circe.generic.auto._
import io.circe.{Error, Json, ParsingFailure, yaml}

val mappingSource = scala.io.Source.fromFile(mappingFilePath)

mappingData = try mappingSource.mkString finally mappingSource.close()

val mappings: Either[ParsingFailure, Json] = yaml.parser.parse(mappingData)

val contentMapping: ContentMappingExample = mappings
      .leftMap(err => err: Error)
      .flatMap(_.as[ContentMappingExample])
      .valueOr(throw _)

错误消息是:

CNil: DownArray,DownField(mappings)
DecodingFailure(CNil, List(DownArray, DownField(mappings)))

1 个答案:

答案 0 :(得分:0)

对此进行更新:我发现您可以创建代数数据类型(ADT)并定义自定义编码器。我遵循了适用于我的以下示例:https://circe.github.io/circe/codecs/adt.html