Serializable里serialversionuid有点意思呀

冷不防 2023-10-10 16:53 2阅读 0赞

#### serialversionuid的作用 ####

`serialVersionUID`是Java中用于序列化和反序列化对象的机制中的一个重要属性。它是一个长整型的常量，用于标识一个特定版本的类，确保在不同的JVM实例之间，序列化和反序列化的过程中能够正确地识别和匹配类的版本。

当一个实现了Serializable接口的类被序列化时，Java会自动生成一个`serialVersionUID`。如果不手动指定`serialVersionUID`，则根据类的内部细节自动生成，但是一旦类的内部细节发生变化，`serialVersionUID`的值也会随之改变，这会导致反序列化失败。为了避免这种情况，可以手动指定一个`serialVersionUID`，并且在类的内部细节发生变化时，手动修改该值。

因此，`serialVersionUID`的作用是确保序列化和反序列化的正确性，即使类的内部细节发生变化，也能够正确地识别和匹配类的版本，避免出现反序列化失败的情况。

多个类的serialVersionUID可以相同吗

不同类的`serialVersionUID`可以相同，但是同一个类在不同版本中的`serialVersionUID`必须不同。

在Java中，`serialVersionUID`是一个长整型的常量，用于标识一个特定版本的类。因此，同一个类在不同版本中的`serialVersionUID`必须不同，否则在反序列化时可能会导致版本不匹配的问题。然而，不同的类可以共享相同的`serialVersionUID`，因为这个值只是用于标识类的版本，而不是用于标识具体的类。

需要注意的是，如果两个类的`serialVersionUID`相同，但是它们的实现并不兼容（比如字段数量或类型不同），则在反序列化时也会出现问题。因此，即使`serialVersionUID`相同，也不能保证两个类可以相互转换。

serialVersionUID 如何手动生成

在Java中，`serialVersionUID`是一个长整型的常量，可以手动生成。手动生成`serialVersionUID`的步骤如下：

1.  手动添加一个名为`serialVersionUID`的静态变量到实现了`Serializable`接口的类中。
2.  给`serialVersionUID`赋一个长整型的值，比如`private static final long serialVersionUID = 123456789L`。
3.  如果该类的内部结构发生了变化，比如新增或删除了字段、修改了字段的类型等，就需要更新`serialVersionUID`的值，确保新版本的类与旧版本的类可以正确地进行序列化和反序列化操作。

需要注意的是，手动生成`serialVersionUID`要保证其唯一性。如果手动生成的`serialVersionUID`与其他类的`serialVersionUID`相同，可能会导致序列化和反序列化失败。因此，建议使用工具类来生成`serialVersionUID`，比如`serialver`命令或IDE中的相应工具。

#### 如何利用IDEa自动生成serialVersionUID ####

在 IntelliJ IDEA 中，可以使用内置的“Generate Serial Version UID”功能来自动生成 `serialVersionUID`。以下是使用该功能的步骤：

1.  打开需要生成 `serialVersionUID` 的类。
2.  在编辑器的右键菜单中，选择“Generate” -> “Serial Version UID”。
3.  在弹出的对话框中，可以选择要使用的算法类型、固定值和版本控制等选项。也可以使用默认选项，直接点击“OK”按钮。
4.  IDEA 将自动在类中生成一个 `private static final long serialVersionUID` 常量，并赋予一个唯一的值。

需要注意的是，自动生成的 `serialVersionUID` 只有在类的内部结构没有改变的情况下才能保证其唯一性。如果类的内部结构发生了改变，建议手动修改 `serialVersionUID` 的值。

#### 为什么必须手动指定serialVersionUID ####

在Java中，当一个类实现了`Serializable`接口并需要进行序列化和反序列化操作时，Java会自动生成一个默认的`serialVersionUID`。但是，由于默认的`serialVersionUID`是基于类的内部结构自动生成的，因此当类的内部结构发生改变时，`serialVersionUID`的值也会发生变化。这就会导致序列化和反序列化操作时版本不匹配的问题，从而无法正确地反序列化对象。

为了避免这个问题，可以手动指定一个稳定的`serialVersionUID`。手动指定`serialVersionUID`可以确保在类的内部结构发生变化时，`serialVersionUID`的值不会改变，从而保证对象的序列化和反序列化操作的正确性。

此外，手动指定`serialVersionUID`还可以提高代码的可维护性和可读性。通过手动指定`serialVersionUID`，可以清楚地看到代码中哪些类是需要进行序列化和反序列化操作的，从而更方便地对代码进行维护和修改。

总之，手动指定`serialVersionUID`是一个良好的编程实践，可以提高代码的可靠性、可维护性和可读性。

#### 每次类的属性发生改变都必须重新指定 serialVersionUID吗 ####

是的，每当类的属性发生变化时，都建议重新指定 `serialVersionUID`，以确保序列化和反序列化操作的正确性。当类的属性发生变化时，`serialVersionUID` 的值也会发生变化，因此如果不更新 `serialVersionUID`，可能会导致版本不匹配的问题。

需要注意的是，即使类的属性发生变化，如果变化并不会影响序列化和反序列化操作，也就是说，变化后的类的结构与旧版本的类的结构兼容，那么可以不更新 `serialVersionUID`。但是，在实践中很难完全确定哪些变化会影响序列化和反序列化操作，因此建议每次类的属性发生变化时都更新 `serialVersionUID`。

在一些特殊的情况下，比如一些内部使用的类或数据传输协议已经稳定的情况下，可以通过指定固定的 `serialVersionUID` 来避免每次都需要更新的问题。但是，在大多数情况下，建议每次类的属性发生变化时都重新指定 `serialVersionUID`。

