lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

설정

애플리케이션에는 흔히 사용자가 앱 기능과 동작을 수정할 수 있는 설정이 포함되어 있습니다. 예를 들어 몇몇 앱은 사용자에게 알림을 활성화할지 여부를 지정하거나 애플리케이션이 클라우드와 데이터를 동기화할 빈도를 지정할 수 있게 해줍니다.

자신의 앱에 설정을 제공하고자 하는 경우, Android의 Preference API를 사용하여 다른 Android 앱(시스템 설정 포함)의 사용자 환경과 일관성을 유지하는 인터페이스를 구축할 수 있게 해야 합니다. 이 문서에서는 Preference API를 사용하여 앱 설정을 구축하는 방법을 설명합니다.

설정 디자인

설정을 디자인하는 방법에 관련된 정보는 설정 디자인 가이드를 읽어보세요.

그림 1. Android 메시지 앱의 설정에서 가져온 스크린샷. Preference가 정의한 항목을 선택하면 인터페이스가 열려 설정을 변경할 수 있게 됩니다.

개요

사용자 인터페이스를 구축할 때에는 View 객체를 사용하지만, 설정은 그 대신 Preference 클래스의 다양한 서브클래스를 사용하여 구축합니다. 이와 같은 서브클래스는 XML 파일에서 선언합니다.

Preference 객체는 하나의 설정을 이루는 기본 단위입니다. 각각의 Preference는 목록의 항목으로 나타나며 사용자가 설정을 수정하기에 적절한 UI를 제공합니다. 예를 들어 CheckBoxPreference는 체크박스를 표시하는 목록 항목을 만들고, ListPreference는 선택 목록이 있는 대화상자를 여는 항목을 만듭니다.

각각의 Preference를 추가할 때마다 상응하는 키-값 쌍이 있어 시스템이 이를 사용하여 해당 설정을 앱의 설정에 대한 기본 SharedPreferences 파일에 저장합니다. 사용자가 설정을 변경하면 시스템이 SharedPreferences 파일에 있는 상응하는 값을 개발자 대신 업데이트합니다. 개발자가 직접 연관된 SharedPreferences 파일과 상호작용을 해야 하는 경우는 사용자의 설정을 기반으로 앱의 동작을 결정하기 위해 값을 읽어야 할 때뿐입니다.

각 설정에 대하여 SharedPreferences에 저장된 값은 다음과 같은 데이터 유형 중 한 가지를 취할 수 있습니다.

  • 부울
  • Float
  • Int
  • Long
  • 문자열
  • String Set

앱의 설정 UI는 View 객체 대신 Preference 객체를 사용하여 구축되기 때문에, 목록 설정을 표시하려면 특수 Activity 또는 Fragment 서브클래스를 사용해야 합니다.

  • 앱이 Android 3.0 이전 버전(API 레벨 10 이하)을 지원하는 경우, 액티비티를 구축할 때 PreferenceActivity 클래스의 확장으로 구축해야 합니다.
  • Android 3.0 이후의 경우에는 대신 기존의 Activity를 사용해야 합니다. 이것은 앱 설정을 표시하는 PreferenceFragment를 호스팅합니다. 하지만, 여러 개의 설정 그룹이 있는 경우 PreferenceActivity를 사용하여 대형 화면에 맞는 창 두 개짜리 레이아웃을 만들 수도 있습니다.

PreferenceActivityPreferenceFragment의 인스턴스를 설정하는 방법은 기본 설정 액티비티 만들기기본 설정 프래그먼트 사용에 관한 섹션에서 설명합니다.

기본 설정

앱에 대한 설정은 모두 Preference 클래스의 특정 서브클래스로 표현됩니다. 각 서브클래스에 핵심 속성이 한 세트씩 포함되어 있어 설정의 제목과 기본 값 등과 같은 것을 지정할 수 있게 해줍니다. 각 서브클래스는 또한 자신만의 특수 속성과 사용자 인터페이스도 제공합니다. 예를 들어, 그림 1은 메시지 앱의 설정에서 가져온 스크린샷을 나타낸 것입니다. 설정 화면에 있는 각 목록 항목은 각기 서로 다른 Preference 객체로 지원됩니다.

가장 보편적인 기본 설정을 몇 가지만 소개하면 다음과 같습니다.

CheckBoxPreference
활성화되었거나 비활성화된 설정에 대한 체크박스가 있는 항목을 표시합니다. 저장된 값은 부울입니다(체크박스가 선택된 경우 true).
ListPreference
라디오 버튼 목록이 있는 대화상자를 엽니다. 저장된 값은 지원되는 값 유형(위에 나열) 중 어느 것이라도 될 수 있습니다.
EditTextPreference
EditText 위젯이 있는 대화상자를 엽니다. 저장된 값은 String입니다.

다른 모든 서브클래스와 이에 상응하는 속성의 목록을 보려면 Preference 클래스를 참조하세요.

물론 기본 제공 클래스만으로는 필요한 것을 모두 충족할 수 없고 앱에 무언가 좀 더 특수한 것이 필요할 수도 있습니다. 예를 들어 플랫폼은 현재 숫자나 날짜를 선택할 수 있는 Preference 클래스를 제공하지 않습니다. 따라서 개발자 나름대로 Preference 서브클래스를 정의해야 할 수도 있습니다. 이 작업을 수행하는 데 유용한 내용인 사용자 지정 기본 설정 구축하기에 관한 섹션을 참조하세요.

XML로 기본 설정 정의

새로운 Preference 객체를 런타임에 인스턴스화하는 것도 가능하지만, 설정 목록을 정의할 때에는 Preference 객체의 계층과 함께 XML을 사용해야 합니다. 설정 컬렉션을 정의하는 데 XM 파일을 사용하는 것이 선호되는 이유는 이 파일이 읽기 쉬운 구조를 제공하여 업데이트가 단순하기 때문입니다. 또한, 앱의 설정은 보통 미리 정의되어 있습니다. 다만 개발자도 여전히 런타임에 설정 컬렉션을 수정할 수 있습니다.

