[아이템 03] private 생성자나 열거 타입으로 싱글턴임을 보증하라

[102092]

[david215]

Serializable 인터페이스를 상속하는 클래스의 객체는 serialize(바이트 스트림으로 변환)해 (1) 파일이나 데이터베이스에 저장하거나 (2) 네트워크를 통해 전송할 수 있고 또 이 바이트 스트림을 deserialize해서 객체를 복원할 수 있습니다. 사실 우리는 일반적으로 (1) Spring Data JDBC나 JPA 등을 사용해 DB에 저장하고 (2) JSON을 만들어서 전송했기 때문에 쓴 적이 없고 앞으로도 쓸 일이 있을지는 잘 모르겠으나? 자바 지식을 확장하는 의미에서 알고가면 좋을 듯 합니다.

잭이 transient keyword나 싱글턴임을 보장하기 위해서는 왜 readResolve() 메소드를 추가해야 하는지 등의 디테일한 부분들에 대해서 간단하게 정리해주시면 좋을 거 같아요.

Serializable Interface
Introduction to Java Serialization

[david215]

마지막으로 Joshua Bloch이 가장 추천하는 enum으로 구현하는 싱글턴을 잘 활용하기 위해서 인터페이스 상속을 enum 클래스에 적용하는 방법 / 예시도 있으면 👍

[guswns1659]

@david215 자바 직렬화에 대해 정리했습니다. 덕분에 직렬화에 대한 이해가 생겼네요.

자바의 Serializable

무엇인가?

• 자바 시스템 내부에서 사용되는 객체 또는 데이터를 외부의 자바 시스템에서도 사용할 수 있도록 바이트(byte) 형태로 테이터 변환하는 기술과 바이트로 변환된 데이터를 다시 객체로 변환하는 기술(역직렬화)를 통칭하는 말을 의미한다.
• 동작 원리를 말하자면 런타임 메모리 영역(힙) 에 상주하고 있는 객체 데이터를 바이트 형태로 변환하는 기술과 바이트 형태의 데이터를 다시 객체로 변환해 런타임 메모리 영역에 상주시키는 기술을 의미한다.

참고) DB의 Serializable과의 차이점은?
DB의 Serializable은 여러개의 트랜잭션이 동일한 데이터를 접근할 때 트랜잭션의 결과가 마치 하나씩 처리된 것처럼 나오는 격리 수준을 의미한다. 일렬로 하나씩 처리된 것처럼 나오는 현상의 의미가 크다. 단점은 동시에 여러 트랜잭션을 처리할 수 없으니 성능 이슈가 발생할 수 있으며 쓰기가 불가능하다.

직렬화 방법 : Serializable을 구현하고 ObjectOutputStream을 사용한다.

        /*
         * 자바 직렬화 : ObjectOutputStream을 이용한다
         */
        Account account = Account.of("jack", "010-7720-7954", 28);
        byte[] serializedAccount;

        try (ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
            try (ObjectOutputStream oos = new ObjectOutputStream(baos)) {
                oos.writeObject(account);
                serializedAccount = baos.toByteArray();

                // 바이트로 변환된 (직렬화된) 결과를 String으로 인코딩                
                System.out.println(Base64.getEncoder().encodeToString(serializedAccount));
            }
        } catch (IOException e) {
            e.printStackTrace();
        }

직렬화 결과

역직렬화 방법

역직렬화 조건

• 직렬화 대상이 된 객체의 클래스가 클래스 패스에 존재해야 하며 import 되어 있어야 한다.
• 자바 직렬화 대상 객체는 동일한 serialVersionUID를 가지고 있어야 한다.

// seialVersionUID
private static final long serialVersionUID = 1L;

        /*
         * 자바 역직렬화 : ObjectInputStream을 이용한다.
         */
        try (ByteArrayInputStream bais = new ByteArrayInputStream(serializedAccount)) {
            try (ObjectInputStream ois = new ObjectInputStream(bais)) {
                Object objectAccount = ois.readObject();
                Account accountFromSerialized = (Account) objectAccount;
                System.out.println(accountFromSerialized);
            }
        } catch (IOException | ClassNotFoundException e) {
            e.printStackTrace();
        }

