간단한 위젯 만들기

앱 위젯은 다른 앱(예: 홈 화면)에 삽입하여 주기적인 업데이트를 받을 수 있는 소형 앱 뷰입니다. 이러한 뷰는 사용자 인터페이스에서 위젯이라고 하며, 앱 위젯 제공자 (또는 위젯 제공자)를 사용해 게시할 수 있습니다. 다른 위젯을 보유하는 앱 구성요소를 앱 위젯 호스트 (또는 위젯 호스트)라고 합니다. 그림 1은 샘플 음악 위젯을 보여줍니다.

이 문서에서는 위젯 제공자를 사용하여 위젯을 게시하는 방법을 설명합니다. 자체 AppWidgetHost를 만들어 앱 위젯을 호스팅하는 방법에 관한 자세한 내용은 위젯 호스트 빌드를 참고하세요.

위젯을 디자인하는 방법에 관한 자세한 내용은 앱 위젯 개요를 참고하세요.

위젯 구성요소

위젯을 만들려면 다음 기본 구성요소가 필요합니다.

AppWidgetProviderInfo 객체

위젯의 레이아웃, 업데이트 빈도, AppWidgetProvider 클래스와 같은 위젯의 메타데이터를 설명합니다. AppWidgetProviderInfo는 이 문서에 설명된 대로 XML로 정의됩니다.

AppWidgetProvider 클래스

위젯과 프로그래매틱 방식으로 상호작용할 수 있는 기본 메서드를 정의합니다. 이를 통해 위젯이 업데이트, 사용 설정, 사용 중지 또는 삭제될 때 브로드캐스트를 수신합니다. 매니페스트에서 AppWidgetProvider를 선언한 다음 이 문서에 설명된 대로 구현합니다.

레이아웃 보기

위젯의 초기 레이아웃을 정의합니다. 레이아웃은 이 문서에 설명된 대로 XML로 정의됩니다.

그림 2는 이러한 구성요소가 전체 앱 위젯 처리 흐름에 어떻게 부합하는지 보여줍니다.

위젯에 사용자 구성이 필요한 경우 앱 위젯 구성 활동을 구현합니다. 이 활동을 통해 사용자는 위젯 설정(예: 시계 위젯의 시간대)을 수정할 수 있습니다.

• Android 12 (API 수준 31)부터 기본 구성을 제공하고 사용자가 나중에 위젯을 재구성하도록 허용할 수 있습니다. 자세한 내용은 위젯의 기본 구성 사용 및 사용자가 배치된 위젯을 재구성할 수 있도록 사용 설정을 참고하세요.
• Android 11 (API 수준 30) 이하에서는 사용자가 홈 화면에 위젯을 추가할 때마다 이 활동이 실행됩니다.

또한 유연한 위젯 레이아웃, 기타 개선사항, 고급 위젯, 컬렉션 위젯, 위젯 호스트 빌드와 같은 개선사항이 권장됩니다.

AppWidgetProviderInfo XML 선언

AppWidgetProviderInfo 객체는 위젯의 필수 특성을 정의합니다. 단일 <appwidget-provider> 요소를 사용하여 XML 리소스 파일에 AppWidgetProviderInfo 객체를 정의하고 프로젝트의 res/xml/ 폴더에 저장합니다.

예를 들면 다음과 같습니다.

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:minWidth="40dp"
    android:minHeight="40dp"
    android:targetCellWidth="1"
    android:targetCellHeight="1"
    android:maxResizeWidth="250dp"
    android:maxResizeHeight="120dp"
    android:updatePeriodMillis="86400000"
    android:description="@string/example_appwidget_description"
    android:previewLayout="@layout/example_appwidget_preview"
    android:initialLayout="@layout/example_loading_appwidget"
    android:configure="com.example.android.ExampleAppWidgetConfigurationActivity"
    android:resizeMode="horizontal|vertical"
    android:widgetCategory="home_screen"
    android:widgetFeatures="reconfigurable|configuration_optional">
</appwidget-provider>

위젯 크기 속성

기본 홈 화면은 높이와 너비가 정의된 셀의 그리드를 기반으로 창에 위젯을 배치합니다. 대부분의 홈 화면에서는 위젯이 그리드 셀의 정수 배수(예: 가로로 2개 셀, 세로 셀 세 개)만 사용할 수 있습니다.

