如何优雅

75 阅读2分钟

地观察 Vue.js 3 中 localStorage 的变化?

为什么要这样做?

原生 localStorage 只能监听同源跨不同页面的变化。然而,对于单页面应用程序来说,这种方式并不实用。因此,我打算创建一个自定义钩子来监视 localStorage 中的变化。

方法

我们需要重写 localStorage 下的所有方法,以便无论何时使用它们都可以被观察到。这就需要一个事件机制来进行消息传递。

由于 Vue 3 删除了onon和emit 事件接口,我们可以使用 mitt 或 tiny-emitter 等第三方库来实现此功能。

不过,我打算使用自己实现的中介模式作为通信方法。

解决方案

使用中介者模式的实现解决方案。

// mediator.ts
export interface MediatorProps {
uuid?: number;
publish?: (topic: string, ...args: unknown[]) => void;
subscribe?: (topic: string, callback: (...args: unknown[]) => void) => void;
}



  const mediator = (function () {
    let topics = [],
        uuid = 0;
        
          function subscribe(topic: string, callback: (...args: unknown[]) => void) {
              uuid++;
                  topics[topic] = topics[topic]
                        ? [...topics[topic], { callback, uuid }]
                              : [{ callback, uuid }];
                                }
                                
                                  function publish(topic: string, ...args: unknown[]) {
                                      if (topics[topic]) {
                                            topics[topic].map((item) => item.callback(...args));
                                                }
                                                  }
                                                    return {
                                                        install: function (obj: MediatorProps) {
                                                              obj.uuid = uuid;
                                                                    obj.publish = publish;
                                                                          obj.subscribe = subscribe;
                                                                                return obj;
                                                                                    },
                                                                                      };
                                                                                      })();
                                                                                      
                                                                                      export default mediator;</code></pre><p>然后我重写 localStorage 函数。</p><pre><code class="js">// localStorage.ts
                                                                                      import mediator from "./mediator";
                                                                                      
                                                                                      const keys: string[] = [];
                                                                                      
                                                                                      const createMediator = () =&gt; mediator.install({});
                                                                                      
                                                                                      const sub = createMediator();
                                                                                      
                                                                                      export const $localStorage = {
                                                                                        getItem: (key: string) =&gt; {
                                                                                            return window.localStorage.getItem(key);
                                                                                              },
                                                                                              
                                                                                                setItem: (key: string, value: any) =&gt; {
                                                                                                    // 防止重复发布
                                                                                                        if (!keys.includes(key)) keys.push(key);
                                                                                                        
                                                                                                            // 发布事件(如果已修改)
                                                                                                                sub.publish(key, value);    
                                                                                                                
                                                                                                                    window.localStorage.setItem(key, value);
                                                                                                                      },
                                                                                                                        clear: () =&gt; {
                                                                                                                            // 为每个键清除时发布一个事件
                                                                                                                                keys.map((key) =&gt; sub.publish(key, undefined));
                                                                                                                                    // 发布后,清除记录键值的数组
                                                                                                                                        keys.length = 0;
                                                                                                                                        
                                                                                                                                            window.localStorage.clear();
                                                                                                                                              },
                                                                                                                                                removeItem: (key: string) =&gt; {
                                                                                                                                                    keys.splice(keys.indexOf(key), 1);
                                                                                                                                                    
                                                                                                                                                        // 删除时,发布undefined
                                                                                                                                                            sub.publish(key, undefined);
                                                                                                                                                            
                                                                                                                                                                window.localStorage.removeItem(key);
                                                                                                                                                                  },
                                                                                                                                                                    key: window.localStorage.key,
                                                                                                                                                                      length: window.localStorage.length,
                                                                                                                                                                      };</code></pre><p>第三,我实现了 useStorage 钩子</p><pre><code class="js">// useStorage.ts
                                                                                                                                                                      import { ref } from "vue";
                                                                                                                                                                      import mediator from "./mediator";
                                                                                                                                                                      const createMediator = () =&gt; mediator.install({});
                                                                                                                                                                      
                                                                                                                                                                       export const useStorage = (key: string) =&gt; {
                                                                                                                                                                         
                                                                                                                                                                           const string = ref(null);
                                                                                                                                                                           
                                                                                                                                                                             const sub = createMediator();
                                                                                                                                                                             
                                                                                                                                                                               sub.subscribe(key, (value) =&gt; string.value = value);
                                                                                                                                                                               
                                                                                                                                                                                 return string;
                                                                                                                                                                                 };</code></pre><p>第四,我写的测试代码是这样的:</p><pre><code class="js">// One.vue
                                                                                                                                                                                 // use localStorage
                                                                                                                                                                                 import { watch } from "vue";
                                                                                                                                                                                 import { useStorage } from "./hook";
                                                                                                                                                                                 
                                                                                                                                                                                 const key = useStorage("imodd");
                                                                                                                                                                                 
                                                                                                                                                                                 watch([key], (a) =&gt; console.log(a));
                                                                                                                                                                                 
                                                                                                                                                                                 // Two.vue
                                                                                                                                                                                 // Observe localStorage</code></pre><p>然后,结果是这样的</p><p></p><p>好了,这就是全部了。希望这篇文章能给你带来一点帮助。</p>