关掉浏览器,设置还在:localStorage 实战指南
点单页要记住顾客的主题、字号和常点的菜,下次打开不用重新选,靠的是 localStorage。本文按 MDN 的 Web Storage API、localStorage 与 Storage 官方文档讲清楚:只存字符串、setItem 三件套、先判空、JSON 转换、别用属性写法、length 与 key、localStorage 和 sessionStorage、storage 事件、可用性检测、协议与 file、SecurityError 与隐私模式。

先把这篇的边界说清楚。站里已经有《别再让请求悄悄失败:Fetch 实战指南》,讲的是怎么从后端拿数据;还有《注册不是终点:新用户上手引导设计实战》,里面顺带用 localStorage 存了三步引导的状态,但只讲了那一个用法。这篇不讲发请求、不讲引导流程,只讲一件事:浏览器里那个关掉再打开还在的小仓库 localStorage,怎么存、怎么取、哪里会翻车。下面用到的“青石咖啡馆”还是那个虚构的练手项目:一个帮街边咖啡馆做点单的网页小工具。这回讲的是它的点单页:记住顾客上次选的主题颜色、字号和常点的那几道菜,下次打开页面不用重新选。本文所有以它为例的操作、代码和数字,都是为了讲清楚做法编出来的,不是真实记录。所有关于本地存储的语法和行为,都来自 MDN 的《Using the Web Storage API》《Window: localStorage property》《Storage》三篇官方文档,来源见每篇的 meta 信息与 evidence 记录。文档里的例子,比如颜色设置 colorSetting、背景色 bgcolor、猫的名字 myCat、名字是 Alex 的那个人,都是文档自带的示例,不是真实服务。
第一步:它是个小仓库,键和值永远是字符串,关掉浏览器还在
localStorage 是浏览器给每个网站留的一个小仓库,里面装的是键值对:一个键、一个值,像对象一样简单,但关掉页面、关掉浏览器再打开,它还在。MDN 的原话是:存储对象是简单的键值对存储,和对象类似,但能撑过页面加载;键和值永远是字符串;整数键会自动转成字符串。拿 localStorage 存东西,就是往这个仓库里放一张小纸条,纸条上只能写字,不能直接放一个对象、一串数字、一个数组——想放别的东西,得先把它变成字符串,这点第四步细讲。咖啡馆的点单页就是这么记偏好的:顾客选了深色主题,页面把 "theme" 这个键写成 "dark",下次打开页面,先来仓库里看一眼,有就直接用深色,不用再问一遍。记住第一句话:localStorage 是按网站分的字符串小仓库,关掉浏览器,它还在。
第二步:三件套加一个清空:setItem、getItem、removeItem、clear
往仓库里放东西、取东西、扔东西,就四个方法。MDN 的 Storage 接口一页写得很干净:setItem() 传一个键名和一个值,加上这个键,或者键已经在那儿了就更新它的值;getItem() 传一个键名,返回这个键的值;removeItem() 传一个键名,把这个键从仓库里拿掉;clear() 不传参数,把整个仓库的键全清空。MDN 在 localStorage 一页给的例子就是这四个动作的最小写法:localStorage.setItem("myCat", "Tom") 存一只叫 Tom 的猫,const cat = localStorage.getItem("myCat") 把它读出来,localStorage.removeItem("myCat") 把它删掉,localStorage.clear() 把仓库清空。咖啡馆的点单页就是这么记主题的:localStorage.setItem("theme", "dark") 写进去,下次打开 localStorage.getItem("theme") 读出来,顾客点了“恢复默认”,就调 localStorage.removeItem("theme") 只删这一条,而不是把整个仓库清空——clear 是把所有键一起倒掉,删一条和全清空要分清。记住判断句:存用 setItem,取用 getItem,删一条用 removeItem,全倒掉才用 clear。
删的时候想清楚:removeItem 只删一个键,clear 是把整个仓库倒空,两个动作都没有撤销,删之前先想想别的页面是不是还在用这把键。咖啡馆的点单页有一次在“恢复默认”里错调了 clear,顾客存的常点菜全没了,只好改成只删 theme 这一条。
第三步:读不到的键,先判空再往下走
读一个没存过的键,getItem 给的是一个空值,MDN 的例子就是拿这个来判断仓库里有没有东西:if (!localStorage.getItem("bgcolor")),没有就先调 populateStorage() 把默认值写进去,有就调 setStyles() 直接用存好的值更新页面样式。所以读之前先判空,是写 localStorage 的第一道关。咖啡馆的点单页早期没判空:第一次打开的顾客,仓库里根本没有 "theme",代码直接拿读出来的值去拼样式,结果样式变成了 undefined,页面一片空白;后来改成先判空,没有就写默认的 "light",再往下走。记住判断句:getItem 之前先问一句“有没有”,没有就先写默认值。
第四步:只存字符串,对象要先变成字符串再存
这是 localStorage 里最容易踩的坑,MDN 用了一个完整的反例讲清楚。Storage 只支持存取字符串,想存别的数据类型,得先把它转成字符串;普通对象和数组,可以用 JSON.stringify()。反例是这样的:const person = { name: "Alex" },直接 localStorage.setItem("user", person),再读出来 localStorage.getItem("user"),得到的是 "[object Object]",没法用;正确做法是 localStorage.setItem("user", JSON.stringify(person)),读的时候 JSON.parse(localStorage.getItem("user")),拿回来的就是 { name: "Alex" }。MDN 还补了两句:没有通用的办法存任意数据类型;读出来的对象是原来那个对象的深拷贝,改它不会影响原来的对象。咖啡馆的点单页就踩过这个坑:常点的菜是个数组,直接 setItem 存进去,读出来变成 "[object Object]",页面上常点那一栏直接没了;改成存之前 JSON.stringify、读出来 JSON.parse,数组才原样回来。记住判断句:存之前先问一句“这是字符串吗”,不是就先 JSON.stringify。
第五步:别用属性写法,用 setItem 这一套
MDN 有一句明确的告诫:永远用 Web Storage API 的 setItem()、getItem()、removeItem()、key()、length(),不要用 localStorage.key = value 或者 localStorage["key"] = value 这种直接往对象上写属性的办法。文档列了三个理由:属性名可能撞上原生的内置方法,比如 clear() 或者 getItem();原型继承会带来意想不到的数据泄露;处理不受信任的用户输入时,还可能有原型污染这样的安全问题。三种写法 localStorage.colorSetting = "#a4509b"、localStorage["colorSetting"] = "#a4509b"、localStorage.setItem("colorSetting", "#a4509b") 存的是同一个东西,但只有第三种是 MDN 推荐的写法。咖啡馆的点单页早期用属性写法存过一个叫 "length" 的键,结果读出来的不是存进去的值,而是仓库里有几条的数字——键名撞上了内置的 length 属性。改成 setItem 之后,键名再怪也不会撞上内置方法。记住判断句:存取一律走 setItem、getItem,别往 localStorage 对象上直接写属性。
第六步:数一数有几条、按序号取键名:length 与 key()
除了存取删,Storage 接口还给了两个帮你清点仓库的方法。length 是只读的,返回仓库里现在有几条数据;key() 传一个数字 n,返回第 n 个键的名字。MDN 在 Using 一页里说:也可以用 Storage.length 来判断仓库是不是空的。咖啡馆的点单页在“我的偏好”页里用了这两个方法:先看 localStorage.length 是不是 0,是 0 就显示“还没存过偏好”;不是 0,就用 key(i) 一条条把键名列出来,让顾客自己挑哪一条删。记住判断句:要清点仓库,看 length;要列出键名,用 key(n)。
第七步:localStorage 和 sessionStorage,别用混了
Web Storage 里有两套机制,名字像,用法一样,但寿命和共享范围不一样。MDN 的说法是:sessionStorage 给每个来源留一块单独的存储区,只在页面会话期间能用,浏览器开着的时候都在,包括页面重新加载和恢复;localStorage 也一样,但浏览器关了再打开,它还在。两套机制分别走 Window.sessionStorage 和 Window.localStorage,拿到的是两个不同的 Storage 对象,操作办法一样,但各管各的。共享范围也不同:localStorage 的存储空间,在同一个来源的所有标签页之间是共享的;sessionStorage 的存储空间,只在同一个标签页之内、同一个来源的 iframe 之间共享。咖啡馆的点单页一开始用 sessionStorage 记主题,顾客关掉浏览器再回来,主题又变回默认了——记偏好这种要跨会话留下的东西,得用 localStorage;反过来,点单过程中临时记的“这单正在选哪几道菜”,关掉页面就该忘掉,用 sessionStorage 更合适。记住判断句:要留到下次打开,用 localStorage;只留这一次会话,用 sessionStorage。
第八步:storage 事件只在别的标签页触发,本页等不到
仓库变了,浏览器会发一个 storage 事件,但这个事件有个反直觉的规矩:它只在共享同一块存储空间的别的文档上触发,在正在改数据的那个页面上是不会触发的。MDN 的原话是:storage 事件是在另一个文档的 Storage 对象发生变化时触发的,在正在做改动的同一个页面上不会触发——它真正的用途,是让同一个来源的其他页面同步改动。事件对象身上带着改动的信息:key 是哪个键变了,oldValue 是改之前的值,newValue 是改之后的值,url 是改动那个文档的地址,storageArea 是那个存储对象本身。MDN 的例子是在 window 上监听 storage 事件,把这几个属性写到事件输出页上。咖啡馆的点单页就用这个做多标签同步:顾客在一个标签页改了主题,另一个开着点单页的标签页收到 storage 事件,马上跟着换主题;但改主题的那个标签页自己是收不到这个事件的,它的主题是 setItem 当时就换掉的,不用等事件。记住判断句:等 storage 事件同步,只在别的标签页等,本页的改动本页当时就办。
第九步:先验一验,仓库到底能不能用
能调 localStorage,不等于真能用。MDN 提醒:支持 localStorage 的浏览器,window 对象上会有 localStorage 这个属性,但只测属性在不在可能不够——有些浏览器提供设置关掉存储 API,却不把全局对象藏起来;隐私浏览模式下,有些浏览器会给一个空的 localStorage 对象,配额是零,实际上没法用。反过来,拿到一个 QuotaExceededError,意思是存储空间用完了,但存储本身是可用的。MDN 给了一个现成的检测函数 storageAvailable(type):先试着写一条再删掉,写得进去就返回 true;写不进去就看是不是 DOMException、名字是不是 QuotaExceededError,而且仓库里已经有东西(storage.length 不是 0),是就返回 true,否则返回 false。用的时候就是 if (storageAvailable("localStorage")),能用再往下走,不能用就走备用的路。咖啡馆的点单页就是先调这个检测,隐私模式下检测不过,就把偏好只记在内存里,这次会话能用、关掉就忘掉,页面不会报错。记住判断句:先试写试删验一验,再决定往仓库里放东西。
第十步:http 和 https 是两个仓库,file 打开的页面别依赖它
localStorage 是按来源分的,来源里还包括协议。MDN 在 localStorage 一页写得很清楚:localStorage 的数据是和文档的协议绑定的,用 http 打开的网站和用 https 打开的同一个网站,拿到的是两个不同的 localStorage 对象。还有 file: 这种直接在浏览器里打开本地文件的情况:规范对这种情况下 localStorage 的行为没有定义,各个浏览器的做法可能不一样;在现在所有浏览器里,看起来每个 file: 地址都有自己单独的一块本地存储区,但这没有任何保证,不应该依赖它,因为规范没写死,浏览器随时可能改,实际上也确实有浏览器改过。咖啡馆的点单页开发时有人直接双击 html 文件在浏览器里打开,主题存进去了,换个浏览器打开又没了——就是 file: 下行为未定义惹的祸。记住判断句:测 localStorage 一定要走 http 或 https 的服务,别直接双击文件测。
第十一步:存不进去时,浏览器会用什么理由拒绝
读 localStorage 有时会抛 SecurityError,MDN 列了两种情况。第一种是来源不是一个合法的协议、主机、端口组合,比如来源用的是 file: 或者 data: 这种方案;第二种是违反了一条策略决定,比如用户把浏览器设置成不让页面持久化数据。MDN 还补了一句:如果用户屏蔽了 cookie,浏览器很可能会把它理解为不让页面持久化数据的指示。咖啡馆的点单页在顾客浏览器开了严格隐私设置时就遇到过:读 localStorage 直接抛错,页面白屏;后来把读 localStorage 的代码包在 try/catch 里,抛错就走内存备用方案,页面照常用。记住判断句:读 localStorage 也可能抛错,关键地方包一层 try/catch,别让一次存取失败拖垮整个页面。
第十二步:键名定个规矩,别等乱了再收拾
这一步不是 MDN 的原文,是写给自己团队的规矩,但它能省掉很多麻烦。键名前面加个项目前缀,再加个版本号,比如 "cafe:theme:v1"、"cafe:favorites:v1",三个好处:第一,不同功能的东西不会撞键名;第二,以后改数据格式,版本号一升,旧数据一眼就能认出来、按旧格式处理或者清掉;第三,调试时打开开发者工具,一眼就能看出哪些键是这个项目的。咖啡馆的点单页早期键名就是裸的 "theme"、"favorites",后来接了个第三方小组件也往 localStorage 里写 "theme",两边互相覆盖,顾客的主题一天变三次;加上 "cafe:" 前缀之后,再也没撞过。记住判断句:键名带上项目前缀和版本号,省得以后翻仓库对账。
第十三步:隐私模式里,它只活到最后一个隐私标签关掉
localStorage 有一条容易被忽略的例外,MDN 在 localStorage 一页写得很清楚:用隐私浏览或者无痕模式打开的文档,它的 localStorage 数据会在最后一个隐私标签关闭时被清除。平时用的 localStorage 是没有过期时间的,关掉浏览器再打开还在;但隐私模式下的那一份,寿命只到最后一个隐私标签关掉为止。咖啡馆的点单页就遇到过顾客的反馈:在隐私窗口里选好的主题,关掉窗口再打开就没了,还以为是页面出问题了——其实不是页面出问题,是隐私模式的规矩就是这样,关掉最后一个隐私标签,数据就清掉了。记住判断句:隐私模式里别指望 localStorage 长期留着,它只活到最后一个隐私标签关掉。
第十四步:表单一改就存,不用等提交
偏好这种东西,不用等顾客点“保存”才写进仓库,表单一改就可以存。MDN 的 Web Storage Demo 就是这么做的:每个表单元素上都挂了一个 onchange 处理函数,bgcolorForm.onchange = populateStorage,fontForm.onchange = populateStorage,imageForm.onchange = populateStorage,值一改就调 populateStorage(),把三个值写进 localStorage,再调 setStyles() 更新页面样式。好处是顾客改完就走,刷新页面回来,改过的东西都在,不会因为没点保存丢掉。咖啡馆的点单页就是这么记主题和字号的:下拉框一改,马上写进仓库,页面马上跟着变;顾客不用找保存按钮,也不会因为忘了保存丢掉自己的设置。记住判断句:偏好一改就写进仓库,别等提交按钮。
版本号还有一个用法:数据格式改了,旧版本的数据读出来先按旧格式处理,或者直接清掉重写,别让新代码去猜旧数据长什么样。咖啡馆的点单页把常点菜从只存名字改成存名字加价格那次,就是靠 v1 升 v2 认出旧数据、悄悄清掉重写的,顾客一点感觉都没有。
检查清单:写完 localStorage,对着这张表过一遍
下图是虚构的青石咖啡馆点单页一个月里 70 次本地存储事故的原因分布:直接存对象没 stringify,读出来是 [object Object] 21 次(30.0%);getItem 拿不到就直接 JSON.parse,空值炸掉 14 次(20.0%);属性写法撞上内置方法名 11 次(15.7%);把 sessionStorage 当 localStorage 用,关掉浏览器就没了 9 次(12.9%);等 storage 事件等错了地方,同页等不到同步 8 次(11.4%);file: 直接双击打开页面,存储行为各浏览器不一样 7 次(10.0%)。21 + 14 + 11 + 9 + 8 + 7 = 70,百分比合计 100.0%。数字是编的例子,道理是真的:事故最多的一类,恰恰是 localStorage 最基本的那条规矩——只存字符串。写完自己的 localStorage,对着下面这张表过一遍:存之前问一句“这是字符串吗”,不是就先 JSON.stringify;读之前先判空,没有就先写默认值;存取一律走 setItem、getItem,别往对象上直接写属性;要留到下次打开还是只留这次会话,localStorage 和 sessionStorage 有没有用混;等 storage 事件同步,有没有在正确的标签页等;先验一验仓库能不能用,隐私模式下有没有备用方案;测的时候走的是 http 或 https 服务,还是直接双击文件;读 localStorage 的关键地方,有没有包 try/catch;键名有没有带项目前缀和版本号;隐私模式下有没有指望它长期留着;表单改了有没有马上存,不用等提交。十一条都过了,本地存储才算写完了。
评论 (0)
原始来源
相关文章
localStorage 只能存字符串、没有索引。IndexedDB 是浏览器里真正的数据库:能存结构化数据、容量大得多、能建索引、能用事务。本文按 MDN 的《Using IndexedDB》《IDBDatabase》《IDBObjectStore》三篇官方文档讲清楚:五步套路、开库、升级、主键、索引、事务、add 与 put、get、游标、范围与多标签页升级。
函数你每天都在调,这篇把你一直在做的事讲清楚。本文按 MDN 的《Functions》《Arrow function expressions》《Rest parameters》三篇官方文档讲清楚:声明与表达式、参数与实参、默认值、剩余参数、展开语法、返回值、箭头函数省写规则、this 的坑、回调与高阶函数、作用域。
同一个页面要在手机、平板、电脑上都站得住。本文按 MDN 的《Responsive web design》《Using media queries》《viewport meta 参考》三篇官方文档讲清楚:流式 HTML、viewport 标签、流式网格与 max-width、图片不撑破容器、媒体查询语法、按内容定断点、mobile-first、响应式字号、按能力查设备与上线检查清单。