Preference 서브클래스는 클래스 이름과 일치하는 XML 요소로 선언하면 됩니다. 예를 들면 <CheckBoxPreference>가 이에 해당됩니다.

이 XML 파일은 반드시 res/xml/ 디렉터리에 저장해야 합니다. 파일의 이름은 무엇이든 원하는 대로 지정할 수 있지만, 일반적으로는 preferences.xml이라고 명명합니다. 파일은 하나만 필요한 것이 보통입니다. 왜냐하면 계층에 있는 분기(자신만의 설정 목록을 여는)는 PreferenceScreen의 중첩된 인스턴스를 사용하여 선언되기 때문입니다.

참고: 설정에 다중 창 레이아웃을 만들고자 하는 경우, 각 프래그먼트에 대해 별도의 XML 파일이 필요합니다.

루트 노드는 반드시 XML 파일의 PreferenceScreen 요소여야 합니다. 바로 이 요소 내에 각 Preference를 추가하는 것입니다. <PreferenceScreen> 요소 내에 추가하는 각 하위는 설정 목록에서 각기 항목 하나씩으로 나타납니다.

예:

<?xml version="1.0" encoding="utf-8"?>
<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">
    <CheckBoxPreference
        android:key="pref_sync"
        android:title="@string/pref_sync"
        android:summary="@string/pref_sync_summ"
        android:defaultValue="true" />
    <ListPreference
        android:dependency="pref_sync"
        android:key="pref_syncConnectionType"
        android:title="@string/pref_syncConnectionType"
        android:dialogTitle="@string/pref_syncConnectionType"
        android:entries="@array/pref_syncConnectionTypes_entries"
        android:entryValues="@array/pref_syncConnectionTypes_values"
        android:defaultValue="@string/pref_syncConnectionTypes_default" />
</PreferenceScreen>

이 예시에서는 CheckBoxPreferenceListPreference가 하나씩 있습니다. 두 항목 모두 다음과 같은 세 가지 특성을 포함하고 있습니다.

android:key
이 특성은 데이터 값을 유지하는 기본 설정에 필수입니다. 이것은 SharedPreferences에 이 설정의 값을 저장할 때 시스템이 사용하는 고유 키(문자열)를 지정합니다.

이 특성이 필요하지 않은 경우는 기본 설정이 PreferenceCategory 또는 PreferenceScreen이거나 기본 설정이 호출할 Intent를 지정하거나(<intent> 요소 사용) 표시할 Fragment를 지정(android:fragment 특성 사용)할 때뿐입니다.

android:title
이것은 설정에 대하여 사용자가 볼 수 있는 이름을 제공합니다.
android:defaultValue
이것은 시스템이 SharedPreferences 파일에 설정해야 하는 초기 값을 지정합니다. 모든 설정에 기본 값을 제공해야 합니다.

다른 모든 지원되는 특성에 대해서는 Preference(및 해당 서브클래스) 관련 문서를 참조하세요.

그림 2. 제목이 있는 설정 카테고리.
1. 카테고리는 <PreferenceCategory> 요소로 지정합니다.
2. 제목은 android:title 특성으로 지정합니다.

설정 목록이 약 10개 항목을 초과하면 제목을 추가하여 설정 그룹을 정의하거나, 해당 그룹을 별도의 화면에 표시하는 것이 좋을 수도 있습니다. 이러한 옵션은 다음 섹션에 설명되어 있습니다.

설정 그룹 만들기

10개 이상의 설정 목록을 제시하는 경우, 사용자가 이들을 둘러보고 이해하며 처리하는 데 어려움을 겪을 수 있습니다. 이 문제를 해결하려면 설정의 일부 또는 모두를 그룹으로 나누어 사실상 하나의 긴 목록을 여러 개의 더 짧은 목록으로 바꿔주면 됩니다. 관련된 설정 그룹 하나를 나타낼 때에는 다음과 같은 두 가지 방식 중 하나를 택하면 됩니다.

이와 같은 그룹화 기법 중 하나 또는 둘 모두를 사용하여 앱의 설정을 조직화할 수 있습니다. 어느 것을 사용할지, 설정을 어떻게 나눌지 결정할 때에는 Android 디자인의 설정 가이드에 있는 지침을 따라야 합니다.

제목 사용

여러 개의 설정 그룹 사이에 구분선과 제목을 제공하고자 하는 경우(그림 2에 나오는 것처럼), 각 Preference 객체 그룹을 PreferenceCategory 내부에 배치합니다.

예:

<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">
    <PreferenceCategory
        android:title="@string/pref_sms_storage_title"
        android:key="pref_key_storage_settings">
        <CheckBoxPreference
            android:key="pref_key_auto_delete"
            android:summary="@string/pref_summary_auto_delete"
            android:title="@string/pref_title_auto_delete"
            android:defaultValue="false"... />
        <Preference
            android:key="pref_key_sms_delete_limit"
            android:dependency="pref_key_auto_delete"
            android:summary="@string/pref_summary_delete_limit"
            android:title="@string/pref_title_sms_delete"... />
        <Preference
            android:key="pref_key_mms_delete_limit"
            android:dependency="pref_key_auto_delete"
            android:summary="@string/pref_summary_delete_limit"
            android:title="@string/pref_title_mms_delete" ... />
    </PreferenceCategory>
    ...
</PreferenceScreen>

보조 화면 사용

설정 그룹 여러 개를 보조 화면에 배치하고자 하는 경우(그림 3에 나오는 것처럼), 해당 Preference 객체 그룹을 PreferenceScreen 안에 배치합니다.

그림 3. 설정 보조 화면. <PreferenceScreen> 요소가 항목을 만들며, 이 항목이 선택되면 별도의 목록이 열려 중첩된 설정을 표시합니다.

예:

<PreferenceScreen  xmlns:android="http://schemas.android.com/apk/res/android">
    <!-- opens a subscreen of settings -->
    <PreferenceScreen
        android:key="button_voicemail_category_key"
        android:title="@string/voicemail"
        android:persistent="false">
        <ListPreference
            android:key="button_voicemail_provider_key"
            android:title="@string/voicemail_provider" ... />
        <!-- opens another nested subscreen -->
        <PreferenceScreen
            android:key="button_voicemail_setting_key"
            android:title="@string/voicemail_settings"
            android:persistent="false">
            ...
        </PreferenceScreen>
        <RingtonePreference
            android:key="button_voicemail_ringtone_key"
            android:title="@string/voicemail_ringtone_title"
            android:ringtoneType="notification" ... />
        ...
    </PreferenceScreen>
    ...
</PreferenceScreen>

인텐트 사용

어떤 경우에는 기본 설정 항목을 사용하여 설정 화면 대신 여러 가지 액티비티를 열고자 할 수도 있습니다. 예를 들어 웹 브라우저를 열어 웹 페이지를 보는 것이 이에 해당됩니다. 사용자가 기본 설정 항목을 선택할 때 Intent를 호출하려면, <intent> 요소를 해당 <Preference> 요소의 하위 요소로 추가합니다.

예를 들어 다음은 기본 설정 항목을 사용하여 웹 페이지를 열도록 하는 방법입니다.

<Preference android:title="@string/prefs_web_page" >
    <intent android:action="android.intent.action.VIEW"
            android:data="http://www.example.com" />
</Preference>

다음 특성을 사용하여 명시적 인텐트와 암시적 인텐트 두 가지를 모두 만들 수 있습니다.

android:action
할당할 작업이며, setAction() 메서드를 따릅니다.
android:data
할당할 데이터이며, setData() 메서드를 따릅니다.
android:mimeType
할당할 MIME 유형이며, setType() 메서드를 따릅니다.
android:targetClass
구성 요소 이름의 클래스 부분이며, setComponent() 메서드를 따릅니다.
android:targetPackage
구성 요소 이름의 패키지 부분이며, setComponent() 메서드를 따릅니다.

기본 설정 액티비티 만들기

설정을 액티비티에서 표시하려면 PreferenceActivity 클래스를 확장하면 됩니다. 이는 Preference 객체의 계층에 따라 설정 목록을 표시하는 일반적인 Activity 클래스 확장입니다. PreferenceActivity는 사용자가 변경 작업을 하면 각 Preference와 연관된 설정을 유지합니다.

참고: Android 3.0 이상에 맞춰 애플리케이션을 개발하는 경우, 대신 PreferenceFragment를 사용해야 합니다. 다음 섹션의 기본 설정 프래그먼트 사용 관련 내용을 참조하세요.

여기서 기억해야 할 가장 중요한 점은 onCreate() 콜백 중에 뷰 레이아웃을 로드해서는 안 된다는 것입니다. 그 대신 addPreferencesFromResource()를 호출하여 XML 파일에서 선언한 기본 설정을 액티비티에 추가합니다. 예를 들어 다음은 기능적인 PreferenceActivity에 필요한 최소한의 코드를 나타낸 것입니다.

public class SettingsActivity extends PreferenceActivity {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        addPreferencesFromResource(R.xml.preferences);
    }
}

사실 이 코드만으로 몇몇 앱에는 충분합니다. 사용자가 기본 설정을 수정하자마자 시스템이 해당 변경을 기본 SharedPreferences 파일에 저장하여, 사용자의 설정을 확인해야 할 때 다른 애플리케이션 구성 요소가 이를 읽을 수 있도록 하기 때문입니다. 하지만 대다수의 앱은 기본 설정에 일어나는 변경을 수신 대기하기 위해 약간의 코드가 더 필요합니다. SharedPreferences 파일에 일어나는 변경을 수신 대기하는 데 관한 자세한 정보는 기본 설정 읽기에 관한 섹션을 참조하세요.

기본 설정 프래그먼트 사용

Android 3.0(API 레벨 11) 이상을 대상으로 개발하는 경우, PreferenceFragment를 사용하여 Preference 객체 목록을 표시해야 합니다. PreferenceFragment는 모든 액티비티에 추가할 수 있습니다. 즉, PreferenceActivity를 사용하지 않아도 됩니다.

프래그먼트는 액티비티만 사용하는 것에 비해 애플리케이션에 보다 유연한 아키텍처를 제공하며, 이는 구축하는 액티비티의 종류와 무관하게 적용됩니다. 따라서 설정 표시를 제어하려면 PreferenceFragmentPreferenceActivity 대신 사용하는 방안을 권장합니다(가능한 경우).

PreferenceFragment 구현은 매우 간단합니다. onCreate() 메서드를 정의하여 기본 설정 파일을 addPreferencesFromResource()로 로드하도록 하기만 하면 됩니다. 예:

public static class SettingsFragment extends PreferenceFragment {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // Load the preferences from an XML resource
        addPreferencesFromResource(R.xml.preferences);
    }
    ...
}

그런 다음 이 프래그먼트를 Activity에 추가하면 되고, 이는 다른 모든 Fragment에서와 마찬가지입니다. 예:

public class SettingsActivity extends Activity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // Display the fragment as the main content.
        getFragmentManager().beginTransaction()
                .replace(android.R.id.content, new SettingsFragment())
                .commit();
    }
}

참고: PreferenceFragment에는 자신만의 Context 객체가 없습니다. Context 객체가 필요한 경우, getActivity()를 호출하면 됩니다. 하지만, getActivity()를 호출하는 것은 프래그먼트가 액티비티에 첨부되어 있는 경우만으로 국한시켜야 한다는 점을 유의하세요. 프래그먼트가 아직 첨부되지 않았거나 수명 주기가 끝날 무렵 분리된 경우, getActivity()가 null을 반환합니다.

기본 값 설정

여러분이 만드는 기본 설정은 애플리케이션에 중요한 동작을 정의하는 경우가 많을 것입니다. 따라서 연관된 SharedPreferences 파일을 각 Preference에 대한 기본 값으로 초기화하여 사용자가 애플리케이션을 처음 열 때 적용하는 것이 중요합니다.

