缓存和存储 - 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()

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