1、SharedPreferences概述

要想使用 SharedPreferences 来存储数据，首先需要获取到 SharedPreferences 对象。Android 提供了三种方法得到 SharedPreferences 对象：

1、Context 类中的 getSharedPreferences()方法

此方法接收两个参数，第一个参数指定 SharedPreferences 文件的名称，第二个参数指定操作模式，目前只有
MODE_PRIVATE 一种模式，和直接传入 0 效果相同。其他几种模式已被废弃。
2、Activity 类中的 getPreferences()方法
此方法和上面的方法相似，但只接收一个操作模式参数，使用这个方法时会自动将当前活动的类名作为 SharedPreferences 的文件名。
3、PreferenceManager 类中的 getDefaultSharedPreferences()方法
这是一个静态方法，它接收一个 Context 参数，并自动使用当前应用程序的包名作为前缀来命名 SharedPreferences 文件。

得到了 SharedPreferences 对象之后，分为三步实现向 SharedPreferences 文件中存储数据：

（1）调用 SharedPreferences 对象的 edit()方法来获取一个 SharedPreferences.Editor对象。
（2）向 SharedPreferences.Editor 对象中添加数据，如添加一个布尔型数据使用 putBoolean方法，添加一个字符串使用 putString()方法，以此类推。
（3）调用 apply()方法将添加的数据提交，完成数据存储。

当然，SharedPreference在提交数据时也可用 Editor 的 commit 方法，两者区别如下：

apply() 没有返回值，而 commit() 返回 boolean 表明修改是否提交成功
apply() 将修改提交到内存，然后再异步提交到磁盘上;而 commit() 是同步提交到磁盘上。谷歌建议：若在UI线程中，使用apply() 减少UI线程的阻塞（写到磁盘上是耗时操作）引起的卡顿。

新建一个项目

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical" >
 
    <Button
        android:id="@+id/save_data"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="保存数据" />
 
</LinearLayout>

放一个按钮，将一些数据存储到SharedPreferences 文件当中。然后修改 Activity 中的代码

public class SharePreferencesActivity extends AppCompatActivity {
 
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_share_preferences);
 
        Button save_data = (Button) findViewById(R.id.save_data);
        save_data.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                // 1.指定文件名为 wonderful，并得到 SharedPreferences.Editor 对象
                SharedPreferences.Editor editor = getSharedPreferences("wonderful",MODE_PRIVATE).edit();
                // 2.添加数据
                editor.putString("name","开心wonderful");
                editor.putInt("age",20);
                editor.putBoolean("married",false);
                // 3.数据提交
                editor.apply();
            }
        });
    }
}

点击按钮后，这时数据已保存成功了，生成了一个 wonderful.xml 文件

SharedPreferences 文件是使用 XML 格式来对数据进行管理的

2、从 SharedPreferences 中读取数据

SharedPreferences 对象中提供了一系列的 get 方法用于对存储的数据进行读取

每种 get 方法都对应了 SharedPreferences. Editor 中的一种 put 方法

这些 get 方法接收两个参数，第一个参数是键，即传入存储数据时使用的键；第二个参数是默认值

即当传入的键找不到对应的值时，返回默认值

修改上面项目中的布局代码：

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"  >
 
    <Button
        android:id="@+id/save_data"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="保存数据" />
 
    <Button
        android:id="@+id/restore_data"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="读取数据" />
    
    <TextView
        android:id="@+id/show_data"
        android:layout_width="match_parent"
        android:layout_height="wrap_content" />
 
</LinearLayout>

增加了一个还原数据的按钮和 TextView，点击按钮来从 SharedPreferences 文件中读取数据并在 TextView 中显示读取的数据

修改 Activity 中的代码：

public class SharePreferencesActivity extends AppCompatActivity {
    
    private Button save_data,restore_data;
    