가장 먼저 해야 할 일은 XML 파일에서 android:defaultValue 특성을 사용하여 각 Preference 객체에 대해 기본값을 지정하는 것입니다. 이 값은 상응하는 Preference 객체에 대해 적절한 어느 데이터 유형이라도 될 수 있습니다. 예:

<!-- default value is a boolean -->
<CheckBoxPreference
    android:defaultValue="true"
    ... />

<!-- default value is a string -->
<ListPreference
    android:defaultValue="@string/pref_syncConnectionTypes_default"
    ... />

그런 다음, 애플리케이션의 기본 액티비티에 있는 onCreate() 메서드로부터—또한 사용자가 애플리케이션에 처음으로 들어올 통로가 될 수 있는 다른 모든 액티비티도 포함—setDefaultValues()를 호출합니다.

PreferenceManager.setDefaultValues(this, R.xml.advanced_preferences, false);

이것을 onCreate() 중에 호출하면 애플리케이션이 기본 설정으로 적절히 초기화되도록 보장할 수 있습니다. 이것은 애플리케이션이 몇 가지 동작을 결정하기 위해 읽어야 할 수도 있습니다(예를 들어 셀룰러 네트워크에서 데이터를 다운로드할지 여부 등).

이 메서드는 다음과 같은 세 개의 인수를 취합니다.

  • 애플리케이션 Context.
  • 기본 값을 설정하고자 하는 기본 설정 XML 파일에 대한 리소스 ID.
  • 기본 값을 한 번 이상 설정해야 하는지 여부를 나타내는 부울 값.

    false인 경우, 시스템은 이 메서드가 전에 한 번도 호출된 적이 없을 경우에만 기본 값을 설정합니다(아니면 기본 값을 공유한 기본 설정 파일에 있는 KEY_HAS_SET_DEFAULT_VALUES 가 안전합니다).

세 번째 인수를 false로 설정해 두는 한 이 메서드를 액티비티가 시작될 때마다 안전하게 호출할 수 있으며, 그렇게 해도 사용자의 저장된 기본 설정을 기본값으로 초기화하여 재정의하지 않습니다. 하지만 이를 true로 설정하면, 이전의 모든 값을 기본 값으로 재정의하게 됩니다.

기본 설정 헤더 사용

드문 경우지만 설정을 디자인할 때 첫 화면에는 보조 화면 목록만 표시하도록 하고자 할 수도 있습니다(예: 시스템 설정 앱, 그림 4와 5 참조). Android 3.0 이상을 대상으로 이러한 디자인을 개발하는 경우, 중첩된 PreferenceScreen 요소를 사용하여 보조 화면을 빌드하는 대신 '헤더' 기능을 사용해야 합니다.

헤더를 사용하여 설정을 구축하려면 다음과 같이 해야 합니다.

  1. 각 설정 그룹을 별개의 PreferenceFragment 인스턴스로 구분합니다. 다시 말해, 설정 그룹마다 별도의 XML 파일이 하나씩 있어야 한다는 뜻입니다.
  2. 각 설정 그룹을 나열하는 XML 헤더 파일을 생성하고 어느 프래그먼트에 해당 설정 목록이 들어있는지 선언합니다.
  3. PreferenceActivity 클래스를 확장하여 설정을 호스팅하도록 합니다.
  4. onBuildHeaders() 콜백을 구현하여 헤더 파일을 지정합니다.

이 디자인 사용 시 커다란 이점은 PreferenceActivity가 (앱이) 대형 화면에서 실행될 때 그림 4에 나오는 것처럼 두 개의 창으로 구성된 레이아웃을 자동으로 표시한다는 것입니다.

애플리케이션이 Android 3.0 이전 버전을 지원한다 하더라도 애플리케이션이 PreferenceFragment를 사용하여 신형 기기에서 창 두 개짜리 표시를 지원하도록 하면서도 구형 기기에서는 일반적인 다중 화면 계층을 여전히 지원하도록 할 수도 있습니다(기본 설정 헤더로 이전 버전 지원을 참조하세요).

그림 4. 헤더가 있는 창 두 개로 구성된 레이아웃.
1. 헤더는 XML 헤더 파일에서 정의합니다.
2. 각 설정 그룹은 PreferenceFragment로 정의하며, 이는 헤더 파일에 있는 <header> 요소로 지정합니다.

그림 5. 설정 헤더가 있는 핸드셋 기기. 항목을 선택하면 연관된 PreferenceFragment가 헤더를 대체합니다.

헤더 파일 만들기

헤더 목록에 있는 각 설정 그룹은 루트 <preference-headers> 요소 안에 있는 단일 <header> 요소로 지정합니다. 예:

<?xml version="1.0" encoding="utf-8"?>
<preference-headers xmlns:android="http://schemas.android.com/apk/res/android">
    <header
        android:fragment="com.example.prefs.SettingsActivity$SettingsFragmentOne"
        android:title="@string/prefs_category_one"
        android:summary="@string/prefs_summ_category_one" />
    <header
        android:fragment="com.example.prefs.SettingsActivity$SettingsFragmentTwo"
        android:title="@string/prefs_category_two"
        android:summary="@string/prefs_summ_category_two" >
        <!-- key/value pairs can be included as arguments for the fragment. -->
        <extra android:name="someKey" android:value="someHeaderValue" />
    </header>
</preference-headers>

각 헤더는 android:fragment 특성으로 사용자가 헤더를 선택하면 열리는 PreferenceFragment의 인스턴스를 선언합니다.

<extras> 요소를 사용하면 키-값 쌍을 Bundle 내의 프래그먼트에 전달할 수 있습니다. 이 프래그먼트는 getArguments()를 호출하여 인수를 검색할 수 있습니다. 인수를 프래그먼트에 전달하는 여러 가지 이유가 있을 수 있지만, 한 가지 중요한 이유는 각 그룹에 대해 동일한 PreferenceFragment 서브클래스를 재사용하고, 이 인수를 사용하여 해당 프래그먼트가 로드해야 하는 기본 설정 XML 파일을 지정하는 것입니다.