역직렬화 결과

자바 직렬화 방법을 왜 사용하는가?

• 직렬화 방법은 다양하다. 자바 객체를 CSV, XML, JSON으로 바꾸는 방법도 직렬화 방법이다. 그럼 그냥 JSON 형식으로 직렬화를 해서 시스템 간 소통을 하면 될텐데 왜 자바 직렬화 방법을 사용할까?

물론 사용해도 된다. 목적에 따라 잘 사용하면 된다. 그럼 자바 직렬화의 장점을 살펴보자

자바 직렬화의 장점

• 자바 직렬화는 자바 시스템에서 개발에 최적화되어 있다. 복잡한 데이터 구조의 클래스라도 직렬화가 쉽게 가능하다.

자바 직렬화의 단점

• 역직렬화 시 객체 데이터의 구조가 바뀌면 직렬화가 실패할 수 있다. -> 직접 serialVersionUID 값을 관리해주어야 클래스 변경 시 혼란을 줄일 수 있다. 만약 serialVersionUID가 없다면 내부적으로 클래스의 구조정보로 해쉬값이 만들어져서 serialVersionUID로 지정된다. 사용자가 직접 지정하지 않고 클래스 구조가 바뀌면 serialVersionUID가 바뀐다.
• 직접 serialVersionUID를 관리하더라도 객체 필드의 타입이 변경되면 역직렬화가 실패한다.

자바 직렬화가 우리랑 무슨 상관일까? (중요한 기술임에도 잘 몰랐던 이유는?)

• 런타임 메모리 영역에만 상주하고 있는 객체 데이터를 영속화(Persistence)할 때 필요하다. 시스템이 종료되더라도 없어지지 않는 장점이 있고 네트워크로 주고 받을 수도 있다.
• 우리가 사용하는 스프링에서는 자바 직렬화를 지원하고 있다. @RestController 사용 시 자바 객체를 JSON 형태로 변환해주는데 이 때 해당 객체를 JSON으로 바꾸는 과정에도 직렬화가 일어난다. (자세한 내용은 공부가 필요..)

@RestController는 @controller와 @responsebody가 합쳐져 있다. @responsebody 어노테이션을 통해 반환되는 객체가 자동으로 직렬화되어 HttpResponse에 담긴다.

• 외부에 오랜 시간 저장하는(영속화) 데이터는 변경 가능성이 있기 때문에 직렬화를 구현하지 않는게 좋다.

참고

• 자바 직렬화, 그것이 알고싶다.
• @RestController 밸덩

[guswns1659]

@david215 transient와 readResolve()에 대해 정리했습니다.

싱글턴 직렬화를 위한 Transient와 readResolve() 구현

Transient란

• 해당 데이터(객체 등)을 직렬화할 때 제외하고 싶은 경우 선언하는 키워드이다.
• 패스워드와 같은 보안정보가 직렬화되는 것을 막을 때 사용할 수 있다.

Transient 실습

• name 필드에 transient 추가

@Getter
public class Account implements Serializable {

