Java Entity实体中serialVersionUID的作用

探讨序列化接口的作用,序列化与反序列化过程,及serialVersionUID在类版本控制中的重要性。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

在实际项目开发中,肯定在实体类中见到过serialVersionUID所声明的常量,有没有想过这个serialVersionUID有什么作用呢?

一、实现Serializable接口的作用

类实现Serializable接口的目的是为了对象可持久化,比如网络传输或本地存储,为系统的分布和异构部署提供先决条件支持。若没有序列化,现在熟悉的远程调用、对象数据库都不可能存在;

二、序列化与反序列化代码示例

  • 首先通过一个简单的代码示例JavaBean实现Serializable接口;
import java.io.Serializable;
public class Person implements Serializable {
    private String name;

	private Integer age;

   //setter/getter省略...
}
  • 定义一个消息生产者类(Producer)将Person类序列化到本地存储/读取:
public class Producer {
    public static void main(String[] args) {
        Person p = new Person();
        p.setName("张三");
        p.setAge(21);
        // 序列化,保存到磁盘上
        SerializationUtils.writeObject(p);
    }
}
  • 工具类SerializationUtils对一个类进行序列化和反序列化,并存储到硬盘上(模拟网络传输),代码如下:
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;

public class SerializationUtils {
    private static String FILE_NAME = "d:/obj.bin";
    //序列化
    public static void writeObject(Serializable s) {
        try {
            ObjectOutputStream oos = new ObjectOutputStream(new FileOutputStream(FILE_NAME));
            oos.writeObject(s);
            oos.close();
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    //反序列化
    public static Object readObject() {
        Object obj = null;
        try {
            ObjectInputStream input = new ObjectInputStream(new FileInputStream(FILE_NAME));
            obj=input.readObject();
            input.close();
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
        return obj;
    }
}
  • 序列化存储操作后,在d盘可以看到序列化后的文件:
    在这里插入图片描述
  • 定义一个消息消费者类(Producer)将磁盘上的文件反序列化后获取数据:
public class Customer {
    public static void main(String[] args) {
        //反序列化
        Person p=(Person) SerializationUtils.readObject();
        System.out.println(p.getName());
    }
}
  • 这是一个反序列化的过程,也就是对象数据流转换为一个实例的过程,其运行后的输出结果为 “张三,21”,这就是序列化和反序列化的示例:
    在这里插入图片描述
  • 思考一个问题,如果消息生产者消息消费者(Person类)的中成员变量属性有差异,比如:在分布式部署应用中,一个应用中的消息生产者中的Person类添加一个性别属性,而另一个应用中的消费者没有增加性别属性。消息发送通过中间件广播方式发消息的情况,漏掉一两个订阅者也是很正常的。在这种情况下会发生什么?

三、生产者与消费者中实体属性不一致

1.不声明serializableUID,生产者成员变量(有sex变量)>消费者成员变量(无sex变量)

  • 生产者Person类::
public class Person implements Serializable {
    private String name;

    private Integer age;

    private String sex;

   //setter/getter省略...
}
  • 生产者代码:
public class Producer {
    public static void main(String[] args) {
        Person p = new Person();
        p.setName("张三");
        p.setAge(21);
        p.setSex("男");
        // 序列化,保存到磁盘上
        SerializationUtils.writeObject(p);
    }
}
  • 消费者Person类:
public class Person implements Serializable {
	private String name;

    private Integer age;

   //setter/getter省略...
 }
  • 消费者代码:
public class Customer {
    public static void main(String[] args) {
        //反序列化
        Person p = (Person) SerializationUtils.readObject();
        System.out.println(p.getName() + " , " + p.getAge());
    }
}
  • 结果报了一个InalidClassException异常,原因是序列化和反序列化所对应的类版本发生了变化,JVM不能把数据流转换为实例对象:
    在这里插入图片描述
  • JVM是根据SerializableUID来判断一个类的版本,SerializableUID也叫做流标识符(Stream Unique Identifier),即类的版本定义的,它可以显示声明也可以隐式声明
    1. 隐示声明:编译器在编译的时候生成。生成依据通过包名、类名、继承关系、非私有的方法和属性,以及参数、返回值等诸多因子算出来的,极度复杂,基本上计算出来的这个值是唯一的。
    2. 显示声明格式如下(可以避免对象的不一致导致反序列化报错):
private static final long serialVersionUID = 7111078431122519129L; 
  • serialVersionUID的作用:JVM在反序列化时,会比较数据流中的serialVersionUID与消费者类的serialVersionUID是否相同,如果相同,则认为类没有改变,反序列化成功;如果不相同,JVM就会抛出InviladClassException异常。这是一个非常好的校验机制,可以保证一个对象即使在网络或磁盘中“滚过”一次,仍能做到“出淤泥而不染”,完美的实现了类的一致性。
  • 但是,有时候我们需要一点特例场景,例如我的类改变不大,JVM是否可以把以前的对象反序列化回来?就是依据显示声明的serialVersionUID,向JVM撒谎说"类版本没有变化",如此编写的类就实现了向上兼容

2.声明serializableUID,生产者成员变量(有sex变量)>消费者成员变量(无sex变量)

修改一下示例代码,在生产者消费者的Person类中同时添加private static final long serialVersionUID = 7111078431122519129L;

  • 生产者Person类 :
public class Person implements Serializable {
	//添加serialVersionUID 
    private static final long serialVersionUID = 7111078431122519129L;

    private String name;

    private Integer age;

    private String sex;

	//setter/getter省略...
 }   
  • 生产代码:
public class Producer {
    public static void main(String[] args) {
        Person p = new Person();
        p.setName("张三");
        p.setAge(21);
        p.setSex("男");
        // 序列化,保存到磁盘上
        SerializationUtils.writeObject(p);
    }
}
  • 消费者Person类:
public class Person implements Serializable {
	//添加serialVersionUID 
    private static final long serialVersionUID = 7111078431122519129L;

    private String name;

    private Integer age;

	//setter/getter省略...
 }   
  • 消费者代码:
public class Customer {
    public static void main(String[] args) {
        //反序列化
        Person p = (Person) SerializationUtils.readObject();
        System.out.println(p.getName() + " , " + p.getAge());
    }
}
  • 看消费者运行结果(这里的生产者Person中sex属性,消费者Person中没有sex属性):
    在这里插入图片描述

3.声明serializableUID,生产者成员变量(无age变量、sex变量)<消费者成员变量(有age变量、sex变量)

一起来看看,当生产者成员变量(无age变量、sex变量)<消费者成员变量(有age变量、sex变量)时,会出现什么情况:

  • 生产者Person类:
public class Person implements Serializable {
    private static final long serialVersionUID = 7111078431122519129L;

    private String name;
    
//setter/getter省略...
}
  • 生产者代码:
public class Producer {
    public static void main(String[] args) {
        Person p = new Person();
        p.setName("张三");
        // 序列化,保存到磁盘上
        SerializationUtils.writeObject(p);
    }
}
  • 消费者Person类:
public class Person implements Serializable {
    private static final long serialVersionUID = 7111078431122519129L;

    private String name;

    private Integer age;

    private String sex;
    
//setter/getter省略...
  • 消费者代码:
public class Customer {
    public static void main(String[] args) {
        //反序列化
        Person p = (Person) SerializationUtils.readObject();
        System.out.println(p.getName() + " , " + p.getAge()+ " , " +p.getSex());
    }
}
  • 反序列化操作成功,运行结果,age变量和sex变量在消费者端反序列化后被自动赋值为null
    在这里插入图片描述
  • 从示例2、示例3结果可以看出,声明了serialVersionUID后,消费者程序并没有在抛出InalidClassException异常,而是可以正常完成反序列化操作,只是没有接收到sex属性值或自动填充不存在的值。刚开始生产者和消费者持有的Person类一致,都是V1.0,某天生产者的Person类变更了,增加了一个“性别”属性,升级为V2.0,由于种种原因(比如程序员疏忽,升级时间窗口不同等)消费端的Person类还是V1.0版本,添加的代码为 priavte String sex;以及对应的setter和getter方法。此时虽然生产者和消费者对应的类版本不同,但是显示声明的serialVersionUID相同,这时的反序列化是可运行的!!! 所带来的业务问题就是消费端不能读取到新增的业务属性(sex属性而已)。通过此例,反序列化也实现了版本向上兼容的功能,使用V1.0版本的应用访问了一个V2.0的对象,这无疑提高了代码的健壮性。所以在编写序列化类代码时随手添加一个serialVersionUID字段,也不会带来太多的工作量,但它却可以在关键时候发挥异乎寻常的作用。
生成 Java 实体类,需要获取数据库表的字段名、字段类型、字段注释等信息,然后根据这些信息生成对应的 Java 实体类。下面是一个简单的 Java 实体类生成器的示例代码,可以通过 JDBC 获取数据库表信息,然后生成对应的 Java 实体类: ```java import java.sql.*; import java.util.*; public class EntityGenerator { // 数据库连接信息 private static final String DB_URL = "jdbc:mysql://localhost:3306/test"; private static final String DB_USER = "root"; private static final String DB_PASS = "123456"; // Java 包名 private static final String PACKAGE_NAME = "com.example.entity"; // Java 实体类生成路径 private static final String CLASS_PATH = "src/main/java/com/example/entity/"; public static void main(String[] args) { Connection conn = null; try { // 获取数据库连接 conn = DriverManager.getConnection(DB_URL, DB_USER, DB_PASS); // 获取表字段信息 List<ColumnInfo> columnInfos = getColumnInfos(conn, "user"); // 生成 Java 实体类 generateEntityClass("User", columnInfos); } catch (SQLException e) { e.printStackTrace(); } finally { // 关闭数据库连接 if (conn != null) { try { conn.close(); } catch (SQLException e) { e.printStackTrace(); } } } } /** * 获取数据库表字段信息 * @param conn 数据库连接 * @param tableName 表名 * @return 字段信息列表 */ private static List<ColumnInfo> getColumnInfos(Connection conn, String tableName) throws SQLException { List<ColumnInfo> columnInfos = new ArrayList<>(); // 获取表字段信息的 SQL String sql = String.format("SELECT COLUMN_NAME, DATA_TYPE, COLUMN_COMMENT FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='%s' AND TABLE_NAME='%s'", conn.getCatalog(), tableName); Statement stmt = conn.createStatement(); ResultSet rs = stmt.executeQuery(sql); // 遍历结果集,获取字段信息 while (rs.next()) { String columnName = rs.getString("COLUMN_NAME"); String dataType = rs.getString("DATA_TYPE"); String columnComment = rs.getString("COLUMN_COMMENT"); columnInfos.add(new ColumnInfo(columnName, dataType, columnComment)); } return columnInfos; } /** * 生成 Java 实体类 * @param className 类名 * @param columnInfos 字段信息列表 */ private static void generateEntityClass(String className, List<ColumnInfo> columnInfos) { StringBuilder sb = new StringBuilder(); // 生成包名和导入类 sb.append(String.format("package %s;%n%n", PACKAGE_NAME)); sb.append("import java.io.Serializable;\n\n"); // 生成类声明和实现 Serializable 接口 sb.append(String.format("public class %s implements Serializable {\n\n", className)); sb.append(" private static final long serialVersionUID = 1L;\n\n"); // 生成字段声明和 getter/setter 方法 for (ColumnInfo columnInfo : columnInfos) { sb.append(String.format(" /** %s */\n", columnInfo.getColumnComment())); sb.append(String.format(" private %s %s;\n\n", getJavaType(columnInfo.getDataType()), columnInfo.getColumnName())); sb.append(String.format(" public %s get%s() {\n", getJavaType(columnInfo.getDataType()), capitalize(columnInfo.getColumnName()))); sb.append(String.format(" return %s;\n", columnInfo.getColumnName())); sb.append(" }\n\n"); sb.append(String.format(" public void set%s(%s %s) {\n", capitalize(columnInfo.getColumnName()), getJavaType(columnInfo.getDataType()), columnInfo.getColumnName())); sb.append(String.format(" this.%s = %s;\n", columnInfo.getColumnName(), columnInfo.getColumnName())); sb.append(" }\n\n"); } sb.append("}\n"); // 将生成的 Java 代码写入文件 String filePath = CLASS_PATH + className + ".java"; writeToFile(sb.toString(), filePath); } /** * 根据数据库字段类型获取对应的 Java 类型 * @param dataType 数据库字段类型 * @return Java 类型 */ private static String getJavaType(String dataType) { switch (dataType) { case "int": case "tinyint": case "smallint": case "mediumint": case "bigint": return "Long"; case "float": return "Float"; case "double": return "Double"; case "decimal": return "BigDecimal"; case "varchar": case "text": case "longtext": return "String"; case "datetime": case "timestamp": return "Date"; default: return "Object"; } } /** * 将字符串的第一个字符转换为大写字母 * @param str 字符串 * @return 转换后的字符串 */ private static String capitalize(String str) { return str.substring(0, 1).toUpperCase() + str.substring(1); } /** * 将字符串写入文件 * @param content 字符串内容 * @param filePath 文件路径 */ private static void writeToFile(String content, String filePath) { try { Files.write(Paths.get(filePath), content.getBytes()); } catch (IOException e) { e.printStackTrace(); } } /** * 数据库字段信息类 */ private static class ColumnInfo { private String columnName; // 字段名 private String dataType; // 字段类型 private String columnComment; // 字段注释 public ColumnInfo(String columnName, String dataType, String columnComment) { this.columnName = columnName; this.dataType = dataType; this.columnComment = columnComment; } public String getColumnName() { return columnName; } public String getDataType() { return dataType; } public String getColumnComment() { return columnComment; } } } ``` 上面的代码会根据数据库中的表名和字段信息,生成对应的 Java 实体类,并将生成的代码写入到指定的文件中。可以根据需要修改 Java 包名、实体类生成路径等参数,以及修改 `getJavaType()` 方法的实现,以适应不同的数据库类型和 Java 类型。
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

zhuzicc

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值