    private TextView textView;
 
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_share_preferences);
 
        save_data = (Button) findViewById(R.id.save_data);
        save_data.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                // 1.指定文件名为 wonderful，并得到 SharedPreferences.Editor 对象
                SharedPreferences.Editor editor = getSharedPreferences("wonderful",MODE_PRIVATE).edit();
                // 2.添加不同类型的数据
                editor.putString("name","开心wonderful");
                editor.putInt("age",20);
                editor.putBoolean("married",false);
                // 3.数据提交
                editor.apply();
            }
        });
 
        textView = (TextView) findViewById(R.id.show_data);
        restore_data = (Button) findViewById(R.id.restore_data);
        restore_data.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                // 获得 SharedPreferences 对象
                SharedPreferences pref = getSharedPreferences("wonderful",MODE_PRIVATE);
                // 获取相应的值
                String name = pref.getString("name","");
                int age = pref.getInt("age",0);
                boolean married = pref.getBoolean("married",false);
                // 将获取到的值显示
                textView.setText("name is " + name + ",age is "+ age + ",married is "+ married);
            }
        });
    }
}

3 、实现记住密码功能

会用上一章广播的强制下线的例子

修改项目前，先来简单封装下关于 SharedPreferences 的工具类，如下：

public class PrefUtils {
 
    private static final String PREF_NAME = "config";
 
    /**
     * 读取布尔数据
     * @param ctx 上下文
     * @param key 键
     * @param defaultValue 默认值
     * @return
     */
    public static boolean getBoolean(Context ctx, String key,
                                     boolean defaultValue) {
        SharedPreferences sp = ctx.getSharedPreferences(PREF_NAME,
                Context.MODE_PRIVATE);
        return sp.getBoolean(key, defaultValue);
    }
 
    /**
     * 添加布尔数据
     * @param ctx 上下文
     * @param key 键
     * @param value 添加的数据
     */
    public static void setBoolean(Context ctx, String key, boolean value) {
        SharedPreferences sp = ctx.getSharedPreferences(PREF_NAME,
                Context.MODE_PRIVATE);
        sp.edit().putBoolean(key, value).apply();
    }
 
    /**
     * 读取字符串
     * @param ctx
     * @param key
     * @param defaultValue
     * @return
     */
    public static String getString(Context ctx, String key, String defaultValue) {
        SharedPreferences sp = ctx.getSharedPreferences(PREF_NAME,
                Context.MODE_PRIVATE);
        return sp.getString(key, defaultValue);
    }
 
    /**
     * 添加字符串
     * @param ctx
     * @param key
     * @param value
     */
    public static void setString(Context ctx, String key, String value) {
        SharedPreferences sp = ctx.getSharedPreferences(PREF_NAME,
                Context.MODE_PRIVATE);
        sp.edit().putString(key, value).apply();
    }
 
    /**
     * 读取int类型数据
     * @param ctx
     * @param key
     * @param defaultValue
     * @return
     */
    public static int getInt(Context ctx, String key, int defaultValue) {
        SharedPreferences sp = ctx.getSharedPreferences(PREF_NAME,
                Context.MODE_PRIVATE);
        return sp.getInt(key, defaultValue);
    }
 
    /**
     * 添加int类型数据
     * @param ctx
     * @param key
     * @param value
     */
    public static void setInt(Context ctx, String key, int value){
        SharedPreferences sp = ctx.getSharedPreferences(PREF_NAME,
                Context.MODE_PRIVATE);
        sp.edit().putInt(key, value).apply();
    }
 
    /**
     * 将数据全部清除掉
     * @param ctx
     */
    public static void clear(Context ctx){
        SharedPreferences sp = ctx.getSharedPreferences(PREF_NAME,
                Context.MODE_PRIVATE);
        sp.edit().clear().apply();
    }
}

