기본 설정으로 앱 최적화를 사용 설정하면 R8은 성능 이점을 극대화하기 위해 광범위한 최적화를 실행합니다. R8은 클래스, 필드, 메서드의 이름 바꾸기, 이동, 삭제를 포함하여 코드를 크게 수정합니다. 이러한 수정으로 인해 오류가 발생하는 경우, 유지 규칙에서 선언하여 R8이 수정하지 않아야 하는 코드 부분을 지정해야 합니다.
보관 규칙이 필요한 일반적인 시나리오
R8은 코드의 모든 직접 호출을 식별하고 보존합니다. 하지만 R8은 간접 코드 사용을 확인할 수 없으므로 앱에 필요한 코드를 삭제하여 비정상 종료를 일으킬 수 있습니다. keep 규칙을 사용하여 R8에 이러한 간접적으로 사용되는 코드를 보존하도록 지시합니다. 보관 규칙이 필요할 수 있는 몇 가지 일반적인 상황은 다음과 같습니다.
- 리플렉션으로 액세스하는 코드: R8은 리플렉션으로 클래스, 필드 또는 메서드에 액세스하는 시점을 식별할 수 없습니다. 예를 들어 R8은
Class.getDeclaredMethod()를 사용하여 이름으로 빠른 검색된 메서드나Class.getAnnotation()로 검색된 주석을 식별할 수 없습니다. 이러한 경우 R8은 이러한 메서드와 주석의 이름을 바꾸거나 완전히 삭제하여 런타임 시ClassNotFoundException또는NoSuchMethodException가 발생할 수 있습니다. - 자바 네이티브 인터페이스(JNI)에서 호출된 코드: 네이티브(C 또는 C++) 코드가 자바 또는 Kotlin 메서드를 호출하거나 자바 또는 Kotlin 코드가 JNI를 사용하여 C++ 코드를 호출하는 경우 호출은 메서드 이름의 동적 문자열 조회를 기반으로 합니다. R8은 동적 문자열 기반 메서드 호출을 볼 수 없으므로 최적화로 인해 코드가 손상될 수 있습니다.
이 목록은 보관 규칙이 필요한 모든 시나리오를 포함하는 것은 아니지만 보관 규칙이 필요할 수 있는 대부분의 경우를 다룹니다.
자체 코드가 리플렉션을 사용하거나 JNI에서 호출되는 경우 keep 규칙을 수동으로 작성하는 대신 Jetpack Keep 주석으로 코드에 주석을 달 수 있습니다. Gradle 플러그인은 빌드 시 주석에서 유지 규칙을 생성합니다.
보관 규칙이 최적화에 미치는 영향 이해하기
R8은 앱 코드를 분석하여 사용되지 않는 코드, 인라인 메서드, 병합 클래스, 난독화 식별자를 삭제하는 전체 프로그램 최적화 도구입니다. 하지만 R8은 정의된 구성 내에서만 최적화할 수 있습니다.
유지 규칙은 최적화를 제한하는 명시적인 지침을 나타냅니다. 선언하는 모든 유지 규칙은 코드베이스의 해당 부분을 변환하는 R8의 기능을 제한합니다. 잘 작성된 유지 규칙의 가치는 구체성에 있습니다.
좁은 유지 규칙으로 최적화 극대화: 동적으로 액세스되는 정확한 진입점(예: 리플렉션 생성자 또는 직렬화된 필드)만 타겟팅하면 R8이 나머지 코드를 최적화할 수 있습니다.
광범위한 유지 규칙으로 인한 최적화 방지: 패키지 전체 규칙 또는 광범위한 와일드 카드를 선언하면 R8이 전체 클래스와 모든 멤버를 최적화하지 못합니다. R8은 이 코드를 삭제, 인라인, 병합 또는 난독화할 수 없습니다.
유지 규칙이 지나치게 광범위하면 DEX 바이너리가 비대해지고, 앱 메모리 사용량이 증가하며, 시작 시간(TTID 및 TTFD)이 느려지고, ANR 발생률이 높아집니다. 목표는 '만일의 경우'를 위해 클래스를 유지하는 것이 아니라 동적 실행에 필요한 최소한의 계약을 정의하는 것입니다.
서드 파티 라이브러리의 규칙을 포함하여 광범위하거나 불필요한 유지 규칙을 찾으려면 R8 구성 분석기를 사용하세요. R8이 코드를 얼마나 최적화할 수 있는지 보여주는 축소, 최적화, 난독화 점수를 보고합니다.
앱에 유지 규칙을 추가하는 방법
유지 규칙 구성은 사용하는 AGP 버전에 따라 다릅니다.
대규모 앱은 일반적으로 여러 라이브러리 모듈에 코드가 있습니다. 이러한 경우 특정 라이브러리 모듈 내에서 적용되는 코드와 함께 유지 규칙을 배치하는 것이 좋습니다. 라이브러리의 유지 규칙을 유지하는 데 있어 중요한 차이점은 라이브러리 모듈의 build.gradle.kts(또는 build.gradle) 파일 내에서 이러한 규칙을 선언하는 방식에 있습니다. 자세한 내용은 라이브러리 작성자를 위한 최적화를 참고하세요.
AGP 버전 9.3 이상
src/<variant>/keepRules 디렉터리에 있는 접미사 .keep가 있는 파일에 규칙을 추가합니다. 예를 들면 src/main/keepRules/custom-rules.keep입니다. AGP 9.3 이상에서 업데이트된 DSL을 사용하면 코드 및 리소스 최적화를 모두 사용 설정할 수 있으며, 기본 Android 보관 규칙 파일(proguard-android-optimize.txt)을 명시적으로 정의할 필요가 없습니다. 명시적으로 생략하지 않는 한 기본적으로 포함되기 때문입니다.
Kotlin
android {
buildTypes {
release {
optimization {
enable = true // Enables code and resource optimizations.
}
}
}
}
Groovy
android {
buildTypes {
release {
optimization {
enable = true // Enables code and resource optimizations.
}
}
}
}
기본 Android 플랫폼 유지 규칙 생략(고급)
AGP는 기본 Android 플랫폼 규칙 집합을 제공합니다. 프로젝트 구성에서 이러한 규칙을 생략하고 모든 유지 규칙을 직접 관리하려면 optimization.keepRules.includeDefault를 false로 설정합니다.
Kotlin
android {
buildTypes {
release {
optimization {
enable = true // Enables code and resource optimizations.
keepRules {
includeDefault = false // The file with optimization
// rules for the Android platform is included by
// default. To omit this file, set this option to false.
}
}
}
}
}
Groovy
android {
buildTypes {
release {
optimization {
enable = true // Enables code and resource optimizations.
keepRules {
includeDefault = false // The file with optimization
// rules for the Android platform is included by
// default. To omit this file, set this option to false.
}
}
}
}
}
9.3 미만 AGP 버전의 기존 DSL
앱 모듈의 루트 디렉터리에 있는 proguard-rules.pro 파일에 규칙을 추가합니다. 파일이 이미 있을 수도 있지만, 없는 경우 파일을 만듭니다. 파일의 규칙을 적용하려면 모듈 수준 build.gradle.kts(또는 build.gradle) 파일에서 파일을 선언해야 합니다.
기본적으로 빌드 파일에는 proguard-android-optimize.txt 파일도 포함됩니다. 이 파일에는 대부분의 Android 프로젝트에 필요한 규칙이 포함되어 있으므로 빌드 파일에 그대로 두어야 합니다. 이 파일은 proguard-common.txt 파일을 기반으로 하며 이 파일과 콘텐츠를 공유합니다.
기존 DSL(Kotlin)
android {
buildTypes {
release {
isMinifyEnabled = true
isShrinkResources = true
proguardFiles(
// Default file with default optimization rules.
getDefaultProguardFile("proguard-android-optimize.txt"),
...
)
}
}
}
기존 DSL(Groovy)
android {
buildTypes {
release {
minifyEnabled = true
shrinkResources = true
// Default file with default optimization rules.
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt')
...
}
}
}
보관 규칙 추가
유지 규칙을 추가할 때 전역 옵션을 포함하고 자체 유지 규칙을 정의할 수 있습니다.
전역 옵션: 전역 옵션은 R8이 전체 코드베이스에서 작동하는 방식에 영향을 미치는 일반적인 지시어입니다. 자세한 내용은 전역 옵션을 참고하세요.
유지 규칙: 유지 규칙은 앱을 실수로 손상시키지 않으면서 코드 최적화를 극대화하는 적절한 균형을 유지하도록 신중하게 설계해야 합니다. 유지 규칙을 작성하는 방법을 알아보려면 유지 규칙 추가를 참고하세요.
라이브러리 작성자를 위한 규칙 유지
유지 규칙의 전역 옵션과 문법을 알아본 후 자세한 내용은 라이브러리 작성자를 위한 최적화를 참고하세요.