간단한 위젯 만들기

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

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

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

위젯 구성요소

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

AppWidgetProviderInfo 객체

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

AppWidgetProvider 클래스

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

레이아웃 보기

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

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

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

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

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

AppWidgetProviderInfo XML 선언

AppWidgetProviderInfo 객체는 위젯의 필수 품질을 정의합니다. XML 리소스 파일에서 단일 <appwidget-provider> 요소를 사용하여 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개, 세로 3개).

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

다음 표에서는 위젯 크기 조정에 관한 <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: 메타데이터 이름을 지정합니다. 데이터를 AppWidgetProviderInfo 설명자로 표시하려면 android.appwidget.provider를 사용하세요.
• android:resource: AppWidgetProviderInfo 리소스 위치를 지정합니다.

AppWidgetProvider 클래스 구현

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

onUpdate()

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

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

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

onAppWidgetOptionsChanged()

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

• OPTION_APPWIDGET_MIN_WIDTH: 위젯 인스턴스의 너비 하한값을 dp 단위로 포함합니다.
• OPTION_APPWIDGET_MIN_HEIGHT: 위젯 인스턴스 높이의 하한값을 dp 단위로 포함합니다.
• OPTION_APPWIDGET_MAX_WIDTH: 위젯 인스턴스의 너비 상한값을 dp 단위로 포함합니다.
• OPTION_APPWIDGET_MAX_HEIGHT: 위젯 인스턴스의 높이 상한값을 dp 단위로 포함합니다.
• OPTION_APPWIDGET_SIZES: 위젯 인스턴스가 사용할 수 있는 크기 (List<SizeF>) 목록을 dp 단위로 포함합니다. 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를 만듭니다. 여기에는 이 제공자가 만든 각 위젯을 나타내는 ID의 배열인 appWidgetIds의 각 항목을 통해 반복되는 루프가 포함됩니다. 사용자가 위젯 인스턴스를 두 개 이상 만들면 모두 동시에 업데이트됩니다. 하지만 위젯의 모든 인스턴스에 하나의 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" />