Android 之 getSharedPreferences 和 getPreferences

今天为所做的小程序设计参数的保存，用到了 getSharedPreferences 和 getPreferences。

首先，将对 getSharedPreferences 和 getPreferences 的调用模块化，做成一个类。关于这两个函数使用的要点，在代码中以注释的形式给出。

类的实现如下：

package com.hs.leozheng.backuprecords;

import android.app.Activity;
import android.content.Context;
import android.content.SharedPreferences;

/*
 * 定义了两组函数，分别使用 getSharedPreferences 和 getPreferences
 * */

public class ConfigsData {
	// public static final String NetConfigsData = "NetConfigsData";
	public static final String NetConfigIP = "NetConfigIP";
	
	/*
	 * 可以通过如下两个方法中的某个方法来创建一个新的 Shared preferences 文件或者访问一个已经存在的文件
		1、getSharedPreferences() 如果应用中有多个 Shared Preferences 文件需要保存，这个方法很适合
			第一个参数为你给这个文件指定的 ID，可以通过应用的上下文来调用它
			getSharedPreferences 是 Context 类中的方法， 可以指定 filename 以及  mode
		2、getPreferences() 如果应用只需要保存一个 Shared Preferences 文件，这个方法很适合
			由于应用只有一个 Shared Preferences 文件，所以不需要为其指定名称，系统在创建时会默认一个名称
			getPreferences 是 Activity 类中的方法，只需指定 mode
	 * */
	
	/*
	 * 根据 API 文档描述，SharedPreferences 是一个单例类，这样容易保证多方同时操作时的同步
	 * SharedPreferences 实际上管理的是 XML 文件，所有的设置值都以 KEY-VALUE 的形式保存在 /data/data/PACKAGE_NAME/shared_prefs 目录下对应的文件中
	 * */
	boolean saveConfigDataEx(Context context,String configName,String value) {
		SharedPreferences settings = context.getSharedPreferences(configName, 0);
		SharedPreferences.Editor editor = settings.edit();
		editor.putString(configName, value);
		editor.commit();
		
		return true;
	}
	
	String readConfigDataEx(Context context,String configName) {
		SharedPreferences settings = context.getSharedPreferences(configName, 0);
		String ip = settings.getString(configName, "127.0.0.1");
		
		return ip;
	}
	
	/* ---------------------------------------------------------------------------------- */
	boolean saveConfigData(Activity activity,String configName,String value) {
		SharedPreferences settings = activity.getPreferences(Context.MODE_PRIVATE);
		SharedPreferences.Editor editor = settings.edit();
		editor.putString(configName, value);
		editor.commit();
		
		return true;
	}
	
	String readConfigData(Activity activity,String configName) {
		SharedPreferences settings = activity.getPreferences(Context.MODE_PRIVATE);
		String ip = settings.getString(configName, "127.0.0.1");
		
		return ip;
	}
}

类实现了，就要对类进行简单的测试。编写了如下的测试代码，先是分析调用 getSharedPreferences 和 getPreferences 的两个函数，然后是对这两个函数的调用。

如下代码所示：

void testCallConfigSave(Activity activity) {
	ConfigsData configsData = new ConfigsData();
	String netIP = configsData.readConfigData(activity, ConfigsData.NetConfigIP);
	Log.i(phoneBookInfo.TAG, "Read config data,IP is: " + netIP);
	
	configsData.saveConfigData(activity, ConfigsData.NetConfigIP, "192.168.3.9");
	netIP = configsData.readConfigData(activity, ConfigsData.NetConfigIP);
	Log.i(phoneBookInfo.TAG, "Read config data,IP is: " + netIP);
	
	configsData.saveConfigData(activity, ConfigsData.NetConfigIP, "192.168.3.10");
	netIP = configsData.readConfigData(activity, ConfigsData.NetConfigIP);
	Log.i(phoneBookInfo.TAG, "Read config data,IP is: " + netIP);
}

void testCallConfigSaveEx(Context context) {
	ConfigsData configsData = new ConfigsData();
	configsData.readConfigDataEx(context, ConfigsData.NetConfigIP);
	String netIP = configsData.readConfigDataEx(context, ConfigsData.NetConfigIP);
	Log.i(phoneBookInfo.TAG, "ReadEx config data,IP is: " + netIP);
	
	configsData.saveConfigDataEx(context, ConfigsData.NetConfigIP, "192.168.4.9");
	netIP = configsData.readConfigDataEx(context, ConfigsData.NetConfigIP);
	Log.i(phoneBookInfo.TAG, "ReadEx config data,IP is: " + netIP);
	
	configsData.saveConfigDataEx(context, ConfigsData.NetConfigIP, "192.168.4.10");
	netIP = configsData.readConfigDataEx(context, ConfigsData.NetConfigIP);
	Log.i(phoneBookInfo.TAG, "ReadEx config data,IP is: " + netIP);
}

在 Activity 的 onCreate 中调用(注意参数的不同)：

testCallConfigSave(this);
testCallConfigSaveEx(getApplicationContext());

两次运行后输出的 LOG 分别如下：

第一次运行的 LOG 如下(卸载后运行算是第一次)：
 Read config data,IP is: 127.0.0.1
 Read config data,IP is: 192.168.3.9
 Read config data,IP is: 192.168.3.10
 ReadEx config data,IP is: 127.0.0.1
 ReadEx config data,IP is: 192.168.4.9
 ReadEx config data,IP is: 192.168.4.10

第二次运行的 LOG 如下：
 Read config data,IP is: 192.168.3.10
 Read config data,IP is: 192.168.3.9
 Read config data,IP is: 192.168.3.10
 ReadEx config data,IP is: 192.168.4.10
 ReadEx config data,IP is: 192.168.4.9
 ReadEx config data,IP is: 192.168.4.10

至此，测试完成。对 getSharedPreferences 和 getPreferences 调用的代码功能正常。