java - 使用 HTML5 localStorage 在 GWT 应用程序/小部件中缓存

Question

我正在尝试为我的一个 GWT 小部件合并数据缓存。
我有一个数据源接口(interface)/类，它通过 RequestBuilder 和 JSON 从我的后端检索一些数据。因为我多次显示小部件，所以我只想检索一次数据。

所以我尝试使用应用程序缓存。天真的方法是在单例对象中使用 HashMap 来存储数据。但是，如果支持，我也想使用 HTML5 的 localStorage/sessionStorage。
HTML5 localStorage 仅支持 String 值。所以我必须将我的对象转换为 JSON 并存储为字符串。但是不知何故，我想不出一个干净的方法来做到这一点。这是我目前所拥有的。

我定义了一个包含两个函数的接口(interface):fetchStatsList() 获取可以在小部件中显示的统计列表，fetchStatsData() 获取实际数据。

public interface DataSource {
    public void fetchStatsData(Stat stat,FetchStatsDataCallback callback);
    public void fetchStatsList(FetchStatsListCallback callback);
}

Stat 类是一个简单的 Javascript 覆盖类 (JavaScriptObject)，带有一些 getter(getName() 等)我的 DataSource 有一个正常的不可缓存实现 RequestBuilderDataSource，如下所示:

public class RequestBuilderDataSource implements DataSource {
    @Override
    public void fetchStatsList(final FetchStatsListCallback callback) {
         // create RequestBuilderRequest, retrieve response and parse JSON 
        callback.onFetchStatsList(stats);
    }

    @Override
    public void fetchStatsData(List<Stat> stats,final FetchStatsDataCallback callback) {
        String url = getStatUrl(stats);
        //create RequestBuilderRquest, retrieve response and parse JSON
        callback.onFetchStats(dataTable); //dataTable is of type DataTable
    }
}

我省略了 RequestBuilder 的大部分代码，因为它非常简单。

这是开箱即用的，但是每次都会检索统计列表和数据，即使数据在每个小部件实例之间共享也是如此。

为了支持缓存，我添加了一个 Cache 接口(interface)和两个 Cache 实现(一个用于 HTML5 localStorage，一个用于 HashMap):

public interface Cache {
    void put(Object key, Object value);
    Object get(Object key);
    void remove(Object key);
    void clear();
}

我添加了一个新类 RequestBuilderCacheDataSource，它扩展了 RequestBuilderDataSource 并在其构造函数中采用了一个 Cache 实例。

public class RequestBuilderCacheDataSource extends RequestBuilderDataSource {

    private final Cache cache;

    publlic RequestBuilderCacheDataSource(final Cache cache) {
        this.cache = cache;
    }

    @Override
    public void fetchStatsList(final FetchStatsListCallback callback) {
       Object value = cache.get("list");
       if (value != null) {
           callback.fetchStatsList((List<Stat>)value);
       }
       else {
           super.fetchStatsList(stats,new FetchStatsListCallback() {
               @Override
               public void onFetchStatsList(List<Stat>stats) {
                   cache.put("list",stats);
                   callback.onFetchStatsList(stats);
               }
           });
           super.fetchStatsList(callback);
       }
    }

    @Override
    public void fetchStatsData(List<Stat> stats,final FetchStatsDataCallback callback) {
        String url = getStatUrl(stats);
        Object value = cache.get(url);
        if (value != null) {
            callback.onFetchStatsData((DataTable)value); 
        }
        else {
            super.fetchStatsData(stats,new FetchStatsDataCallback() {
                @Override
                public void onFetchStatsData(DataTable dataTable) {
                    cache.put(url,dataTable);
                    callback.onFetchStatsData(dataTable);
                }
            });
        }
    }
}

基本上新类会在Cache中查找值，如果没有找到它会调用父类中的fetch函数并拦截回调将其放入缓存中，然后调用实际回调。
因此，为了同时支持 HTML5 本地存储和普通 JS HashMap 存储，我创建了我的 Cache 接口(interface)的两个实现:

JS HashMap存储:

public class DefaultcacheImpl implements Cache {
    private HashMap<Object, Object> map;

    public DefaultCacheImpl() {
        this.map = new HashMap<Object, Object>();
    }

    @Override
    public void put(Object key, Object value) {
        if (key == null) {
            throw new NullPointerException("key is null");
        }
        if (value == null) {
            throw new NullPointerException("value is null");
        }
        map.put(key, value);
    }

    @Override
    public Object get(Object key) {
        // Check for null as Cache should not store null values / keys
        if (key == null) {
            throw new NullPointerException("key is null");
        }
        return map.get(key);
    }

    @Override
    public void remove(Object key) {
        map.remove(key);
    }

    @Override
    public void clear() {
       map.clear();
    }
}

HTML5 本地存储:

public class LocalStorageImpl implements Cache{

    public static enum TYPE {LOCAL,SESSION} 
    private TYPE type;
    private Storage cacheStorage = null;

    public LocalStorageImpl(TYPE type) throws Exception {
        this.type = type;
        if (type == TYPE.LOCAL) {
            cacheStorage = Storage.getLocalStorageIfSupported();
        }
        else {
            cacheStorage = Storage.getSessionStorageIfSupported();
        }
        if (cacheStorage == null) {
            throw new Exception("LocalStorage not supported");
        }
    }


