Object 키워드 : 클래스 선언과 인스턴스 생성

코틀린에서는 Object키워드를 다양한 상황에서 사용하지만 모든 경우 클래스를 정의하면서 동시에 인스턴스를 생성한다는 공통점이 있다

object 키워드를 사용하는 상황

• 객체 선언은 싱글턴을 정의하는 방법 중 하나
• 동반 객체는 인스턴스 메서드는 아니지만 어떤 클래스와 관련 있는 메서드와 펙토리 메서드를 담을 때 쓰인다. 동반 객체 메서드에 접근할 때는 동반 객체가 포함된 클래스의 이름을 사용할 수 있다.
• 객체 식은 자바의 무명 내부 클래스 대신 쓰인다.

싱글턴을 쉽게 만들기

자바에서는 싱글톤을 만들기 위해 보통 클래스의 생성자를 private로 제한하고 정적인 필드에 그 클래스의 유일한 객체를 저장하는 방식으로 구현한다.

코틀린에서는 객체 선언 기능을 통해 싱글톤을 언어에서 기본 지원한다. -> 객체 선언은 클래스 선언 + 클래스에 속한 단일 인스턴스의 선언을 합친 선언이다.

class Payroll {
    val allEmployees = arrayListOf<Person>()
    fun calculateSalary(){
        for(person in allEmployees){
            /**
             * CODE
             */
        }
    }
}

• 객체 선언은 object 키워드로 시작한다.
• 객체 선언은 클래스를 정의하고 그 클래스의 인스턴스를 만들어서 변수에 저장하는 모든 작업을 한 문장으로 처리한다.
• 클래스와 마찬가지로 객체 선언 안에도 프로퍼티, 메서드, 초기화 블록 등이 들어갈 수 있다.
  • 단, 생성자는 객체 선언에 쓸 수 없다
  • 일반 클래스 인스턴스와 달리 싱글턴 객체는 객체 선언문이 있는 위치에서 생성자 호출 없이 즉시 만들어 지기 때문
• 변수와 마찬가지로 객체선언에 사용한 이름 뒤에 마침표를 붙여 객체에 속한 메서드나 프로퍼티에 접근이 가능하다.

object CaseInsensitiveFileComparator : Comparator<File> {
    override fun compare(file1: File, file2: File): Int {
        return file1.path.compareTo(file2.path, ignoreCase = true)
    }
}

• 객체 선언도 클래스나 인터페이스를 상속할 수 있다.
  • 프레임워크를 사용하기 위해 특정 인터페이스를 구현해야 하는데, 그 구현 내부에 다른 상태가 필요하지 않은 경우에 이런 기능이 유용하다.
  • Comparator 구현은 두 객체를 인자로 받아 어느 객체가 더 큰지 알려주는 정수를 반환하는데 , Comparator 같은 경우 데이터를 저장할 필요가 없기 때문에 클래스마다 하나만 구현하면 된다.
• 일반 객체를 사용할 수 있는 곳에서는 항상 싱글턴 객체를 사용할 수 있다

fun main(args: Array<String>) {
    val files = listOf(File("/Z"), File("/A"))
    println(files.sortedWith(CaseInsensitiveFileComparator))
}

클래스 안에서 객체를 선언할 수 있는데 그런 객체도 인스턴스는 단 하나뿐이다.

data class Person(val name:String) {
    object NameComparator: Comparator<Person>{
        override fun compare(p1: Person, p2: Person): Int =
            p1.name.compareTo(p2.name)
    }
}

fun main(args: Array<String>) {
    val persons = listOf(Person("Bob"), Person("Alice"))
    println(persons.sortedWith(Person.NameComparator))
}

TIP : 코틀린 객체를 자바에서 사용하기

코틀린 객체 선언은 유일한 인스턴스에 대한 정적인 필드가 있는 자바 클래스로 컴파일이 된다. 이때 인스턴스 이름은 항상 INSTANCE이고, 자바 코드에서 코틀린 싱글턴 객체를 사용하려면 정적인 INSTANCE 필드를 통해 사용하면 된다.

CaseInsensitiveFileComparator.INSTANCE.compare(file1, file2)

팩토리 메서드와 정적 멤버가 들어갈 장소(동반 객체)

