基于RESTFUL的API接口緩存

最近有一個新項目是基于ANGULARJS開發(fā)的, 涉及到前端接口緩存以及如何更新緩存的問題. 要做到對開發(fā)者透明, 所以選擇從攔截器下手, 在發(fā)請求前通過一個唯一的key值去讀緩存中的數(shù)據(jù), 如果有緩存, 則直接返回緩存, 如果沒有緩存, 就向服務器發(fā)起請求, 并在請求成功后緩存response. 所有的開發(fā)者不需要關(guān)心如何去處理緩存. 偽代碼如下

request: function(){
    if(cache[hashKey]){
        return cache[hashKey];
    }else{
        doRequest();
        cache.set(hashKey, response)
    }
}

如何生成唯一的hashKey?
利用RESTFUL基于資源的URI設計, 一個資源就可以用一個URI(統(tǒng)一資源定位符)指向它, 而且每個資源對應一個特定的URI, 這完全符合我們對于hashKey唯一性的要求.

如何實現(xiàn)緩存對象?
ANGULARJS的$cacheFactory可以為我們提供一個緩存對象, 并賦值給$http.config中的cache字段.

利用$resource封裝一個最基本的具有增刪改查功能API

angular.module('app')
    .factory('examineAPI', function (API_SERVER, $resource, $cacheFactory) {
        var cache = $cacheFactory('examine', {capacity: 20});
        return $resource(API_SERVER + 'api/examine/:action/:id',
            {
                id: '@id',
                action: '@action'
            },
            {
                list: {
                    method: 'GET',
                    cache: cache,
                    params: {
                        action: 'list'
                    }
                },
                view: {
                    method: 'GET',
                    cache: cache,
                    params: {
                        action: 'view'
                    }
                }
                create: {
                    method: 'POST',
                    cache: cache,
                    params: {
                        action: 'create'
                    }
                },
                update: {
                    method: 'PUT',
                    cache: cache,
                    params: {
                        action: 'update'
                    }
                },
                delete; {
                    method: 'DELETE',
                    cache: cache,
                    params: {
                        action: 'delete'
                    }
                }
            }
        )
    })

攔截器代碼, 若請求為查詢操作(GET), 曾默認走緩存, 若請求為非查詢操作(SAVE,UPDATE,DELETE)仿荆,成功后需要重新刷新cache(清空對應cache). 默認cache為$http

angular.module('app')
    .factory('cacheInterceptor', function () {
        return {
            request: request,
            response: response
        };

        function clearCache(config, key) {
            (angular.isObject(config.cache) ? config.cache : $cacheFactory.get("$http"))[key ? 'remove' : 'removeAll'](key);
        }

        function request(config){
            if (config.method === 'GET' && config.params && config.params.$forceRefresh) {
                clearCache(config);
            }
            return config;
        }

        function response(res){
            var config = res.config;
            if (config.method !== 'GET' && config.cache) {
                clearCache(config);
            }
            return res;
        }
    });

在config函數(shù)中配置

$httpProvider.interceptors.push('cacheInterceptor');

大功告成, 開發(fā)者無需關(guān)心緩存的處理, 完全透明.

examineAPI.query(); //發(fā)起GET請求, 返回examines數(shù)組, 結(jié)果被緩存
examineAPI.query(); //不發(fā)請求, 直接返回緩存
examineAPI.update({id: 1}) //發(fā)起PUT請求, 緩存會清空
examineAPI.query(); //重新發(fā)起GET請求, 返回examines數(shù)組, 結(jié)果被緩存

參考文章
Power up http with caching

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末贰您,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子拢操,更是在濱河造成了極大的恐慌,老刑警劉巖杠园,帶你破解...
    沈念sama閱讀 218,546評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件陈醒,死亡現(xiàn)場離奇詭異,居然都是意外死亡爷辙,警方通過查閱死者的電腦和手機膝晾,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,224評論 3 395
  • 文/潘曉璐 我一進店門洒疚,熙熙樓的掌柜王于貴愁眉苦臉地迎上來油湖,“玉大人撤奸,你說我怎么就攤上這事胧瓜。” “怎么了钝满?”我有些...
    開封第一講書人閱讀 164,911評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長碎捺。 經(jīng)常有香客問我悍引,道長俩块,這世上最難降的妖魔是什么玉凯? 我笑而不...
    開封第一講書人閱讀 58,737評論 1 294
  • 正文 為了忘掉前任,我火速辦了婚禮署照,結(jié)果婚禮上建芙,老公的妹妹穿的比我還像新娘禁荸。我一直安慰自己,他們只是感情好映砖,可當我...
    茶點故事閱讀 67,753評論 6 392
  • 文/花漫 我一把揭開白布涨醋。 她就那樣靜靜地躺著乓土,像睡著了一般趣苏。 火紅的嫁衣襯著肌膚如雪尽棕。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,598評論 1 305
  • 那天,我揣著相機與錄音歉提,去河邊找鬼。 笑死恋拷,一個胖子當著我的面吹牛蔬顾,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播舷胜,決...
    沈念sama閱讀 40,338評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼材泄,長吁一口氣:“原來是場噩夢啊……” “哼峦树!你這毒婦竟也來了急灭?” 一聲冷哼從身側(cè)響起葬馋,我...
    開封第一講書人閱讀 39,249評論 0 276
  • 序言:老撾萬榮一對情侶失蹤白对,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后条摸,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,696評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡昌屉,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,888評論 3 336
  • 正文 我和宋清朗相戀三年竞帽,在試婚紗的時候發(fā)現(xiàn)自己被綠了屹篓。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,013評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出伴澄,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 35,731評論 5 346
  • 正文 年R本政府宣布玖媚,位于F島的核電站,受9級特大地震影響咏删,放射性物質(zhì)發(fā)生泄漏激挪。R本人自食惡果不足惜宛篇,卻給世界環(huán)境...
    茶點故事閱讀 41,348評論 3 330
  • 文/蒙蒙 一听诸、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦敛惊、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,929評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽杰赛。三九已至,卻和暖如春蛤迎,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背宜咒。 一陣腳步聲響...
    開封第一講書人閱讀 33,048評論 1 270
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 48,203評論 3 370
  • 正文 我出身青樓罐呼,卻偏偏與公主長得像,于是被迫代替她去往敵國和親夯尽。 傳聞我的和親對象是個殘疾皇子陈轿,可洞房花燭夜當晚...
    茶點故事閱讀 44,960評論 2 355

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理半等,服務發(fā)現(xiàn)莽囤,斷路器,智...
    卡卡羅2017閱讀 134,657評論 18 139
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,147評論 25 707
  • API定義規(guī)范 本規(guī)范設計基于如下使用場景: 請求頻率不是非常高:如果產(chǎn)品的使用周期內(nèi)請求頻率非常高贺氓,建議使用雙通...
    有涯逐無涯閱讀 2,547評論 0 6
  • 概覽 緩存組件應該說是每個客戶端程序必備的核心組件,試想對于每個界面的訪問都必須重新請求勢必降低用戶體驗。但是如何...
    默默_David閱讀 1,930評論 1 9
  • 你的心目中是否有著一個成為音樂人的夢想呢?聽著臺上悠揚的歌聲,是不是激發(fā)了你心中音樂的“小魔鬼”呢?想要成為一名音...
    徘徊走遇見閱讀 239評論 0 0