ObjectOutputStream em Java – escrever Objeto em Arquivo

ObjectOutputStream em Java pode ser usado para converter um objeto em OutputStream. O processo de conversão de objeto para fluxo é chamado de serialização em java. Uma vez que um objeto é convertido em Output Stream, ele pode ser salvo em arquivo ou banco de dados, enviado pela rede ou usado em conexões de soquete. Portanto, podemos usar FileOutputStream para escrever Objeto em arquivo.

ObjectOutputStream

ObjectOutputStream faz parte das classes Java IO e seu objetivo principal é fornecer um meio para converter objetos Java em um fluxo. Quando criamos uma instância de ObjectOutputStream, precisamos fornecer o OutputStream a ser usado. Este OutputStream é posteriormente usado pelo ObjectOutputStream para canalizar o fluxo de objeto para o fluxo de saída subjacente, por exemplo, FileOutputStream.

Requisitos do ObjectOutputStream

O objeto que queremos serializar deve implementar a interface java.io.Serializable. Serializable é apenas uma interface marcadora e não tem nenhum método abstrato que precisamos implementar. Obteremos java.io.NotSerializableException se a classe não implementar a interface Serializable. Algo como a pilha de exceção abaixo.

java.io.NotSerializableException: com.journaldev.files.EmployeeObject
	at java.io.ObjectOutputStream.writeObject0(ObjectOutputStream.java:1184)
	at java.io.ObjectOutputStream.writeObject(ObjectOutputStream.java:348)
	at com.journaldev.files.ObjectOutputStreamExample.main(ObjectOutputStreamExample.java:21)

Exemplo de Java ObjectOutputStream para escrever objeto em arquivo

Vamos dar uma olhada em um exemplo de Java ObjectOutputStream para escrever um objeto em um arquivo. Para isso, em primeiro lugar, devemos ter uma classe com algumas propriedades. Vamos criar um objeto que iremos salvar no arquivo.

package com.journaldev.files;

import java.io.Serializable;

public class Employee implements Serializable {

	private static final long serialVersionUID = -299482035708790407L;

	private String name;
	private String gender;
	private int age;

	private String role;
	
// private transient String role;


	public Employee(String n) {
		this.name = n;
	}

	public String getGender() {
		return gender;
	}

	public void setGender(String gender) {
		this.gender = gender;
	}

	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	public String getRole() {
		return role;
	}

	public void setRole(String role) {
		this.role = role;
	}

	@Override
	public String toString() {
		return "Employee:: Name=" + this.name + " Age=" + this.age + " Gender=" + this.gender + " Role=" + this.role;
	}

}

Observe que não é necessário ter getter/setter para todas as propriedades. Ou ter um construtor sem argumentos. Como você pode ver, o objeto Employee acima não possui métodos getter/setter para a propriedade “nome”. Também não possui um construtor sem argumentos. Aqui está o programa mostrando como escrever um objeto em um arquivo em Java usando ObjectOutputStream.

package com.journaldev.files;

import java.io.FileOutputStream;
import java.io.IOException;
import java.io.ObjectOutputStream;

public class ObjectOutputStreamExample {

	public static void main(String[] args) {
		Employee emp = new Employee("Pankaj");

		emp.setAge(35);
		emp.setGender("Male");
		emp.setRole("CEO");
		System.out.println(emp);
		
		try {
			FileOutputStream fos = new FileOutputStream("EmployeeObject.ser");
			ObjectOutputStream oos = new ObjectOutputStream(fos);
			
// escrever objeto no arquivo

			oos.writeObject(emp);
			System.out.println("Done");
			
// fechando recursos
			oos.close();
			fos.close();
		} catch (IOException e) {
			e.printStackTrace();
		}
	}

}

A imagem abaixo mostra a saída do programa acima. Se você está se perguntando qual é o conteúdo do arquivo EmployeeObject.ser, ele está um pouco confuso e algo como abaixo.

��srcom.journaldev.files.Employee�����yyIageLgendertLjava/lang/String;Lnameq~
Lroleq~
xp#tMaletPankajtCEO

ObjectOutputStream com um transient

Se não queremos que alguma propriedade do objeto seja convertida em fluxo, devemos usar a palavra-chave transient para isso. Por exemplo, apenas altere a propriedade de função como abaixo e ela não será salva.

private transient String role;

ObjectOutputStream e serialVersionUID

Você reparou no serialVersionUID definido no objeto Employee? Ele é usado pelas classes ObjectOutputStream e ObjectInputStream para operações de escrita e leitura de objetos. Embora não seja obrigatório ter esse campo, você deve mantê-lo. Caso contrário, sempre que você alterar sua classe, isso não terá efeito nos objetos serializados anteriormente e eles começarão a falhar. Para uma análise detalhada, vá até Serialização em Java. Se você está se perguntando se nosso programa funcionou corretamente ou não, use o código abaixo para ler um objeto do arquivo salvo.

FileInputStream is = new FileInputStream("EmployeeObject.ser");
ObjectInputStream ois = new ObjectInputStream(is);
Employee emp = (Employee) ois.readObject();

ois.close();
is.close();
System.out.println(emp.toString());
//Saída será "Funcionário:: Nome=Pankaj Idade=35 Gênero=Masculino Função=CEO"

Isso é tudo sobre o ObjectOutputStream do Java e como usá-lo para escrever o objeto no arquivo.

Você pode verificar mais exemplos de IO em Java no nosso Repositório do GitHub.

Referência: Documentação da API