코틀린 클래스 안에는 정적인 멤버가 없다( 자바의 static 키워드를 지원하지 않기 때문), 그 대신 코틀린에서는 패키지 수준의 최상위 함수와 객체 선언을 활용한다. -> 대부분의 경우 최상위 함수를 활용하는 편을 더 권장하지만, 최상위 함수는 인스턴스에 private로 표시된 클래스 비공개 멤버에는 접근할 수 없다.

그래서 클래스의 인스턴스와 관계없이 호출해야 하지만, 클래스 내부 정보에 접근해야 하는 함수가 필요할 때는 클래스에 중첩된 객체 선언의 멤버 함수로 정의해야 한다.( 대표적으로 펙토리 메서드를 들 수 있다)

class A {
    companion object{
        fun bar(){
            println("Companion Object Called")
        }
    }
}

fun main(args: Array<String>) {
    A.bar()
}

• 클래스 안에 정의된 객체 중 하나에 companion 표시를 붙이면 그 클래스의 동반 객체로 만들 수 있다
• 동반 객체의 프로퍼티나 메서드에 접근하려면 그 동반 객체가 정의된 클래스 이름을 사용한다.
  • 객체의 이름을 따로 지정할 필요 X
  • 결과적으로 동반 객체의 멤버를 사용하는 구문은 자바의 정적메서드 호출이나 정적 필드 사용 구문과 같아진다.
• 동반 객체는 private 생성자를 호출하기 좋은 위치다.
  • 동반 객체는 자신을 둘러싼 클래스의 모든 private 맴버에 접근할 수 있다.
  • 동반 객체는 바깥쪽 클래스의 private 생성자도 호출이 가능하다.
  • 펙토리 패턴을 구현하기 가장 적합하다.

부 생성자가 여럿 있는 클래스

class User{
    val nickname: String
    //부 생성자가 여럿있는 클래스
    constructor(email: String){
        nickname = email.substringBefore('@')
    }
    constructor(facebookAccountId: Int){
        nickname = getFacebookName(facebookAccountId)
    }
}

• 이런 로직을 표현하는 더 유용한 방법으로 클래스의 인스턴스를 생성하는 팩토리 메서드가 있다.
• 생성자를 통해 User 인스턴스를 만들 수 없고 펙토리 메서드를 통해서만 만들 수가 있다

class User private constructor(val nickname: String){
    companion object{ //동반 객체 선언
        fun newSubscribingUser(email: String) =
            User(email.substringBefore('@'))
        fun newFacebookUser(accountId: Int) = User(getFacebookName(accountId))
    }
}

fun main(args: Array<String>) {
    val subscribingUser = User.newSubscribingUser("bob@gmail.com")
    val facebookUser = User.newFacebookUser(4)
    println(subscribingUser.nickname)
}

 

• 클래스 이름을 사용해 그 클래스에 속한 동반 객체의 메서드를 호출할 수 있다.
• 목적에 따라 팩토리 메서드 이름을 정할 수 있다
• 팩토리 메서드는 그 팩토리 메서드가 선언된 클래스의 하위 클래스 객체를 반환할 수도 있다
• 팩토리 메서드는 생성할 필요가 없는 객체를 생성하지 않을 수도 있다
  • 예를 들어 중복된 이메일로 회원가입한경우 새 인스턴스를 만들지 않고 캐시를 반환할 수도 있다
• 단, 클래스를 확장해야하는 경우 동반 객체 멤버를 하위 클래스에서 오버라이드 할 수 없으므로 여러 생성자를 사용하는 편이 나은 해결방법이다.

동반 객체를 일반 객체처럼 사용

동반 객체는 클래스 안에 정의된 일반 객체로 이름을 붙이거나, 인터페이스를 상속하거나, 확장 함수와 프로퍼티를 정의할 수 있다/

class Person(val name: String){
    companion object Loader{ //동반객체에 이름을 붙힌다
        fun fromJSON(jsonText: String): Person = ...
    }
}

fun main(args: Array<String>) {
    val person = Person.Loader.fromJSON("{name:'Dmity'}")
    println(person.name)
}

• 대부분의 경우 클래스 이름을 통해 동반 객체에 속한 멤버를 찾을 수 있다.
• companion object Loader 처럼 특별한 방식으로 동반 객체에 이름을 붙일 수 있다.
  • 특별히 이름을 붙이지 않는다면 클래스 이름은 Companion 이 된다

동반 객체에서 인터페이스 구현

인터페이스를 구현하는 동반 객체를 참조할 때 객체를 둘러싼 클래스의 이름을 바로 사용할 수 있다.

