[Java] Java 关键字 : transient

0 序

Java中的transient关键字，transient是短暂的意思。对于transient修饰的成员变量，在类的实例对象的序列化处理过程中会被忽略。
因此，transient变量不会贯穿对象的序列化和反序列化，生命周期仅存于调用者的内存中而不会写到磁盘里进行持久化。

1 序列化

Java中对象的序列化: 指的是将对象转换成以字节序列的形式来表示。这些字节序列包含了对象的数据和信息，一个序列化后的对象可以被写到数据库或文件中，也可用于网络传输。

一般地，当我们使用缓存cache（内存空间不够有可能会本地存储到硬盘）或远程调用rpc（网络传输）的时候，经常需要让实体类实现Serializable接口，目的就是为了让其可序列化。

当然，序列化后的最终目的是为了反序列化，恢复成原先的Java对象实例。所以序列化后的字节序列都是可以恢复成Java对象的，这个过程就是反序列化。

2 为什么要用transient关键字？

在持久化对象时，对于一些特殊的数据成员（如用户的密码，银行卡号等），我们不想用序列化机制来保存它。为了在一个特定对象的一个成员变量上关闭序列化，可以在这个成员变量前加上关键字transient。

3 transient的作用

作用

transient是Java语言的关键字，用来表示一个成员变量不是该对象序列化的一部分。
当一个对象被序列化的时候，transient型变量的值不包括在序列化的结果中。而非transient型的变量是被包括进去的。

即：一旦变量被transient修饰，变量将不再是对象持久化的一部分，该变量内容在序列化后无法被访问。

transient关键字只能修饰变量，而不能修饰方法和类。

注意，本地变量是不能被transient关键字修饰的。变量如果是用户自定义类变量，则该类需要实现Serializable接口。

一个静态变量不管是否被transient修饰，均不能被序列化

如果反序列化后类中static变量还有值，则值为当前JVM中对应static变量的值。

序列化保存的是对象状态，静态变量保存的是类状态。因此，序列化并不保存静态变量。

典型应用：如果类中使用了Logger实例(private final static Logger logger = ...)，那么Logger实例也是不需要序列化的。
即：static修饰的静态变量天然地就是不可序列化的。

案例：序列化与反序列化

TransientTest

package org.example;

import lombok.extern.slf4j.Slf4j;
import org.example.entity.User;
import org.springframework.util.ObjectUtils;

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;

public class TransientTest {
    public static void main(String[] args) {
        User user = new User();
        user.setUsername("Jack");
        user.setPassword("123456");

        System.out.println("read before serializable :");
        System.out.println("username : " + user.getUsername());//username : Jack
        System.out.println("password : " + user.getPassword());//password : 123456
        System.out.println("toString : " + user.toString());//toString : User{username='Jack', password='123456'}
        //com.alibaba.fastjson2:fastjson2:2.0.37
        System.out.println("JSON.toString : " + JSON.toJSONString(user));//JSON.toString : {"username":"Jack"}

        //序列化数据
        try {
            ObjectOutputStream objectOutputStream = new ObjectOutputStream(
                new FileOutputStream("E:\\tmp_data\\user.serial-data.txt")
            );
            objectOutputStream.writeObject( user );
            objectOutputStream.flush();
            objectOutputStream.close();
        } catch (Exception exception) {
            System.err.println("Fail to write serial data to file! exception : " + exception);
        }

        //反序列化数据
        try {
            ObjectInputStream objectInputStream = new ObjectInputStream(
                    new FileInputStream("E:\\tmp_data\\user.serial-data.txt")
            );
            user = (User) objectInputStream.readObject();
            objectInputStream.close();
            System.out.println("read after serializable :");
            System.out.println("username : " + user.getUsername());//username : Jack
            System.out.println("password : " + user.getPassword());//password : null
            System.out.println("toString : " + user.toString());//toString : User{username='Jack', password='null'}
            //com.alibaba.fastjson2:fastjson2:2.0.37
            System.out.println("JSON.toString : " + JSON.toJSONString(user));//JSON.toString : {"username":"Jack"}
        } catch (Exception exception) {
            System.err.println("Fail to read serial data from file! exception : " + exception);
        }
    }
}

User

package org.example.entity;

import java.io.Serializable;

/**
 * @note 实体类不实现`Serializable`接口的风险：
 *  0. JSON.toJSONString(user) : 不受影响 | com.alibaba.fastjson2:fastjson2:2.0.37
 *  1. 序列化时报错(以序列化对象到文件为例) : Fail to write serial data to file! exception : java.io.NotSerializableException: org.example.entity.User
 *  2. 反序列化时报错(序列化文件数据为例) : Fail to read serial data from file! exception : java.io.WriteAbortedException: writing aborted; java.io.NotSerializableException: org.example.entity.User
 */
public class User implements Serializable {
    private static final Long serialVersionUID = 3535352442213124L;

    private String username;
    private transient String password;

    public User() {
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    @Override
    public String toString() {
        return "User{" +
                "username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}