Nextjs实现Cookie、Localstorage、SessionStorage通用的方法

13 阅读1分钟

在使用Nextjs时,针对服务端和客户端实现统一调用本地存储信息,实现维护的统一管理,方便整个项目的维护拓展

export type StorageType = 'local' | 'session' | 'cookie'

class UniversalStorage {
  private isServer = typeof window === 'undefined'

  /**
   * 设置存储
   * @param type 存储类型
   * @param key 键
   * @param value 值
   * @param days Cookie 特有的过期时间(天)
   */
  set(type: StorageType, key: string, value: any, days: number = 7): void {
    if (this.isServer) return

    const stringValue =typeof value === 'string' ? value : JSON.stringify(value)

    switch (type) {
      case 'local':
        window.localStorage.setItem(key, stringValue)
        break
      case 'session':
        window.sessionStorage.setItem(key, stringValue)
        break
      case 'cookie':
        const expires = new Date(Date.now() + days * 864e5).toUTCString()
        document.cookie = `${key}=${encodeURIComponent(stringValue)}; expires=${expires}; path=/; SameSite=Lax`
        break
    }
  }

  /**
   * 读取存储
   * @param type 存储类型
   * @param key 键
   */
  get<T>(type: StorageType, key: string): T | null {
    if (this.isServer) return null

    let val: string | null = null

    switch (type) {
      case 'local':
        val = window.localStorage.getItem(key)
        break
      case 'session':
        val = window.sessionStorage.getItem(key)
        break
      case 'cookie':
        const match = document.cookie.match(
          new RegExp('(^| )' + key + '=([^;]*)(;|$)'),
        )
        val = match ? decodeURIComponent(match[2]) : null
        break
    }

    try {
      return val ? JSON.parse(val) : null
    } catch (e) {
      return val as unknown as T // 如果不是 JSON 字符串则直接返回
    }
  }

  /**
   * 删除存储
   */
  remove(type: StorageType, key: string): void {
    if (this.isServer) return

    switch (type) {
      case 'local':
        window.localStorage.removeItem(key)
        break
      case 'session':
        window.sessionStorage.removeItem(key)
        break
      case 'cookie':
        document.cookie = `${key}=; expires=Thu, 01 Jan 1970 00:00:00 GMT; path=/`
        break
    }
  }
}

export const storage = new UniversalStorage()

调用方法示例:

import { storage, StorageType } from './storageutil'

export const TokenStorage = {
  name: 'token',
  get: async function (type: StorageType = 'local') {
    return await storage.get(type, this.name)
  },
  set: function (value: string, type: StorageType = 'local') {
    storage.set(type, this.name, value)
  },
  remove: function (type: StorageType = 'local') {
    storage.remove(type, this.name)
  },
}

通过上面的方法实现调用本地缓存数据方法的统一,也保证了缓存名称的可维护性。避免在每个组件中散落着cookie、localStorage、sessionStorage的读取以及名称的不可控。