android 数据存储 轻量级存储SharedPreferences

很多软件都有配置文件，里面存放该程序运行中的各个属性值，由于其配置信息并不多，所以通常不采用数据库的存储方式，而是存放在properties、XML等格式的文件中。Android中利用SharedPreferences来存放应用中的配置信息。

SharedPreferences是Android平台上一个轻量级的存储类，主要用于存储一些应用程序的配置参数，例如登录状态、自定义参数的设置等。SharedPreferences中存储的数据是以key-value，也就是键值对的形式保存在XML文件中的，该文件位于data/data/<packagename>/shared_prefs/目录下。需要注意的是，SharedPreferences中的value值只能是float、int、long、boolean、String或StringSet类型的数据。

1 将数据存储到SharedPreferences中

使用SharedPreferences类存储数据时，首先需要获取SharedPreferences对象。Android中获取SharedPreferences对象的方法有两种：

getSharedPreferences（Stringname，intmode）方法

getSharedPreferences（）方法在Context类中，此方法接收两个参数：第一个参数用于指定SharedPreferences文件的名称，当指定的文件不存在时，会进行创建；第二个参数用于指定文件操作模式，该模式有四个值可供选择，具体如下：

● MODE_PRIVATE：默认操作模式，代表该文件是私有数据，只能被本应用程序访问。

● MODE_APPEND：会检查文件是否存在，如果存在，就向文件追加内容，否则创建新文件。

● MODE_WORLD_READABLE：允许其他应用程序对该SharedPreferences文件进行读操作。

● MODE_WORLD_WRITEABLE：允许其他应用程序对该SharedPreferences文件进行读写操作。

getPreferences（intmode）方法

该方法在Activity中，和getSharedPreferences（）方法相似，不过它只接收一个参数，即操作模式，因为使用这个方法时会自动将当前活动的类名作为SharedPreferences的文件名。

得到了SharedPreferences对象后，就可以开始向SharedPreferences文件中存储数据了。但是还有一点需要注意，SharedPreferences对象本身只能获取数据，并不支持数据的存储和修改，存储和修改数据需要通过SharedPreferences.Editor对象实现。实际上，Editor是SharedPreferences的一个内部接口，要想获取Editor的实例，需要调用SharedPreferences对象的Edit（）方法，示例代码如下：

SharedPreferences.Editor的相关方法

通过SharedPreferences对象获取到Editor实例之后，就可以通过Editor对象的相关方法存储数据了，具体代码如下：

与存储数据类似，SharedPreferences删除数据时同样需要先获取到Editor对象，然后通过该对象删除数据，具体代码如下：

多学一招：通过Editor.apply（）方法提交数据。

在SharedPreferences文件中使用Editor的putXXX（）方法或remove（）方法存入或删除数据后，也可以使用editor.apply（）方法提交数据。它和commit（）方法的区别在于：

● apply（）方法没有返回值而commit（）方法返回boolean表明修改是否提交成功。

● apply（）方法是将修改数据的操作先提交到内存，而后异步的真正提交到硬件磁盘，而commit（）方法是同步的提交到硬件磁盘。因此，在多个线程中并发的调用commit（）方法的时候，它们会等待正在处理的commit保存到磁盘后再操作，从而降低了执行效率。

● apply（）方法没有任何失败的提示。

由于在一个进程中，SharedPreferences是单个实例，一般不会出现并发冲突，如果对提交的结果不关心，建议使用apply（）方法，当然需要确保提交成功且有后续操作的话，还是建议使用commit（）方法的。

2 从SharedPreferences中读取数据

使用SharedPreferences，更准确的说是Editor对象来存储数据是非常简单的，从SharedPreferences文件中读取数据更是如此。SharedPreferences对象中提供了一系列的get方法，用于读取存储的数据，每个get方法都对应于SharedPreferences.Editor中的一种put方法。例如，读取一个布尔型数据可以使用getBoolean（）方法，读取一个字符串可以使用getString（）方法。

SharedPreferences的相关方法

从上表中可以看出，SharedPreferences中的get方法都接收两个参数：第一个参数是“键”，应与存储数据时使用的key一致，否则查找不到数据；第二个参数是默认值，表示当传入的键找不到对应的值时该方法就以这个值作为返回值。

SharedPreferences获取数据更加地简单，只需要创建SharedPreferences对象，然后使用该对象获取相应key对应的value即可，示例代码如下：

 

保存登录信息实例

类似于微信、美团等很多Android应用，只有在手机上第一次安装使用时需要输入用户名和密码，后续打开App就直接进入已经登录成功的界面了。接下来通过一个实例演示如何使用SharedPreferences实现保存登录信息的功能。具体步骤如下所示。

