一. SharedPreference简介
1. 官方介绍
SharedPreferences类提供了一个通用框架，以便您能够保存和检索原始数据类型的永久性键值对。 您可以使用 SharedPreferences
来保存任何原始数据：布尔值、浮点值、整型值、长整型和字符串。 此数据将跨多个用户会话永久保留（即使您的应用已终止亦如此）。
2. 适用范围
适用于存储数据量小，类型简单（SharedPreference只支持五种基本类型的存储），如配置信息，简单的数据，实现记住密码功能等，但是官方不推荐用来存储用户的系统设置，如果要存储用户首选项，更应该用PreferenceActivity。（引用自官方原文）
严格来说，共享首选项并非用于保存“用户首选项”，例如用户所选择的铃声。 如果您有兴趣为您的应用创建用户首选项，请参阅 PreferenceActivity，其中为您提供了一个 Activity 框架，用于创建将会自动永久保留（通过共享首选项）的用户首选项。
3. 存储位置
SharedPreference一般存储在内置存储的data/data/package name/shared_prefs/文件夹下，普通用户和应用程序是无法查看到应用的SharedPreference数据的。
4. 文件格式（以键值对存储的xml文件）
SharedPreference格式
二. 使用方法：
1. 写入数据
1.1 获取到SharedPreference对象（三种方法）
- Context.getSharedPreferences()方法
getSharedPreferences(String name, int mode)//name是文件名，mode是操作模式（只有MODE_PRIVATE可选，其他均已废弃）
- Activity.getPreferences()方法
getPreferences(int mode)//模式还是只能选MODE_PRIVATE，该方法不用指定文件名，会自动将当前类名作为文件名
- PreferenceManager类中的getDefaultSharedPreferences()方法
SharedPreferences getDefaultSharedPreferences(Context context)//该方法是静态方法，只需要传入上下文参数，无操作模式，文件名形式是packagename_preferences
1.2 调用SharedPreference对象的edit（）方法获取一个SharedPreference.Editor对象
1.3 调用Editor对象的putXXX（）方法像SharedPreference文件中写入数据
1.4 调用Editor对象的apply/commit方法提交数据，完成写入
原本只有commit()这一种提交方法，但因为这是一个同步的方法，若数据量大会堵塞UI线程，所以Google后来折腾出了apply（）这么一个异步的提交方法，因此推荐使用apply方法进行提交
两种方法比较
2. 读取数据
- 用1中的方法获取到SharedPreference，再调用getXXX（）方法即可
三. 源码
- activity_main.xml
<?xml version="1.0" encoding="utf-8"?>
<android.support.constraint.ConstraintLayout
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context="com.example.nickelfox.sharedpreferencedemo.MainActivity">
<Button
android:id="@+id/bt_save_data"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:text="Save data"
app:layout_constraintTop_toTopOf="parent"
android:layout_marginTop="8dp"
android:layout_marginRight="8dp"
app:layout_constraintRight_toRightOf="parent"
android:layout_marginLeft="8dp"
app:layout_constraintLeft_toLeftOf="parent"
android:onClick="SaveData"/>
<Button
android:id="@+id/bt_restore_data"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:layout_marginLeft="8dp"
android:layout_marginRight="8dp"
android:layout_marginTop="8dp"
android:text="Restore data"
app:layout_constraintLeft_toLeftOf="parent"
app:layout_constraintRight_toRightOf="parent"
app:layout_constraintTop_toBottomOf="@+id/bt_save_data"
android:onClick="restoreData"/>
<TextView
android:id="@+id/tv_data"
android:layout_width="0dp"
android:layout_height="0dp"
android:text="TextView"
android:layout_marginTop="8dp"
app:layout_constraintTop_toBottomOf="@+id/bt_restore_data"
android:layout_marginRight="8dp"
app:layout_constraintRight_toRightOf="parent"
android:layout_marginLeft="8dp"
app:layout_constraintLeft_toLeftOf="parent"
app:layout_constraintBottom_toBottomOf="parent"
android:layout_marginBottom="8dp"
app:layout_constraintVertical_bias="0.502"/>
</android.support.constraint.ConstraintLayout>
- MainActivity
public class MainActivity extends AppCompatActivity {
TextView mTextView;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
mTextView = (TextView) findViewById(R.id.tv_data);
}
/*将数据存储到SharedPreference*/
public void SaveData(View view) {
/*获取到SharedPreference
* 方法一：Context.getSharedPreferences()方法*/
SharedPreferences.Editor editor = getSharedPreferences("data",MODE_PRIVATE).edit();
editor.putString("name","Tom");
editor.putInt("age",28);
editor.putBoolean("married",false);
editor.apply();
Toast.makeText(this,"Data saved",Toast.LENGTH_SHORT).show();
/*获取到Shared Preference
* 方法二：Activity.getPreferences()*/
SharedPreferences.Editor editor2 = getPreferences(MODE_PRIVATE).edit();
editor2.putString("name","Tom");
editor2.putInt("age",28);
editor2.putBoolean("married",false);
editor2.apply();
/*获取到Shared Preference
* 方法三：PreferenceManager类中的getDefaultSharedPreferences()方法*/
SharedPreferences.Editor editor3 = PreferenceManager.getDefaultSharedPreferences(this).edit();
editor3.putString("name","Tom");
editor3.putInt("age",28);
editor3.putBoolean("married",false);
editor3.apply();
}
/*从SharedPreference读取数据*/
public void restoreData(View view) {
/*方法一*/
SharedPreferences sharedPreferences = getSharedPreferences("data",MODE_PRIVATE);
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append(sharedPreferences.getString("name","Tom"))
.append(sharedPreferences.getInt("age",28))
.append(sharedPreferences.getBoolean("married",false)+"\n");
/*方法二*/
SharedPreferences sharedPreferences1 = getPreferences(MODE_PRIVATE);
stringBuilder.append(sharedPreferences1.getString("name","Tom"))
.append(sharedPreferences1.getInt("age",28))
.append(sharedPreferences1.getBoolean("married",false)+"\n");
/*方法三*/
SharedPreferences sharedPreferences2 = PreferenceManager.getDefaultSharedPreferences(this);
stringBuilder.append(sharedPreferences1.getString("name","Tom"))
.append(sharedPreferences1.getInt("age",28))
.append(sharedPreferences1.getBoolean("married",false)+"\n");
if(!TextUtils.isEmpty(stringBuilder)){
mTextView.setText(stringBuilder);
}
}
}
四. Editor方法详解
- 除了putXXX方法之外，Editor还有两个方法（remove和clear）
/*remove方法根据输入的键值将对应的数据删除*/
public void remove(View view) {
SharedPreferences.Editor editor = getSharedPreferences("data",MODE_PRIVATE).edit();
editor.remove("name");
editor.apply();
}
/*clear方法用于将对应的SharedPreference数据清空*/
public void clear(View view) {
SharedPreferences.Editor editor = getSharedPreferences("data",MODE_PRIVATE).edit();
editor.clear();
editor.apply();
}
