[java] SnakeYAML을 사용하여 YAML 파일의 코드 검사하기

16 Nov 2023

java

이번 글에서는 SnakeYAML 라이브러리를 사용하여 YAML 파일의 코드를 검사하는 방법을 알아보겠습니다.

SnakeYAML이란?

SnakeYAML은 Java에서 YAML 데이터를 읽고 쓰는 라이브러리입니다. YAML은 사람이 읽기 쉬운 데이터 직렬화 형식으로, 설정 파일, 데이터 전송 등 다양한 용도로 사용됩니다. SnakeYAML은 YAML 데이터를 Java 객체로 변환하거나 Java 객체를 YAML 형식으로 변환하는 기능을 제공합니다.

SnakeYAML 설치하기

먼저 SnakeYAML을 프로젝트에 추가해야 합니다. 다음과 같이 Maven을 사용한다면, pom.xml 파일에 다음 의존성을 추가합니다:

<dependency>
    <groupId>org.yaml</groupId>
    <artifactId>snakeyaml</artifactId>
    <version>1.27</version>
</dependency>

Maven을 사용하지 않는다면, 직접 JAR 파일을 다운로드하여 프로젝트에 추가해야 합니다.

YAML 파일 코드 검사하기

이제 SnakeYAML을 사용하여 YAML 파일의 코드를 검사하는 방법을 알아보겠습니다. 다음은 YAML 파일의 코드를 검사하여 오류를 출력하는 예제 코드입니다:

import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.parser.ParserException;

public class YamlValidator {
    public static void validateYaml(String yamlFile) {
        Yaml yaml = new Yaml();
        try {
            yaml.load(yamlFile);
            System.out.println("YAML 파일 검사 완료: 유효한 형식입니다.");
        } catch (ParserException e) {
            System.out.println("YAML 파일 검사 오류: 유효하지 않은 형식입니다.");
            System.out.println("오류 메시지: " + e.getMessage());
        }
    }

    public static void main(String[] args) {
        String yamlFile = "---\n" +
                "name: John\n" +
                "age: 25\n" +
                "email: john@example.com\n" +
                "phone: 123-456-7890\n" +
                "address:\n" +
                "  street: Main St\n" +
                "  city: New York\n" +
                "  state: NY";
                
        validateYaml(yamlFile);
    }
}

위 예제에서 validateYaml 메소드는 주어진 YAML 문자열을 로드하여 검사합니다. 만약 형식이 유효하지 않다면 ParserException이 발생하고, 오류 메시지를 출력합니다.

주어진 예제를 실행해보면, 유효한 YAML 형식인 경우 “YAML 파일 검사 완료: 유효한 형식입니다.”가 출력되고, 유효하지 않은 형식인 경우 “YAML 파일 검사 오류: 유효하지 않은 형식입니다.”와 함께 오류 메시지가 출력됩니다.

마치며

SnakeYAML을 사용하여 YAML 파일의 코드를 검사하는 방법에 대해 알아보았습니다. SnakeYAML은 간편하고 유연한 사용법으로 YAML 데이터를 처리할 수 있습니다. 추가로 SnakeYAML 공식 문서를 참고하시면 더 자세한 정보를 얻을 수 있습니다.