如何在 Java 中将 YAML 转换为 JSON？

Question

我只想将一个包含 yaml 的字符串转换为另一个包含使用 Java 转换的对应 json 的字符串。

例如假设我有这个 yaml 的内容

---
paper:
   uuid: 8a8cbf60-e067-11e3-8b68-0800200c9a66
   name: On formally undecidable propositions of Principia Mathematica and related systems I.
   author: Kurt Gödel.
tags:
   - tag:
       uuid: 98fb0d90-e067-11e3-8b68-0800200c9a66
       name: Mathematics
   - tag:
       uuid: 3f25f680-e068-11e3-8b68-0800200c9a66
       name: Logic

在名为 yamlDoc 的字符串中：

String yamlDoc = "---\npaper:\n   uuid: 8a... etc...";

我想要一些可以将yaml字符串转换为另一个带有相应json的字符串的方法，即以下代码

String yamlDoc = "---\npaper:\n   uuid: 8a... etc...";
String json = convertToJson(yamlDoc); // I want this method
System.out.println(json);

应该打印：

{
    "paper": {
        "uuid": "8a8cbf60-e067-11e3-8b68-0800200c9a66",
        "name": "On formally undecidable propositions of Principia Mathematica and related systems I.",
        "author": "Kurt Gödel."
    },
    "tags": [
        {
            "tag": {
                "uuid": "98fb0d90-e067-11e3-8b68-0800200c9a66",
                "name": "Mathematics"
            }
        },
        {
            "tag": {
                "uuid": "3f25f680-e068-11e3-8b68-0800200c9a66",
                "name": "Logic"
            }
        }
    ]
}

我想知道在这个例子中是否存在类似于 convertToJson() 方法的东西。

我尝试使用SnakeYAML 来实现这一点，所以这段代码

 Yaml yaml = new Yaml();
 Map<String,Object> map = (Map<String, Object>) yaml.load(yamlDoc);

构造一个包含已解析 YAML 结构的映射（使用嵌套映射）。那么如果有一个解析器可以将地图转换为json字符串，它将解决我的问题，但我也没有找到类似的东西。

我们将不胜感激。

Answer 1

感谢 HotLicks 提示（在问题 cmets 中）我终于以这种方式使用库 org.json 和 SnakeYAML 实现了转换：

private static String convertToJson(String yamlString) {
    Yaml yaml= new Yaml();
    Map<String,Object> map= (Map<String, Object>) yaml.load(yamlString);

    JSONObject jsonObject=new JSONObject(map);
    return jsonObject.toString();
}

我不知道这是否是最好的方法，但它对我有用。

Answer 2

非常感谢 Miguel A. Carrasco，他实际上已经解决了这个问题。但他的版本是限制性的。如果 root 是列表或原始值，他的代码将失败。最通用的解决方案是：

private static String convertToJson(String yamlString) {
    Yaml yaml= new Yaml();
    Object obj = yaml.load(yamlString);

    return JSONValue.toJSONString(obj);
}

Answer 3

这是一个使用 Jackson 的实现：

String convertYamlToJson(String yaml) {
    ObjectMapper yamlReader = new ObjectMapper(new YAMLFactory());
    Object obj = yamlReader.readValue(yaml, Object.class);

    ObjectMapper jsonWriter = new ObjectMapper();
    return jsonWriter.writeValueAsString(obj);
}

要求：

compile('com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.7.4')

Answer 4

我发现该示例在将 Swagger (OpenAPI) YAML 转换为 JSON 时没有生成正确的值。我写了如下例程：

  private static Object _convertToJson(Object o) throws JSONException {
    if (o instanceof Map) {
      Map<Object, Object> map = (Map<Object, Object>) o;

      JSONObject result = new JSONObject();

      for (Map.Entry<Object, Object> stringObjectEntry : map.entrySet()) {
        String key = stringObjectEntry.getKey().toString();

        result.put(key, _convertToJson(stringObjectEntry.getValue()));
      }

      return result;
    } else if (o instanceof ArrayList) {
      ArrayList arrayList = (ArrayList) o;
      JSONArray result = new JSONArray();

      for (Object arrayObject : arrayList) {
        result.put(_convertToJson(arrayObject));
      }

      return result;
    } else if (o instanceof String) {
      return o;
    } else if (o instanceof Boolean) {
      return o;
    } else {
      log.error("Unsupported class [{0}]", o.getClass().getName());
      return o;
    }
  }

然后我可以使用 SnakeYAML 来加载和输出 JSON：

Yaml yaml= new Yaml();
Map<String,Object> map= (Map<String, Object>) yaml.load(yamlString);