위젯 크기 조정 속성을 사용하면 위젯의 기본 크기를 지정하고 위젯 크기의 하한 및 상한을 제공할 수 있습니다. 이 컨텍스트에서 위젯의 기본 크기는 위젯이 홈 화면에 처음 추가될 때 사용되는 크기입니다.

다음 표에서는 위젯 크기 조정과 관련된 <appwidget-provider> 속성을 설명합니다.

예

위 표의 속성이 위젯 크기에 어떤 영향을 미치는지 보여주기 위해 다음 사양을 가정하겠습니다.

• 그리드 셀의 너비는 30dp, 높이는 50dp입니다.
• 다음과 같은 속성 사양이 제공됩니다.

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:minWidth="80dp"
    android:minHeight="80dp"
    android:targetCellWidth="2"
    android:targetCellHeight="2"
    android:minResizeWidth="40dp"
    android:minResizeHeight="40dp"
    android:maxResizeWidth="120dp"
    android:maxResizeHeight="120dp"
    android:resizeMode="horizontal|vertical" />

Android 12부터:

targetCellWidth 및 targetCellHeight 속성을 위젯의 기본 크기로 사용합니다.

위젯의 크기는 기본적으로 2x2입니다. 위젯은 2x1 또는 최대 4x3까지 크기를 조절할 수 있습니다.

Android 11 이하:

위젯의 기본 크기를 계산하려면 minWidth 및 minHeight 속성을 사용합니다.

기본 너비 = Math.ceil(80 / 30) = 3

기본 높이 = Math.ceil(80 / 50) = 2

위젯의 크기는 기본적으로 3x2입니다. 위젯은 2x1 또는 전체 화면까지 크기를 조절할 수 있습니다.

추가 위젯 속성

다음 표에서는 위젯 크기 조정 외의 품질과 관련된 <appwidget-provider> 속성을 설명합니다.

AppWidgetProvider 클래스를 사용하여 위젯 브로드캐스트 처리

AppWidgetProvider 클래스는 위젯 브로드캐스트를 처리하고 위젯 수명 주기 이벤트에 응답하여 위젯을 업데이트합니다. 다음 섹션에서는 매니페스트에서 AppWidgetProvider를 선언하고 구현하는 방법을 설명합니다.

매니페스트에서 위젯 선언

먼저 다음 예와 같이 앱의 AndroidManifest.xml 파일에서 AppWidgetProvider 클래스를 선언합니다.

<receiver android:name="ExampleAppWidgetProvider"
                 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/example_appwidget_info" />
</receiver>

<receiver> 요소에는 위젯에서 사용하는 AppWidgetProvider를 지정하는 android:name 속성이 필요합니다. 별도의 프로세스가 AppWidgetProvider에 브로드캐스트해야 하는 경우가 아니면 구성요소는 내보내면 안 됩니다(일반적으로는 그렇지 않음).

<intent-filter> 요소는 android:name 속성을 가진 <action> 요소를 포함해야 합니다. 이 속성은 AppWidgetProvider가 ACTION_APPWIDGET_UPDATE 브로드캐스트를 허용함을 지정합니다. 이 브로드캐스트만 명시적으로 선언하면 됩니다. AppWidgetManager는 필요에 따라 다른 모든 위젯 브로드캐스트를 자동으로 AppWidgetProvider로 전송합니다.

<meta-data> 요소는 AppWidgetProviderInfo 리소스를 지정하며 다음 속성이 필요합니다.

• android:name: 메타데이터 이름을 지정합니다. android.appwidget.provider를 사용하여 데이터를 AppWidgetProviderInfo 설명어로 식별합니다.
• android:resource: AppWidgetProviderInfo 리소스 위치를 지정합니다.

AppWidgetProvider 클래스 구현

AppWidgetProvider 클래스는 위젯 브로드캐스트를 처리하기 위한 편의 클래스로 BroadcastReceiver를 확장합니다. 위젯이 업데이트, 삭제, 사용 설정, 사용 중지될 때와 같이 위젯과 관련된 이벤트 브로드캐스트만 수신합니다. 이러한 브로드캐스트 이벤트가 발생하면 다음 AppWidgetProvider 메서드가 호출됩니다.

onUpdate()

이 메서드는 AppWidgetProviderInfo의 updatePeriodMillis 속성으로 정의된 간격으로 위젯을 업데이트하기 위해 호출됩니다. 자세한 내용은 이 페이지의 추가 위젯 속성 설명 표를 참고하세요.

