web-dev-qa-db-fra.com

Comment faire une copie complète d'un objet en Java?

En Java, il est un peu difficile d'implémenter une fonction de copie d'objet profonde. Quelles mesures prenez-vous pour vous assurer que l'objet d'origine et l'objet cloné ne partagent aucune référence?

277
Andrei Savu

Un moyen sûr consiste à sérialiser l'objet, puis à le désérialiser. Cela garantit que tout est une toute nouvelle référence.

Voici un article sur la façon de le faire efficacement.

Mises en garde: il est possible que les classes écrasent la sérialisation de sorte que les nouvelles instances ne soient pas créées , par exemple. pour les singletons. De plus, cela ne fonctionne bien sûr pas si vos classes ne sont pas sérialisables.

161
Jason Cohen

Quelques personnes ont mentionné utiliser ou remplacer Object.clone(). Ne le fais pas. Object.clone() présente des problèmes majeurs et son utilisation est déconseillée dans la plupart des cas. Veuillez vous reporter au point 11 de " Effective Java " de Joshua Bloch pour obtenir une réponse complète. Je crois que vous pouvez utiliser en toute sécurité Object.clone() sur des tableaux de type primitif, mais à part cela, vous devez faire preuve de discernement pour utiliser correctement et remplacer le clone.

Les schémas qui reposent sur la sérialisation (XML ou autre) sont kludgy.

Il n'y a pas de réponse facile ici. Si vous souhaitez copier en profondeur un objet, vous devez parcourir le graphe d'objet et copier explicitement chaque objet enfant via le constructeur de copie de l'objet ou une méthode de fabrique statique qui à son tour copie en profondeur l'objet enfant. Les immutables (par exemple, Strings) n'ont pas besoin d'être copiés. En passant, vous devriez favoriser l'immuabilité pour cette raison.

67
Julien Chastang

Vous pouvez effectuer une copie complète avec la sérialisation sans créer de fichiers.

Votre objet que vous souhaitez copier en profondeur devra avoir implement serializable. Si la classe n'est pas finale ou ne peut pas être modifiée, développez-la et implémentez-la sérialisable.

Convertissez votre classe en un flux d'octets:

ByteArrayOutputStream bos = new ByteArrayOutputStream();
ObjectOutputStream oos = new ObjectOutputStream(bos);
oos.writeObject(object);
oos.flush();
oos.close();
bos.close();
byte[] byteData = bos.toByteArray();

Restaurez votre classe à partir d'un flux d'octets:

ByteArrayInputStream bais = new ByteArrayInputStream(byteData);
(Object) object = (Object) new ObjectInputStream(bais).readObject();
54
Thargor

Vous pouvez créer un clone profond basé sur la sérialisation en utilisant org.Apache.commons.lang3.SerializationUtils.clone(T) dans Apache Commons Lang, mais soyez prudent, les performances sont catastrophiques.

En règle générale, il est recommandé d'écrire vos propres méthodes de clonage pour chaque classe d'un objet du graphe nécessitant un clonage.

37
user8690

Une façon d'implémenter la copie approfondie consiste à ajouter des constructeurs de copie à chaque classe associée. Un constructeur de copie prend une instance de 'this' comme argument unique et en copie toutes les valeurs. Un peu de travail, mais assez simple et sûr.

EDIT: notez qu'il n'est pas nécessaire d'utiliser des méthodes d'accès pour lire des champs. Vous pouvez accéder directement à tous les champs car l'instance source est toujours du même type que l'instance avec le constructeur de copie. Évident mais peut être négligé.

Exemple:

public class Order {

    private long number;

    public Order() {
    }

    /**
     * Copy constructor
     */
    public Order(Order source) {
        number = source.number;
    }
}


public class Customer {

    private String name;
    private List<Order> orders = new ArrayList<Order>();

    public Customer() {
    }

    /**
     * Copy constructor
     */
    public Customer(Customer source) {
        name = source.name;
        for (Order sourceOrder : source.orders) {
            orders.add(new Order(sourceOrder));
        }
    }

