📝 SeSAC의 'JetPack과 Kotlin을 활용한 Android App 개발' 강좌를 정리한 글 입니다.

---

📇 Persistence 개요

로컬에 데이터를 저장하는 방법은 여러가지가 있다.

• File Read/Write

• SharedPreference

• Database (DBMS)

세 가지 방법 모두 쓰인다.

기본적으로 모든 기기는 파일 읽기/쓰기 가 가능하다. 때문에 프로세스가 종료되어도 작성한 파일은 저장되고 다시 읽어 올 수 있다. 그럼 그냥 File Read/Write 방법으로 다 퉁치면 되는 것 아니냐?

저장하는 데이터가 문자열, Boolean 값, 숫자값 등이라면 File Read/Write 가 아닌 SharedPreference 나 Database 를 이용하는 것이 좋다. 물론 File Read/Write 로도 가능하지만, SharedPreference 와 Database 쪽이 훨씬 쉽다.

File Read/Write 는 이미지 데이터에 사용한다. 특히 카메라 앱을 다룬 때 많이 사용한다.

🔎 [참고]

영속성(persistence)은 데이터를 생성한 프로그램의 실행이 종료되더라도 사라지지 않는 데이터의 특성을 의미한다.

---

📚 File

SharedPreference 와 데이터베이스 프로그래밍 도 결국 File 과 관련 있기 때문에 개념만 짧게 살펴보자.

자바 API 로 File Read/Write

• File : 파일 및 디렉토리를 지칭하는 클래스

• FileInputStream / FileOutputStream : 파일에서 바이트 스트림으로 데이터를 읽거나 쓰는 클래스

• FileReader / FileWriter : 파일에서 문자열 스트림으로 데이터를 읽거나 쓰는 클래스

❗ 주의점

파일을 읽기/쓰기 할 때 내장 메모리인지 외장 메모리인지 구별해야 한다.

• 파일이 저장되는 곳을 내장 메모리 공간 과 외장 메모리 공간 으로 구분

• 외장 메모리 공간은 앱별 저장공간과 공유 저장공간으로 구분
  
  

❓ 내장 메모리 공간이란?

val file = File(filesDir, "test.txt")
val writeStream: OutputStreamWriter = file.writer()
writeStream.write("hello world")
writeStream.flush()

• 내장 메모리 공간이란 앱이 설치되면 시스템에서 자동으로 할당하는 메모리 공간

• 앱의 패키지명으로 폴더를 만들어 주며 이 폴더가 이 앱의 내장 메모리 공간

• filesDir 라는 프로퍼티로 내장 메모리 공간임을 지정한다.

---

📚 SharedPreference

• 데이터를 키-값 형태로 저장 (Map)

• 내부적으로 내장 메모리의 앱 폴더에 XML 파일로 데이터가 저장

XML 형태로 파일이 저장되기 때문에 이미지 저장에는 적합하지 않다.

📌 Preference 객체 획득

2가지 방법이 있다.

📑 Activity.getPreferences (int mode)

• 하나의 액티비티를 위한 데이터 저장을 목적, 때문에 매개변수에 파일명이 없다.

• 이 함수를 이용한 액티비티 클래스명으로 XML 파일명이 만들어 짐

즉, 어플리케이션 전역의 데이터 저장을 목적으로 하지 않는다. 그래서 SharedPreference 를 사용하는 것이 일반적이다.

📑 Context.getSharedPreferences (String name, int mode)

val sharedPref = getSharedPreferences("my_prefs", Context.MODE_PRIVATE)

• 앱 전체의 데이터를 키-값 형태로 저장

• 범위가 전역이기 때문에 매개변수에 파일명이 들어간다.
  
  

📌 데이터 저장

데이터를 저장하기 위해서는 SharedPreferences.Editor 클래스의 함수를 이용한다.

SharedPreferences.Editor 객체는 SharedPreferences 의 edit() 함수로 획득한다.

