How to Write an Object to a File in Java

🎓 Top 15 Udemy Courses (80-90% Discount): My Udemy Courses - Ramesh Fadatare — All my Udemy courses are real-time and project oriented courses.

▶️ Subscribe to My YouTube Channel (178K+ subscribers): Java Guides on YouTube

▶️ For AI, ChatGPT, Web, Tech, and Generative AI, subscribe to another channel: Ramesh Fadatare on YouTube

Writing an object to a file in Java is a common task in many applications, such as saving user data, configuration settings, or any other data that needs to be persisted between application runs. Java provides a simple and efficient way to serialize objects and write them to a file. 

This blog post will guide you through the process of writing an object to a file using the ObjectOutputStream class with an example Employee class.

Table of Contents

1. Introduction
2. Prerequisites
3. Writing an Object to a File
4. Complete Example
5. Conclusion

Introduction

Java allows you to write objects to files through serialization, which is the process of converting an object into a byte stream. This byte stream can then be saved to a file and later read back to reconstruct the original object through deserialization. This tutorial will demonstrate how to write an Employee object to a file.

Prerequisites

Before you can write an object to a file, you need to ensure that the object class implements the Serializable interface. This interface is a marker interface, meaning it does not contain any methods, but it tells the Java Virtual Machine (JVM) that the class can be serialized.

Example

import java.io.Serializable;

public class Employee implements Serializable {
    private static final long serialVersionUID = 1L;
    private String name;
    private int id;
    private String department;

    public Employee(String name, int id, String department) {
        this.name = name;
        this.id = id;
        this.department = department;
    }

    @Override
    public String toString() {
        return "Employee{name='" + name + "', id=" + id + ", department='" + department + "'}";
    }
}

Writing an Object to a File

To write an object to a file, you need to use the ObjectOutputStream class. This class serializes objects and primitive data types to an output stream.

Example

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

public class WriteObjectToFile {
    public static void main(String[] args) {
        Employee employee = new Employee("John Doe", 12345, "Engineering");

        try (ObjectOutputStream oos = new ObjectOutputStream(new FileOutputStream("employee.dat"))) {
            oos.writeObject(employee);
            System.out.println("Object has been serialized and written to employee.dat");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

Explanation:

• An Employee object is created and initialized.
• An ObjectOutputStream is created to write the object to a file named employee.dat.
• The writeObject method is called to serialize the object and write it to the file.
• The try-with-resources statement ensures that the stream is closed automatically.

Complete Example

Here is the complete example including the Employee class and the WriteObjectToFile class.

Employee.java

import java.io.Serializable;

public class Employee implements Serializable {
    private static final long serialVersionUID = 1L;
    private String name;
    private int id;
    private String department;

    public Employee(String name, int id, String department) {
        this.name = name;
        this.id = id;
        this.department = department;
    }

    @Override
    public String toString() {
        return "Employee{name='" + name + "', id=" + id + ", department='" + department + "'}";
    }
}

WriteObjectToFile.java

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

public class WriteObjectToFile {
    public static void main(String[] args) {
        Employee employee = new Employee("John Doe", 12345, "Engineering");

        try (ObjectOutputStream oos = new ObjectOutputStream(new FileOutputStream("employee.dat"))) {
            oos.writeObject(employee);
            System.out.println("Object has been serialized and written to employee.dat");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

Conclusion

Writing an object to a file in Java involves serializing the object using the ObjectOutputStream class. This process is straightforward and requires the object class to implement the Serializable interface. By following the steps outlined in this tutorial, you can efficiently serialize and write objects to files in your Java applications.

Feel free to experiment with the code examples provided in this tutorial to gain a deeper understanding of how to write objects to files in Java. Happy coding!