[Android][WebView] cannot find symbol method setAppCacheEnabled(boolean)

시작. 이슈 확인

target version이 31인 프로젝트의 target version을 33으로 수정했다. 그 후 cannot find symbol method setAppCacheEnabled(boolean) 라는 빌드 에러를 확인했다.

 

살펴보니 기존에 잘 쓰던 코드를 IDE에서 평소와는 다르게 보여주고 있다는 것을 확인했다.

 

기존 모습. target version이 31이었을 때.

변경된 모습. target version을 33으로 수정했을 때

 

내부 코드 확인

WetSettings의 내부 코드를 확인한다. 

target version이 31일 때에는 Control 키 + 마우스 클릭으로 내부 코드로의 이동이 가능했는데, target version이 33일 때에는 이 방법으로 내부 코드로의 이동이 불가했다. WebSettings 클래스 코드를 찾아나셔서 target version이 33일 때의 해당 코드의 내부 코드를 확인했다. 

 

target version 31일 때 내부 코드 deprecated되었다고 주석에 나와있다.

target version 33에서의 내부 코드. 아예 removed 라고 주석에 나와있다.

 

상황 파악하기

다른 블로그 글을 확인했다.

https://growup-lee.tistory.com/entry/WebView-setAppCacheEnabled-Deprecated

[WebView] setAppCacheEnabled Deprecated

 

해당 블로그 글을 읽고 target version 33에서의 WebSettings.setAppCacheEnabled()의 주석 내용이 이해갔다. 

1) AppCache가 Chrome 85버전부터 지원되지 않는다.

2) 안드로이드 WebView도 Chromium기반이기 때문에 AppCache관련 API가 API Level 30부터 Deprecated됐다.

3) target version 33에서의 WebView는 WebView 95 이상이기 때문에 해당 메소드는 동작하지 않는다no-op.

no-op의 뜻 : http://ko.dictionary.education/english/dictionary/no-op

 

구글 쪽에서 AppCache를 제거할 거라고 써놓은 글도 저 블로그 글 덕분에 알았다.

https://web.dev/appcache-removal/

AppCache 제거 준비하기

Service Worker로 마이그래이션하라고 해서 살펴봤는데, 안드로이드에서 어떻게 마이그레이션 하는지에 대한 글을 못 찾았다😖😵 구글링해도 안나온다🥴 코드 수정을 해야 하는데, 방법을 모르겠다. 구글링을 하면서 스트레스 받고 있다는 걸 인식하고 있는데, 길이 트이는 스택오버플로우 답변을 발견했다. 

 

https://stackoverflow.com/a/17429301

Caching in Android webview

 

These have nothing to do with the default webview internal cache. Appcache is an entirely different feature mean to make you able to run the website w/o an internet connection. It does not work that great and probably you do not want to use it.

With setting this: viewer.getSettings().setCacheMode(WebSettings.LOAD_DEFAULT) is enough.

 

AppCache가 웹뷰가 기본으로 가지고 있는 내부 캐시와는 다른 존재라는 것을 알았다. AppCache가 없어도, 웹뷰는 기본 캐시 기능을 동작한다는 거다. 이제야 주석의 내용이 눈에 들어온다.

 

Application Cache, 즉 AppCache를 활성화하기 위해 쓰는 API였던 setAppCacheEnabled(). setAppCachePath도 설정해야지만 활성화된다고.

 

안드로이드 API 레퍼런스 문서에서 WebSettings 쪽에 더 이상 setAppCacheEnable()의 흔적은 없지만

https://developer.android.com/reference/android/webkit/WebSettings

WebSettings  |  Android Developers

 

낡은 안드로이드 API 레퍼러스 문서를 찾았고, 여기에는 WebSettings의 setAppCacheEnabled(boolean)에 대해 나온다.

http://www.dre.vanderbilt.edu/~schmidt/android/android-4.0/out/target/common/docs/doc-comment-check/reference/android/webkit/WebSettings.html

WebSettings | Android Developers

AppCache API 활성화 용도였던 setAppCacheEnabled()

 

이젠 WebView에서 더 이상 Applicatin Caches API, 즉 AppCache를 제공하지 않으니 AppCache와 관련된 메소드들이 아예 사라지는 게 맞다는 게 이해된다.

 

AppCache는 누구를, 무엇을 위해 쓰였던 건데

https://web.dev/appcache-beginner/#introduction

A beginner's guide to using the application cache

구글링하면 AppCache가 제거된다는 글만 나오던데, 이걸 찾아냈다. Introduction 부분을 보니, 이 기능은 오프라인 상태의 사용자를 위한 기능으로 보인다. 

AppCache의 세 가지 장점. https://web.dev/appcache-beginner/#introduction

AppCache가 제거된다는 글에서는 AppCache가 제공하는 오프라인 경험을 Service Worker가 제공할 거라며 Service Worker로 마이그레이션하라고 한다. AppCache는 오프라인 상태의 사용자를 위한 기능이 맞는 것으로 보인다.

https://web.dev/appcache-removal/

AppCache 제거 준비하기

AppCache가 오프라인 경험을 제공했었네. https://web.dev/appcache-removal/

 

WebView에서 기본적으로 제공하는 Cache 기능은 무엇을 하는데 

WebSetting에서 CacheMode 설정은 setCacheMode() 를 이용한다.

https://developer.android.com/reference/android/webkit/WebSettings#setCacheMode(int)

WebSettings  |  Android Developers

 

The way the cache is used is based on the navigation type. For a normal page load, the cache is checked and content is re-validated as needed. When navigating back, content is not revalidated, instead the content is just retrieved from the cache.

발번역