이 메서드는 사용자가 위젯을 추가할 때도 호출되므로 View 객체의 이벤트 핸들러를 정의하거나 위젯에 표시할 데이터를 로드하는 작업을 시작하는 등의 필수 설정을 실행합니다. 그러나 configuration_optional 플래그 없이 구성 활동을 선언하면 이 메서드는 사용자가 위젯을 추가할 때 호출되지 않지만 후속 업데이트에서는 호출됩니다. 구성이 완료된 경우 구성 활동에서 첫 번째 업데이트를 실행해야 합니다. 자세한 내용은 사용자가 앱 위젯을 구성할 수 있도록 설정을 참조하세요.

가장 중요한 콜백은 onUpdate()입니다. 자세한 내용은 이 페이지의 onUpdate() 클래스로 이벤트 처리를 참고하세요.

onAppWidgetOptionsChanged()

위젯이 처음 배치될 때와 위젯의 크기가 조절될 때마다 호출됩니다. 위젯의 크기 범위를 기반으로 콘텐츠를 표시하거나 숨기려면 이 콜백을 사용합니다. 다음을 포함하는 Bundle를 반환하는 getAppWidgetOptions()를 호출하여 크기 범위(및 Android 12부터는 위젯 인스턴스가 사용할 수 있는 크기 목록)를 가져옵니다.

• OPTION_APPWIDGET_MIN_WIDTH: 위젯 인스턴스 너비의 하한값을 dp 단위로 포함합니다.
• OPTION_APPWIDGET_MIN_HEIGHT: 위젯 인스턴스 높이의 하한값을 dp 단위로 포함합니다.
• OPTION_APPWIDGET_MAX_WIDTH: 위젯 인스턴스 너비의 상한값을 dp 단위로 포함합니다.
• OPTION_APPWIDGET_MAX_HEIGHT: 위젯 인스턴스 높이의 상한값을 dp 단위로 포함합니다.
• OPTION_APPWIDGET_SIZES: 위젯 인스턴스에서 사용할 수 있는 dp 단위의 가능한 크기 목록 (List<SizeF>)을 포함합니다. Android 12에서 도입되었습니다.

onDeleted(Context, int[])

위젯 호스트에서 위젯이 삭제될 때마다 호출됩니다.

onEnabled(Context)

이 메서드는 위젯 인스턴스가 처음 생성될 때 호출됩니다. 예를 들어 사용자가 위젯 인스턴스를 두 개 추가하는 경우 이 작업은 처음에만 호출됩니다. 새 데이터베이스를 열거나 모든 위젯 인스턴스에 한 번만 실행되어야 하는 다른 설정을 실행해야 하는 경우 여기에서 실행하는 것이 좋습니다.

onDisabled(Context)

이 메서드는 위젯의 마지막 인스턴스가 위젯 호스트에서 삭제될 때 호출됩니다. 여기에서 임시 데이터베이스 삭제와 같이 onEnabled(Context)에서 실행된 모든 작업을 삭제합니다.

onReceive(Context, Intent)

모든 브로드캐스트와 이전의 각 콜백 메서드 전에 호출됩니다. 일반적으로 이 메서드는 구현하지 않아도 됩니다. 기본 AppWidgetProvider 구현이 모든 위젯 브로드캐스트를 필터링하고 적절한 이전 메서드를 호출하기 때문입니다.

AndroidManifest에서 <receiver> 요소를 사용하여 AppWidgetProvider 클래스 구현을 broadcast receiver로 선언해야 합니다. 자세한 내용은 이 페이지의 매니페스트에서 위젯 선언을 참고하세요.

onUpdate() 클래스로 이벤트 처리

가장 중요한 AppWidgetProvider 콜백은 onUpdate()입니다. configuration_optional 플래그 없이 구성 활동을 사용하지 않는 한 각 위젯이 호스트에 추가될 때 호출되기 때문입니다. 위젯이 사용자 상호작용 이벤트를 허용하는 경우 이 콜백에 이벤트 핸들러를 등록합니다. 위젯이 임시 파일 또는 데이터베이스를 만들지 않거나 정리가 필요한 다른 작업을 실행하지 않는 경우 onUpdate() 콜백 메서드만 정의해야 할 수 있습니다.

