【Android 开发】：数据存储之 SharedPreference 共享参数

    在上一讲中，我们学习了如何将数据存储在SD卡中[数据存储之File文件存储 [即SD卡的写入与读取]]，这是一种存储方式，这一讲我们来学习一下使用SharedPreferences存储数据。

1.SharedPreferences 介绍

1) SharedPreferences 是一种参数共享的存储方式，它是通过键值对 key-value的形式来储存的。 所以读取方式也是通过读取键值对来的。
2) 这种存储方式主要用在存储一些简单的状态信息，比如在实际的软件界面设计中，我们需要保存一些系统的参数，例如屏幕大小和亮度、高度等。在没有数据的情况下我们把这些参数设置到参数共享的文件中以便下次访问。
3) SharedPreferences的基本用法：

1、SharedPreferences preferences =context.getSharedPreferences("login", Context.MODE_PRIVATE);
2、通过SharedPreferences .edit方法获得一个Editor对象。
3、通过SharedPreferences 的Editor.putXXX方法放置键值对保存到文件中。

4、最后调用commit方法保存文件。只有事务结束之后才能提交。

4) 查看 API文档中的SharedPreferences类详细介绍
    这个类 SharedPreferences 提供了一个通用的框架让你存储和检索已经存在的原生数据类型的键值对.你可以使用 SharedPreferences 来保存任何的原生数据：booleans, floats, ints, longs, and strings. (所以这边不建议用共享参数来保存一些复杂的数据类型：比如对象，图片等) 这些数据都会在用户会话期间保留(在应用程序进程关闭掉存储起来)
   在你的应用获取到一个 SharedPreferences 对象，需要使用下面两种方法的一种：
    (1) getSharedPreferences()
    (2) getPreferences()   

        两种方式的区别:

        调用Context对象的getSharedPreferences()方法获得的SharedPreferences对象可以被同一应用程序下的其他组件共享.

        调用Activity对象的getPreferences()方法获得的SharedPreferences对象只能在该Activity中使用.

    5) 写入数据

1. 调用 edit() 方法来得到一个 SharedPreferences.Editor.

2. 调用 putBoolean() 和 putString()方法来添加数据

3. 调用 commit() 方法来提交新的数据。

    6) 读取数据

使用 SharedPreferences 中的方法如 getBoolean() 和 getString().

2. 程序实现

1) AndroidMainifest.xml 文件，这里面包含了单元测试的内容，如有不懂可以参考前面几讲内容介绍

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.android.sharedprefrencesdemo"
    android:versionCode="1"
    android:versionName="1.0" >

    <uses-sdk
        android:minSdkVersion="10"
        android:targetSdkVersion="17" />
    <instrumentation android:name="android.test.InstrumentationTestRunner" android:targetPackage="com.android.sharedprefrencesdemo"></instrumentation>

    <application
        android:allowBackup="true"
        android:icon="@drawable/ic_launcher"
        android:label="@string/app_name"
        android:theme="@style/AppTheme" >
        <uses-library android:name="android.test.runner"/>
        <activity
            android:name="com.android.sharedprefrencesdemo.MainActivity"
            android:label="@string/app_name" >
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

2) 程序的布局文件，只有一个读取的按钮，写入数据在MainActivity的onCreate()方法中写入。

<RelativeLayout 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:paddingBottom="@dimen/activity_vertical_margin"
    android:paddingLeft="@dimen/activity_horizontal_margin"
    android:paddingRight="@dimen/activity_horizontal_margin"
    android:paddingTop="@dimen/activity_vertical_margin"
    tools:context=".MainActivity" >

    <Button
        android:id="@+id/button1"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_alignParentLeft="true"
        android:layout_alignParentTop="true"
        android:layout_marginLeft="34dp"
        android:layout_marginTop="44dp"
        android:text="取出" />

</RelativeLayout>

3) MySharedPrefrences.java 类，这个主要是用来实现sharedPreferences存储的方法

package com.android.sharedprefrencesdemo;

import java.util.HashMap;
import java.util.Map;

import android.content.Context;
import android.content.SharedPreferences;

/**
 * 实现往共享参数中存储简单的用户名和密码
 * 
 * @author AHuier
 */
public class MySharedPrefrences {

    private Context context;

    public MySharedPrefrences(Context context) {
        this.context = context;
    }