编辑下登录界面，修改 activity_login.xml 中的代码：

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical">
 
    <!--***************** 账号 *********************-->
    <LinearLayout
        android:orientation="horizontal"
        android:layout_width="match_parent"
        android:layout_height="60dp">
        <TextView
            android:layout_width="90dp"
            android:layout_height="wrap_content"
            android:layout_gravity="center_vertical"
            android:gravity="center"
            android:textSize="18sp"
            android:text="账号："/>
 
        <EditText
            android:id="@+id/et_account"
            android:layout_width="0dp"
            android:layout_height="wrap_content"
            android:layout_weight="1"
            android:layout_gravity="center_vertical"/>
    </LinearLayout>
 
    <!--***************** 密码 *********************-->
    <LinearLayout
        android:orientation="horizontal"
        android:layout_width="match_parent"
        android:layout_height="60dp">
        <TextView
            android:layout_width="90dp"
            android:layout_height="wrap_content"
            android:layout_gravity="center_vertical"
            android:gravity="center"
            android:textSize="18sp"
            android:text="密码："/>
 
        <EditText
            android:id="@+id/et_password"
            android:layout_width="0dp"
            android:layout_height="wrap_content"
            android:layout_weight="1"
            android:layout_gravity="center_vertical"
            android:inputType="textPassword"/>
    </LinearLayout>
 
    <!--***************** 是否记住密码 *********************-->
    <LinearLayout
        android:orientation="horizontal"
        android:layout_width="match_parent"
        android:layout_height="wrap_content">
 
        <CheckBox
            android:id="@+id/cb_remember_pass"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_margin="10dp"/>
 
        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:textSize="18sp"
            android:layout_gravity="center_vertical"
            android:text="记住密码"/>
 
    </LinearLayout>
 
    <Button
        android:id="@+id/btn_login"
        android:layout_width="match_parent"
        android:layout_height="60dp"
        android:layout_margin="10dp"
        android:text="登录"/>
 
</LinearLayout>

添加了个 CheckBox 来勾选记住密码，接着修改 LoginActivity 的代码：

public class LoginActivity extends BaseActivity {
 
    private EditText et_account, et_password;
    private CheckBox cb_remember_pass;
    private Button btn_login;
 
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
 
        et_account = (EditText) findViewById(R.id.et_account);
        et_password = (EditText) findViewById(R.id.et_password);
        cb_remember_pass = (CheckBox) findViewById(R.id.cb_remember_pass);
        btn_login = (Button) findViewById(R.id.btn_login);
        
        Boolean isRemember = PrefUtils.getBoolean(this,"remember_pass",false);
        if (isRemember){
            // 将账号和密码都设置到文本框中
            String account = PrefUtils.getString(this,"account","");
            String password = PrefUtils.getString(this,"password","");
            et_account.setText(account);
            et_password.setText(password);
            cb_remember_pass.setChecked(true);
        }
 
        btn_login.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                String account = et_account.getText().toString();
                String password = et_password.getText().toString();
                // 若账号是 wonderful 且密码是 123456，就认为登录成功
                if (account.equals("wonderful") && password.equals("123456")){
                    // 检查复选框是否被勾选
                    if (cb_remember_pass.isChecked()){
                        // 保存数据到SharePreference文件中
                        PrefUtils.setBoolean(LoginActivity.this,"remember_pass",true);
                        PrefUtils.setString(LoginActivity.this,"account",account);
                        PrefUtils.setString(LoginActivity.this,"password",password);
                    }else {
                        // 清除SharePreference文件中的数据
                        PrefUtils.clear(LoginActivity.this);
                    }
                    // 登录成功跳转到主界面
                    IntentUtils.myIntent(LoginActivity.this,ForceOfflineActivity.class);
                    finish();
                }else {
                    ToastUtils.showShort("账号或密码无效！");
                }
            }
        });
 
    }
 
    @Override
    protected int initLayoutId() {
        return R.layout.activity_login;
    }
}

参考

1、第一行代码之SharedPreferences存储

Android ：数据存储方案学习笔记之 SharedPreferences

SharedPreferences

1、SharedPreferences概述

2、从 SharedPreferences 中读取数据

3 、实现记住密码功能

参考

猜你喜欢