Учебник по примерам общих настроек Android
В этом руководстве мы будем использовать общие настройки в нашем приложении для Android для хранения данных в виде пары ключ-значение. н
Обзор общих настроек Android
Общие настройки позволяют действиям и приложениям сохранять настройки в виде пар ключ-значение, подобных Map, которые будут сохраняться, даже когда пользователь закрывает приложение. Android хранит общие настройки в виде XML-файла в папке shared_prefs в каталоге DATA/data/{application package}. Папку DATA можно получить, вызвав Environment.getDataDirectory()
. SharedPreferences зависит от приложения, т. е. данные теряются при выполнении одного из следующих действий:
- при удалении приложения
- об очистке данных приложения (через настройки)
Как следует из названия, основной целью является хранение указанных пользователем сведений о конфигурации, таких как пользовательские настройки, что позволяет пользователю войти в приложение. Чтобы получить доступ к настройкам, у нас есть три API на выбор:
- getPreferences() : используется внутри вашей деятельности для доступа к настройкам конкретной деятельности.
- getSharedPreferences(): используется в вашей деятельности (или другом контексте приложения) для доступа к настройкам уровня приложения.
- getDefaultSharedPreferences(): используется в PreferenceManager для получения общих настроек, которые работают в соответствии с общей структурой настроек Android.
В этом руководстве мы воспользуемся getSharedPreferences()
. Метод определяется следующим образом: getSharedPreferences (String PREFS_NAME, режим int)
PREFS_NAME — это имя файла. режим - это рабочий режим. Применяются следующие режимы работы:
- MODE_PRIVATE: режим по умолчанию, в котором созданный файл может быть доступен только вызывающему приложению.
- MODE_WORLD_READABLE: создание общедоступных файлов очень опасно и может вызвать уязвимости в приложениях.
- MODE_WORLD_WRITEABLE: создание файлов, доступных для записи всем пользователям, очень опасно и может вызвать уязвимости в приложениях.
- MODE_MULTI_PROCESS: этот метод будет проверять изменение настроек, даже если экземпляр Shared Preference уже загружен.
- MODE_APPEND: новые настройки будут добавлены к уже существующим.
- MODE_ENABLE_WRITE_AHEAD_LOGGING: флаг открытия базы данных. Когда он установлен, по умолчанию будет включена запись в журнал с опережением
Инициализация
Нам нужен редактор для редактирования и сохранения изменений в общих настройках. Следующий код можно использовать для получения общих настроек.
SharedPreferences pref = getApplicationContext().getSharedPreferences("MyPref", 0); // 0 - for private mode
Editor editor = pref.edit();
Хранение данных
editor.commit() используется для сохранения изменений в общих настройках.
editor.putBoolean("key_name", true); // Storing boolean - true/false
editor.putString("key_name", "string value"); // Storing string
editor.putInt("key_name", "int value"); // Storing integer
editor.putFloat("key_name", "float value"); // Storing float
editor.putLong("key_name", "long value"); // Storing long
editor.commit(); // commit changes
Извлечение данных
Данные можно получить из сохраненных настроек, вызвав getString() следующим образом:
pref.getString("key_name", null); // getting String
pref.getInt("key_name", -1); // getting Integer
pref.getFloat("key_name", null); // getting Float
pref.getLong("key_name", null); // getting Long
pref.getBoolean("key_name", null); // getting boolean
Очистка или удаление данных
remove(\key_name) используется для удаления этого конкретного значения. clear() используется для удаления всех данных
editor.remove("name"); // will delete key name
editor.remove("email"); // will delete key email
editor.commit(); // commit changes
editor.clear();
editor.commit(); // commit changes
Структура проекта
Код проекта общих настроек Android
Макет activity_main.xml
состоит из двух представлений EditText, в которых хранятся и отображаются имя и адрес электронной почты. Три кнопки реализуют свои соответствующие onClicks в MainActivity
.
<RelativeLayout xmlns:android="https://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:paddingBottom="@dimen/activity_vertical_margin"
android:paddingLeft="@dimen/activity_horizontal_margin"
android:paddingRight="@dimen/activity_horizontal_margin"
android:paddingTop="@dimen/activity_vertical_margin" >
<Button
android:id="@+id/btnSave"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_centerVertical="true"
android:layout_alignParentLeft="true"
android:layout_alignParentStart="true"
android:onClick="Save"
android:text="Save" />
<Button
android:id="@+id/btnRetr"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_centerHorizontal="true"
android:layout_centerVertical="true"
android:onClick="Get"
android:text="Retrieve" />
<Button
android:id="@+id/btnClear"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_alignRight="@+id/etEmail"
android:layout_centerVertical="true"
android:layout_alignParentRight="true"
android:layout_alignParentEnd="true"
android:onClick="clear"
android:text="Clear" />
<EditText
android:id="@+id/etEmail"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:ems="10"
android:hint="Email"
android:inputType="textEmailAddress"
android:layout_below="@+id/etName"
android:layout_marginTop="20dp"
android:layout_alignParentRight="true"
android:layout_alignParentEnd="true" />
<EditText
android:id="@+id/etName"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:ems="10"
android:hint="Name"
android:inputType="text"
android:layout_alignParentTop="true"
android:layout_alignLeft="@+id/etEmail"
android:layout_alignStart="@+id/etEmail" />
</RelativeLayout>
Файл MainActivity.java
используется для сохранения и извлечения данных с помощью ключей.
package com.journaldev.sharedpreferences;
import android.app.Activity;
import android.content.Context;
import android.content.SharedPreferences;
import android.os.Bundle;
import android.view.Menu;
import android.view.View;
import android.widget.TextView;
public class MainActivity extends Activity {
SharedPreferences sharedpreferences;
TextView name;
TextView email;
public static final String mypreference = "mypref";
public static final String Name = "nameKey";
public static final String Email = "emailKey";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
name = (TextView) findViewById(R.id.etName);
email = (TextView) findViewById(R.id.etEmail);
sharedpreferences = getSharedPreferences(mypreference,
Context.MODE_PRIVATE);
if (sharedpreferences.contains(Name)) {
name.setText(sharedpreferences.getString(Name, ""));
}
if (sharedpreferences.contains(Email)) {
email.setText(sharedpreferences.getString(Email, ""));
}
}
public void Save(View view) {
String n = name.getText().toString();
String e = email.getText().toString();
SharedPreferences.Editor editor = sharedpreferences.edit();
editor.putString(Name, n);
editor.putString(Email, e);
editor.commit();
}
public void clear(View view) {
name = (TextView) findViewById(R.id.etName);
email = (TextView) findViewById(R.id.etEmail);
name.setText("");
email.setText("");
}
public void Get(View view) {
name = (TextView) findViewById(R.id.etName);
email = (TextView) findViewById(R.id.etEmail);
sharedpreferences = getSharedPreferences(mypreference,
Context.MODE_PRIVATE);
if (sharedpreferences.contains(Name)) {
name.setText(sharedpreferences.getString(Name, ""));
}
if (sharedpreferences.contains(Email)) {
email.setText(sharedpreferences.getString(Email, ""));
}
}
@Override
public boolean onCreateOptionsMenu(Menu menu) {
// Inflate the menu; this adds items to the action bar if it is present.
getMenuInflater().inflate(R.menu.menu_main, menu);
return true;
}
}
Скачать пример проекта общих настроек Android