예를 들어, 다음은 각 헤더가 "settings" 키로 <extra> 인수를 정의할 때 여러 가지 설정 그룹에 재사용할 수 있는 프래그먼트입니다.

public static class SettingsFragment extends PreferenceFragment {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        String settings = getArguments().getString("settings");
        if ("notifications".equals(settings)) {
            addPreferencesFromResource(R.xml.settings_wifi);
        } else if ("sync".equals(settings)) {
            addPreferencesFromResource(R.xml.settings_sync);
        }
    }
}

헤더 표시

기본 설정 헤더를 표시하려면 onBuildHeaders() 콜백 메서드를 구현하고 loadHeadersFromResource()를 호출해야 합니다. 예:

public class SettingsActivity extends PreferenceActivity {
    @Override
    public void onBuildHeaders(List<Header> target) {
        loadHeadersFromResource(R.xml.preference_headers, target);
    }
}

사용자가 헤더 목록에서 항목을 선택하면 시스템이 연관된 PreferenceFragment를 엽니다.

참고: 기본 설정 헤더를 사용하는 경우, PreferenceActivity의 서브클래스가 onCreate() 메서드를 구현하지 않아도 됩니다. 액티비티에 대해 유일하게 필요한 작업은 헤더를 로드하는 것뿐이기 때문입니다.

기본 설정 헤더로 이전 버전 지원

애플리케이션이 Android 3.0 이전 버전을 지원하는 경우에도 여전히 헤더를 사용하여 Android 3.0 이상에서 창 두 개짜리 레이아웃을 제공하도록 할 수 있습니다. 개발자가 해야 할 일은 추가로 기본 설정 XML 파일을 생성하는 것뿐입니다. 이 파일은 마치 헤더 항목처럼 동작하는 기본적인 <Preference> 요소를 사용합니다(이것을 이전 Android 버전이 사용하도록 할 예정).

하지만 새로운 PreferenceScreen을 여는 대신 각 <Preference> 요소가 로드할 기본 설정 XML 파일을 지정하는 PreferenceActivityIntent를 전송합니다.

예를 들어 다음은 Android 3.0 이상에서 사용되는 기본 설정 헤더에 대한 XML 파일입니다(res/xml/preference_headers.xml).

<preference-headers xmlns:android="http://schemas.android.com/apk/res/android">
    <header
        android:fragment="com.example.prefs.SettingsFragmentOne"
        android:title="@string/prefs_category_one"
        android:summary="@string/prefs_summ_category_one" />
    <header
        android:fragment="com.example.prefs.SettingsFragmentTwo"
        android:title="@string/prefs_category_two"
        android:summary="@string/prefs_summ_category_two" />
</preference-headers>

그리고 다음은, Android 3.0 이전 버전에 같은 헤더를 제공하는 기본 설정 파일입니다(res/xml/preference_headers_legacy.xml).

<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">
    <Preference
        android:title="@string/prefs_category_one"
        android:summary="@string/prefs_summ_category_one"  >
        <intent
            android:targetPackage="com.example.prefs"
            android:targetClass="com.example.prefs.SettingsActivity"
            android:action="com.example.prefs.PREFS_ONE" />
    </Preference>
    <Preference
        android:title="@string/prefs_category_two"
        android:summary="@string/prefs_summ_category_two" >
        <intent
            android:targetPackage="com.example.prefs"
            android:targetClass="com.example.prefs.SettingsActivity"
            android:action="com.example.prefs.PREFS_TWO" />
    </Preference>
</PreferenceScreen>

<preference-headers>에 대한 지원이 Android 3.0에서 추가되었기 때문에 Android 3.0 이상에서 실행되는 경우에만 시스템이 PreferenceActivity에서 onBuildHeaders()를 호출합니다. '레거시' 헤더 파일(preference_headers_legacy.xml)을 로드하려면 반드시 Android 버전을 확인해야 하며, 해당 버전이 Android 3.0 이전인 경우(HONEYCOMB), addPreferencesFromResource()를 호출하여 레거시 헤더 파일을 로드해야 합니다. 예:

@Override
public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    ...

    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.HONEYCOMB) {
        // Load the legacy preferences headers
        addPreferencesFromResource(R.xml.preference_headers_legacy);
    }
}

// Called only on Honeycomb and later
@Override
public void onBuildHeaders(List<Header> target) {
   loadHeadersFromResource(R.xml.preference_headers, target);
}

이제 남은 할 일이라고는 Intent를 처리하는 것뿐입니다. 이것은 액티비티로 전달되어 어느 기본 설정 파일을 로드해야 하는지 식별하는 데 쓰입니다. 그럼 이제 인텐트의 작업을 검색하고 기본 설정 XML의 <intent> 태그에서 사용한 알려진 작업 문자열과 비교해보겠습니다.

final static String ACTION_PREFS_ONE = "com.example.prefs.PREFS_ONE";
...

@Override
public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    String action = getIntent().getAction();
    if (action != null && action.equals(ACTION_PREFS_ONE)) {
        addPreferencesFromResource(R.xml.preferences);
    }
    ...

    else if (Build.VERSION.SDK_INT < Build.VERSION_CODES.HONEYCOMB) {
        // Load the legacy preferences headers
        addPreferencesFromResource(R.xml.preference_headers_legacy);
    }
}

addPreferencesFromResource()를 연이어 호출하면 모든 기본 설정을 하나의 목록에 쌓게 된다는 점을 유의하세요. 따라서 'Else-if' 문이 있는 조건을 변경하여 딱 한 번만 호출하도록 주의해야 합니다.

기본 설정 읽기