#### 举一个不更新 serialVersionUID , 序列化失败的例子 ####

以下是一个简单的例子，演示了如果不更新 `serialVersionUID` 可能会导致序列化和反序列化操作失败的情况：

先将改动前的类序列化到文件中

类改变了之后

再从文件中反序列化回来

import java.io.*;
    
    class SerializationExample {
        
        private static final String FILE_NAME = "E:\\java\\java-base\\person.ser";
    
        public static void main(String[] args) throws IOException, ClassNotFoundException {
        
            // 修改 Person 类的定义，新增一个属性
            // 如果不更新 serialVersionUID，反序列化时会失败
            class Person implements Serializable {
        
                private String name;
                private int age;
                private String address;
    
                public Person(String name, int age, String address) {
        
                    this.name = name;
                    this.age = age;
                    this.address = address;
                }
    
                public String getName() {
        
                    return name;
                }
    
                public int getAge() {
        
                    return age;
                }
    
                public String getAddress() {
        
                    return address;
                }
            }
    
            // 从文件中反序列化 Person 对象
            // 由于修改了 Person 类的定义，但是没有更新 serialVersionUID，
            // 反序列化时会抛出 InvalidClassException 异常，导致反序列化失败
            ObjectInputStream objectInputStream = new ObjectInputStream(new FileInputStream(FILE_NAME));
            Person deserializedPerson = (Person) objectInputStream.readObject();
            System.out.println(deserializedPerson.getName() + ", " + deserializedPerson.getAge() + ", " + deserializedPerson.getAddress());
            objectInputStream.close();
        }
    }

D:\app\code\java\jdk\bin\java.exe "-javaagent:D:\app\code\idea\202203\IntelliJ IDEA Community Edition 2022.3.3\lib\idea_rt.jar=10746:D:\app\code\idea\202203\IntelliJ IDEA Community Edition 2022.3.3\bin" -Dfile.encoding=UTF-8 -classpath C:\Users\hong\AppData\Local\Temp\classpath792671612.jar SerializationExample
    Exception in thread "main" java.io.InvalidClassException: SerializationExample$1Person; local class incompatible: stream classdesc serialVersionUID = 6949151319318117359, local class serialVersionUID = 1216303917685852109
    	at java.io.ObjectStreamClass.initNonProxy(ObjectStreamClass.java:699)
    	at java.io.ObjectInputStream.readNonProxyDesc(ObjectInputStream.java:1885)
    	at java.io.ObjectInputStream.readClassDesc(ObjectInputStream.java:1751)
    	at java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:2042)
    	at java.io.ObjectInputStream.readObject0(ObjectInputStream.java:1573)
    	at java.io.ObjectInputStream.readObject(ObjectInputStream.java:431)
    	at SerializationExample.main(scratch_3.java:37)
    
    Process finished with exit code 1

在上面的代码中，首先创建了一个 `Person` 对象，并将其序列化为字节数组。然后，修改了 `Person` 类的定义，新增了一个属性 `address`。由于 `Person` 类的结构发生了变化，而在序列化时使用的 `serialVersionUID` 值没有更新，所以在反序列化时会抛出 `InvalidClassException` 异常，导致反序列化失败。

因此，为了避免这种情况，建议每当类的结构发生变化时，都要更新 `serialVersionUID` 的值。

自己有填写 serialVersionUID 的情况下, 就算字段改变, 不改变serialVersionUID, 甚至构造器换了也没问题

import java.io.*;
    
    import java.io.*;
    
    class SerializationExample {
        
        private static final String FILE_NAME = "E:\\java\\java-base\\person.ser";
        // 定义一个类，实现了 Serializable 接口
        static class Person implements Serializable {
        
            private static final long serialVersionUID = 9001383854419957096L;
            private String name;
            private int age;
            
    
    
            public Person(String name, int age) {
        
                this.name = name;
                this.age = age;
            }
    
            public String getName() {
        
                return name;
            }
    
            public int getAge() {
        
                return age;
            }
        }
    
        public static void main(String[] args) throws IOException, ClassNotFoundException {
        
            // 创建一个 Person 对象，并将其序列化到文件中
            Person person = new Person("Alice", 30);
            ObjectOutputStream objectOutputStream = new ObjectOutputStream(new FileOutputStream(FILE_NAME));
            objectOutputStream.writeObject(person);
            objectOutputStream.close();
        }
    }

package cn.gd.cz.hong.springbootredisdemo.database;
    
    import java.io.*;
    
    import java.io.*;
    
    class SerializationExample {
        
        private static final String FILE_NAME = "E:\\java\\java-base\\person.ser";
    
        static class Person implements Serializable {
        
            private static final long serialVersionUID = 9001383854419957096L;
            private String name;
            private int age;
            private String address;
    
    
    
            public Person(String name, int age, String address) {
        
                this.name = name;
                this.age = age;
                this.address = address;
            }
    
            public String getName() {
        
                return name;
            }
    
            public int getAge() {
        
                return age;
            }
    
            public String getAddress() {
        
                return address;
            }
        }
    
        public static void main(String[] args) throws IOException, ClassNotFoundException {
        
            // 从文件中反序列化 Person 对象
            // 由于修改了 Person 类的定义，但是没有更新 serialVersionUID，
            // 反序列化时会抛出 InvalidClassException 异常，导致反序列化失败
            ObjectInputStream objectInputStream = new ObjectInputStream(new FileInputStream(FILE_NAME));
            Person deserializedPerson = (Person) objectInputStream.readObject();
            System.out.println(deserializedPerson.getName() + ", " + deserializedPerson.getAge() + ", " + deserializedPerson.getAddress());
            objectInputStream.close();
        }
    }

Alice, 30, null