Spring Boot 웹 애플리케이션에서 열거형 직렬화

Enum은 애플리케이션 도메인 내에서 제한적이고 잘 정의된 값 집합을 정의하는 데 좋은 구조입니다. 이는 코드베이스에서 불가능한 상태를 방지하는 데 도움이 될 수 있습니다.

시나리오

음 값을 직렬화 및 역직렬화하는 방법을 보여주기 위해 메모 작성 웹 애플리케이션을 예로 들어 보겠습니다.

Spring Boot 3.3.x와 MongoDB를 사용하여 구현할 예정입니다.

애플리케이션 내에서 허용되는 할 일 유형(이벤트 및 활동)을 나타내기 위해 유형 열거형 클래스를 정의합니다.

public enum Type {
    EVENT("event"),
    ACTIVITY("activity");

    private Type(String value) {
       this.value = value;
    }

   public String getValue() {
       return value;
    }

}

우리의 Todo 수업

public class Todo {

    private String id;
    private String name;
    private boolean completed;

    private Type type;

    ...
    ...

}

다음 시나리오에서 열거형 직렬화를 분석할 예정입니다.

1. 쿼리 매개변수로 열거형
2. JSON 본문 요청의 일부로 열거형.
3. MongoDB 문서의 필드인 열거형.

쿼리 매개변수로서의 열거형

이 시나리오에서는 문자열 값을 열거형으로 변환하는 데 관심이 있으므로 deserialize 메서드만 필요합니다.

모든 할일을 유형별로 읽는 컨트롤러 메소드를 나타내는 코드 조각 아래에는 해당 유형이 쿼리 매개변수로 전달됩니다.

 public Collection<todo> read(@RequestParam(required = false) Type type) {
     ...
     ...
 }
</todo>

쿼리 매개변수는 문자열이므로 이를 변환하려면 적절한 변환기를 정의해야 합니다.
변환 메소드 내에서는 enum 클래스에서 생성된 정적 메소드인 Type.fromString을 호출하며 이는 다른 시나리오에서도 사용됩니다. fromString 메소드의 코드는 다음 시나리오에 나와 있습니다.

public class StringToType implements Converter<string type> {

    @Override
    public Type convert(String source) {
        return Type.fromString(source);
    }

}
</string>

애플리케이션에 변환기를 등록해야 합니다.

@Configuration
public class Config implements WebMvcConfigurer {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new StringToType());
        WebMvcConfigurer.super.addFormatters(registry);
    }
}

이제 Type을 RequestParam으로 사용할 때 StringToType 변환기를 사용하여 열거형의 문자열 값을 변환해 봅니다.

JSON 본문 요청의 일부로 열거형

JSON 본문 콘텐츠의 필드로서 열거형을 올바르게 관리하려면 열거형 유형 클래스에 일부 코드를 추가해야 합니다.

열거형 직렬화에 사용할 값으로 필드를 표시하려면 @JsonValue 주석을 사용해야 합니다.
그런 다음 열거형 내부에 정적 맵을 추가하여 유형을 관련 문자열 표현으로 매핑해야 합니다.

public enum Type {
    EVENT("event"),
    ACTIVITY("activity");

    @JsonValue
    private String value;

    private static Map<string type> enumMap;

    private Type(String value) {
        this.value = value;
    }

    static {
        enumMap = Stream.of(values()).collect(Collectors.toMap(t -> t.value, t -> t));
    }

    public static Type fromString(String value) {
        return enumMap.get(value);
    }

    public String getValue() {
        return value;
    }

}
</string>

MongoDB 문서의 필드인 Enum입니다.

MongoDB 문서에서 열거형의 직렬화/역직렬화를 관리하려면 문서의 필드를 특정 PropertyValueConverter 클래스와 바인딩하는 @ValueConverter 주석을 사용해야 합니다.

예제에서 Type 필드는 변환을 관리하기 위한 읽기 및 쓰기 메서드를 제공하는 MongoEnumConverter와 바인딩됩니다.

@Document(collection = "todo")
@TypeAlias("todo")
public class Todo {

    @Id
    private String id;
    private String name;
    private boolean completed;

    @ValueConverter(MongoEnumConverter.class)
    private Type type;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public boolean isCompleted() {
        return completed;
    }

    public void setCompleted(boolean completed) {
        this.completed = completed;
    }

    public Type getType() {
        return type;
    }

    public void setType(Type type) {
        this.type = type;
    }

}

자세히 읽어 보면 enum 클래스에서 Type.fromString을 호출하여 유효한 Type 인스턴스의 문자열을 변환하려고 시도합니다.

public enum Type {
    EVENT("event"),
    ACTIVITY("activity");

    private Type(String value) {
       this.value = value;
    }

   public String getValue() {
       return value;
    }

}

결론적으로

이 기사에서는 일반적인 웹 시나리오에서 열거형 클래스의 직렬화/역직렬화를 관리하는 몇 가지 방법을 제시했습니다. Spring과 Jackson 라이브러리는 이 작업을 단순화하는 몇 가지 기능을 제공합니다.

코드는 Gitlab 저장소에서 공개적으로 제공됩니다.

이 글에 제시된 코드는 CC0 라이선스를 따릅니다.

위 내용은 Spring Boot 웹 애플리케이션에서 열거형 직렬화의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!