Widget 알아보기(1) - 위젯에서 위치 정보 받기

https://github.com/kimmandoo/android-drill/tree/main/Widget

android-drill/Widget at main · kimmandoo/android-drill

위젯을 한 번 알아보자, 이번에 학습해보면서 기록한 레포지토리라서 계속 변경될 가능성이 있다.

https://developer.android.com/develop/ui/views/appwidgets?hl=ko

간단한 위젯 만들기  |  Views  |  Android Developers

일단 이걸 토대로 입문해봤다. 

 

위젯은 홈화면에서 접근할 수 있는 앱의 remote view라고 생각해야된다. 앱과는 다른 생명주기를 가지며 바로가기의 특성을 가짐과 동시에 위젯만의 생명주기를 갖고있기 때문에 앱에 있는 중요한 기능을 따로 위젯에서 작업할 수 있다.

 

크게 4가지 종류로 구분하는 것 같다.

• 정보
• 컬렉션
• 관리
• 하이브리드 

자세한 정보는 공식문서에 들어가면 나온다. 현재 위치에서 어떤 목적지까지의 걸리는 시간같은 걸 표시하려면 정보위젯이 적절하다고 생각한다. 대표적으로 날씨 위젯이 정보 위젯에 해당한다. 근데 공부를 좀 해보니 위치를 적극적으로 사용하려면 아래 페이지를 좀 더 살펴봐야될 것으로 보인다.

https://developer.android.com/about/versions/oreo/background-location-limits?hl=ko

백그라운드 위치 제한  |  Android Developers

# `AppWidgetProviderInfo`, `AppWidgetProvider`

위젯은 2가지 구성요소가 `필수`다. AppWidgetProviderInfo랑 AppWidgetProvider다. xml로 정의된 Info와 브로드캐스드 리시버를 상속받는 Provider로 나뉘고, Info는 Provider를 포함해서 위젯의 메타데이터를 설명하는 객체다. xml로 작성하는 객체라서 좀 어색했다.

`res/xml` 밑에 Info 객체를 만들어줘야된다.

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:initialKeyguardLayout="@layout/widget_layout"
    android:initialLayout="@layout/widget_layout"
    android:minWidth="40dp"
    android:minHeight="40dp"
    android:previewImage="@drawable/ic_launcher_foreground"
    android:resizeMode="horizontal|vertical"
    android:updatePeriodMillis="86400000"
    android:widgetCategory="home_screen">
</appwidget-provider>

말그대로 속성을 다 적어둔 것인데, 홈화면에 배치할 수 있는 위젯이고 갱신 주기는 24시간이다. (24*60*60*1000ms)

Android 12(21년 8월에 정식 출시 된 OS 버전이라 생각보다 최신이다.)부터는 Cell 개념으로 위젯을 배치할 수 있기 때문에 `targetCellWidth`, `targetCellHeight`를 조절해서 몇칸 차지하게 할 건지 더 명확하게 지정할 수 있다. 참고로 이 Cell 기준이 minWidth, Height 보다 우선순위가 높은데 아직 12 밑 버전도 상당수라 꼭 둘다 선언해줘야된다.

 

다크모드같은 시스템 설정을 따라가게 하는 속성도 있다.

android:widgetFeatures="widgetFeatures=reconfigurable|configuration_optional"

 

위에서 `AppWidgetProvider`는 브로드캐스트 리시버를 상속받은 클래스라고 했다. 그 말은 매니페스트 파일에 리시버를 선언해줘야된다는 말과 동일하다.

<receiver android:name=".MyWidgetProvider" android:exported="false">
    <intent-filter>
        <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
    </intent-filter>
    <meta-data
        android:name="android.appwidget.provider"
        android:resource="@xml/widget_info" />
</receiver>

 따로 만들어둔 Provider 클래스를 지정해서 receiver 선언 해준다. 메타데이터를 설정하는 info 객체 역시같이 달아줘야한다.

 

이제 Provider 클래스를 보자.

private const val TAG = "MyWidgetProvider"
class MyWidgetProvider : AppWidgetProvider() {
    override fun onReceive(context: Context?, intent: Intent?) {
        super.onReceive(context, intent)
    }

    override fun onUpdate(
        context: Context?,
        appWidgetManager: AppWidgetManager?,
        appWidgetIds: IntArray?
    ) {
        super.onUpdate(context, appWidgetManager, appWidgetIds)
        Log.d(TAG, "onUpdate: ")
    }

    override fun onAppWidgetOptionsChanged(
        context: Context?,
        appWidgetManager: AppWidgetManager?,
        appWidgetId: Int,
        newOptions: Bundle?
    ) {
        super.onAppWidgetOptionsChanged(context, appWidgetManager, appWidgetId, newOptions)
        Log.d(TAG, "onAppWidgetOptionsChanged: ")
    }

    override fun onDeleted(context: Context?, appWidgetIds: IntArray?) {
        super.onDeleted(context, appWidgetIds)
        Log.d(TAG, "onDeleted: ")
    }

    override fun onEnabled(context: Context?) {
        super.onEnabled(context)
        Log.d(TAG, "onEnabled: ")
    }

    override fun onDisabled(context: Context?) {
        super.onDisabled(context)
        Log.d(TAG, "onDisabled: ")
    }

