[Kotlin] Inline class

 💡 경량 클래스의 한 형태인 inline class에 대하여 학습하였습니다.

Inline class

• Inline class는 경량 클래스의 한 형태로, 단일 프로퍼티를 가지고 있으며 런타임 시에 실제 클래스 인스턴스로 할당되지 않는 특징이 있습니다.
• 대신에 해당 클래스의 단일 프로퍼티가 직접 인라인됩니다.
• 이는 성능 향상과 불필요한 객체 생성을 방지할 수 있습니다.

특징

• [단일 프로퍼티] Inline class는 반드시 단일 프로퍼티를 가집니다.
• [경량성] 런타임 시 객체로 할당되지 않고 단일 프로퍼티 값이 직접 사용됩니다.
• [타입 안전성] 인라인 클래스를 활용하면 코드에 더 명확한 타입을 명시할 수 있습니다.
• [함수와 연산자 오버로딩] 메서드와 연산자를 오버로딩 할 수 있습니다.
• [제한사항] 아래와 같은 제한 사항을 가집니다.
  • init 블록을 가질 수 없음
  • Any를 상속할 수 없으며, Nullable 타입이 불가능

High-Order Function?

• 코틀린에서는 고차함수를 활용해서 함수를 호출 인자로 전달하거나, 반환값으로 활용할 수 있습니다.
• 하지만 해당 방식은 부가적인 메모리 할당으로 인해 메모리 효율이 나빠지고, 함수 호출로 인한 런타임 오버헤드가 발생합니다.

fun load(data: Int, loadData : () -> Unit) : Int {
		loadData()
		return data
}

fun main() {
		val result = load(10) {
				print("load data")
		}
		print(result)
}

• 위와 같은 고차 함수를 활용한 코드가 있다고 가정해보겠습니다.
• 해당 코드가 컴파일 시 어떤 Java코드로 변환되는 지 확인하기 위해서 Decompile하여 확인하였습니다.

public final class MainKt {
    public static final int load(int data, Function0<Unit> loadData) {
        loadData.invoke();
        return data;
    }

    public static final void main() {
        int result = load(10, new Function0<Unit>() {
            @Override
            public Unit invoke() {
                System.out.print("load data");
                return Unit.INSTANCE;
            }
        });
        System.out.print(result);
    }
}

• loadData 에 람다식을 전달해주도록 구현한 부분에서 새로운 객체를 생성해서 넘겨주는 식으로 변환되는 것을 확인할 수 있었습니다.
• 또한 넘긴 객체를 통해 함수 호출을 구현하도록 되어있는데, 이러한 방식은 무의미한 객체를 생성하여 메모리를 차지하고 내부적으로 연쇄적인 함수 호출을 하게 될 가능성이 있습니다.
• 이는 오버헤드를 발생시켜 성능을 떨어뜨릴 위험이 존재합니다.
• 따라서 이러한 람다식 내부의 코드들을 컴파일 시 람다를 호출하는 부분에 주입하는 방식을 활용할 수 있는데, 이에 Inline Function을 적용할 수 있습니다.

인라인 함수 활용

inline class UserId(val id: String)

fun getUser(userId: UserId) {
    println("User ID: ${userId.id}")
}

fun main() {
    val userId = UserId("12345")
    getUser(userId) 
}

• UserId는 인라인 클래스이며, id:Strint 이라는 단일 프로퍼티를 가집니다.
• 이 때 UserId는 런타임 시 객체로 존재하지 않고 단일 프로퍼티 값이 직접 사용되며, 아래와 같은 이점을 얻을 수 있습니다.
  • [성능] 객체 생성 오버헤드가 없어 성능이 향상됩니다.
  • [명확한 타입] 코드의 타입 안전성과 가독성을 높여줍니다.
  • [메모리 사용량 감소] 불필요한 객체 생성이 줄어들어 메모리 사용량이 감소합니다.

Nullable 인라인 클래스

• Kotlin 1.5부터 @JvmInline 어노테이션을 활용하여 nullable 인라인 클래스를 정의할 수 있습니다.

@JvmInline
value class UserId(val id: String)

fun getUser(userId: UserId?) {
    if (userId != null) {
        println("User ID: ${userId.id}")
    } else {
        println("User ID is null")
    }
}

고차함수와 인라인 클래스

• 위에서 작성한 load() 고차 함수를 인라인 클래스로 선언했을 때, 어떤 차이가 있는지 확인해보았습니다.

public final class MainKt {
    public static final void main() {
        System.out.print("load data");
        int result = 10;
        System.out.print(result);
    }
}

• inline 키워드를 컴파일하여 자바 코드로 변환한다면, load 함수가 직접 호출되지 않고 load 함수의 본문이 main 함수에 직접 삽입되어 함수 호출에 대한 오버헤드를 줄일 수 있습니다.
• 이런 경우 고차 함수가 빈번하게 호출되는 경우에 최적화를 진행할 수 있습니다.
• 컴파일되는 바이트코드의 양은 증가하여도, 객체를 생성하거나 함수를 또 호출하는 등의 비효율적인 행동은 하지 않게 되었습니다.

noinline Keyword

• 인라인 함수는 일반 함수보다 성능이 좋지만, 내부적으로 코드를 복사하는 개념이기 때문에 인자로 전달받은 함수는 다른 함수로 전달되거나 참조될 수 없습니다.
• 아래의 예를 보겠습니다.

inline fun load(data: Int, loadData : () -> Unit, loadData2: () -> Unit) : Int {
		loadData()
		return data
}

fun load2(data: Int, loadData2 : () -> Unit) : Int {
		loadData2()
		return data
}

fun main() {
		load(1, {
				print("load Function")
		}, {
				print("load2 Function")
		})
}

• 위에서는 전달받은 함수의 일부를 다른 함수로 넘겨주고 있습니다.
• 이는 컴파일 에러를 발생하게 되며, 이때 필요한 것이 noninline 키워드의 활용입니다.

inline fun load(data: Int, loadData : () -> Unit, noinline loadData2: () -> Unit) : Int {
		loadData()
		return data
}

• inline에서 제외시킬 인자 앞에 noinline 키워드를 붙이면서 문제를 해결할 수 있습니다.

결론

• inline은 일반 함수보다 좋은 성능을 가지며, 고차함수에서 발생하는 오버헤드를 줄일 수 있다는 장점을 가지고 있습니다.
• 하지만 지나친 inline 함수의 활용은 바이트코드 양을 증가시키며 이는 성능 악화로 이어질 수 있습니다.
• inline 처리는 1~3줄의 길이를 권장하고 있으며, 적절하게 활용한다면 매우 좋은 성능을 얻을 수 있습니다.

참고

https://kotlinlang.org/docs/inline-classes.html

https://medium.com/android-news/learning-kotlin-inline-functions-18a94d3efe46