    public String getName() {
        return name;
    }

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

Edit: notez que lorsque vous utilisez des constructeurs de copie, vous devez connaître le type d’exécution de l’objet que vous copiez. Avec l'approche ci-dessus, vous ne pouvez pas facilement copier une liste mélangée (vous pourrez peut-être le faire avec un code de réflexion).

23
Adriaan Koster

Apache commons offre un moyen rapide de cloner en profondeur un objet.

My_Object object2= org.Apache.commons.lang.SerializationUtils.clone(object1);
19
TheByeByeMan

Vous pouvez tiliser une bibliothèque avec une API simple et un clonage relativement rapide avec réflexion (devrait être plus rapide que les méthodes de sérialisation).

Cloner cloner = new Cloner();

MyClass clone = cloner.deepClone(o);
// clone is a deep-clone of o
18
CorayThan

XStream est vraiment utile dans de tels cas. Voici un code simple pour faire du clonage

private static final XStream XSTREAM = new XStream();
...

Object newObject = XSTREAM.fromXML(XSTREAM.toXML(obj));
11
sankara

Une approche très simple consiste à utiliser Jackson JSON pour sérialiser un objet Java complexe en JSON et le relire.

http://wiki.fasterxml.com/JacksonInFiveMinutes

9
Ravi Chinoy

Pour Spring Framework utilisateurs. Utilisation de la classe org.springframework.util.SerializationUtils:

@SuppressWarnings("unchecked")
public static <T extends Serializable> T clone(T object) {
     return (T) SerializationUtils.deserialize(SerializationUtils.serialize(object));
}
8
Igor Rybak

Utilisez XStream ( http://x-stream.github.io/ ). Vous pouvez même contrôler les propriétés que vous pouvez ignorer par le biais d'annotations ou en spécifiant explicitement le nom de la propriété dans la classe XStream. De plus, vous n'avez pas besoin d'implémenter une interface clonable.

8
Adi

Pour les objets compliqués et lorsque les performances ne sont pas significatives, j'utilise une bibliothèque json, telle que gson pour sérialiser l'objet en texte json, puis désérialiser le texte pour obtenir un nouvel objet.

gson qui basé sur la réflexion fonctionnera dans la plupart des cas, sauf que les champs transient ne seront pas copiés et les objets avec une référence circulaire avec la cause StackOverflowError.

public static <T> T copy(T anObject, Class<T> classInfo) {
    Gson gson = new GsonBuilder().create();
    String text = gson.toJson(anObject);
    T newObject = gson.fromJson(text, classInfo);
    return newObject;
}
public static void main(String[] args) {
    String originalObject = "hello";
    String copiedObject = copy(originalObject, String.class);
}
7
tiboo

Une copie en profondeur ne peut être effectuée qu'avec le consentement de chaque classe. Si vous avez le contrôle sur la hiérarchie des classes, vous pouvez implémenter l'interface clonable et la méthode Clone. Sinon, il est impossible d'effectuer une copie en profondeur en toute sécurité, car l'objet peut également partager des ressources autres que des données (connexions à une base de données, par exemple). En général, toutefois, la copie en profondeur est considérée comme une mauvaise pratique dans l'environnement Java et doit être évitée par le biais des pratiques de conception appropriées.

7
Orion Adrian
import com.thoughtworks.xstream.XStream;

public class deepCopy {
    private static  XStream xstream = new XStream();

    //serialize with Xstream them deserialize ...
    public static Object deepCopy(Object obj){
        return xstream.fromXML(xstream.toXML(obj));
    }
}
6
user946968

J'ai utilisé Dozer pour le clonage des objets Java et c'est formidable, la bibliothèque Kryo est une autre excellente alternative.

4
supernova

1)

public static Object deepClone(Object object) {
   try {
     ByteArrayOutputStream baos = new ByteArrayOutputStream();
     ObjectOutputStream oos = new ObjectOutputStream(baos);
     oos.writeObject(object);
     ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
     ObjectInputStream ois = new ObjectInputStream(bais);
     return ois.readObject();
   }
   catch (Exception e) {
     e.printStackTrace();
     return null;
   }
 }

2)

    // (1) create a MyPerson object named Al
    MyAddress address = new MyAddress("Vishrantwadi ", "Pune", "India");
    MyPerson al = new MyPerson("Al", "Arun", address);

    // (2) make a deep clone of Al
    MyPerson neighbor = (MyPerson)deepClone(al);

Ici, vos classes MyPerson et MyAddress doivent implémenter une interface sérialisable.

2
Arun

BeanUtils fait un très bon travail de clonage en profondeur des haricots.

BeanUtils.cloneBean(obj);
1
Alfergon