    private transient String name;
    private String phoneNumber;
    private int age;

• Account 객체 직렬화 및 역직렬화 진행

public static void main(String[] args) {

        /*
         * 자바 직렬화 : ObjectOutputStream을 이용한다
         */
        Account account = Account.of("jack", "010-7720-7954", 28);
        byte[] serializedAccount = new byte[1000];

        try (ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
            try (ObjectOutputStream oos = new ObjectOutputStream(baos)) {
                oos.writeObject(account);
                serializedAccount = baos.toByteArray();

                // 바이트로 변환된 (직렬화된) 결과를 String으로 인코딩
                System.out.println(Base64.getEncoder().encodeToString(serializedAccount));
            }
        } catch (IOException e) {
            e.printStackTrace();
        }

        /*
         * 자바 역직렬화 : ObjectInputStream을 이용한다.
         */
        try (ByteArrayInputStream bais = new ByteArrayInputStream(serializedAccount)) {
            try (ObjectInputStream ois = new ObjectInputStream(bais)) {
                Object objectAccount = ois.readObject();
                Account accountFromSerialized = (Account) objectAccount;
                System.out.println(accountFromSerialized);
            }
        } catch (IOException | ClassNotFoundException e) {
            e.printStackTrace();
        }
    }

역직렬화 결과

• transient 필드가 null로 역직렬화된다.

readResolve()

• 싱글턴으로 구현한 객체를 역직렬화할 때 다른 인스턴스가 반환되는 것을 막는 기능이다. 만약 readResolve()를 싱글턴 객체에 구현하지 않으면 싱글턴이라도 역직렬화할 때 다른 인스턴스가 반환된다.

readResolve() 실습

• 싱글턴 객체 생성

public class JackSingleton implements Serializable {
    private static final JackSingleton INSTANCE = new JackSingleton();

    public JackSingleton() {
    }
    
    public static JackSingleton getInstance() {
        return INSTANCE;
    }
}

• Serializer 클래스 구현

package com.titanic.javatest.serializable;

import java.io.*;
import java.util.Base64;

public class Serializer {

    public String serialize(Object object) {
        /*
         * 자바 직렬화 : ObjectOutputStream을 이용한다
         */
        byte[] serialized;

        try (ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
            try (ObjectOutputStream oos = new ObjectOutputStream(baos)) {
                oos.writeObject(object);
                serialized = baos.toByteArray();

                // 바이트로 변환된 (직렬화된) 결과를 String으로 인코딩
                return Base64.getEncoder().encodeToString(serialized);
            }
        } catch (IOException e) {
            e.printStackTrace();
            return "";
        }
    }

    public Object deserialize(String serialized) {
        /*
         * 자바 역직렬화 : ObjectInputStream을 이용한다.
         */
        byte[] serializedSingleton = Base64.getDecoder().decode(serialized);
        try (ByteArrayInputStream bais = new ByteArrayInputStream(serializedSingleton)) {
            try (ObjectInputStream ois = new ObjectInputStream(bais)) {
                Object objectAccount = ois.readObject();
                return objectAccount;
            }
        } catch (IOException | ClassNotFoundException e) {
            e.printStackTrace();
            return null;
        }
    }

}

• readResolveTest 구현

package com.titanic.javatest.serializable;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import static org.assertj.core.api.Assertions.assertThat;

public class readResolveTest {

    private JackSingleton jackSingleton;
    private Serializer serializer;

    @BeforeEach
    void setUp() {
        this.jackSingleton = JackSingleton.getInstance();
        this.serializer = new Serializer();
    }

    @Test
    void 일반직렬화를_테스트한다() throws Exception {
        // when
        String serialized = serializer.serialize(jackSingleton);
        JackSingleton deserialized = (JackSingleton) serializer.deserialize(serialized);

        // then
        assertThat(deserialized).isSameAs(jackSingleton);
        assertThat(deserialized).isEqualTo(jackSingleton);
    }

    @Test
    void readResolve를_테스트한다() throws Exception {
        // when
        String serialized = serializer.serialize(jackSingleton);
        JackSingleton deserialized = (JackSingleton) serializer.deserialize(serialized);

        // then
        assertThat(deserialized).isSameAs(jackSingleton);
        assertThat(deserialized).isEqualTo(jackSingleton);
    }
}

• readResove() 구현한 싱글톤 객체

package com.titanic.javatest.serializable;

import java.io.Serializable;

public class JackSingleton implements Serializable {
    private static final JackSingleton INSTANCE = new JackSingleton();

    public JackSingleton() {
    }

