使用SharedPreferences存储List<T>

最新推荐文章于 2024-09-03 16:29:08 发布

原创最新推荐文章于 2024-09-03 16:29:08 发布 · 420 阅读

CC 4.0 BY-SA版权

本文介绍了一种利用Gson工具包将List<String>序列化为字符串，并通过SharedPreferences存储的方法。避免了直接使用SharedPreferences的putStringSet方法导致的数据顺序混乱和重复数据问题，提供了一种稳定可靠的存储方案。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一次实际需求中需要把一个list<String>存储到本地，那么有其中一种操作就是使用SharedPreferences。这里最后会给出泛型list存储。
很显然，查看系统这个类提供的putXXX方法，并没有发现能够直接存储list的。倒是发现有一个 StringSet相关的。

只是看似可行方式 `putStringSet(String key, Set<String> values);`

那把list转换为set存储，这样操作结果怎么样呢？

set集合元素唯一，无序；list集合元素可以重复，有序。
set转list：数据保持不变，顺序发生变化，可以使用Collections.sort进行排序(Collections.shuffle 随机排序,Collections.reverse 反转顺序)。
list转set：去除重复数据，只保留一个。转成linkedHashSet时，原顺序不变；转成treeSet可以排序，转成hashSet无序。

既不能保证数据的顺序，就算可以自定义排序规则，那也是相当麻烦的。而且数据也不能重复。所以放弃这种。还是选择下面这种传统一点好了。

推荐方式：把这个`List`序列化为`String`，然后使用`putString()`来存储

直接贴一下代码

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

import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import com.example.AppContext;

import java.lang.reflect.Type;
import java.util.List;


public class CommonSharedPrefs {

    private static final String STORE_FILE_NAME = "num_list_file";

    private static SharedPreferences sharedPreferences = AppContext.getContext().getSharedPreferences(STORE_FILE_NAME, Context.MODE_PRIVATE);

    private static SharedPreferences.Editor editor = sharedPreferences.edit();

    public static <T> void saveList(String key, List<T> list) {
        // 注释1
        Type personType = new TypeToken<List<T>>() {
        }.getType();
        Gson gson = new Gson();
        String json = gson.toJson(list, personType);
        set(key, json);
    }

    private static void set(String key, String value) {
        editor.putString(key, value);
        editor.commit();

    }


   public static <T> List<T> getList(String key, Class<T> clazz) {
        List<T> list = null;
        try {
            String string = sharedPreferences.getString(key, null);
            Gson gson = new Gson();
            //注释2
            Type type = new ParameterizedTypeImpl(List.class, new Class[]{clazz});
            list = gson.fromJson(string, type);
        } catch (Exception e) {
            e.printStackTrace();
        }

        return list;
    }

}

上述代码的核心逻辑是，使用了Gson工具包来处理List与String之间转换。需要注意以下三点:

如果你存储的是其他bean，记得要把这个bean序列化，也就是泛型T要进行序列化

Gson是不支持序列化匿名类型的。
如下图，为了省事，我直接使用匿名进行了初始化。那这个时候就需要手动为Gson指定类型，上图注释1处。

   private List<String> numList = new ArrayList<String>() {
          {
              add("1");
              add("2");
              add("3");
              add("4");
              add("5");
              add("6");
              add("10");
              add("11");
              add("12");
          }
      };

关于注释2处这里要说明一下上面getList的泛型封装

image.png

最开始我用的是上面这种方式来为这个List指定泛型，但是这种是无效的。那么怎么才能让外部动态的来指定这个泛型呢？

import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;

public class ParameterizedTypeImpl implements ParameterizedType {
    private final Class raw;
    private final Type[] args;

    public ParameterizedTypeImpl(Class raw, Type[] args) {
        this.raw = raw;
        this.args = args != null ? args : new Type[0];
    }

    @Override
    public Type[] getActualTypeArguments() {
        return args;
    }

    @Override
    public Type getRawType() {
        return raw;
    }

    @Override
    public Type getOwnerType() {
        return null;
    }
}