JSONObject jsonObject = (JSONObject) _convertToJson(map);
System.out.println(jsonObject.toString(2));

Answer 5

在寻找同一问题的解决方案时，我被定向到了这个问题。

我还偶然发现了以下文章https://dzone.com/articles/read-yaml-in-java-with-jackson

Jackson JSON 库似乎有一个基于 SnakeYAML 的 YAML 扩展。 由于 Jackson 是事实上的 JSON 库之一，我认为我应该在这里链接它。

Answer 6

谢谢，米格尔！你的例子帮助很大。我不想使用“JSON-java”库。我更喜欢GSON。但是将逻辑从 JSON-java 转换为 GSON 的域模型并不难。一个函数就可以解决问题：

/**
 * Wraps the object returned by the Snake YAML parser into a GSON JsonElement 
 * representation.  This is similar to the logic in the wrap() function of:
 * 
 * https://github.com/stleary/JSON-java/blob/master/JSONObject.java
 */
public static JsonElement wrapSnakeObject(Object o) {

    //NULL => JsonNull
    if (o == null)
        return JsonNull.INSTANCE;

    // Collection => JsonArray
    if (o instanceof Collection) {
        JsonArray array = new JsonArray();
        for (Object childObj : (Collection<?>)o)
            array.add(wrapSnakeObject(childObj));
        return array;
    }

    // Array => JsonArray
    if (o.getClass().isArray()) {
        JsonArray array = new JsonArray();

        int length = Array.getLength(array);
        for (int i=0; i<length; i++)
            array.add(wrapSnakeObject(Array.get(array, i)));

        return array;
    }

    // Map => JsonObject
    if (o instanceof Map) {
        Map<?, ?> map = (Map<?, ?>)o;

        JsonObject jsonObject = new JsonObject();
        for (final Map.Entry<?, ?> entry : map.entrySet()) {
            final String name = String.valueOf(entry.getKey());
            final Object value = entry.getValue();
            jsonObject.add(name, wrapSnakeObject(value));
        }

        return jsonObject;
    }

    // everything else => JsonPrimitive
    if (o instanceof String)
        return new JsonPrimitive((String)o);
    if (o instanceof Number)
        return new JsonPrimitive((Number)o);
    if (o instanceof Character)
        return new JsonPrimitive((Character)o);
    if (o instanceof Boolean)
        return new JsonPrimitive((Boolean)o);

    // otherwise.. string is a good guess
    return new JsonPrimitive(String.valueOf(o));
}

然后您可以使用以下命令从 YAML 字符串中解析 JsonElement：

Yaml yaml = new Yaml();
Map<String, Object> yamlMap = yaml.load(yamlString);
JsonElement jsonElem = wrapSnakeObject(yamlMap);

然后打印出来：

Gson gson = new GsonBuilder().setPrettyPrinting().create();
System.out.println(gson.toJson(jsonElem));

Answer 7

使用 Gson：

var yaml = new YAML();
var gson = new Gson();        
var reader = new FileReader(path.toFile());
var obj = yaml.load(reader);
var writer = new StringWriter();
gson.toJson(obj, writer);
String result = writer.toString();

Answer 8

使用 kotlin 进行 Spring Boot 以将 yaml 文件内容作为 json 数据返回

package br.com.sportplace.controller

import com.fasterxml.jackson.databind.ObjectMapper
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory
import org.springframework.http.HttpStatus
import org.springframework.http.ResponseEntity
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RestController
import java.io.InputStream


@RestController
@RequestMapping(value = ["resources/docs"])
class DocsController {


    @GetMapping(produces = ["application/json"])
    fun load(): ResponseEntity<Any> {
        return getResourceFileAsString()
    }

    fun getResourceFileAsString(): ResponseEntity<Any> {
        val inputStream = getResourceFileAsInputStream("openapi/api.yaml")
        return if (inputStream != null) {
            val objectMapper = ObjectMapper(YAMLFactory())
            ResponseEntity.ok(objectMapper.readValue(inputStream, Any::class.java))
        } else {
            ResponseEntity(ErrorResponse(), HttpStatus.INTERNAL_SERVER_ERROR)
        }
    }

    fun getResourceFileAsInputStream(fileName: String?): InputStream? {
        val classLoader = DocsController::class.java.classLoader
        return classLoader.getResourceAsStream(fileName)
    }

    private data class ErrorResponse(
        val message: String = "Failed to load resource file",
        val success: Boolean = false,
        val timestamp: Long = System.currentTimeMillis()
    )
}