×

Android中最简单的数据存储方式:SharedPreferences

96
食梦兽
2015.12.07 17:08* 字数 1113

Android技术中哪一种存储技术最容易理解和使用,没错,就是标题上所说的SharedPreferences , 实际上,SharedPreferences 处理的就是一个个key-value对。

一. 使用SharedPreferences存储数据

使用 SharedPreferences 保存key-value对的步骤一般是这样:

  1. 使用Activity类的getSharedPreferences方法获取到 SharedPreferences 对象,指定文件名和访问权限
  2. 获得SharedPreferences.Editor对象,并使用该对象的 putXxx方法保存key-value对。
  3. 通过SharedPreferences.Editor的commit方法保存(提交)key-value对。

实例:
程序退出,再次启动时,显示出上次在EditText控件中填写的内容。

在Activity生命周期的回调方法onStop中保存数据:

@Override
    protected void onStop() {
        //获取一个文件名为test、权限为private的xml文件的SharedPreferences对象
        SharedPreferences sharedPreferences = getSharedPreferences("test", MODE_PRIVATE);

        //得到SharedPreferences.Editor对象,并保存数据到该对象中
        SharedPreferences.Editor editor = sharedPreferences.edit();
        editor.putString("name", et_name.getText().toString().trim());

        //保存key-value对到文件中
        editor.commit();
        super.onStop();
    }

当然 SharedPreferences 提供可以直接保存的数据格式不仅只有String,还有 int、boolean、float、long以及Set<String>。

在onCreate方法中获取数据,回显

et_name = (EditText) findViewById(R.id.et_name);
SharedPreferences sharedPreferences = this.getSharedPreferences("test", MODE_PRIVATE);
et_name.setText(sharedPreferences.getString("name",""));

二. 数据的存储位置和格式

实际上,SharedPreferences 将数据文件写在了手机内存私有的目录中该app的文件夹下。
可以通过DDMS的【File Explorer】找到data\data\程序包名\shared_prefs目录(如果使用真机测试,必须保存已root,否则因为权限问题无法进入data目录),发现test.xml 文件。导出文件并查看:

<!--   test.xml   -->
<?xml version='1.0' encoding='utf-8' standalone='yes'>
<map>
        <string name="name">小明</string>
</map>

三. 存取复杂类型的数据

如果要用 SharedPreferences 存取复杂的数据类型(类,图像等),就需要对这些数据进行编码。通常会将复杂类型的数据转换成Base64编码,然后将转换后的数据以字符串的形式保存在XML文件中。

实例:
使用 SharedPreferences 保存Product类的一个对象和一张图片。

界面如下:

演示界面

提供了两Button,用来保存和获取使用 SharedPreferences 保存的Product对象和图片。

保存按钮的点击事件:

bt_prod_save.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    //保存对象
                    Product product = new Product();
                    product.setId(et_prod_id.getText().toString().trim());
                    product.setName(et_prod_name.getText().toString().trim());
                    SharedPreferences sharedPreferences = getSharedPreferences("base64", MODE_PRIVATE);
                    SharedPreferences.Editor editor = sharedPreferences.edit();
                    ByteArrayOutputStream baos = new ByteArrayOutputStream();
                    ObjectOutputStream oos = new ObjectOutputStream(baos);
                    oos.writeObject(product);
                    String base64Product = Base64.encodeToString(baos.toByteArray(), Base64.DEFAULT);
                    editor.putString("product", base64Product);

                    //保存图片
                    ByteArrayOutputStream baos2 = new ByteArrayOutputStream();
                    ((BitmapDrawable) getResources().getDrawable(R.drawable.lanbojini)).getBitmap().compress(Bitmap.CompressFormat.JPEG, 100, baos2);
                    String imageBase64 = Base64.encodeToString(baos2.toByteArray(), Base64.DEFAULT);
                    editor.putString("productImg", imageBase64);

                    editor.commit();

                    baos.close();
                    oos.close();
                    Toast.makeText(MainActivity.this, "保存成功!!!", Toast.LENGTH_SHORT).show();
                } catch (Exception e) {
                    Toast.makeText(MainActivity.this, "保存出错了!!!" + e.getMessage(), Toast.LENGTH_SHORT).show();
                }

            }
        });