commit() 하는 순간 저장된다.

• putBoolean(String key, Boolean value)

• putInt(String key, Int value)

• putFloat(String key, Float value)

• putLong(String key, Long value)

• putString(String key, String value)
  
  

📌 데이터 획득

데이터 획득은 SharedPreferences 의 getter 함수를 이용한다.

• getBoolean(String key, Boolean defvalue)

• getInt(String key, Int defvalue)

• getFloat(String key, Float defvalue)

• getLong(String key, Long defvalue)

• getString(String key, String defvalue)
  
  

🧩 실습 예제

• activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:gravity="center"
    android:orientation="vertical"
    tools:context=".MainActivity">

    <EditText
        android:id="@+id/editView"
        android:layout_width="match_parent"
        android:layout_height="wrap_content" />

    <CheckBox
        android:id="@+id/checkView"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="check" />

    <Button
        android:id="@+id/saveButton"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="SAVE" />

    <Button
        android:id="@+id/getButton"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Get Data" />

    <TextView
        android:id="@+id/resultView"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content" />


</LinearLayout>

• MainActivity.kt

package com.kotdev99.android.c55

class MainActivity : AppCompatActivity() {
	override fun onCreate(savedInstanceState: Bundle?) {
		super.onCreate(savedInstanceState)
		setContentView(R.layout.activity_main)

		val editView = findViewById<EditText>(R.id.editView)
		val checkView = findViewById<CheckBox>(R.id.checkView)
		val saveButton = findViewById<Button>(R.id.saveButton)
		val getButton = findViewById<Button>(R.id.getButton)
		val resultView = findViewById<TextView>(R.id.resultView)

		val sharedPref = getSharedPreferences("my_prefs", Context.MODE_PRIVATE)

		saveButton.setOnClickListener {
			sharedPref.edit().run {
				putString("data1", editView.text.toString())
				putBoolean("data2", checkView.isChecked)
				commit()
			}
		}

		getButton.setOnClickListener {
			val data1 = sharedPref.getString("data1", "none")
			val data2 = sharedPref.getBoolean("data2", false)
			resultView.text = "data1: ${data1}, data2: ${data2}"
		}
	}
}

📲 결과

---

📚 Settings XML

앱의 환경설정 자동화를 목적으로 한다.

앱에 대한 환경설정을 위해서는 우선 설정을 출력할 액티비티를 만들어야 한다. 그리고 환경설정 액티비티에서 발생한 유저 이벤트를 처리하고 설정 데이터를 기기에 영속적으로 저장해야 한다.
즉, UI 액티비티 + 유저 이벤트 처리 + Persistence 를 또! 추가로! 구현해야 하는 것이다.

하지만 Settings XML 을 사용하면 위의 과정이 자동화 된다. 일일히 액티비티 UI를 구성하지 않아도, 이벤트 처리 로직을 작성하지 않아도, 영속적 저장 코드를 짜지 않아도, Settings XML 이 알아서 만들어 준다. 물론 SharedPreference로 환경설정을 구현할 수는 있다.

📝 작성 방법

📌 의존성 추가

implementation("androidx.preference:preference-ktx:1.2.0")

• 앱 설정을 위한 XML 작성

• API Level 29 이전 버전에서는 PreferenceFragment 을 이용

• API Level 29 버전부터 AndroidX Preference 를 이용할 것을 권장
  
  

📌 XML 파일 생성

환경설정을 위한 특정 디렉토리는 없다. xml 폴더에 짬 때리면 된다.

• res/xml 폴더에 설정과 관련된 XML 파일 작성
  
  

📌 XML 작성

<PreferenceScreen xmlns:app="http://schemas.android.com/apk/res-auto">
	<SwitchPreferenceCompat
    	app:key="notifications"
        app:title="Enable message notifications"/>
        
</PreferenceScreen>        

• 루트 태그가 <PreferenceScreen>

