[AOS] Android Proguard 설정

 

 

🐱

라이브러리 배포 전에 코드 난독화 설정 부탁드려요!
난독화하지 않으면 라이브러리 디컴파일 시 코드가 노출되거든요.

난독화는 어떻게 하면 되는건가요...?

🐶

 

 

🐱

proguard라고 한 번쯤 들어보셨죠? 그걸 이용하면 됩니다.

아하! (디게 간단한가보네ㅎㅎ) 넵, 알겠습니다!

🐶

 

 

 

 

 

 

안드로이드 개발을 하다보면 다들 한 번쯤 build.gradle에서 아래 코드나

buildTypes {
    release {
        minifyEnabled false
        proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
    }
}

 

 

proguard-rules.pro라는 파일을 본 적 있을 것이다.

 

 

 

 

아무래도 공부할 때에나, 학부 프로젝트를 진행할 때 난독화할 필요가 크게 없기 때문에 사용해 본 경험이 적을 것이다. (나 역시도 사용해 본 적이 없었다.)

하지만 실무에서는 다른 곳으로 라이브러리나 어플리케이션을 배포할 때 코드 유출을 방지하기 위해 필수적으로 사용한다.

 

 

Proguard 설정하기

 

proguard를 사용하기 위해서는 build.gradle을 약간 수정해주어야 한다.

위에서 본 app 수준 build.gradle의 코드에서 minifyEnabled false를 true로 변경해야 적용된다.

buildTypes {
    release {
        minifyEnabled true
        proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
    }
}

 

 

하지만 이 설정도 buildTypes가 release 버전일 경우에만 적용된다.

debug 버전일 경우에도 적용하고 싶다면 아래와 같이 build type을 추가해준다.

buildTypes {
    release {
        minifyEnabled true
        proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
    }
    debug {
        minifyEnabled true
        proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
    }
}

 

 

빌드 타입은 안드로이드 스튜디오 하단 Build Variants 탭에서 설정 가능하다.

 

 

 

이렇게 간단하게 끝나면 좋겠지만... proguard 적용 제외 설정이 필요하다.

 

라이브러리 프로젝트의 경우, proguard를 이용해 코드 난독화 후 배포하면 다른 프로젝트에서 해당 라이브러리의 함수를 가져와 사용할 수 없게 된다.

따라서 다른 프로젝트에서 끌어와 사용해야하는 필수 함수나 인터페이스는 난독화 제외 설정을 해주어야 한다.

해당 설정은 위에서 본 proguard-rules.pro 파일에서 설정 가능하다.

 

 

 

 

난독화 예외처리

모든 인터페이스 난독화 예외처리

- keep interface com.프로젝트.패키지명.* { *; }

 

모든 클래스 난독화 예외처리

- keep class com.프로젝트.패키지명.* { *; }

 

난독화할 라이브러리

- injars libs/라이브러리.jar // or aar, ... etc

 

난독화할 필요 없는 라이브러리

- libraryjars libs/라이브러리.jar // or aar, ... etc

 

 

Proguard 공식 문서

ProGuard Manual: Usage | Guardsquare

 

 

 

 

라이브러리의 규모가 클수록 난독화 예외설정 후 빌드된 라이브러리로 모든 작업의 경우의 수를 테스트 해보는 것이 중요하다.

예상치 못한 클래스가 난독화되어 오류가 발생하는 경우가 많기 때문에 오랜 기간, 그리고 다양한 테스트를  수행해야 한다.

 

 

 

화이팅...!