예를 들어, 눌렀을 때 활동을 실행하는 버튼이 있는 위젯을 원하는 경우 다음과 같은 AppWidgetProvider 구현을 사용하면 됩니다.

class ExampleAppWidgetProvider : AppWidgetProvider() {

    override fun onUpdate(
            context: Context,
            appWidgetManager: AppWidgetManager,
            appWidgetIds: IntArray
    ) {
        // Perform this loop procedure for each widget that belongs to this
        // provider.
        appWidgetIds.forEach { appWidgetId ->
            // Create an Intent to launch ExampleActivity.
            val pendingIntent: PendingIntent = PendingIntent.getActivity(
                    /* context = */ context,
                    /* requestCode = */  0,
                    /* intent = */ Intent(context, ExampleActivity::class.java),
                    /* flags = */ PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
            )

            // Get the layout for the widget and attach an onClick listener to
            // the button.
            val views: RemoteViews = RemoteViews(
                    context.packageName,
                    R.layout.appwidget_provider_layout
            ).apply {
                setOnClickPendingIntent(R.id.button, pendingIntent)
            }

            // Tell the AppWidgetManager to perform an update on the current
            // widget.
            appWidgetManager.updateAppWidget(appWidgetId, views)
        }
    }
}

public class ExampleAppWidgetProvider extends AppWidgetProvider {

    public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
        // Perform this loop procedure for each widget that belongs to this
        // provider.
        for (int i=0; i < appWidgetIds.length; i++) {
            int appWidgetId = appWidgetIds[i];
            // Create an Intent to launch ExampleActivity
            Intent intent = new Intent(context, ExampleActivity.class);
            PendingIntent pendingIntent = PendingIntent.getActivity(
                /* context = */ context,
                /* requestCode = */ 0,
                /* intent = */ intent,
                /* flags = */ PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE
            );

            // Get the layout for the widget and attach an onClick listener to
            // the button.
            RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.example_appwidget_layout);
            views.setOnClickPendingIntent(R.id.button, pendingIntent);

            // Tell the AppWidgetManager to perform an update on the current app
            // widget.
            appWidgetManager.updateAppWidget(appWidgetId, views);
        }
    }
}

이 AppWidgetProvider는 onUpdate() 메서드만 정의하며, 이 메서드를 사용하여 Activity를 실행하고 setOnClickPendingIntent(int, PendingIntent)를 사용하여 위젯의 버튼에 연결하는 PendingIntent를 만듭니다. 여기에는 appWidgetIds의 각 항목을 반복하는 루프가 포함됩니다. 이는 이 제공업체에서 만든 각 위젯을 식별하는 ID의 배열입니다. 사용자가 위젯 인스턴스를 두 개 이상 만들면 모두 동시에 업데이트됩니다. 그러나 위젯의 모든 인스턴스에서 하나의 updatePeriodMillis 일정만 관리됩니다. 예를 들어 업데이트 일정이 2시간마다 정의되고 위젯의 두 번째 인스턴스가 첫 번째 인스턴스로부터 1시간 후에 추가되면 첫 번째 인스턴스에서 정의된 기간에 모두 업데이트되고 두 번째 업데이트 기간은 무시됩니다. 둘 다 1시간이 아니라 2시간마다 업데이트됩니다.

자세한 내용은 ExampleAppWidgetProvider.java 샘플 클래스를 참고하세요.

위젯 브로드캐스트 인텐트 수신

AppWidgetProvider는 편의 클래스입니다. 위젯 브로드캐스트를 직접 수신하려면 자체 BroadcastReceiver를 구현하거나 onReceive(Context,Intent) 콜백을 재정의하면 됩니다. 주의해야 하는 인텐트는 다음과 같습니다.

• ACTION_APPWIDGET_UPDATE
• ACTION_APPWIDGET_DELETED
• ACTION_APPWIDGET_ENABLED
• ACTION_APPWIDGET_DISABLED
• ACTION_APPWIDGET_OPTIONS_CHANGED

위젯 레이아웃 만들기

위젯의 초기 레이아웃을 XML로 정의하고 프로젝트의 res/layout/ 디렉터리에 저장해야 합니다. 자세한 내용은 디자인 가이드라인을 참고하세요.