回显按钮的点击事件:

bt_prod_show.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    //获取对象
                    et_prod_id = (EditText) findViewById(R.id.et_prod_id);
                    et_prod_name = (EditText) findViewById(R.id.et_prod_name);
                    SharedPreferences sharedPreferences = getSharedPreferences("base64", MODE_PRIVATE);
                    String productString = sharedPreferences.getString("product", "");
                    byte[] base64Product = Base64.decode(productString, Base64.DEFAULT);
                    ByteArrayInputStream bais = new ByteArrayInputStream(base64Product);
                    ObjectInputStream ois = new ObjectInputStream(bais);
                    Product product = (Product) ois.readObject();
                    et_prod_id.setText(product.getId());
                    et_prod_name.setText(product.getName());

                    //获取图片
                    iv_prod_img = (ImageView) findViewById(R.id.iv_prod_img);
                    byte[] imagByte = Base64.decode(sharedPreferences.getString("productImg",""), Base64.DEFAULT);
                    ByteArrayInputStream bais2 = new ByteArrayInputStream(imagByte);
                    iv_prod_img.setImageDrawable(Drawable.createFromStream(bais2,  "imagByte"));

                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        });

原理:使用Base64把Product对象和图片进行编码成字符串后,然后通过 SharedPreferences 把转换后的字符串保存到xml文件中,在需要使用该对象或者图片时,通过Base64把从 SharedPreferences 获取的字符串解码成对象或者图片再使用。

查看base64.xml 文件,会看到如下内容:

<?xml version='1.0' encoding='utf-8' standalone='yes' ?>
<map>
    <string name="productImg">/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDABALDA4MChAOoOjM9PDkz......
    </string>
    <string name="product">rO0ABXNyACNjbHViLmxldGdldC50ZXN0c2hhGJqb......
    </string>
</map>

注意:
虽然可以采用编码的方式通过 SharedPreferences 保存任何类型的数据,但不建议使用 SharedPreferences 保存尺寸很大的数据。如果要存取更多的数据,一般使用文件存储、SQLite数据库等技术。

保存成功后回显产品信息和图片

四. 设置数据文件的访问权限

大家都知道,Android系统本质上是Linux,那么Android文件权限也和Linux一致。

Linux文件属性分为4段,
第一段:
[d]:表示目录
[-]:表示文件
[l]:表示链接文件
[b]:表示可供存储的接口设备文件
[c]:表示串口设备文件,例如键盘、鼠标
第二段:
[r]:表示可读
[w]:表示可写
[x]:表示可执行
如果不具备某个属性,该项将以[-]代替,例如rw-、--x等
第三段和第四段和第二段相同,区别在于,第二段表示文件所有者拥有的权限,第三段表示文件所有者所在的用户组中其他用户的权限,第四段表示其他用户的权限。

例如:-rw-rw-rw,表示这是一个文件,并且该用户和该组内其他用户和其他用户的权限都为可读和可写不可执行。

我们在获取 SharedPreferences 对象时,使用的是下面这行代码:
SharedPreferences sharedPreferences = this.getSharedPreferences("test", MODE_PRIVATE);
其中getSharedPreferences方法第二个参数就是对文件权限的描述。

这个参数有四个可选值:
Activity.MODE_PRIVATE:表示该文件是私有数据,只能被应用本身访问,在该模式下,写入的内容会覆盖原文件的内容
Activity.MODE_APPEND:也是私有数据,新写入的内容会追加到原文件中
Activity.MODE_WORLD_READABLE:表示当前文件可以被其他应用读取
Activity.MODE_WORLD_WRITEABLE:表示当前文件可以被其他应用写入


END

Android笔记
Web note ad 1