⚡ Encapsule record

General

• 데이터들을 표현하는 레코드 ( == property )를 하나의 클래스로 묶어서 캡슐화
• 특정 레코드에 접근 하거나, 특정 레코드를 수정하기 위한 getter / setter 함수 제공
• 특정 레코드에 직접 접근하는것을 막음으로써 클래스 외부에서의 수정을 막을 수 있음

In Android Tip

• Java를 활용하여 개발 시엔, POJO 활용
• Kotlin에서는 data class 키워드를 제공 함으로써 쉽게 활용 가능

💡 Data class / POJO 비교 글 → 링크

⚡ Encapsule collection

General

• 캡슐화된 데이터 클래스에서, 클라이언트에서 collection객체를 통째로 받아 수정 가능한 경우 캡슐화 규칙이 깨질 수 있음
• 따라서 데이터 클래스에서, 웬만하면 수정 가능한 collection 객체를 통쨰로 get 하는 메소드를 제공하지 않는 것이 좋음
• 피치못할 사정으로 데이터 클래스에서 수정 가능한 collection 객체를 통쨰로 제공하는 api가 있어야 할 경우, 해당 collection의 복사된 객체를 제공하여 원본 데이터를 수정하지 않도록 함
• 이를 위한 방법으로 아래의 방법이 있음
  • 절대로 collection을 반환하지 않음
    • collection을 통한 연산이 필요 한 경우 캡슐화된 data class 내부에 이 연산을 위한 api 제공
    • 하지만, 이 방법을 활용하면 부가적인 코드가 양산되며 collection 연산들을 조합하기 힘들어 지므로 권장되지 않음
  • collection을 읽기 전용으로 제공
    • collection 클래스를 다른 인터페이스로 감싸거나, custom iteration 등의 방식을 통해 collection의 읽기 작업을 허용하고 쓰기 작업에 대해서는 모두 blocking
  • getter를 제공하되, collection의 복사본을 제공하여 복제본을 수정해도 캡슐화된 원본 컬렉션은 보존하는것
    • 컬렉션의 크기가 상당히 크다면 성능상의 이슈가 있을 수 있음
• 무슨 방법이던간에, 프로젝트 내에서 일관된 방식으로 작업하여 혼용되지 않도록 하는것이 좋음
• collection을 수정 하는 것에 대해 민감하게 대응하는것이 좋음

In Android Tip

• Kotlin의 mutableList / immutableList를 활용하면 좋을 듯

fun main() {
    val testCase = TestClass(testCases = listOf("haha" to 1, "nana" to 2))
    // testCase.testCases.add("dada" to 3) -> 컴파일 에러 !

    val mutableTestCase = MutableTestClass(testCases = mutableListOf("haha" to 1, "nana" to 2))
    mutableTestCase.testCases.add("dada" to 3)

    val encapsulatedMutableTestCase = EncapsulatedTestClass(mutableListOf("haha" to 1, "nana" to 2))
    // encapsulatedMutableTestCase.testCases.add("dada" to 3) -> 컴파일 에러 !
    encapsulatedMutableTestCase.addTestCase("dada" to 3)
    // encapsulatedMutableTestCase.getTestCasesList().add("dada" to 3) -> 컴파일 에러 !

    println(testCase) // TestClass(testCases=[(haha, 1), (nana, 2)])
    println(mutableTestCase) // MutableTestClass(testCases=[(haha, 1), (nana, 2), (dada, 3)])
    println(encapsulatedMutableTestCase) // EncapsulatedTestClass(_testCases=[(haha, 1), (nana, 2), (dada, 3)])
}

data class TestClass(val testCases: List<Pair<String, Int>>)

data class MutableTestClass(val testCases: MutableList<Pair<String, Int>>)

data class EncapsulatedTestClass(private val _testCases: MutableList<Pair<String, Int>>) {
    fun addTestCase(data: Pair<String, Int>) {
        _testCases.add(data)
    }

    fun removeTestCase(data: Pair<String, Int>) {
        _testCases.remove(data)
    }

    fun getTestCasesList(): List<Pair<String, Int>> {
        return _testCases
    }
}