枚舉是一個很好的結(jié)構(gòu)，可以在我們的應(yīng)用程序域內(nèi)定義一組有限且定義明確的值。它們可以幫助防止我們的代碼庫中出現(xiàn)不可能的狀態(tài)。

場景

讓我們以筆記 Web 應(yīng)用程序?yàn)槔齺碚故拘蛄谢头葱蛄谢?eum 值的可能方法。

我們將使用 Spring Boot 3.3.x 和 MongoDB 來實(shí)現(xiàn)它。

我們定義一個 Type 枚舉類來表示應(yīng)用程序內(nèi)允許的待辦事項(xiàng)類型：事件和活動。

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. 枚舉作為查詢參數(shù)。
2. 枚舉作為 JSON 正文請求的一部分。
3. 枚舉作為 MongoDB 文檔的字段。

枚舉作為查詢參數(shù)

在這種情況下，我們只需要一個反序列化方法，因?yàn)槲覀兏信d趣的是從字符串值轉(zhuǎn)換為枚舉。

下面是表示按類型讀取所有待辦事項(xiàng)的控制器方法的代碼片段，類型作為查詢參數(shù)傳遞。

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

查詢參數(shù)是一個字符串，因此我們必須定義一個適當(dāng)?shù)霓D(zhuǎn)換器來轉(zhuǎn)換它。
在convert方法中，我們調(diào)用Type.fromString，這是在枚舉類中創(chuàng)建的靜態(tài)方法，它也將在其他場景中使用。 fromString 方法的代碼將在下一個場景中呈現(xiàn)。

public class StringToType implements Converter<String, Type> {

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

}

轉(zhuǎn)換器必須在應(yīng)用程序中注冊。

@Configuration
public class Config implements WebMvcConfigurer {

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

現(xiàn)在，當(dāng)我們使用 Type 作為 RequestParam 時，StringToType 轉(zhuǎn)換器將用于嘗試轉(zhuǎn)換枚舉中的字符串值。

枚舉作為 JSON 正文請求的一部分

為了正確管理枚舉作為 JSON 正文內(nèi)容的字段，我們應(yīng)該向枚舉 Type 類添加一些代碼。

我們需要使用注釋 @JsonValue 將字段標(biāo)記為用于序列化枚舉的值。
然后我們應(yīng)該在枚舉內(nèi)添加一個靜態(tài)映射，以將類型與相關(guān)的字符串表示形式進(jìn)行映射。

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;
    }

}

枚舉作為 MongoDB 文檔的字段。

要管理 MongoDB 文檔中枚舉的序列化/反序列化，我們必須使用 @ValueConverter 注釋，將文檔的字段與特定的 PropertyValueConverter 類綁定。

在示例中，字段 Type 類型與 MongoEnumConverter 綁定，MongoEnumConverter 提供讀寫方法來管理轉(zhuǎn)換。

@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;
    }

}

詳細(xì)來說，在 read 方法中，我們從枚舉類調(diào)用 Type.fromString 來嘗試將字符串轉(zhuǎn)換為有效的 Type 實(shí)例。

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

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

   public String getValue() {
       return value;
    }

}

綜上所述

在本文中，我介紹了一些在典型 Web 場景中管理枚舉類的序列化/反序列化的方法。 Spring 和 Jackson 庫提供了一些工具來簡化這項(xiàng)工作。

代碼在此 Gitlab 存儲庫中公開可用。

本文中提供的代碼已獲得 CC0 許可。

以上是在 Spring Boot Web 應(yīng)用程序中序列化枚舉的詳細(xì)內(nèi)容。更多信息請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！