WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Java

Java-Objekte in ein Byte-Array serialisieren

Schreibe ein Objekt in ein `byte[]` und stelle es aus vertrauenswürdigen Bytes desselben Programms wieder her. Sieh, warum die Standardserialisierung `transient`-Felder auslässt.

Version: Java SE 21

Syntax

Java SE 21 — java.io
ByteArrayOutputStream()
ObjectOutputStream(OutputStream out) throws IOException
void ObjectOutputStream.writeObject(Object obj) throws IOException
void ObjectOutputStream.flush() throws IOException
byte[] ByteArrayOutputStream.toByteArray()
ByteArrayInputStream(byte[] buf)
ObjectInputStream(InputStream in) throws IOException
Object ObjectInputStream.readObject() throws IOException, ClassNotFoundException

In Java SE 21 lassen sich Objekte mit den Klassen aus java.io vollständig im Arbeitsspeicher schreiben und wiederherstellen. Der Konstruktor von ObjectOutputStream schreibt den Stream-Header. writeObject(Object) serialisiert das Objekt und den über die mitgeschriebenen Referenzen erreichbaren Objektgraphen. Der Parameter vom Typ Object garantiert keinen Erfolg: Implementiert ein zu serialisierendes Objekt Serializable nicht, kann NotSerializableException auftreten.

Rufe nach writeObject(Object) die Methode flush() auf, um gepufferte Bytes an den zugrunde liegenden Stream weiterzugeben, ohne ihn zu schließen. Danach liefert ByteArrayOutputStream.toByteArray() ein neues byte[], das nur die geschriebenen Bytes als Kopie enthält. Die Methode gibt weder den internen Puffer frei noch leert sie den Puffer des Objektstreams. ByteArrayInputStream(byte[]) verwendet das Array ohne Kopie.

Der Konstruktor von ObjectInputStream liest den Header. readObject() stellt das Objekt wieder her und gibt es als Object zurück. Der Cast zu Profile prüft den erwarteten Typ erst nach der Deserialisierung. Lies aufeinanderfolgende Werte in derselben Reihenfolge und mit den zum Schreiben passenden Typen. Stream-Operationen können IOException auslösen; beim Lesen kann zusätzlich ClassNotFoundException auftreten, wenn eine benötigte Klasse fehlt. Die Try-with-Resources-Blöcke schließen die Objektstreams.

Die Standardserialisierung lässt static- und transient-Felder aus. Beim Wiederherstellen einer gewöhnlichen serialisierbaren Klasse werden ihr Konstruktor und ihre Feldinitialisierer nicht ausgeführt. Deshalb hat cache den Standardwert null statt warm. Wenn die Werte von serialVersionUID übereinstimmen müssen, führt eine Abweichung zu InvalidClassException. Für Array- und Record-Klassen ist diese Übereinstimmung nicht erforderlich. Ein übereinstimmender Wert macht nicht jede Klassenänderung kompatibel. Das ist kein sprachunabhängiges Austauschformat. Deserialisiere keine nicht vertrauenswürdigen Daten: Das Beispiel liest nur Bytes, die dasselbe Programm lokal erzeugt.

Beispiele

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serial;
import java.io.Serializable;

public class SerializationRoundTrip {
    private static final class Profile implements Serializable {
        @Serial
        private static final long serialVersionUID = 1L;

        private final String name;
        private transient String cache = "warm";

        private Profile(String name) {
            this.name = name;
        }
    }

    public static void main(String[] args)
            throws IOException, ClassNotFoundException {
        Profile original = new Profile("Ada");
        ByteArrayOutputStream buffer = new ByteArrayOutputStream();
        byte[] bytes;
        try (ObjectOutputStream out = new ObjectOutputStream(buffer)) {
            out.writeObject(original);
            out.flush();
            bytes = buffer.toByteArray();
        }

        Profile restored;
        try (ObjectInputStream in = new ObjectInputStream(new ByteArrayInputStream(bytes))) {
            restored = (Profile) in.readObject();
        }

        System.out.println("before: " + original.name + ", cache=" + original.cache);
        System.out.println("after: " + restored.name + ", cache=" + restored.cache);
    }
}

Ergebnis

before: Ada, cache=warm
after: Ada, cache=null

Vergleiche `before` und `after`: `name` bleibt `Ada`, aber `cache` ist im Original `warm` und im wiederhergestellten Objekt `null`.

Zugehörige Lektionen

  • Java · Lektion 52 · Fortgeschritten · Version: 2

Quellen