Objet sérialisable Java en tableau d'octets

292

Disons que j'ai une classe sérialisable AppMessage .

Je voudrais le transmettre comme byte[]sur des sockets à une autre machine où il est reconstruit à partir des octets reçus.

Comment pourrais-je y parvenir?

iTEgg
la source
5
Pourquoi comme byte[]? Pourquoi ne pas simplement l'écrire directement dans le socket avec ObjectOutputStream, et le lire avec ObjectInputStream?
Marquis de Lorne
utiliser apache camel
la main de NOD
1
new ObjectMapper().writeValueAsBytes(JAVA_OBJECT_HERE)
Asad Shakeel

Réponses:

411

Préparez le tableau d'octets à envoyer:

ByteArrayOutputStream bos = new ByteArrayOutputStream();
ObjectOutputStream out = null;
try {
  out = new ObjectOutputStream(bos);   
  out.writeObject(yourObject);
  out.flush();
  byte[] yourBytes = bos.toByteArray();
  ...
} finally {
  try {
    bos.close();
  } catch (IOException ex) {
    // ignore close exception
  }
}

Créez un objet à partir d'un tableau d'octets:

ByteArrayInputStream bis = new ByteArrayInputStream(yourBytes);
ObjectInput in = null;
try {
  in = new ObjectInputStream(bis);
  Object o = in.readObject(); 
  ...
} finally {
  try {
    if (in != null) {
      in.close();
    }
  } catch (IOException ex) {
    // ignore close exception
  }
}
Taylor Leese
la source
48
Ce n'est pas ainsi que j'ai lu la question. Pour moi, il semble que son problème est de savoir comment convertir l'objet en octet [] - pas comment l'envoyer.
Taylor Leese
1
Taylor: oui, vous avez bien compris. je veux transformer l'objet en octet [] et le transmettre. pouvez-vous s'il vous plaît également fournir le code concernant la façon de transformer cet octet [] en un objet s'il vous plaît?
iTEgg
Veuillez toujours fermer tout flux pour libérer les ressources système. (Modifié en code)
LuckyMalaka
cela peut-il fonctionner avec des objets que je ne peux pas implémenter sérialisables?
KJW
2
ObjectInput, ObjectOuput, ByteArrayOutputStreamEt ByteArrayInputStreammettre en œuvre toute l' AutoCloseableinterface, ne serait - il une bonne pratique de l' utiliser pour éviter de manquer les fermer par erreur? (Je ne suis pas tout à fait sûr que ce soit la meilleure pratique, qui est la raison pour laquelle je me demande.) Exemple: try(ByteArrayOutputStream bos = new ByteArrayOutputStream(); ObjectOutput out = new ObjectOutputStream(bos)){ /*Do stuff*/ }catch(IOException e){/*suppress exception*/}. Il supprime également la nécessité de la finalclause et son additionnel try-catch.
Ludvig Rydahl
307

La meilleure façon de le faire est d'utiliser SerializationUtilsApache Commons Lang .

Pour sérialiser:

byte[] data = SerializationUtils.serialize(yourObject);

Pour désérialiser:

YourObject yourObject = SerializationUtils.deserialize(data)

Comme mentionné, cela nécessite la bibliothèque Commons Lang. Il peut être importé à l'aide de Gradle:

compile 'org.apache.commons:commons-lang3:3.5'

Maven:

<!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>3.5</version>
</dependency>

Fichier Jar

Et plus de façons mentionnées ici

Alternativement, la collection entière peut être importée. Référez ce lien

