Android初学者之SharePreferences



使用 SharedPreferences

 

SharedPreferences是一种轻量级的数据存储方式,学过Web开发的同学,可以想象它是一个小小的Cookie。它可以用键值对的方式把简单数据类型（boolean、int、float、long和String）存储在应用程序的私有目录下(data/data/包名/shared_prefs/)自己定义的xml文件中。

    SharedPreferences接口主要负责读取应用程序的Preferences数据，它提供了如下常用方法来访问SharedPreferences的key_value键值对。

   

SharedPreferences常用的属性和方法

方法名称	描述
public abstract boolean contains (String key)	判断SharedPreferences是否包含特定key的数据
public abstract SharedPreferences.Editor edit ()	返回一个Edit对象用于操作SharedPreferences
public abstract Map<String, ?> getAll ()	获取SharedPreferences数据里全部的key-value对
getXXX(String key,XXX defvlaue)	获取SharedPreferences数据指定key所对应的value，如果该key不存在，返回默认值defValue。其中XXX可以是boolean、float、int、long、String等基本类型的值

由于SharedPreference是一个接口，而且在这个接口里并没有提供写入数据和读取数据的能力。但是在其内部有一个Editor内部的接口，Edit这个接口有一系列的方法用于操作SharedPreference。

Editor接口的常用方法

方法名称	描述
public abstract SharedPreferences.Editor clear ()	清空SharedPreferences里所有的数据
public abstract boolean commit ()	当Editor编辑完成后，调用该方法可以提交修改，而且必须要调用这个数据才修改
public abstract SharedPreferences.Editor putXXX (String key, boolean XXX)	向SharedPreferences存入指定的key对应的数据，其中XXX可以是boolean、float、int、long、String等基本类型的值
public abstract SharedPreferences.Editor remove (String key)	删除SharedPreferences里指定key对应的数据项

 

SharedPreferences是一个接口，程序是无法创建SharedPreferences实例的，可以通过Context.getSharedPreferences(String name,int mode)来得到一个SharedPreferences实例

name：是指文件名称，不需要加后缀.xml，系统会自动为我们添加上。一般这个文件存储在/data/data/<package name>/shared_prefs下(这个面试常问到)

mode：是指定读写方式，其值有三种，分别为：

Context.MODE_PRIVATE：指定该SharedPreferences数据只能被本应用程序读、写

Context.MODE_WORLD_READABLE：指定该SharedPreferences数据能被其他应用程序读，但不能写

Context.MODE_WORLD_WRITEABLE：指定该SharedPreferences数据能被其他应用程序读写。

Java代码  

1. package com.learn.android;  
2.   
3. import android.app.Activity;  
4.   
5. import android.content.SharedPreferences;  
6. import android.content.SharedPreferences.Editor;  
7. import android.os.Bundle;  
8. import android.view.View;  
9. import android.view.View.OnClickListener;  
10. import android.widget.Button;  
11. import android.widget.EditText;  
12.   
13. public class SharedPreferences_LearnActivity extends Activity {  
14.     EditText edit1;  
15.     EditText edit2;  
16.     Button write;  
17.     Button read;  
18.     SharedPreferences sp;  
19.     Editor edit;  
20.     /** Called when the activity is first created. */  
21.     @Override  
22.     public void onCreate(Bundle savedInstanceState) {  
23.         super.onCreate(savedInstanceState);  
24.         setContentView(R.layout.main);  
25.         initComponent();  
26.         //可以让其他应用程序读取  
27.         sp = this.getSharedPreferences("preferences",MODE_WORLD_READABLE);  
28.         edit = sp.edit();  
29.     }  
30.   
31.     private void initComponent() {  
32.         // TODO Auto-generated method stub  
33.         edit1 = (EditText) this.findViewById(R.id.editText1);  
34.         edit2 = (EditText) this.findViewById(R.id.editText2);  
35.         write = (Button) this.findViewById(R.id.button1);  
36.         read = (Button) this.findViewById(R.id.button2);  
37.         write.setOnClickListener(writeListener);  
38.         read.setOnClickListener(readListener);  
39.     }  
40.     OnClickListener writeListener = new OnClickListener(){  
41.   
42.         @Override  
43.         public void onClick(View arg0) {  
44.             // TODO Auto-generated method stub  
45.             String name = edit1.getText().toString();  
46.             System.out.println("name="+name);  
47.             edit.putString("name",name);  
48.             int count = sp.getInt("count",0);  
49.             System.out.println("count="+count);  
50.             edit.putInt("count",++count);  
51.             edit.commit();  
52.         }  
53.           
54.     };  
55.     OnClickListener readListener = new OnClickListener(){  
56.   
57.         @Override  
58.         public void onClick(View v) {  
59.             // TODO Auto-generated method stub  
60.             String name = sp.getString("name","");  
61.             int count = sp.getInt("count",0);  
62.             edit1.setText(name);  
63.             edit2.setText(count+"");  
64.         }  
65.           
66.     };  
67. }  

package com.learn.android;

import android.app.Activity;

import android.content.SharedPreferences;
import android.content.SharedPreferences.Editor;
import android.os.Bundle;
import android.view.View;
import android.view.View.OnClickListener;
import android.widget.Button;
import android.widget.EditText;