• <SwitchPreferenceCompat> , <Preference> 등의 태그를 이용해 각각의 설정 항목을 준비
  
  

📌 XML 파일 적용

class SettingsFragment : PreferenceFragmentCompat() {
	override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
    	setPreferencesFromResource(R.xml.settings, rootKey)
	}        
}        

• PreferenceFragmentCompat 을 상속받은 Fragment 로 설정 XML 적용

• 매개변수 R.xml.settings 에 설정 XML 파일만 지정하면 끝
  
  

🧷 설정 태그

PreferenceScreen : 설정 화면단위. 중첩 가능하며 중첩된 내용은 별도의 화면에 나옴.

PreferenceCategory : 설정 여러개를 시각적으로 묶어서 표현

CheckboxPreference : 체크박스가 나오는 설정

EditTextPreference : 글 입력을 위한 설정

ListPreference : 항목 Dialog 을 위한 설정

MultiSelectListPreference : 항목 Dialog 인데 체크박스가 자동 추가되어 다중 선택 가능

RingtonPreference : Rington 선택을 위한 설정

SwitchPreference : Switch 을 이용한 설정

🧩 실습 예제

res/xml 하위에 환경설정 XML 파일 생성

• settings.xml

<?xml version="1.0" encoding="utf-8"?>
<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto">
    <PreferenceCategory>
        app:key="a_category"
        app:title="A Setting">
        <SwitchPreferenceCompat
            app:key="a1"
            app:title="A - 1 Setting" />
        <SwitchPreferenceCompat
            app:key="a2"
            app:title="A - 2 Setting" />
    </PreferenceCategory>
    <PreferenceCategory>
        app:key="B_category"
        app:title="B Setting">
        <SwitchPreferenceCompat
            app:key="b1"
            app:title="B - 1 Setting" />
    </PreferenceCategory>
</PreferenceScreen>

XML 파일을 적용한 프래그먼트를 띄울 액티비티 레이아웃 작성

• activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<fragment xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    class="com.kotdev99.android.c56.SettingsFragment" />

XML 파일을 적용할 프래그먼트 작성

• SettingsFragment.kt

package com.kotdev99.android.c56

class SettingsFragment : PreferenceFragmentCompat() {
	override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
		setPreferencesFromResource(R.xml.settings, rootKey)
	}
}

📲 결과

---

📚 PreferenceFragmentCompat

• 설정을 위한 XML 만 만들어 적용시켜 주면 설정 화면이 나오고 유저가 설정 항목을 클릭하면 설정 내용이 자동으로 저장

• 어떤 경우에는 설정 XML 의 설정 부분을 코드에서 제어 필요

• 설정 항목을 클릭하는 순간의 이벤트를 처리하고 싶거나 코드가 실행되어 발생한 결과를 설정 항목의 title 혹은 summary 로 지정하고 싶은 경우

Settings XML 에서 제공하는 기본 기능 이외에 필요하다면 사용하자.

📝 작성 방법

📌 태그 객체 획득

<EditTextPreference
	android:key="id"
    android:title="ID 설정"
    android:isPreferenceVisible="false"/>

val idPreference: EditTextPreference? = findPreference("id")
idPreference?.isVisible = true

• 설정을 위해 사용한 태그에 해당되는 객체를 findPreference() 태그로 획득
  
  

📌 SimpleSummaryProvider

설정 항목을 선택한 후에도 "항목을 선택 해주세요" 라는 문구가 출력되면 무언가 이상하다.

그래서 이미 라이브러리에 Summary 값을 자동으로 변경주는 클래스가 준비되어 있다.

soundPreference!!.setSummaryProvider(ListPreference.SimpleSummaryProvider.getInstance())

• <EditTextPreference> , <ListPreference> 에 의한 설정한 값 화면에 출력

• SimpleSummaryProvider 이용