uris
la source
56
Frais généraux ajoutés? Autant reconstruire la roue à ce stade. Sérieusement, il est beaucoup plus facile de comprendre ce one-liner et de réduire les erreurs possibles (comme ne pas fermer le flux au bon moment et ainsi de suite).
ALOToverflow
2
Meilleur moyen car vous utilisez une bibliothèque commune vous offrant: 1) Robustesse: les gens l'utilisent et donc elle est validée pour fonctionner. 2) Il fait ce qui précède (réponse la plus populaire) avec seulement 1 ligne afin que votre code reste propre. 3) Parce que Dan l'a dit. 4) Je plaisante à propos de 3 :-)
Lawrence
2
Malheureusement, la méthode limite la taille de sortie à 1024. Si l'on a besoin de convertir un fichier en un flux d'octets, mieux vaut ne pas l'utiliser.
Abilash
Je ne préférerais pas celui-ci pour les microservices. La bibliothèque pourrait les rendre plus lourdes que leur taille, par rapport aux méthodes directes.
Zon
89

Si vous utilisez Java> = 7, vous pouvez améliorer la solution acceptée en utilisant try with resources :

private byte[] convertToBytes(Object object) throws IOException {
    try (ByteArrayOutputStream bos = new ByteArrayOutputStream();
         ObjectOutput out = new ObjectOutputStream(bos)) {
        out.writeObject(object);
        return bos.toByteArray();
    } 
}

Et l'inverse:

private Object convertFromBytes(byte[] bytes) throws IOException, ClassNotFoundException {
    try (ByteArrayInputStream bis = new ByteArrayInputStream(bytes);
         ObjectInput in = new ObjectInputStream(bis)) {
        return in.readObject();
    } 
}
Víctor Romero
la source
7

Peut être fait par SerializationUtils , par la méthode serialize & deserialize par ApacheUtils pour convertir l'objet en octet [] et vice-versa, comme indiqué dans la réponse @uris.

Pour convertir un objet en octet [] en sérialisant:

byte[] data = SerializationUtils.serialize(object);

Pour convertir l'octet [] en objet en désérialisant ::

Object object = (Object) SerializationUtils.deserialize(byte[] data)

Cliquez sur le lien pour télécharger org-apache-commons-lang.jar

Intégrez le fichier .jar en cliquant sur:

FileName -> Open Medule Settings -> Select your module -> Dependencies -> Add Jar file et vous avez terminé.

J'espère que cela vous aidera .

Pankaj Lilan
la source
3
n'ajoutez jamais une dépendance comme celle-ci, utilisez maven / gradle pour télécharger la dépendance et ajoutez-la au chemin de génération
Daniel Bo
4

Je recommande également d'utiliser l'outil SerializationUtils. Je veux faire un ajustement sur un mauvais commentaire de @Abilash. La SerializationUtils.serialize()méthode n'est pas limitée à 1024 octets, contrairement à une autre réponse ici.

public static byte[] serialize(Object object) {
    if (object == null) {
        return null;
    }
    ByteArrayOutputStream baos = new ByteArrayOutputStream(1024);
    try {
        ObjectOutputStream oos = new ObjectOutputStream(baos);
        oos.writeObject(object);
        oos.flush();
    }
    catch (IOException ex) {
        throw new IllegalArgumentException("Failed to serialize object of type: " + object.getClass(), ex);
    }
    return baos.toByteArray();
}

À première vue, vous pouvez penser que new ByteArrayOutputStream(1024)cela ne permettra qu'une taille fixe. Mais si vous regardez attentivement le ByteArrayOutputStream, vous comprendrez que le flux augmentera si nécessaire:

Cette classe implémente un flux de sortie dans lequel les données sont écrites dans un tableau d'octets. Le tampon augmente automatiquement à mesure que les données y sont écrites. Les données peuvent être récupérées à l'aide de toByteArray()et toString().

gzg_55
la source
pouvez-vous ajouter comment faire l'inverse? alors octet [] pour objecter? Je sais que d'autres l'ont, mais j'aime beaucoup plus votre réponse et je n'arrive pas à faire fonctionner la désérialisation. Je veux éviter de retourner null dans tous les cas.
Tobias Kolb
1

Je voudrais le transmettre sous forme d'octet [] sur des sockets à une autre machine

// When you connect
ObjectOutputStream oos = new ObjectOutputStream(socket.getOutputStream());
// When you want to send it
oos.writeObject(appMessage);

où il est reconstruit à partir des octets reçus.