    public static JackSingleton getInstance() {
        return INSTANCE;
    }

    private Object readResolve() {
        return INSTANCE;
    }
}

readResolve()를 구현하지 않는 결과

• 싱글턴 객체를 역직렬화하면 싱글턴 인스턴스와 다르다고 나온다.
  

• readResolve()를 구현한 결과 : 테스트를 통과한다
  

참고

• 자바 직렬화1
• 자바 직렬화2

[guswns1659]

@david215 enum으로 구현하는 싱글턴 예제는 조금 더 공부해서 정리해보겠습니다!

[102092]

리플렉션이 어떤 건지 간단하게나마 개념만 알면 좋을듯 해요.. 이건 advancend한 걸로 생각됩니다.

[guswns1659]

@102092 리플랙션에 대해 간단히 정리해봤습니다. 덕분에 이해할 수 있었네요.

리플랙션 (Reflection)

• 리플랙션은 자바 언어가 가진 특징이다. 리플랙션은 자바 프로그램이 자기 자신(객체)이나 프로그램 내 속성을 조사,분석하는데 도와주는 기술이다. 예를 들어, 자바 클래스가 클래스 내 멤버 변수에 대한 정보와 해당 멤버 변수를 display(표현?)하게 도와준다.
• 실용적인 내용으로는 이미 로딩이 완료된 클래스에서 또 다른 클래스를 동적으로 로딩(Dynamic Loading)하여 생성자, 멤버 필드, 멤버 메서드 등을 사용할 수 있게 도와준다.
• 반사, 투영이라는 사전적인 의미를 가지고 있는데 객체(인스턴스)를 통해 클래스의 정보를 분석해 내는 프로그램 기법을 의미한다.

왜 사용할까?

• 동적로딩에 대한 기술을 지원하니 자바 프로그램을 유연하게 운영할 수 있다. (다형성 등)

주의할 점

• 외부에 공개되지 않는 private 멤버도 접근과 조작도 가능하니 주의해야 한다. private 멤버는 Field.setAccessible() 메서드를 true로 지정하면 접근이 가능하다고 한다.

참고

• 오라클 리플랙션 공식문서
• 리플랙션이란?

[guswns1659]

p.24 public 필드 방식의 큰 장점은 해당 클래스가 싱글턴임이 API에 명백히 드러난다는 것이다.

여기서 API에 명백히 드러난다는 의미는 무엇일까요??? 같이 논의하고 싶습니다.

@guswns1659 상수로 정의되어 있기에 명확하게 싱글턴임을 알 수 있다.

-> public 필드 방식은 메서드를 통하지 않고 .(dot) 연산자로 바로 인스턴스를 가져오니 다른 로직이 추가되지 않고 인스턴스를 가져올 수 있다.

[102092]

Q) 싱글턴인지 아닌 지 어떻게 판단하다.

• Spring 환경에서 왜 제공하는 지 생각해보자
• Spring에서 Singleton이 중요하다

[102092]

Q) 정적 팩터리 방식은 첫번째 장점은 마음이 바뀌면 싱글턴이 아니게 변경할 수 있다??

• 싱글턴을 보장하지 않도록, new Elvis() 같은 방식으로 변경할 수 있음.
• Java에서 싱글톤을 보장하려면, enum을 사용하라(이 방식이 익숙하진 않지만 싱글톤을 보장하는 가장 쉬운 방식)
• Spring에서 제공해주는 여러 어노테이션들..(@Compent, @Bean)을 통해서, 싱글톤을 만들고 이용할 수 있도록 도와주고 있음.

[102092]

Q) 왜 직렬화, 역직렬화를 사용할까?

• 같은 Java 시스템 간에 가장 쉽게 데이터를 통신할 수 있는 방식
• 언제 사용할까?
  • DB에 영속화 할 때, 이떄 byteStream으로 바꿔서 들어감
  • byteStream -> 직렬화(좀 더 복잡한 방식이 있음) -> DB