<div id="readability-page-1" class="page"><div><figure></figure>코틀린도 여타 다른 언어와 마찬가지로 ‘inlining’ 기능을 제공합니다. 이를 method 단위로 적용하면 inline function, class 단위로 적용하면 inline class 인데, 이번 글에서는 inline class 에 관해 자세히 살펴봅니다.<h2 id="ed1c">Kotlin Inline Class</h2>코틀린의 inline class 는 내부에 프로퍼티를 하나만 선언한 특수한 형태의 클래스입니다. 클래스 내부에 변수 하나만 선언하고 class 이름 앞에 ‘value’ 키워드를 붙입니다.<pre>@JvmInline value class Password(private val s: String)</pre>위 처럼 선언하면 Password 클래스는 inline class 입니다. <code>@JvmInline</code> 은 컴파일 타겟이 JVM 일 경우만 붙여주면 됩니다.처음 inline class 개념을 배우면 이게 대체 무슨 장점이 있나 싶을 수 있습니다. lnline function 은 컴파일러가 함수가 호출된 위치에 함수의 내용을 삽입하는 식으로 성능상 이점을 얻을 수 있지만 inline class 는 어떤 장점이 있고 왜 쓰는지 와닿지 않습니다.복잡한 비즈니스 로직을 처리하다 보면 특정 타입의 wrapper 를 작성하고 싶을 때가 있습니다. 위에 예시로 든 코드도 Password 의 wrapper 클래스죠. 도메인 클래스에 변수가 수십개가 들어가고 같은 primitive 타입의 변수가 많아지면 개발자의 실수를 유발하기 딱 좋은 환경이 됩니다. 이럴 때 wrapper 클래스를 사용하면 좋죠.하지만 단순한 wrapper 클래스를 부분별하게 사용하면 성능에 여러가지 안좋은 영향을 줄 수 있습니다.<ol><li id="8b73">새로운 인스턴스 생성으로 인한 heap 영역 낭비</li><li id="5f48">런타임 primitive 타입 최적화 X</li></ol>wrapper 는 새로운 클래스 인스턴스를 생성하니 불필요하게 heap 영역이 낭비될거고, JVM 은 런타임에 primitive 타입에 많은 최적화를 적용하는데 wrapper 로 감싸게 되면 그 이점을 잃습니다.위같은 단점을 해결하고자 inline class 라는 개념이 생겨났고 코틀린도 이를 구현한거죠.<pre>val securePassword = Password("Don't try this in production")</pre>위 처럼 사용하면 securePassword 변수에는 Password 클래스의 인스턴스가 할당되는 게 아니라 내부 String 변수가 그대로 할당됩니다. 좀 더 이해하기 쉽게 코드와 런타임으로 한번 봅시다.<pre>@JvmInline value class PasswordInlineClass(val value: String) data class PasswordDataClass(val value: String)val passwordPrimitive = "1234" val passwordInline = PasswordInlineClass("1234") val passwordDataClass = PasswordDataClass("1234")</pre>위 코드에서 변수 3개가 선언되어 있는데 각각 원시 타입 변수, inline class 타입, data class 타입 입니다. 이 변수들이 실제로 어떤 형태인지 런타임 스택에서 살펴보죠.<figure></figure><figure></figure>data class 로 래핑한 변수는 인스턴스가 생성된 반면 inline class 로 래핑한 변수는 원시 타입이 그대로 들어가있는걸 볼 수 있습니다. 이게 inline class 의 핵심 기능이자 ‘inline’ 이라는 이름의 의미입니다.<h2 id="575b">유의할 점</h2>1. 상속<pre>interface Printable { fun prettyPrint(): String }@JvmInline value class Name(val s: String) : Printable { override fun prettyPrint(): String = "Let's $s!" }</pre><pre>fun main() { val name = Name("Kotlin") println(name.prettyPrint()) // Still called as a static method }</pre>inline class 는 interface 구현이 가능합니다. 그래서 위처럼 내부적으로 메소드 구현이 가능하죠. 하지만 클래스 상속은 불가능합니다.2. 함수의 이름<pre>@JvmInline value class UInt(val x: Int)// 'public final void compute(int x)' on the JVM fun compute(x: Int) { }// Also 'public final void compute(int x)' on the JVM! fun compute(x: UInt) { }</pre>위 코드를 보면 compute 라는 이름의 함수가 두개죠. 코틀린 코드로 보면 두 함수는 명백히 다른 함수입니다. 파라미터가 한개고 이름도 같지만 그 타입이 다르니까요. 하지만 JVM 관점에서 보면 두 함수는 같습니다. UInt 클래스는 inline class 라서 런타임에는 Int 타입이기 때문입니다. 그래서 별다른 조치를 취하지 않으면 두 함수는 signature 가 같다는 오류를 뿜어낼겁니다.이를 해결하기 위해 코틀린은 inline class 를 파라미터로 사용하는 함수는 런타임에 그 이름에 살짝 수정을 가합니다. 함수 이름뒤에 hashcode 를 덧붙이는 방식으로 말입니다. 가령 위 코드의 <code>fun compute(x: UInt)</code> 함수의 경우 런타임에 <code>public final void compute-&lt;hashcode&gt;(int x)</code> 같은 형태로 변합니다. 실제로 그렇게 변하는지 한번 눈으로 확인해보죠.<pre>@JvmInline value class UInt(val x: Int)// 'public final void compute(int x)' on the JVM fun compute(x: Int) { println(getCurrentMethodName()) }// Also 'public final void compute(int x)' on the JVM! fun compute(x: UInt) { println(getCurrentMethodName()) }</pre>앞선 예시의 코드에서 각 compute 함수 마다 현재 실행중인 메소드 이름을 출력하는 코드를 넣었습니다. 두 메소드를 차례로 실행한 결과는 아래와 같습니다.<figure></figure>보시다시피 inline class 를 파라미터로 받는 <code>fun compute(x: UInt)</code> 함수는 이름 뒤에 hashcode 가 붙었습니다. 이런 기법을 Mangling 이라고 부르더라구요.위에서 메소드 이름을 출력하기 위해 사용했던 <code>getCurrentMethodName()</code> 메소드는 아래처럼 구현했습니다.<pre>fun getCurrentMethodName(): String { val stackTrace = Thread.currentThread().stackTrace return stackTrace[2].methodName }</pre><h2 id="4fd4">Inline class vs type alias</h2>inline class 를 보고 있자니 type alias 와 그 역할이 비슷해보이기도 합니다. 그럴만도한게 둘 다 새로운 타입을 만드는 것 처럼 보이고 런타임에 내부 타입으로 표현되는 것도 비슷하죠. 하지만 이 둘은 그 역할과 기능이 다릅니다.inline class 는 컴파일 타임에서 보면 완전히 새로운 타입을 만드는 개념입니다. 이에 반해 type alias 는 단순히 특정 타입의 별칭일 뿐이구요. 그래서 type alias 는 코드 상에서 그 기저가 되는 타입과 호환이 되지만 inline class 는 그렇지 않죠. 아래 예시 코드를 보면 이해가 쉬울겁니다.<pre>typealias NameTypeAlias = String@JvmInline value class NameInlineClass(val s: String)fun acceptString(s: String) {} fun acceptNameTypeAlias(n: NameTypeAlias) {} fun acceptNameInlineClass(p: NameInlineClass) {}fun main() { val nameAlias: NameTypeAlias = "" val nameInlineClass: NameInlineClass = NameInlineClass("") val string: String = "" acceptString(nameAlias) // OK: String 대신 typealias 를 사용해도 무방 acceptString(nameInlineClass) // Not OK: String 대신 inline class 를 사용할 수 없음 // And vice versa: acceptNameTypeAlias(string) // OK: typealias 대신 String 을 사용해도 무방 acceptNameInlineClass(string) // Not OK: inline class 대신 String 를 사용할 수 없음 }</pre>String 타입을 파라미터로 사용하는 <code>acceptString(s: String)</code> 함수에는 <code>NameInlineClass</code> 를 사용할 수 없고 inline class 타입을 파라미터로 사용하는 <code>acceptNameInlineClass(p: NameInlineClass)</code> 에는 <code>String</code> 타입을 사용할 수 없습니다. 간단하게 아래처럼 정리할 수 있겠습니다.<ul><li id="4ea8">Inline class : 경량 wrapper 클래스</li><li id="eed2">type alias : 단순히 기존 타입의 별칭, 오직 가독성 향상을 위함</li></ul></div></div>

Stories by allocProc on Medium

jaeyeong

[Kotlin] Inline class
코틀린도 여타 다른 언어와 마찬가지로 ‘inlining’ 기능을 제공합니다. 이를 method 단위로 적용하면 inline function, class 단위로 적용하면 inline class 인데, 이번 글에서는 inline class 에 관해 자세히 살펴봅니다.
Kotlin Inline Class
코틀린의 inline class 는 내부에 프로퍼티를 하나만 선언한 특수한 형태의 클래스입니다. 클래스 내부에 변수 하나만 선언하고 class 이름 앞에 ‘value’ 키워드를 붙입니다.
@JvmInline
value class Password(private val s: String)
위 처럼 선언하면 Password 클래스는 inline class 입니다. @JvmInline 은 컴파일 타겟이 JVM 일 경우만 붙여주면 됩니다.
처음 inline class 개념을 배우면 이게 대체 무슨 장점이 있나 싶을 수 있습니다. lnline function 은 컴파일러가 함수가 호출된 위치에 함수의 내용을 삽입하는 식으로 성능상 이점을 얻을 수 있지만 inline class 는 어떤 장점이 있고 왜 쓰는지 와닿지 않습니다.
복잡한 비즈니스 로직을 처리하다 보면 특정 타입의 wrapper 를 작성하고 싶을 때가 있습니다. 위에 예시로 든 코드도 Password 의 wrapper 클래스죠. 도메인 클래스에 변수가 수십개가 들어가고 같은 primitive 타입의 변수가 많아지면 개발자의 실수를 유발하기 딱 좋은 환경이 됩니다. 이럴 때 wrapper 클래스를 사용하면 좋죠.
하지만 단순한 wrapper 클래스를 부분별하게 사용하면 성능에 여러가지 안좋은 영향을 줄 수 있습니다.
새로운 인스턴스 생성으로 인한 heap 영역 낭비
런타임 primitive 타입 최적화 X
wrapper 는 새로운 클래스 인스턴스를 생성하니 불필요하게 heap 영역이 낭비될거고, JVM 은 런타임에 primitive 타입에 많은 최적화를 적용하는데 wrapper 로 감싸게 되면 그 이점을 잃습니다.
위같은 단점을 해결하고자 inline class 라는 개념이 생겨났고 코틀린도 이를 구현한거죠.
val securePassword = Password("Don't try this in production")
위 처럼 사용하면 securePassword 변수에는 Password 클래스의 인스턴스가 할당되는 게 아니라 내부 String 변수가 그대로 할당됩니다. 좀 더 이해하기 쉽게 코드와 런타임으로 한번 봅시다.
@JvmInline
value class PasswordInlineClass(val value: String)
data class PasswordDataClass(val value: String)
val passwordPrimitive = "1234"
val passwordInline = PasswordInlineClass("1234")
val passwordDataClass = PasswordDataClass("1234")
위 코드에서 변수 3개가 선언되어 있는데 각각 원시 타입 변수, inline class 타입, data class 타입 입니다. 이 변수들이 실제로 어떤 형태인지 런타임 스택에서 살펴보죠.
data class 로 래핑한 변수는 인스턴스가 생성된 반면 inline class 로 래핑한 변수는 원시 타입이 그대로 들어가있는걸 볼 수 있습니다. 이게 inline class 의 핵심 기능이자 ‘inline’ 이라는 이름의 의미입니다.
유의할 점
1. 상속
interface Printable {
 fun prettyPrint(): String
}
@JvmInline
value class Name(val s: String) : Printable {
 override fun prettyPrint(): String = "Let's $s!"
}
fun main() {
 val name = Name("Kotlin")
 println(name.prettyPrint()) // Still called as a static method
}
inline class 는 interface 구현이 가능합니다. 그래서 위처럼 내부적으로 메소드 구현이 가능하죠. 하지만 클래스 상속은 불가능합니다.
2. 함수의 이름
@JvmInline
value class UInt(val x: Int)
// 'public final void compute(int x)' on the JVM
fun compute(x: Int) {
}
// Also 'public final void compute(int x)' on the JVM!
fun compute(x: UInt) { 
}
위 코드를 보면 compute 라는 이름의 함수가 두개죠. 코틀린 코드로 보면 두 함수는 명백히 다른 함수입니다. 파라미터가 한개고 이름도 같지만 그 타입이 다르니까요. 하지만 JVM 관점에서 보면 두 함수는 같습니다. UInt 클래스는 inline class 라서 런타임에는 Int 타입이기 때문입니다. 그래서 별다른 조치를 취하지 않으면 두 함수는 signature 가 같다는 오류를 뿜어낼겁니다.
이를 해결하기 위해 코틀린은 inline class 를 파라미터로 사용하는 함수는 런타임에 그 이름에 살짝 수정을 가합니다. 함수 이름뒤에 hashcode 를 덧붙이는 방식으로 말입니다. 가령 위 코드의 fun compute(x: UInt) 함수의 경우 런타임에 public final void compute-<hashcode>(int x) 같은 형태로 변합니다. 실제로 그렇게 변하는지 한번 눈으로 확인해보죠.
@JvmInline
value class UInt(val x: Int)
// 'public final void compute(int x)' on the JVM
fun compute(x: Int) {
 println(getCurrentMethodName())
}
// Also 'public final void compute(int x)' on the JVM!
fun compute(x: UInt) {
 println(getCurrentMethodName())
}
앞선 예시의 코드에서 각 compute 함수 마다 현재 실행중인 메소드 이름을 출력하는 코드를 넣었습니다. 두 메소드를 차례로 실행한 결과는 아래와 같습니다.
보시다시피 inline class 를 파라미터로 받는 fun compute(x: UInt) 함수는 이름 뒤에 hashcode 가 붙었습니다. 이런 기법을 Mangling 이라고 부르더라구요.
위에서 메소드 이름을 출력하기 위해 사용했던 getCurrentMethodName() 메소드는 아래처럼 구현했습니다.
fun getCurrentMethodName(): String {
 val stackTrace = Thread.currentThread().stackTrace
 return stackTrace[2].methodName
}
Inline class vs type alias
inline class 를 보고 있자니 type alias 와 그 역할이 비슷해보이기도 합니다. 그럴만도한게 둘 다 새로운 타입을 만드는 것 처럼 보이고 런타임에 내부 타입으로 표현되는 것도 비슷하죠. 하지만 이 둘은 그 역할과 기능이 다릅니다.
inline class 는 컴파일 타임에서 보면 완전히 새로운 타입을 만드는 개념입니다. 이에 반해 type alias 는 단순히 특정 타입의 별칭일 뿐이구요. 그래서 type alias 는 코드 상에서 그 기저가 되는 타입과 호환이 되지만 inline class 는 그렇지 않죠. 아래 예시 코드를 보면 이해가 쉬울겁니다.
typealias NameTypeAlias = String
@JvmInline
value class NameInlineClass(val s: String)
fun acceptString(s: String) {}
fun acceptNameTypeAlias(n: NameTypeAlias) {}
fun acceptNameInlineClass(p: NameInlineClass) {}
fun main() {
 val nameAlias: NameTypeAlias = ""
 val nameInlineClass: NameInlineClass = NameInlineClass("")
 val string: String = ""
 acceptString(nameAlias) // OK: String 대신 typealias 를 사용해도 무방
 acceptString(nameInlineClass) // Not OK: String 대신 inline class 를 사용할 수 없음
 // And vice versa:
 acceptNameTypeAlias(string) // OK: typealias 대신 String 을 사용해도 무방
 acceptNameInlineClass(string) // Not OK: inline class 대신 String 를 사용할 수 없음
}
String 타입을 파라미터로 사용하는 acceptString(s: String) 함수에는 NameInlineClass 를 사용할 수 없고 inline class 타입을 파라미터로 사용하는 acceptNameInlineClass(p: NameInlineClass) 에는 String 타입을 사용할 수 없습니다. 간단하게 아래처럼 정리할 수 있겠습니다.
Inline class : 경량 wrapper 클래스
type alias : 단순히 기존 타입의 별칭, 오직 가독성 향상을 위함
Reference
https://kotlinlang.org/docs/inline-classes.html

[Kotlin] inline class

댓글