    /**
     * 查看 API文档 ：getSharedPreferences (String name, int mode)方法 根据参数文件 'name'
     * 检索和保存其内容，改方法会返回一个 SharedPreferences 对象，通过它可以检索和修改它的值， 注意任何调用相同 name
     * 的都只返回一个SharedPreferences 的实例(单例模式),这就意味这它们会看到批次修改的内容。 
     * 参数： 
     * name ： 所需的参数文件，如果 这个name 的对应的参数文件不存在，它就会被
     *        editor对象所创建(通过SharedPreferences.edit()方法获得), 然后提交修改
     *       (通过Editor.commit()方法). 
     * mode : 工作模式。使用 0 或者 MODE_PRIVATE 作为默认的操作，
     *        MODE_WORLD_READABLE 和 MODE_WORLD_WRITEABLE 用来控制读写权限。 在多个进程维护同样的
     *        SharedPreferences 文件时会用到 MODE_MULTI_PROCESS。 
     * 注意 MODE_MULTI_PROCESS 一般是用在Android 2.3版本中或者更低版本，并且在最近的版本中它是被默认关闭的。 
     * 工作模式有以下四种： 
     *     MODE_PRIVATE
     *     MODE_WORLD_READABLE 
     *     MODE_WORLD_WRITEABLE 
     *     MODE_MULTI_PROCESS 
     * Returns： 返回一个SharedPreferences 的单例用来检索和修改这个共享参数
     */
    public boolean saveMessage(String name, String pswd) {
        boolean flag = false;
        SharedPreferences sharedPreferences = context.getSharedPreferences("userInfo",
                Context.MODE_PRIVATE);

        // 对数据进行编辑,返回的是一个Editor对象
        SharedPreferences.Editor editor = sharedPreferences.edit();
        editor.putString("name", name);
        editor.putString("pswd", pswd);
        flag = editor.commit(); //讲数据持久化到存储介质中，有可能是手机内置存储,有可能是SD卡。
        return flag;
    }
    
    public Map<String, Object> getMessage(){
        Map<String, Object> map = new HashMap<String, Object>();
        SharedPreferences sharedPreferences = context.getSharedPreferences("userInfo", Context.MODE_PRIVATE);
        //从共享参数 SharedPreferences 取出数据
        String name = sharedPreferences.getString("name", ""); //如果取不到，默认值为空
        String pswd = sharedPreferences.getString("pswd", ""); //如果取不到，默认值为空
        //将数据put到HashMap中
        map.put("name", name);
        map.put("pswd", pswd);
        return map;
    }

}

4) MainActivity.java 类， 程序的主文件

package com.android.sharedprefrencesdemo;

import java.util.Map;

import android.os.Bundle;
import android.app.Activity;
import android.content.Context;
import android.util.Log;
import android.view.Menu;
import android.view.View;
import android.view.View.OnClickListener;
import android.widget.Button;

public class MainActivity extends Activity {

    private static final String TAG = "MainActivity";
    private Button button;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        initComponent();
        save();
        button.setOnClickListener(new OnClickListener() {

            @Override
            public void onClick(View v) {
                // TODO Auto-generated method stub
                getMsInfo();
            }
        });
    }

    @Override
    public boolean onCreateOptionsMenu(Menu menu) {
        // Inflate the menu; this adds items to the action bar if it is present.
        getMenuInflater().inflate(R.menu.main, menu);
        return true;
    }

    private void initComponent() {
        button = (Button) findViewById(R.id.button1);
    }

    public void save() {
        // Context context = getContext();
        MySharedPrefrences mySharedPrefrences = new MySharedPrefrences(MainActivity.this);
        boolean flag = mySharedPrefrences.saveMessage("admin", "1423456");
        Log.i(TAG, "----->>--" + flag);
    }

    public void getMsInfo() {
        // Context context = getContext();
        MySharedPrefrences mySharedPrefrences = new MySharedPrefrences(MainActivity.this);
        Map<String, Object> map = mySharedPrefrences.getMessage();
        Log.i(TAG, "---->> " + map.toString());
    }

}

5) MyTest.java 单元测试类

package com.android.sharedprefrencesdemo;

import java.util.Map;

import android.content.Context;
import android.test.AndroidTestCase;
import android.util.Log;

public class MyTest extends AndroidTestCase {

    private static final String TAG = "MyTest";

    public MyTest() {
        // TODO Auto-generated constructor stub
    }

    public void save() {
        Context context = getContext();
        MySharedPrefrences mySharedPrefrences = new MySharedPrefrences(context);
        boolean flag = mySharedPrefrences.saveMessage("admin", "123456");
        Log.i(TAG, "----->>--" + flag);
    }

    public void getMsInfo() {
        Context context = getContext();
        MySharedPrefrences mySharedPrefrences = new MySharedPrefrences(context);
        Map<String, Object> map = mySharedPrefrences.getMessage();
        Log.i(TAG, "---->> " + map.toString());
    }

}

3. 程序执行结果

1) 编译执行后会生成一个 xml 格式的文件，文件保存位置在 fileExplorer标签页查找 data/data/ 目录下，如下图所示
   注意到这里面文件命名有一个规范，它不需要保存文件的后缀名，它默认是以xml文件来命名的，通常共享参数一般用来保存用户的登陆的状态信息，或者某个功能开关的状态信息。

 

    2) 将其保存在电脑中，然后查看可以发现，它是以一种(map)键值对的形式来存放的，所以我们在取的过程中最好还是以Map的类型去取值。如下图
       所示

3) 编译执行后输出log，打印出读取的信息，如下所示

下一讲，我们来学习一下数据存储的其他存储方式，SQLite等数据存储方式。