    override fun onRestored(context: Context?, oldWidgetIds: IntArray?, newWidgetIds: IntArray?) {
        super.onRestored(context, oldWidgetIds, newWidgetIds)
        Log.d(TAG, "onRestored: ")
    }

    companion object {
        internal fun updateAppWidget(context: Context, appWidgetManager: AppWidgetManager, appWidgetId: Int) {
            val views = RemoteViews(context.packageName, R.layout.widget_layout)
            appWidgetManager.updateAppWidget(appWidgetId, views)
        }
    }
}

생명주기에 로그를 찍어보고 직접 경험해보니 앱의 실행과 독립되어 실행되는 게 신기했다. 일단 홈화면에 위젯을 생성하고 나면 `onUpdate`가 위젯 사이즈 변경같은 상황에서 호출된다. 정확히는 업데이트, 삭제, 설정, 중지와 같은 브로드캐스트 이벤트를 수신한다고 봐야된다.

 

처음 생성할 때는 `onEnabled`로 시작해서 -> `onUpdate` -> `onAppWidgetOptionsChanged` -> `onDeleted` -> `onDisabled` 로 구성된다. `onReceive`는 모든 브로드캐스트와 위 콜백함수들을 호출하기전에 호출되는데 따로 건드릴 필요는 없어보인다. 중요한건 이 콜백함수들이 메인스레드에서 실행된 다는 점이다. 그래서 메인스레드에서 하면 안됐던 작업들은 위젯에서도 하면 안된다.

 

Info 객체의 updatePeriodMillis 주기마다 `onUpdate`가 호출된다. 최소값이 30분으로 정해져있는 듯 하고, 이거보다 더 빠른 주기를 원하면 WorkManager를 사용해야될 것으로 보인다.

https://developer.android.com/develop/ui/views/appwidgets/advanced?hl=ko#periodic

고급 위젯 만들기  |  Views  |  Android Developers

 

onUpdate가 사실 위젯에서 가장 중요한 콜백함수다. 모든 상호작용이 이 콜백을 타기 때문인데, 그래서 DB작업같은 백그라운드 작업이 아닌경우에는 이 콜백함수에서 다 처리한다고 한다.

 

위젯은 `RemoteView`에 기반하는데 생각보다 많은 뷰들을 제공하고 있어(커스텀뷰는 안된다.) 나중에 직접 하나씩 해보면 될 것 같다. 나는 일단 FrameLayout으로 잡고 텍스트뷰만 하나 넣어놔서 아직 RemoteView로 뭘 할 수 있는 지 감이 안온다. 

지원되는 레이아웃, 뷰들이다. 

# 위치정보랑 엮어보려면?

위치기반 서비스의 일부분으로 위젯을 생각했던 것이라서 이게 제일 중요하다.

onUpdate에서 처리하면 된다고는 하지만, 브로드캐스트 리시버를 상속받은 특징이 그대로 살아있어서 onUpdate가 호출되고 나서 프로세스가 살아있다는 보장이없다. 

되긴 되는데 인터벌(약 10분)이 좀 심하고 기준이 뭔지를 모르겠다.

이 부분 때문에 요청이 엄청 늦는 것으로 보인다... `FLP`로 전환하는 방법을 또 찾아봐야겠다.

private const val TAG = "MyWidgetProvider"
class MyWidgetProvider : AppWidgetProvider() {

    private lateinit var fusedLocationClient: FusedLocationProviderClient

    override fun onReceive(context: Context?, intent: Intent?) {
        super.onReceive(context, intent)
    }

    override fun onUpdate(
        context: Context?,
        appWidgetManager: AppWidgetManager?,
        appWidgetIds: IntArray?
    ) {
        super.onUpdate(context, appWidgetManager, appWidgetIds)
        Log.d(TAG, "onUpdate: ")
        fusedLocationClient = LocationServices.getFusedLocationProviderClient(context!!)

        val locationRequest = LocationRequest.create().apply {
            interval = 1000
            fastestInterval = 500
            priority = LocationRequest.PRIORITY_HIGH_ACCURACY
        }

        val locationCallback = object : LocationCallback() {
            override fun onLocationResult(locationResult: LocationResult) {
                locationResult.lastLocation?.let { location ->
                    // 위치 정보를 사용하여 위젯 업데이트
                    Log.d(TAG, "onLocationResult: ${location}")
                }
            }
        }

        // 위치 업데이트 요청
        if (ContextCompat.checkSelfPermission(context, Manifest.permission.ACCESS_FINE_LOCATION) == PackageManager.PERMISSION_GRANTED) {
            fusedLocationClient.requestLocationUpdates(locationRequest, locationCallback, Looper.getMainLooper())
        }
    }

    override fun onAppWidgetOptionsChanged(
        context: Context?,
        appWidgetManager: AppWidgetManager?,
        appWidgetId: Int,
        newOptions: Bundle?
    ) {
        super.onAppWidgetOptionsChanged(context, appWidgetManager, appWidgetId, newOptions)
        Log.d(TAG, "onAppWidgetOptionsChanged: ")
    }

    companion object {
        internal fun updateAppWidget(context: Context, appWidgetManager: AppWidgetManager, appWidgetId: Int) {
            val views = RemoteViews(context.packageName, R.layout.widget_layout)
            appWidgetManager.updateAppWidget(appWidgetId, views)
        }
    }
}

 

도움이 됐다면 댓글이나 공감 버튼 한 번씩 누르고 가주세요!