缓存和存储 - xbmcswift2中文翻译文档

缓存和存储

xbmcswift2提供了一些用于缓存和存储的选项,以帮助改善插件的用户体验。swift提供了一种简单的存储机制,使您可以存储任意请求之间使用的任意python对象。


警告

xbmcswift2的存储的当前实现非常基础,并且不是线程安全的。如果您的插件通过上下文菜单执行后台调用并操纵这些backgound线程中的存储,则可能会遇到一些问题。


存储任意Python对象

xbmcswift2中的所有缓存/存储对象都像python字典一样工作。因此,要获取缓存,只需调用get_storage方法。

people = plugin.get_storage('people')

# 现在我们可以像普通字典一样使用people
people['jon'] = 'developer'
people.update({'dave': 'accountant'})

people.items()
# [('jon', 'deveoper'), ('dave', 'accountant')]

每次插件完成执行时,缓存都会自动保存到磁盘。如果要手动将缓存同步到磁盘,可以直接调用 cache.sync()。但是,这通常不是必需的。

文件格式

默认情况下,缓存以pickle格式保存到磁盘。这很方便,因为它可以存储Python对象。但是,您也可以将file_format关键字arg的'csv'或'json' 传递给get_storage调用。

到期

缓存还提供了一个可选参数TTL,它是以分钟为单位指定的对象的最长生存期。

people = plugin.get_storage('people', TTL=24)

缓存装饰器

xbmcswift2提供了一个方便的缓存装饰器来自动缓存函数的输出。例如,假设我们有一个函数get_api_data,该函数发送到远程API并获取大量数据。如果该网站每天仅更新一次API,则每次运行插件时都发出此请求没有任何意义。因此,我们可以将缓存装饰器与TTL参数一起使用。

@plugin.cached(TTL=60*24)
def get_api_data();
    # 发出远程请求
    data = get_remote_data()
    return data

如果未提供,则默认TTL为1天。

缓存视图

也可以缓存视图(用plugin.route()装饰的函数 )。为了简化附加代码,有一个特殊的装饰器,称为cached_route。cached_route的所有参数都与常规路由装饰器相同。当前,无法为此装饰器指定TTL。默认为24小时。

@plugin.cached_route('/')
def main_menu();
    # do stuff

警告

目前,这仅适用于返回字典列表的视图。如果调用plugin.finish(),则当前无法缓存视图。有关更多信息,请参见下面的“注意事项”。


警告

当前仅可以将单个cached_route附加到视图。如果给定视图上有多个路由,请尝试将一些逻辑重构为可以缓存的新函数,而不要使用cached_route装饰器。


注意事项

xbmcswift2的缓存功能仍然很年轻,因此存在一些潜在的问题需要注意。

  • 首先,如果要从视图调用plugin.finish,则当前无法缓存该视图。这是因为有一些副作用,发生在完成这将不会被缓存。如果是这种情况,也许您可​​以将视图中的某些功能移到新功能中,然后缓存该结果。

  • 确保变量是方法签名的一部分。如果您缓存给定的函数,请确保所有可能的输入都在方法签名中。xbmcswift2使用传递给函数的参数作为缓存的唯一键。因此,可以为函数的不同输入缓存不同的返回值。但是,如果您从函数内部检查某些全局状态,则缓存逻辑将对此一无所知,并将返回错误的结果。

  • 当前,缓存可能会变得非常大,因为它们不会根据文件大小自动清除自身。根据您要缓存的内容,可能需要引入一些逻辑来清除缓存。

    cache = plugin.get_cache('people')
    cache.clear()
    cache.sync()

  • 建议将缓存作为开发过程的最后一步。如果您仍在开发插件,则偶尔会缓存不正确的返回值,这将使您头痛。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,099评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,473评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,229评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,570评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,427评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,335评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,737评论 3 386
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,392评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,693评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,730评论 2 312
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,512评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,349评论 3 314
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,750评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,017评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,290评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,706评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,904评论 2 335