기본적으로 앱의 기본 설정은 모두 애플리케이션 내의 어디서든 정적 메서드 PreferenceManager.getDefaultSharedPreferences()를 호출하여 액세스할 수 있는 파일에 저장됩니다. 이것은 SharedPreferences 객체를 반환하며, 여기에 PreferenceActivity에서 사용한 Preference 객체와 연관된 모든 키-값 쌍이 들어 있습니다.

예를 들어, 다음은 기본 설정 값 중 하나를 애플리케이션 내의 다른 모든 액티비티에서 읽는 방법을 나타낸 것입니다.

SharedPreferences sharedPref = PreferenceManager.getDefaultSharedPreferences(this);
String syncConnPref = sharedPref.getString(SettingsActivity.KEY_PREF_SYNC_CONN, "");

기본 설정 변경 수신 대기

사용자가 기본 설정 중 하나를 변경하자마자 이에 대해 알림을 받는 것이 좋은 데, 여기에는 몇 가지 이유가 있습니다. 기본 설정 중 어느 하나에라도 변경이 발생했을 때 콜백을 받으려면, {SharedPreference.OnSharedPreferenceChangeListener 인터페이스를 구현하고 SharedPreferences 객체에 대한 리스너를 등록합니다. 이때 registerOnSharedPreferenceChangeListener()를 호출하면 됩니다.

이 인터페이스에는 콜백 메서드가 onSharedPreferenceChanged() 하나뿐이며, 인터페이스를 액티비티의 일부분으로 구현하는 것이 가장 쉬운 방법이라는 것을 알 수 있습니다. 예:

public class SettingsActivity extends PreferenceActivity
                              implements OnSharedPreferenceChangeListener {
    public static final String KEY_PREF_SYNC_CONN = "pref_syncConnectionType";
    ...

    public void onSharedPreferenceChanged(SharedPreferences sharedPreferences,
        String key) {
        if (key.equals(KEY_PREF_SYNC_CONN)) {
            Preference connectionPref = findPreference(key);
            // Set summary to be the user-description for the selected value
            connectionPref.setSummary(sharedPreferences.getString(key, ""));
        }
    }
}

이 예시에서 메서드는 변경된 설정이 알려진 기본 설정 키에 대한 것인지 여부를 확인합니다. 이것은 findPreference()를 호출하여 변경된 Preference 객체를 가져오는데, 이렇게 해야 항목의 요약을 수정하여 사용자의 선택에 대한 설명이 되도록 할 수 있습니다. 다시 말해, 설정이 ListPreference 또는 다른 다중 선택 설정인 경우, 설정이 변경되어 현재 상태를 표시하도록 하면 setSummary()를 호출해야 한다는 뜻입니다(예를 들어 그림 5에 표시된 절전 모드 설정과 같음).

참고: Android 디자인 문서의 설정 관련 내용에서 설명한 바와 같이, 현재 설정을 나타내기 위해 사용자가 기본 설정을 변경할 때마다 ListPreference의 요약을 업데이트하는 것이 좋습니다.

액티비티에서 적절한 수명 주기 관리를 수행하려면 SharedPreferences.OnSharedPreferenceChangeListener를 등록하고 등록 해제하는 작업은 각각 onResume()onPause() 콜백 중에 수행하는 것을 권장합니다.

@Override
protected void onResume() {
    super.onResume();
    getPreferenceScreen().getSharedPreferences()
            .registerOnSharedPreferenceChangeListener(this);
}

@Override
protected void onPause() {
    super.onPause();
    getPreferenceScreen().getSharedPreferences()
            .unregisterOnSharedPreferenceChangeListener(this);
}

주의: 현재로서는 registerOnSharedPreferenceChangeListener()를 호출할 때 기본 설정 관리자가 리스너에 대한 강력한 참조를 저장하지 않습니다. 반드시 리스너에 대한 강력한 참조를 저장해야 합니다. 그렇지 않으면 가비지 수집의 대상이 될 가능성이 높습니다. 리스너를 필요로 하는 기간 동안 존재할 것이 확실한 객체의 인스턴스 데이터에 리스너에 대한 참조를 보관하도록 권장합니다.

예를 들어 다음 코드에서 호출자는 리스너에 대한 참조를 보관하지 않습니다. 따라서 해당 리스너가 가비지 수집 대상이 되며 향후 언젠가 미정된 시점에 실패하게 될 것입니다.

prefs.registerOnSharedPreferenceChangeListener(
  // Bad! The listener is subject to garbage collection!
  new SharedPreferences.OnSharedPreferenceChangeListener() {
  public void onSharedPreferenceChanged(SharedPreferences prefs, String key) {
    // listener implementation
  }
});

대신, 리스너가 필요한 기간만큼 오래 존재할 것이 확실한 객체의 인스턴스 데이터 필드에 리스너에 대한 참조를 저장하세요.

SharedPreferences.OnSharedPreferenceChangeListener listener =
    new SharedPreferences.OnSharedPreferenceChangeListener() {
  public void onSharedPreferenceChanged(SharedPreferences prefs, String key) {
    // listener implementation
  }
};
prefs.registerOnSharedPreferenceChangeListener(listener);

네트워크 사용량 관리

Android 4.0부터 시스템의 설정 애플리케이션을 사용하면 사용자가 애플리케이션이 포그라운드와 백그라운드에 있는 동안 각각 얼마나 많은 네트워크 데이터를 사용하는지 알아볼 수 있게 되었습니다. 그런 다음 사용자는 각각의 앱에 대해 백그라운드 데이터 사용을 비활성화할 수 있습니다. 사용자가 여러분의 앱이 백그라운드에서 데이터에 액세스하는 기능을 비활성화하는 사태를 피하려면 데이터 연결을 효율적으로 사용하고 사용자가 애플리케이션 설정을 통하여 앱의 데이터 사용량을 미세 조정할 수 있도록 허용해야 합니다.

예를 들어 사용자에게 앱의 데이터 동기화 빈도를 제어하도록 허용할 수 있습니다. 앱이 Wi-Fi에 있을 때에만 업로드/다운로드를 수행하도록 할지 여부, 앱이 로밍 중에 데이터를 사용하도록 할지 여부 등을 이렇게 조절합니다. 사용자가 이러한 제어 기능을 사용할 수 있게 되면 시스템 설정에서 설정한 한도에 가까워지고 있을 때 앱의 데이터 액세스를 비활성화할 가능성이 낮아집니다. 그 대신 앱이 사용하는 데이터 양을 정밀하게 제어할 수 있기 때문입니다.

일단 필요한 기본 설정을 PreferenceActivity에 추가하여 앱의 데이터 습관을 제어하도록 했으면, 다음으로 매니페스트 파일에 있는 ACTION_MANAGE_NETWORK_USAGE에 대한 인텐트 필터를 추가해야 합니다. 예:

<activity android:name="SettingsActivity" ... >
    <intent-filter>
       <action android:name="android.intent.action.MANAGE_NETWORK_USAGE" />
       <category android:name="android.intent.category.DEFAULT" />
    </intent-filter>
</activity>

이 인텐트 필터는 이것이 애플리케이션의 데이터 사용량을 제어하는 액티비티라는 사실을 시스템에 나타내는 역할을 합니다. 따라서, 사용자가 시스템의 설정 앱에서 여러분의 앱이 얼마나 많은 데이터를 사용하는지 알아볼 때면 View application settings 버튼을 사용할 수 있어 PreferenceActivity를 시작하게 됩니다. 그러면 사용자는 앱이 사용할 데이터 양을 미세하게 조정할 수 있습니다.

사용자 지정 기본 설정 구축

Android 프레임워크에는 다양한 Preference 서브클래스가 포함되어 있어 여러 가지 설정 유형에 맞게 UI를 빌드할 수 있습니다. 하지만, 기본 제공 솔루션이 없는 설정이 필요한 경우도 있습니다. 예를 들어 숫자 선택기 또는 날짜 선택기 등이 이에 해당됩니다. 그러한 경우에는 Preference 클래스 또는 다른 서브클래스 중 하나를 확장하여 사용자 지정 기본 설정을 만들어야 합니다.

Preference 클래스를 확장하는 경우, 다음과 같이 몇 가지 중요한 해야 할 일이 있습니다.

  • 사용자가 설정을 선택하면 나타나는 사용자 인터페이스를 지정합니다.
  • 필요에 따라 설정의 값을 저장합니다.
  • Preference가 보이게 되면 이를 현재(또는 기본) 값으로 초기화합니다.
  • 시스템이 요청하는 경우 기본 값을 제공합니다.
  • Preference가 자체 UI(예: 대화상자)를 제공하는 경우, 상태를 저장하고 복원하여 수명 주기 변경을 처리할 수 있습니다(예: 사용자가 화면을 돌리는 경우).

다음 섹션에서는 이와 같은 각각의 작업을 수행하는 방법을 설명합니다.

사용자 인터페이스 지정

Preference 클래스를 직접 확장하는 경우, onClick()을 구현하여 사용자가 항목을 선택할 때 일어날 동작을 정의해야 합니다. 그러나, 대부분의 사용자 지정 설정은 DialogPreference를 확장하여 대화상자를 표시하며, 따라서 절차가 단순해집니다. DialogPreference를 확장하는 경우에는 클래스 생성자 중에 반드시 setDialogLayoutResourcs()를 호출하여 대화상자에 대한 레이아웃을 지정해야 합니다.

예를 들어 다음은 레이아웃을 선언하는 사용자 지정 DialogPreference와 기본 긍정적 및 부정적 대화상자 버튼에 대한 텍스트를 지정하는 생성자입니다.

public class NumberPickerPreference extends DialogPreference {
    public NumberPickerPreference(Context context, AttributeSet attrs) {
        super(context, attrs);

        setDialogLayoutResource(R.layout.numberpicker_dialog);
        setPositiveButtonText(android.R.string.ok);
        setNegativeButtonText(android.R.string.cancel);

        setDialogIcon(null);
    }
    ...
}

설정의 값 저장

언제든지 Preference 클래스의 persist*() 메서드 중 하나를 호출하여 설정에 대한 값을 저장할 수 있습니다. 예를 들어 설정의 값이 정수인 경우 persistInt()를, 부울을 저장하려면 persistBoolean()을 호출합니다.

참고: 각각의 Preference는 데이터 유형 하나씩만 저장할 수 있으므로, 사용자 지정 Preference에서 사용한 데이터 유형에 적절한 persist*() 메서드를 사용해야 합니다.

설정을 유지하기로 선택하는 시점은 확장하는 Preference 클래스에 따라 달라질 수 있습니다. DialogPreference를 확장할 때는 긍정적인 결과로 인해 대화상자를 닫는 경우(사용자가 'OK' 버튼을 선택하는 경우)에만 값을 유지해야 합니다.

DialogPreference가 닫힐 때 시스템은 onDialogClosed() 메서드를 호출합니다. 이 메서드에는 부울 인수가 포함되어 있어 사용자의 결과가 "긍정적"인지 아닌지를 나타냅니다. 이 값이 true인 경우, 사용자가 긍정 버튼을 선택한 것이고 새 값을 저장해야 합니다. 예:

@Override
protected void onDialogClosed(boolean positiveResult) {
    // When the user selects "OK", persist the new value
    if (positiveResult) {
        persistInt(mNewValue);
    }
}

이 예시에서 mNewValue는 설정의 현재 값을 보유한 클래스 멤버입니다. persistInt()를 호출하면 SharedPreferences 파일에 대한 값을 저장합니다(이 Preference에 대하여 XML 파일에 지정된 키를 자동으로 사용합니다).

현재 값 초기화

시스템이 Preference를 화면에 추가하는 경우, 이는 onSetInitialValue()를 호출하여 설정에 유지된 값이 있는지 없는지를 알립니다. 유지된 값이 없는 경우, 이 호출은 기본 값을 제공합니다.

onSetInitialValue() 메서드는 부울 값 restorePersistedValue를 전달하여 해당 설정에 대해 이미 어떤 값이 유지되었는지 아닌지를 나타냅니다. 만일 이것이 true라면, 유지된 값을 검색하되 Preference 클래스의 getPersisted*() 메서드 중 하나를 호출하는 방법을 써야 합니다. 예를 들어 정수 값이라면 getPersistedInt()를 사용합니다. 보통은 유지된 값을 검색하여, UI에 이전에 저장된 값을 반영하여 이를 적절하게 업데이트할 수 있도록 하는 것이 좋습니다.

restorePersistedValuefalse인 경우, 두 번째 인수로 전달된 기본 값을 사용해야 합니다.

@Override
protected void onSetInitialValue(boolean restorePersistedValue, Object defaultValue) {
    if (restorePersistedValue) {
        // Restore existing state
        mCurrentValue = this.getPersistedInt(DEFAULT_VALUE);
    } else {
        // Set default state from the XML attribute
        mCurrentValue = (Integer) defaultValue;
        persistInt(mCurrentValue);
    }
}

getPersisted*() 메서드는 실제로 유지된 값이 없거나 키가 존재하지 않는 경우 사용할 기본값을 지정하는 인수를 취합니다. 위의 예시에서는 getPersistedInt()가 유지된 값을 반환할 수 없는 경우에 사용할 기본값을 지정하기 위해 지역 상수를 사용하였습니다.

주의: getPersisted*() 메서드에서는 defaultValue를 기본값으로 사용하면 안 됩니다. 이것의 값은 restorePersistedValuetrue인 경우 항상 null이기 때문입니다.

기본 값 제공

Preference 클래스의 인스턴스가 기본값을 지정하는 경우(android:defaultValue 특성 사용), 시스템은 값을 검색하기 위해 객체를 인스턴스화할 때 onGetDefaultValue()를 호출합니다. 이 메서드를 구현해야 시스템이 SharedPreferences에 기본값을 저장할 수 있습니다. 예:

@Override
protected Object onGetDefaultValue(TypedArray a, int index) {
    return a.getInteger(index, DEFAULT_VALUE);
}

이 메서드 인수는 특성 배열은 물론, 검색해야 하는 android:defaultValue의 인덱스 위치를 포함하여 필요한 모든 항목을 제공합니다. 이 메서드를 반드시 구현하여 특성에서 기본 값을 추출해야만 하는 이유는 값이 정의되지 않은 경우, 특성에 대한 지역 기본값을 꼭 지정해야 하기 때문입니다.

기본 설정의 상태 저장 및 복원

레이아웃에서의 View와 마찬가지로 Preference 서브클래스가 액티비티 또는 프래그먼트가 재시작했을 때 그 상태를 저장하고 복원하는 역할을 맡습니다(예를 들어 사용자가 화면을 돌리는 경우 등). Preference 클래스의 상태를 적절하게 저장하고 복원하려면, 수명 주기 콜백 메서드 onSaveInstanceState()onRestoreInstanceState()를 구현해야 합니다.

Preference의 상태를 정의하는 것은 Parcelable 인터페이스를 구현하는 객체입니다. Android 프레임워크는 상태 객체(Preference.BaseSavedState 클래스)를 정의하기 위한 시작점으로 이러한 객체를 제공합니다.

Preference 클래스가 자신의 상태를 저장하는 방법을 정의하려면 Preference.BaseSavedState 클래스를 확장해야 합니다. 아주 약간의 메서드를 재정의하고 CREATOR 객체를 정의해야 합니다.

대부분의 앱에서는 다음과 같은 구현을 복사한 다음, value를 처리하는 줄만 변경하면 됩니다. 이는 Preference 서브클래스가 정수보다는 데이터 유형을 저장하는 경우 해당됩니다.

private static class SavedState extends BaseSavedState {
    // Member that holds the setting's value
    // Change this data type to match the type saved by your Preference
    int value;

    public SavedState(Parcelable superState) {
        super(superState);
    }

    public SavedState(Parcel source) {
        super(source);
        // Get the current preference's value
        value = source.readInt();  // Change this to read the appropriate data type
    }

    @Override
    public void writeToParcel(Parcel dest, int flags) {
        super.writeToParcel(dest, flags);
        // Write the preference's value
        dest.writeInt(value);  // Change this to write the appropriate data type
    }

    // Standard creator object using an instance of this class
    public static final Parcelable.Creator<SavedState> CREATOR =
            new Parcelable.Creator<SavedState>() {

        public SavedState createFromParcel(Parcel in) {
            return new SavedState(in);
        }

        public SavedState[] newArray(int size) {
            return new SavedState[size];
        }
    };
}

위의 Preference.BaseSavedState 구현을 앱에 추가하고 나면(주로 Preference 서브클래스의 서브클래스로 추가함), 이제 Preference 서브클래스에 대해 onSaveInstanceState()onRestoreInstanceState() 메서드를 구현해야 합니다.

예:

@Override
protected Parcelable onSaveInstanceState() {
    final Parcelable superState = super.onSaveInstanceState();
    // Check whether this Preference is persistent (continually saved)
    if (isPersistent()) {
        // No need to save instance state since it's persistent,
        // use superclass state
        return superState;
    }

    // Create instance of custom BaseSavedState
    final SavedState myState = new SavedState(superState);
    // Set the state's value with the class member that holds current
    // setting value
    myState.value = mNewValue;
    return myState;
}

@Override
protected void onRestoreInstanceState(Parcelable state) {
    // Check whether we saved the state in onSaveInstanceState
    if (state == null || !state.getClass().equals(SavedState.class)) {
        // Didn't save the state, so call superclass
        super.onRestoreInstanceState(state);
        return;
    }

    // Cast state to custom BaseSavedState and pass to superclass
    SavedState myState = (SavedState) state;
    super.onRestoreInstanceState(myState.getSuperState());

    // Set this Preference's widget to reflect the restored state
    mNumberPicker.setValue(myState.value);
}