interface JSONFactory<T> {
    fun fromJSON(jsonText: String) : T
}

class Person(val name: String){
    companion object : JSONFactory<Person>{
        override fun fromJSON(jsonText: String): Person { //동반 객체가 인터페이스를 구현한다
            /*CODE*/
        }
    }
}

Tip : 코틀린 동반 객체와 정적 멤버

클래스의 동반 객체는 일반 객체와 비슷한 방식으로 클래스에 정의된 인스턴스를 가리키는 정적 필드로 컴파일된다. 동반 객체에 이름을 붙이지 않았다면 자바 쪽에서 Companion이라는 이름으로 그 참조에 접근할 수 있다. 만약 동반 객체에 이름을 붙였으면 그 이름이 쓰인다. 때로는 자바에서 사용하기 위해 코틀린 클래스의 멤버를 정적인 멤버로 만들 필요가 있는데 @JvmStatic 어노테이션을 코틀린 멤버에 붙이면 된다. 정적 필드가 필요하다면 @JvmField 어노테이션을 최상위 프로퍼티나 객체에서 선언된 프로퍼티 앞에 붙인다.

 

동반 객체 확장

자바의 정적 메서드나 코틀린의 동반 객체 메서드처럼 기존 클래스에 대해 호출할 수 있는 새로운 함수를 정의하고 싶다면 어떻게 해야 할까? 

클래스에 동반 객체가 있으면 그 객체 안에 함수를 정의함으로써 클래스에 대해 호출할 수 있는 확장 함수를 만들 수 있다.

class Person(val firstName: String, val lastName: String){
    companion object{ //비어 있는 동반객체 선언
        
    }
}

fun Person.Companion.fromJSON(json:String): Person = {
	...
}

• 동반 객체 안에서 fromJSON 함수를 정의한 것처럼 fromJSON을 호출할 수 있다.
• 하지만 실제로 fromJSON은 클래스 밖에서 정의한 확장 함수다
  • 다른 보통 확장 함수처럼 fromJSON도 클래스 멤버 함수처럼 보이지만 실제로는 아니다
  • 동반 객체에 대한 확장 함수를 작성할 수 있으려면 원래 클래스에 동반 객체를 꼭 선언해야 한다는 점 주의
  • 비어있는 객체라도 꼭 선언하자

무명 내부 클래스를 다른 방식으로 작성(객체 식)

object 키워드를 싱글턴과 같은 객체를 정의하고 이름 붙일 때만 사용하지 않는다. 무명 객체를 정의할 때도 사용한다.

무명 객체는 자바의 무명 내부 클래스를 대신한다.

window.addMouseListener {
    object: MouseAdapter(){ //MouseAdapter를 확장하는 무명 객체
        override fun mouseClicked(e: MouseEvent) { //MouseAdapter의 메서드를 오버라이드
            //...
        }

        override fun mouseEntered(e: MouseEvent) {
            //...
        }
    }
}

• 객체 식은 클래스를 정의하고 그 클래스에 속한 인스턴스를 생성하지만, 그 클래스나 인스턴스에 이름을 붙이지 않는다.
• 보통 함수를 호출하면서 인자로 무명 객체를 넘기기 때문에 클래스와 무명 인스턴스 모두 이름이 필요하지 않다
• 만약 객체에 이름을 붙여야한다면 변수에 무명 객체를 대입하면 된다.

val listener = object: MouseAdapter(){
	override fun mouseClicked(e: MouseEvent){ ...}
    override fun mouseEntered(e: MouseEvent){ ...}
}

 

• 한 인터페이스만 구현하거나 한 클래스만 확장할 수 있는 자바의 무명 내부 클래스와 달리 코틀린 무명 클래스는 여러 인터페이스를 구현하거나 클래스를 확장하면서 인터페이스를 구현할 수 있다

fun countClicks(window: Window) {
    var clickCount = 0
    window.addMouseListener(object : MouseAdapter() {
        override fun mouseClicked(e: MouseEvent?) {
            clickCount++
        }
    })
}

• 자바의 무명 클래스와 같이 객체 식 안의 코드는 그 식이 포함된 함수의 변수에 접근할 수 있다.
• 단, 자바와 달리 final이 아닌 변수도 객체 식 안에서 사용할 수  있다.
  • 객체식 안에서 그 변수의 값을 변경 할 수 있다