캐시가 사용되는 방식은 화면을 탐색하는 유형을 기반으로 한다. 일반 화면을 로드할 때, 캐시를 확인하고 콘텐츠는 필요에 따라 재검증된다. 화면 뒤로가기를 할 때, 콘텐츠는 재검증되지 않는 대신에 캐시에 반환된다. 

웹 페이지 뒤로가기를 하면 캐시가 사용된다는 것으로 이해했다. 

 

WebSetting은 Cache Mode를 네 가지 가지고 있다. 이 모드를 setCacheMode의 매개변수로 넣어서 설정할 수 있다.

• LOAD_DEFAULT : 캐시된 리소스가 사용 가능하고 만료되지 않았으면 사용하고, 그렇지 않으면 네트워크에서 리소스를 로드한다.
• LOAD_CACHE_ELSE_NETWORK : 캐시된 리소스를 만료되었어도 사용 가능하면 사용하고, 그렇지 않으면 네트워크에서 리소스를 로드한다. 
• LOAD_NO_CACHE : 캐시를 사용하지 않는다. 항상 네트워크에서 리소스를 로드한다.
• LOAD_CACHE_ONLY : 캐시에서 리소스를 로드한다. 네트워크를 사용하지 않는다.

구글 안드로이드 팀은 이렇게 기본으로 제공하는 캐시 기능으로 부족하다고 생각했었어서 AppCache API까지 사용하게 해줬던 건가🤔

 

구글링을 하며 느낀 것

• WebView에 관한 안드로이드 API 레퍼런스 문서는 친절하지 않다. 
• 몇몇 다른 블로그 글들에서 WebView 예제 코드를 보면, setAppCacheEnabled(false) 코드는 캐시를 사용하지 않겠다는 목적으로 썼음을 주석으로 알려준다. 나도 처음에는 setAppCacheEnabled()가 캐시 미사용/사용을 설정하는 목적으로 쓰이는 줄 알았는데(메소드 이름만 보면 그렇게 기능을 유추하게 된다), 헤메고 헤메는 과정을 통해서 실제로는 AppCache API의 활성화 설정 기능임을 알게 됐다. 정말 웹 캐시 기능을 사용하고 싶지 않다면, setAppCacheEnabled(false)에 setCacheMode(LOAD_NO_CACHE)까지 써 주는 게 확실히 동작하는 예제인 것 같다. 
• 위에서 살펴본 스택오버플로우 글 https://stackoverflow.com/a/17429301에서 setCacheMode()를 쓰는 것만으로 충분하다고 했다. 이는 setCacheMode와 setAppCacheEnabled의 기능 차이를 명확히 알고 있기 때문에 할 수 있는 언급인 것 같다.

 

코드 수정

이전 담당자는 어떤 기능을 원해서 setAppCacheEnable(false), setAppCacheEnable(true) 코드를 넣었을지 유추하고 코드 수정을 해야겠다. 정말 AppCache API를 사용하고자/사용하지 않고자 썼는지, 웹뷰 캐시를 사용하고자/사용하지 않고자 썼는지를 파악해야 할 듯 하다. 

 

setAppCacheEnabled(false)

일단 setAppCacheEnabled(false)의 코드를 쓴 의도는 무엇이었을까. 해당 코드가 쓰인 웹뷰 화면들은 공통 웹뷰들이다. 예를 하나 들자면, 공지 리스트에서 항목을 선택하면 해당 공지에 맞는 url을 로드해 보여주는 웹뷰이다. 이러한 특성이라면 캐시를 쓰고 싶지 않았던 것 같다. setCacheMode(LOAD_NO_CACHE) 코드는 보이지 않는다. 

setAppCacheEnabled(false) 코드를 그냥 지우는 것으로 끝나도 된다. 왜나하면 실제로 기본 캐시 모드로 웹뷰는 쓰이고 있었을 테니 말이다. 저 코드를 지우든 지우지 않든, 앱뷰 내부 캐시 동작은 변경사항이 없다. 

 

setAppCacheEnabled(false)를 쓰지 않아도, 원래 기본 설정으로 App Cache API는 비활성화되어 있다는 것이 setAppCacheEnabled()의 주석 내용이다. 이전 담당자가 정말 App Cache API를 비활성화하고 싶어서 해당 코드를 쓴 것이 아니라, 웹 캐시를 사용하고 싶지 않아서 해당 메소드를 이름만 보고 썼다고 유추하는 것이 맞는 것 같다. setAppCacheEnabled(false)는 지우고, setCacheMode(LOAD_NO_CACHE)를 추가하기로 했다.

 

setAppCacheEnabled(true)

setAppCacheEnabled(true)를 쓴 코드를 확인했다. 결제 웹뷰 페이지이고, setAppCachePath() 코드도 작성되어 있어서, AppCache API를 제대로 활성화시켰다. setCacheMode() 코드는 없다. LOAD_DEFAULT 모드로 동작하고 있었겠다.

AppCache가 없어도 결제 기능들이 제대로 돌아가는 게 맞겠지만, 불안한 마음에 다른 웹뷰 결제 예제 코드들을 좀 살펴봤다.

https://developers.nicepay.co.kr/manual-app.php

Manual

https://shopby.works/guide/skin/dev-cover/app-payment-module?lv=11 

워크스페이스 | NHN커머스

 

두 예제 다 setAppCacheEnabled() 는 쓰지도 않고, 기본 Cache 모드를 쓰는 것을 권장하는 듯 하다.

 

그럼, AppCache API 관련 코드들을 지워주는 것만으로 수정은 충분한 것 같다.

 

물론 수정한 코드에 대해 테스트는 필수이고.

 

구글링하다가 찾게된 것

웹 캐시

https://cyberx.tistory.com/9

더 빠른 웹을 위하여 - 웹 캐쉬 (WEB CACHE)