    @Override
    public void put(Object key, Object value) {
        //Convert Object (could be any arbitrary object) into JSON
        String jsonData = null;
        if (value instanceof List) {   // in case it is a list of Stat objects
            JSONArray array = new JSONArray();
            int index = 0;
            for (Object val:(List)value) {
                array.set(index,new JSONObject((JavaScriptObject)val));
                index = index +1;
            }
            jsonData = array.toString();
        }
        else  // in case it is a DataTable
        {
            jsonData = new JSONObject((JavaScriptObject) value).toString();
        }
        cacheStorage.setItem(key.toString(), jsonData);
    }

    @Override
    public Object get(Object key) {
        if (key == null) {
            throw new NullPointerException("key is null");
        }
        String jsonDataString = cacheStorage.getItem(key.toString());
        if (jsonDataString == null) {
            return null;
        }
        Object data = null;
        Object jsonData = JsonUtils.safeEval(jsonDataString);
        if (!key.equals("list")) 
            data = DataTable.create((JavaScriptObject)data);
        else if (jsonData instanceof JsArray){
            JsArray<GenomeStat> jsonStats = (JsArray<GenomeStat>)jsonData;
            List<GenomeStat> stats = new ArrayList<GenomeStat>();
            for (int i = 0;i<jsonStats.length();i++) {
                stats.add(jsonStats.get(i));
            }
            data = (Object)stats;
        }
        return data;
    }

    @Override
    public void remove(Object key) {
        cacheStorage.removeItem(key.toString());
    }

    @Override
    public void clear() {
        cacheStorage.clear();
    }

    public TYPE getType() {
        return type;
    }
}

帖子有点长，但希望能阐明我试图达到的目的。归结为两个问题:

1. 对此方法的设计/架构的反馈(例如，将 RequestBilderDataSource 子类化以实现缓存功能等)。这可以改进吗(这可能与一般设计有关，而不是具体的 GWT)。
2. 使用 DefaultCacheImpl 可以很容易地存储和检索任意对象。在必须转换和解析 JSON 的地方，如何使用 localStorage 实现相同的目的？我正在使用需要调用 DataTable.create(JavaScriptObject jso) 函数才能工作的 DataTable。如果没有很多 if/else 和检查实例，我该如何解决这个问题？

Answer 1

我的第一个想法:让它成为两层缓存，而不是两个不同的缓存。从内存映射开始，因此不需要序列化/反序列化来读取给定的对象，因此在一个地方更改一个对象会改变整个对象。然后依靠本地存储为下一个页面加载保留数据，避免从服务器拉取数据的需要。

我倾向于说跳过 session 存储，因为它不会持续很长时间，但它确实有它的好处。

对于存储/读取数据，我鼓励检查 AutoBeans 而不是使用 JSO。通过这种方式，您可以支持任何类型的数据(可以存储为 autobean)，并且可以将 Class 参数传递给 fetcher 以指定您将从服务器/缓存读取的数据类型，并将 json 解码为 bean以同样的方式。作为一个额外的好处，autobeans 更容易定义——不需要 JSNI。一个方法可能看起来像这样(请注意，在 DataSource 及其实现中，签名是不同的)。

public <T> void fetch(Class<T> type, List<Stat> stats, Callback<T, Throwable> callback);

也就是说，DataTable.create 是什么？如果它已经是 JSO，您可以像从 RequestBuilder 数据读取时(可能)通常所做的那样转换为 DataTable。

我还鼓励不要直接从服务器返回 JSON 数组，而是将其包装在一个对象中，作为保护用户数据不被其他站点读取的最佳做法。 (好的，在重新阅读问题时，对象也不是很好)。与其在这里讨论，不如查看 JSON security best practices?

所以，综上所述，首先定义数据(不太确定这些数据是如何工作的，所以我边走边补)

public interface DataTable {
    String getTableName();
    void setTableName(String tableName);
}
public interface Stat {// not really clear on what this is supposed to offer
    String getKey();
    void setKey(String key);
    String getValue();
    String setValue(String value);
}
public interface TableCollection {
    List<DataTable> getTables();
    void setTables(List<DataTable> tables);
    int getRemaining();//useful for not sending all if you have too much?
}

对于 autobeans，我们定义了一个工厂，当给定一个 Class 实例和一些数据时，它可以创建我们的任何数据。这些方法中的每一个都可以用作一种构造函数来在客户端创建一个新实例，并且可以将工厂传递给 AutoBeanCodex 以解码数据。

interface DataABF extends AutoBeanFactory {
    AutoBean<DataTable> dataTable();
    AutoBean<Stat> stat();
    AutoBean<TableCollection> tableCollection();
}

将 String<=>Object 的所有工作委托(delegate)给 AutoBeanCodex，但您可能需要对其进行一些简单的包装，以便从 html5 缓存和 RequestBuilder 结果中轻松调用。此处的快速示例:

public class AutoBeanSerializer {
    private final AutoBeanFactory factory;
    public AutoBeanSerializer(AutoBeanFactory factory) {
        this.factory = factory;
    }

    public String <T> encodeData(T data) {
        //first, get the autobean mapped to the data
        //probably throw something if we can't find it
        AutoBean<T> autoBean = AutoBeanUtils.getAutoBean(data);

        //then, encode it
        //no factory or type needed here since the AutoBean has those details
        return AutoBeanCodex.encode(autoBean);
    }
    public <T> T decodeData(Class<T> dataType, String json) {
        AutoBean<T> bean = AutoBeanCodex.decode(factory, dataType, json);

        //unwrap the bean, and return the actual data
        return bean.as();
    }
}