（1）新建一个名为SavingLoginInfo的项目，待项目创建成功后修改layout目录下自动生成的activity_main.xml布局文件，代码如下所示。

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout 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"
    android:gravity="center_horizontal"
    android:orientation="vertical"
    android:padding="10dp">

    <ImageView
        android:layout_width="60dp"
        android:layout_height="60dp"
        android:layout_marginTop="80dp"
        android:src="@drawable/head"/>


    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="8dp">

        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="账号："
            android:textColor="#000000"
            android:textSize="20sp"/>
        <EditText
            android:id="@+id/et_username"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:hint="请输入用户名"/>
    </LinearLayout>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="8dp">

        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="密码："
            android:textColor="#000000"
            android:textSize="20sp"/>
        <EditText
            android:id="@+id/et_password"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:hint="请输入密码"/>
    </LinearLayout>

    <Button
        android:id="@+id/btn_login"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="10dp"
        android:text="登录"
        android:textSize="20sp"/>

    <CheckBox
        android:id="@+id/cb_saved"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_gravity="right"
        android:text="是否记住您的用户名和密码"/>
</LinearLayout>

上述XML代码的预览效果如图所示

（2）向项目中添加一个LoginSuccessActivity，并修改它的布局文件，完成后效果如图5-2所示。该Activity的作用仅仅表示登录成功后的跳转界面。

 

 

LoginSuccessActivity界面预览效果

 

（3）需要在MainActivity中实现处理逻辑，具体代码如下所示。

package com.example.savinglogininfo;

import androidx.appcompat.app.AppCompatActivity;

import android.content.Intent;
import android.content.SharedPreferences;
import android.os.Bundle;
import android.text.TextUtils;
import android.util.Log;
import android.view.View;
import android.widget.Button;
import android.widget.CheckBox;
import android.widget.EditText;
import android.widget.Toast;

public class MainActivity extends AppCompatActivity {
    private EditText etUserName;
    private EditText etPassword;
    private Button btnLogin;
    private CheckBox cbSaved;
    private SharedPreferences preferences;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        etUserName= (EditText)findViewById(R.id.et_username);
        etPassword=(EditText)findViewById(R.id.et_password);
        cbSaved=(CheckBox)findViewById(R.id.cb_saved);
        btnLogin=(Button)findViewById(R.id.btn_login);
        preferences=getSharedPreferences("login_info",MODE_PRIVATE);


        btnLogin.setOnClickListener(new View.OnClickListener(){
            @Override
            public void onClick(View v) {
                String username = etUserName.getText().toString().trim();
                String password = etPassword.getText().toString().trim();
                //判断用户输入信息是否完整
                if(!TextUtils.isEmpty(username) && !TextUtils.isEmpty(password)){
                    //如果勾选了cbSaved，则将复选框勾选状态和用户登录信息记录在SharedPreferes中
                    if(cbSaved.isChecked()){
                        SharedPreferences.Editor editor = preferences.edit();
                        editor.putBoolean("isSaved",cbSaved.isChecked());
                        editor.putString("username",username);
                        editor.putString("password",password);
                        editor.commit();
                    } else{//如果没有勾选cbSaved,则清空SharedPreferences的内容
                        SharedPreferences.Editor editor = preferences.edit();
                        editor.clear();
                        editor.commit();
                    }
                    //登录成功，跳转到LoginSuccessActivity
                    Intent intent = new Intent(MainActivity.this, LoginSuccessActivity.class);
                    startActivity(intent);
                    //销毁登录界面
                    finish();
                }else{
                    Toast.makeText(MainActivity.this,"请将登录信息填写完整",Toast.LENGTH_LONG).show();
                }

            }

        });

        //打开登录界面时首先判断SharedPreferences中是否记录了登录信息
        boolean isSaved=preferences.getBoolean("isSaved",false);
        if(isSaved){
            //勾选CheckBox，并将SharedPreferences记录的用户名和密码设置到EditText中
            cbSaved.setChecked(true);
            etUserName.setText( preferences.getString("username",""));
            etPassword.setText(preferences.getString("password",""));
        }
    }
}

上述代码首先在onCreate（）方法中对布局文件里的各控件进行初始化，并获取了一个SharedPreferences对象，用于对登录信息进行存取。然后为“登录”按钮添加了监听器，当用户单击时，执行onClick（）方法检查用户名和密码输入的内容，两者均不为空时，接着判断CheckBox的勾选情况，根据结果分别执行将登录信息存入SharedPreferences或清空SharedPreferences中全部内容的具体操作。接下来简单的做直接登录成功的处理，跳转到LoginSuccessActivity界面并销毁MainActivity。onCreate（）方法的最后，通过SharePreferences对象的getBoolean（）方法获取key为"isSaved"的数据，如果之前记录了登录信息，则直接将其显示在用户名和密码的输入框中。

完成上述操作后，运行程序，效果如图所示。输入用户名和密码，然后勾选CheckBox控件记录登录信息，单击登录按钮跳转到LoginSuccessActivity界面。在此界面单击返回键将退出程序回到应用程序列表界面，接着单击SavingLoginInfo图标重新运行程序，将看到用户之前保存的登录信息已经显示在界面上了，从而避免了每次登录都需要重复输入的麻烦。