레이아웃에 익숙하다면 위젯 레이아웃을 만드는 방법은 간단합니다. 그러나 위젯 레이아웃은 모든 종류의 레이아웃 또는 뷰 위젯을 지원하지는 않는 RemoteViews에 기반합니다. RemoteViews에서 지원하는 뷰의 맞춤 뷰나 서브클래스는 사용할 수 없습니다.

RemoteViews는 런타임 시 레이아웃 리소스를 지연 확장하는 데 사용할 수 있는, 크기가 0인 보이지 않는 View인 ViewStub도 지원합니다.

스테이트풀(Stateful) 동작 지원

Android 12에서는 다음 기존 구성요소를 사용하여 스테이트풀(Stateful) 동작 지원을 추가합니다.

• CheckBox

• Switch

• RadioButton

위젯은 여전히 스테이트리스(Stateless)입니다. 앱은 상태를 저장하고 상태 변경 이벤트에 등록해야 합니다.

다음 코드 예는 이러한 구성요소를 구현하는 방법을 보여줍니다.

// Check the view.
remoteView.setCompoundButtonChecked(R.id.my_checkbox, true)

// Check a radio group.
remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2)

// Listen for check changes. The intent has an extra with the key
// EXTRA_CHECKED that specifies the current checked state of the view.
remoteView.setOnCheckedChangeResponse(
        R.id.my_checkbox,
        RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent)
)

// Check the view.
remoteView.setCompoundButtonChecked(R.id.my_checkbox, true);

// Check a radio group.
remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2);

// Listen for check changes. The intent has an extra with the key
// EXTRA_CHECKED that specifies the current checked state of the view.
remoteView.setOnCheckedChangeResponse(
    R.id.my_checkbox,
    RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent));

두 개의 레이아웃을 제공합니다. 하나는 res/layout-v31에서 Android 12 이상을 실행하는 기기를 타겟팅하고 다른 하나는 기본 res/layout 폴더에서 이전 Android 11 이하를 타겟팅하는 것입니다.

둥근 모서리 구현

Android 12에서는 위젯의 둥근 모서리 반경을 설정하는 다음 시스템 매개변수를 도입합니다.

• system_app_widget_background_radius: 위젯 배경의 모서리 반경으로, 28dp를 넘지 않습니다.

• system_app_widget_inner_radius: 위젯 내 뷰의 모서리 반경입니다. 이는 8dp 패딩을 사용할 때 잘 정렬되도록 배경 반경보다 정확히 8dp 작습니다.

다음 예는 위젯 모서리에 system_app_widget_background_radius를 사용하고 위젯 내부 뷰에 system_app_widget_inner_radius를 사용하는 위젯을 보여줍니다.

1 위젯의 모서리

2 위젯 내부의 뷰 모서리

둥근 모서리 관련 중요 고려사항

• 서드 파티 런처 및 기기 제조업체는 system_app_widget_background_radius 매개변수를 28dp 미만으로 재정의할 수 있습니다. system_app_widget_inner_radius 매개변수는 항상 system_app_widget_background_radius 값보다 8dp 작습니다.
• 위젯이 @android:id/background를 사용하지 않거나 윤곽선에 따라 콘텐츠를 자르는 배경을 정의하지 않는 경우(android:clipToOutline를 true로 설정) 런처는 자동으로 배경을 식별하고 모서리가 최대 16dp까지 둥근 직사각형을 사용하여 위젯을 자릅니다. 위젯이 Android 12와 호환되는지 확인을 참고하세요.

이전 버전의 Android와 위젯 호환성을 위해 다음 샘플 XML 파일과 같이 맞춤 속성을 정의하고 맞춤 테마를 사용하여 Android 12용으로 재정의하는 것이 좋습니다.

<resources>
  <attr name="backgroundRadius" format="dimension" />
</resources>

<resources>
  <style name="MyWidgetTheme">
    <item name="backgroundRadius">@dimen/my_background_radius_dimen</item>
  </style>
</resources>

<resources>
  <style name="MyWidgetTheme" parent="@android:style/Theme.DeviceDefault.DayNight">
    <item name="backgroundRadius">@android:dimen/system_app_widget_background_radius</item>
  </style>
</resources>

<shape xmlns:android="http://schemas.android.com/apk/res/android"
  android:shape="rectangle">
  <corners android:radius="?attr/backgroundRadius" />
  ...
</shape>

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
  ...
  android:background="@drawable/my_widget_background" />