// When you connect
ObjectInputStream ois = new ObjectInputStream(socket.getInputStream());
// When you want to receive it
AppMessage appMessage = (AppMessage)ois.readObject();
Marquis de Lorne
la source
1

Une autre méthode intéressante est de com.fasterxml.jackson.databind.ObjectMapper

byte[] data = new ObjectMapper().writeValueAsBytes(JAVA_OBJECT_HERE)

Dépendance Maven

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
</dependency>
Asad Shakeel
la source
1

Cadre Spring org.springframework.util.SerializationUtils

byte[] data = SerializationUtils.serialize(obj);
xxg
la source
1

Si vous utilisez un ressort, une classe util est disponible dans le noyau de ressort. Vous pouvez simplement faire

import org.springframework.util.SerializationUtils;

byte[] bytes = SerializationUtils.serialize(anyObject);
Object object = SerializationUtils.deserialize(bytes);
Supun Wijerathne
la source
0

exemple de code avec java 8+:

public class Person implements Serializable {

private String lastName;
private String firstName;

public Person() {
}

public Person(String firstName, String lastName) {
    this.firstName = firstName;
    this.lastName = lastName;
}

public void setFirstName(String firstName) {
    this.firstName = firstName;
}

public String getFirstName() {
    return firstName;
}

public String getLastName() {
    return lastName;
}

public void setLastName(String lastName) {
    this.lastName = lastName;
}

@Override
public String toString() {
    return "firstName: " + firstName + ", lastName: " + lastName;
}
}


public interface PersonMarshaller {
default Person fromStream(InputStream inputStream) {
    try (ObjectInputStream objectInputStream = new ObjectInputStream(inputStream)) {
        Person person= (Person) objectInputStream.readObject();
        return person;
    } catch (IOException | ClassNotFoundException e) {
        System.err.println(e.getMessage());
        return null;
    }
}

default OutputStream toStream(Person person) {
    try (OutputStream outputStream = new ByteArrayOutputStream()) {
        ObjectOutput objectOutput = new ObjectOutputStream(outputStream);
        objectOutput.writeObject(person);
        objectOutput.flush();
        return outputStream;
    } catch (IOException e) {
        System.err.println(e.getMessage());
        return null;
    }

}

}
Mohamed.Abdo
la source
0

Dans le cas où vous voulez une belle solution de copier-coller sans dépendances. Prenez le code ci-dessous.

Exemple

MyObject myObject = ...

byte[] bytes = SerializeUtils.serialize(myObject);
myObject = SerializeUtils.deserialize(bytes);

La source

import java.io.*;

public class SerializeUtils {

    public static byte[] serialize(Serializable value) throws IOException {
        ByteArrayOutputStream out = new ByteArrayOutputStream();

        try(ObjectOutputStream outputStream = new ObjectOutputStream(out)) {
            outputStream.writeObject(value);
        }

        return out.toByteArray();
    }

    public static <T extends Serializable> T deserialize(byte[] data) throws IOException, ClassNotFoundException {
        try(ByteArrayInputStream bis = new ByteArrayInputStream(data)) {
            //noinspection unchecked
            return (T) new ObjectInputStream(bis).readObject();
        }
    }
}
Ilya Gazman
la source
0

Ceci est juste une forme de code optimisée de la réponse acceptée au cas où quelqu'un voudrait l'utiliser en production:

    public static void byteArrayOps() throws IOException, ClassNotFoundException{

    String str="123";
     byte[] yourBytes = null;

    // Convert to byte[]

    try(ByteArrayOutputStream bos = new ByteArrayOutputStream();
            ObjectOutputStream out =  new ObjectOutputStream(bos);) {


      out.writeObject(str);
      out.flush();
      yourBytes = bos.toByteArray();

    } finally {

    }

    // convert back to Object

    try(ByteArrayInputStream bis = new ByteArrayInputStream(yourBytes);
            ObjectInput in = new ObjectInputStream(bis);) {

      Object o = in.readObject(); 

    } finally {

    }




}
Nishant_Singh
la source