public class SharedPreferences_LearnActivity extends Activity {
	EditText edit1;
	EditText edit2;
	Button write;
	Button read;
	SharedPreferences sp;
	Editor edit;
    /** Called when the activity is first created. */
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);
        initComponent();
        //可以让其他应用程序读取
        sp = this.getSharedPreferences("preferences",MODE_WORLD_READABLE);
        edit = sp.edit();
    }

	private void initComponent() {
		// TODO Auto-generated method stub
		edit1 = (EditText) this.findViewById(R.id.editText1);
		edit2 = (EditText) this.findViewById(R.id.editText2);
		write = (Button) this.findViewById(R.id.button1);
		read = (Button) this.findViewById(R.id.button2);
		write.setOnClickListener(writeListener);
		read.setOnClickListener(readListener);
	}
	OnClickListener writeListener = new OnClickListener(){

		@Override
		public void onClick(View arg0) {
			// TODO Auto-generated method stub
			String name = edit1.getText().toString();
			System.out.println("name="+name);
			edit.putString("name",name);
			int count = sp.getInt("count",0);
			System.out.println("count="+count);
			edit.putInt("count",++count);
			edit.commit();
		}
		
	};
	OnClickListener readListener = new OnClickListener(){

		@Override
		public void onClick(View v) {
			// TODO Auto-generated method stub
			String name = sp.getString("name","");
			int count = sp.getInt("count",0);
			edit1.setText(name);
			edit2.setText(count+"");
		}
		
	};
}

 效果图:

 

读写其他应用SharedPreferences

在有时的开发过程中，我们可能要访问其他的应用程序的SharedPreferences，要实现这样的功能，我们必须要保证要访问的那个应用程序的SharedPreferences的访问权限要是MODE_WORLD_READABLE，这表明该SharedPreferences可以被其他应用程序读取，如果指定的MODE_WORLD_WRITEABLE表明该SharedPreferences可以被其他应用程序读取写入其实现思路如下

1、  获得其他应用程序对应的Context

2、  通过这个Context得到这个应用程序的SharedPreferences，然后再利用这个SharedPreferences读取内容

以上一例的SharedPreference为例。实现代码：

Java代码  

1. package com.learn.android;  
2.   
3. import android.app.Activity;  
4. import android.content.Context;  
5. import android.content.SharedPreferences;  
6. import android.content.pm.PackageManager.NameNotFoundException;  
7. import android.view.View;  
8. import android.view.View.OnClickListener;  
9. import android.os.Bundle;  
10. import android.widget.Button;  
11. import android.widget.TextView;  
12.   
13. public class GetOtherSharedPreferencesActivity extends Activity {  
14.     Button button;  
15.     TextView view;  
16.     Context othercontext;  
17.     SharedPreferences sp;  
18.     /** Called when the activity is first created. */  
19.     @Override  
20.     public void onCreate(Bundle savedInstanceState) {  
21.         super.onCreate(savedInstanceState);  
22.         setContentView(R.layout.main);  
23.         button = (Button) this.findViewById(R.id.button1);  
24.         view = (TextView) this.findViewById(R.id.view);  
25.         try {  
26.             othercontext = createPackageContext("com.learn.android",  
27.                     Context.CONTEXT_IGNORE_SECURITY);  
28.             sp = othercontext.getSharedPreferences("preferences",othercontext.MODE_PRIVATE);  
29.         } catch (NameNotFoundException e) {  
30.             // TODO Auto-generated catch block  
31.             e.printStackTrace();  
32.         }  
33.         button.setOnClickListener(l);  
34.     }  
35.     OnClickListener l = new OnClickListener(){  
36.   
37.         @Override  
38.         public void onClick(View v) {  
39.             // TODO Auto-generated method stub  
40.             String name = sp.getString("name","");  
41.             int count = sp.getInt("count",0);  
42.             view.setText("name="+name+"操作次数="+count);  
43.         }  
44.           
45.     };  
46. }  

package com.learn.android;

import android.app.Activity;
import android.content.Context;
import android.content.SharedPreferences;
import android.content.pm.PackageManager.NameNotFoundException;
import android.view.View;
import android.view.View.OnClickListener;
import android.os.Bundle;
import android.widget.Button;
import android.widget.TextView;

public class GetOtherSharedPreferencesActivity extends Activity {
	Button button;
	TextView view;
	Context othercontext;
	SharedPreferences sp;
    /** Called when the activity is first created. */
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);
        button = (Button) this.findViewById(R.id.button1);
        view = (TextView) this.findViewById(R.id.view);
        try {
			othercontext = createPackageContext("com.learn.android",
					Context.CONTEXT_IGNORE_SECURITY);
			sp = othercontext.getSharedPreferences("preferences",othercontext.MODE_PRIVATE);
		} catch (NameNotFoundException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
        button.setOnClickListener(l);
    }
    OnClickListener l = new OnClickListener(){

		@Override
		public void onClick(View v) {
			// TODO Auto-generated method stub
			String name = sp.getString("name","");
			int count = sp.getInt("count",0);
			view.setText("name="+name+"操作次数="+count);
		}
    	
    };
}

 

SharedPreferences的注意事项：

编辑完SharedPreferences一定要记得调用Editor的commit()方法，否则不会将数据写入到文件里的。

回顾总结：

1、  如何得到SharedPreferences

SharedPreferences preferences=getPreferences(“test”,MODE_PRIVATE);

2、  如何编辑SharedPreferences

得到Editor对象实例

SharedPreferences.Editor editor=preferences.editor();

3、  SharedPreferences的存储位置

/data/data/<package name>/shared_prefs