Mensiri enum dalam aplikasi web Spring Boot

Enum ialah struktur yang baik untuk mentakrifkan satu set nilai terhad dan jelas dalam domain aplikasi kami. Mereka boleh membantu menghalang keadaan mustahil dalam pangkalan kod kami.

Senario itu

Mari kita gunakan aplikasi web mengambil nota sebagai contoh untuk menunjukkan cara yang mungkin untuk mensiri dan menyahsiri nilai eum.

Kami akan melaksanakannya menggunakan Spring Boot 3.3.x dan MongoDB.

Kami mentakrifkan kelas Jenis enum untuk mewakili jenis todos yang dibenarkan dalam aplikasi: acara dan aktiviti.

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

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

   public String getValue() {
       return value;
    }

}

Kelas Todo kami

public class Todo {

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

    private Type type;

    ...
    ...

}

Kami akan menganalisis siri enum dalam senario ini:

1. Enum sebagai param pertanyaan.
2. Enum sebagai sebahagian daripada permintaan badan JSON.
3. Enum sebagai medan dokumen MongoDB.

Enum sebagai param pertanyaan

Dalam senario ini, kami hanya memerlukan kaedah deserialisasi kerana kami berminat untuk menukar daripada nilai rentetan kepada enum.

Di bawah coretan kod yang mewakili kaedah Pengawal untuk membaca semua tugas mengikut jenis, jenis dihantar sebagai parameter pertanyaan.

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

Parameter pertanyaan ialah rentetan jadi kita perlu menentukan Penukar yang sesuai untuk mengubahnya.
Di dalam kaedah tukar yang kami panggil Type.fromString, kaedah statik yang dicipta dalam kelas enum, yang akan digunakan dalam senario lain juga. Kod kaedah fromString dibentangkan dalam senario seterusnya.

public class StringToType implements Converter<string type> {

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

}
</string>

Penukar mesti didaftarkan dalam aplikasi.

@Configuration
public class Config implements WebMvcConfigurer {

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

Sekarang apabila kami akan menggunakan Type sebagai RequestParam, penukar StringToType akan digunakan untuk cuba menukar nilai rentetan dalam enum kami.

Enum sebagai sebahagian daripada permintaan badan JSON

Untuk mengurus enum dengan betul sebagai medan kandungan badan JSON kita harus menambahkan beberapa kod pada kelas Jenis enum.

Kita perlu menggunakan anotasi @JsonValue untuk menandakan medan sebagai nilai untuk digunakan untuk mensiri enum.
Kemudian kita harus menambah peta statik di dalam enum untuk memetakan Jenis dengan perwakilan rentetan yang berkaitan.

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>

Enum sebagai medan dokumen MongoDB.

Untuk mengurus pensirilan/deserialisasi enum dalam dokumen MongoDB, kita perlu menggunakan anotasi @ValueConverter yang mengikat medan dokumen dengan kelas PropertyValueConverter tertentu.

Dalam contoh jenis medan Jenis terikat dengan MongoEnumConverter yang menyediakan kaedah baca dan tulis untuk mengurus penukaran.

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

}

Secara terperinci dalam kaedah baca kami panggil Type.fromString daripada kelas enum untuk cuba menukar rentetan dalam contoh Jenis yang sah.

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

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

   public String getValue() {
       return value;
    }

}

Kesimpulannya

Dalam artikel ini saya membentangkan beberapa cara untuk mengurus pensirilan/deserializion kelas enum dalam senario Web biasa. Spring dan perpustakaan Jackson menyediakan beberapa kemudahan untuk memudahkan kerja ini.

Kod ini tersedia secara umum dalam repositori Gitlab ini.

Kod yang dibentangkan dalam artikel ini adalah di bawah lesen CC0.

Atas ialah kandungan terperinci Mensiri enum dalam aplikasi web Spring Boot. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!