SimpleSummaryProvider 는 유저가 입력한 값을 자동으로 Summary 에 써준다.

📌 커스텀 SummaryProvider

idPreference?.summaryProvider=
	Preference.SummaryProvider<EditTextPreference> { preference ->
    	val text = preference.text
        if (TextUtils.isEmpty(thext)) {
        	"설정이 되지 않았습니다."
		} else {
        	"설정된 ID값은 : $text 입니다."
		}
	}

• SummaryProvider 의 하위 클래스를 만들어 코드에서 원하는 대로 summary 지정 가능
  
  

📌 onPreferenceClick

유저가 설정 항목을 누르는 순간을 이벤트 처리

idPreference?.setOnPreferenceClickListener {
	true
}

• 이벤트 처리가 필요하다면 setOnPreferenceClickListener() 을 이용해 이벤트 핸들러를 지정

📌 onPreferenceChange

유저가 설정 값을 변경한 순간을 이벤트 처리

idPreference?.setOnPreferenceChangeListener { preference, newValue ->
	Log.d("kotdev", "preference key : ${preference.key}, newValue : $newValue")
	true
}

• 유저가 설정을 변경한 순간을 감지해 변경한 값을 이용해야 하는 경우

• Preference.OnPreferenceChangeListener 를 이용하는 방법은 각 Preference 객체에 적용

• SharedPreferences.OnSharedPreferenceChangeListener 는 모든 설정 객체의 변경을 하나의 이벤트 핸들러에서 감지하기 위한 방법

• 설정한 값이 매개변수 newValue 로 넘어온다.
  
  

🧩 실습 예제

res/xml 하위에 환경설정 XML 파일 생성

• settings.xml

<?xml version="1.0" encoding="utf-8"?>
<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">
    <SwitchPreferenceCompat
        android:key="serverFlag"
        android:summaryOff="서버 연동이 비활성화 되어 있습니다"
        android:summaryOn="서버 연동이 활성화 되어 있습니다"
        android:title="서버연동" />

    <PreferenceCategory
        android:dependency="serverFlag"
        android:title="서버연동정보">
        <EditTextPreference
            android:key="serverId"
            android:title="ID" />
        <ListPreference
            android:entries="@array/array_voice"
            android:entryValues="@array/array_voice"
            android:key="sound_list"
            android:title="서버 메시지 알림음" />
    </PreferenceCategory>
</PreferenceScreen>

ListPreference 항목에 출력할 문자열 배열을 XML 파일로 작성. res/values 하위에 생성한다.

• arrays.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string-array name="array_voice">
        <item>카톡</item>
        <item>카톡왔숑</item>
        <item>카카오톡</item>
    </string-array>
</resources>

XML 파일을 적용한 프래그먼트를 띄울 액티비티 레이아웃 작성

• activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<fragment xmlns:android="http://schemas.android.com/apk/res/android"
    class="com.kotdev99.android.c57.SettingFragment"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

XML 파일을 적용할 프래그먼트 작성

• SettingsFragment.kt

package com.kotdev99.android.c57

class SettingFragment : PreferenceFragmentCompat() {
	override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
		setPreferencesFromResource(R.xml.settings, rootKey)

		val idPreference = findPreference<EditTextPreference>("serverId")
		val soundPreference = findPreference<ListPreference>("sound_list")

		idPreference?.setOnPreferenceChangeListener { preference, newValue ->
			Toast.makeText(activity, "$newValue", Toast.LENGTH_SHORT).show()
			true
		}

		soundPreference!!.summaryProvider = ListPreference.SimpleSummaryProvider.getInstance()
		idPreference!!.summaryProvider =
			Preference.SummaryProvider<EditTextPreference> { preference ->
				val text = preference.text
				if (TextUtils.isEmpty(text)) {
					"설정 되지 않았습니다"
				} else {
					"설정된 id 값은 $text 입니다."
				}
			}
	}
}

📲 결과