SharedPreferences 继承自：Service, BaseControl

提供对持久化键值存储的访问。

示例

import flet as ft


async def main(page: ft.Page):
    async def set_value():
        await ft.SharedPreferences().set(store_key.value, store_value.value)
        get_key.value = store_key.value
        store_key.value = ""
        store_value.value = ""
        page.show_dialog(ft.SnackBar("Value saved to SharedPreferences"))

    async def get_value():
        contents = await ft.SharedPreferences().get(get_key.value)
        page.add(ft.Text(f"SharedPreferences contents: {contents}"))

    page.add(
        ft.SafeArea(
            content=ft.Column(
                controls=[
                    ft.Column(
                        [
                            ft.Row(
                                [
                                    store_key := ft.TextField(label="Key"),
                                    store_value := ft.TextField(label="Value"),
                                    ft.Button("Set", on_click=set_value),
                                ]
                            ),
                            ft.Row(
                                [
                                    get_key := ft.TextField(label="Key"),
                                    ft.Button("Get", on_click=get_value),
                                ]
                            ),
                        ],
                    )
                ],
            ),
        )
    )


if __name__ == "__main__":
    ft.run(main)

属性

名称	类型	默认值	说明
data	Any	skip_	任意类型的自定义数据。
key	Optional['KeyValue']	None	用于在更新之间保持控件标识稳定的键。

只读属性

名称	类型	默认值	说明
parent	Optional['BaseControl']	—	此控件的直接祖先（父级）。 默认为 None，只有在此控件被挂载（加入页面树）后才有值。 Page 控件（页面树的根）是个例外 —— 它的 parent 始终为 None。
page	'Page'	—	此控件所属的页面。

方法

名称	类型	默认值	说明
set	bool	—	为给定的键设置值。 注意： 由于 Android 的限制，无法设置以以下任意前缀开头的值：VGhpcyBpcyB0aGUgcHJlZml4IGZvciBhIGxpc3Qu、VGhpcyBpcyB0aGUgcHJlZml4IGZvciBCaWdJbnRlZ2Vy 和 VGhpcyBpcyB0aGUgcHJlZml4IGZvciBEb3VibGUu。 参数： key：用于存储值的键。 value：要存储的值。 返回： 如果值设置成功则返回 True，否则返回 False。 抛出异常： ValueError：如果 value 的类型不受支持（str、int、float、bool 和 list[str]）。
get	Optional[SharedPreferencesValueType]	—	获取给定键的值。 参数： key：要检索其值的键。 返回： 给定键的值；如果键不存在则返回 None。
contains_key	bool	—	检查给定的键是否存在。 参数： key：要检查是否存在的键。 返回： 如果键存在则返回 True，否则返回 False。
remove	bool	—	移除给定键的值。 参数： key：要移除的键。 返回： 如果键已被移除则返回 True；如果键不存在则返回 False。
get_keys	list[str]	—	获取所有具有给定前缀的键。 参数： key_prefix：用于筛选键的前缀。 返回： 以给定前缀开头的键的列表。
clear	bool	—	清除所有键和值。 返回： 如果首选项清除成功则返回 True，否则返回 False。
init	—	—	—
is_isolated	—	—	返回此控件是否被标记为隔离。 隔离控件会被排除在父级驱动的更新遍历之外，并需要自行管理更新边界。
build	—	—	在控件初始化期间调用一次，用于定义其子控件。在此方法中 page 属性可用。
before_update	—	—	每当此控件被更新时都会调用此方法。 注意： 务必不要在此处调用或请求 update()。
before_event	—	—	在事件处理器执行之前拦截事件。 返回 False 可取消分发。返回 True 或 None 则继续正常的事件处理。
did_mount	—	—	在控件挂载到页面树之后调用。 重写此方法以启动需要已挂载页面的资源，例如订阅、定时器或服务监听器。
will_unmount	—	—	在控件从页面树移除之前调用。 重写此方法以释放 did_mount() 中创建的资源，例如订阅、定时器或外部句柄。
get_data_channel	—	—	解析为此 widget 在 Dart 侧分配的 [DataChannel]。模式： on_data_channel_open: Optional[ft.EventHandler[DataChannelOpenEvent]] = None def init(self): self.on_data_channel_open = self._on_open def _on_open(self, e): self._channel = self.get_data_channel(e.channel_id) 幂等 —— 底层的 Connection 会按 id 缓存 DataChannel，因此重复调用会返回同一实例。没有错误路径：该 id 始终来自框架触发的事件，所以当此方法运行时，通道在两端都已存在。
update	None	—	为此控件请求一次 UI 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。