基于vue+vuex+localStorage的笔记app

本项目采用vue+vuex+localStorage,实现一个本地存储的笔记app,项目预览见demo,源码可访问我的github

项目的下载安装步骤

git clone https://github.com/Anticlimax/vue-note.git
cd vue-note
npm install 
npm run dev

让我们通过这样一个有一定数据操作要求的应用,来学习vue和vuex的使用。

  1. 起步
    首先,通过vue-cli构建基本应用模板,方便开发
npm i vue-cli -g
vue init webpack vue-note
cd vue-note
npm run dev

这样,我们就起了一个本地的开发服务器,而且可以实现热加载,设置一下编辑器的自动保存就能实时看到代码变化。
2.项目逻辑
我们开发的项目的ui如下
![OHLNC51QG}K3D%7VV37Z]L1.png](http://upload-images.jianshu.io/upload_images/3599810-054054226e79bf05.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
大概分为左侧工具栏,中间笔记列表及右侧编辑栏,所以我们先构建项目的基本骨架。

//App.vue
<template>
  <div id="app">
    <Toolbar></Toolbar>
    <NoteList></NoteList>
    <Editor></Editor>
  </div>
</template>
<script>

  import Toolbar from './components/Toolbar.vue'
  import Editor from './components/Editor.vue'
  import NoteList from './components/NoteList.vue'
  import './assets/css/reset.css'

  export default {
    name: 'app',
    store,    //向根组件注入store,这样所有的子组件都能够调用store
    components: {
      Toolbar,
      NoteList,
      Editor
    }
  }
</script>

这是我们的根实例,引用了三个组件Toolbar,NoteList和Editor,这样我们只需要分别对三个组件进行开发就好了。
但是在此之前,我们先思考一下项目的逻辑,我们要完成的功能如下:

  • 通过Toolbar的添加,收藏和删除按钮对NoteList中的列表项进行操作
  • NoteList上的All和Favorites按钮可以切换显示所有笔记和收藏笔记
  • Ediotr上部的title区和NoteList部分笔记显示的题目相同
  • Ediotr下部的内容区在切换笔记后不会消失

基于这样的功能,我们先来编写store.js,在src文件夹下新建一个vuex目录,下包含一个store.js文件

//store.js
import Vue from 'vue'
import Vuex from 'vuex'

Vue.use(Vuex)

let state = {
  notes: [],
  activeNote: {}
}

const mutations = {
}


export default new Vuex.Store({
  state,
  mutations
})

这里就是我们的数据中心,所有的数据操作都由此流入和流出,接下来就是写mutations的相关逻辑,我们先来完成一个添加操作作为例子

// store.js
const mutations = {
  ADD_NOTE(state){
    const newNote = {
      title: 'New Note',
      favorite: false,
      content: '',
      id: new Date()
    }
    state.notes.push(newNote)
    state.activeNote = newNote
  }
}

这段代码表示,每次添加笔记时都会向state下的notes数组push一个对象,并且把激活笔记设置为新添加的这个笔记。
接下来是Toolbar的相关逻辑

//Toolbar.vue
<template>
  <div id="Toolbar">
    <ul class="btnList">
      <li @click="addNote" ><i class="iconfont icon-jiahao"></i></li>
      <li><i class="iconfont icon-wujiaoxingshixin"></i></li>
      <li><i class="iconfont icon-cheng"></i></li>
    </ul>
  </div>
</template>
<script>

  export default {
    methods:{
      addNote(){
        this.$store.commit('ADD_NOTE')
      }
  }
</script>

我们为添加按钮绑定了一个addNote事件,在每次点击的时候触发,这个事件会向store提交一个触发ADD_NOTE这个mutation的请求,这样就向state下的notes新添加了一个对象。接下来我们需要让这个笔记显示出来。

//NoteList.vue
<template>
  <div id="NoteList">
    <div class="header-wrapper">
      <h3 class="header">NOTES</h3>
      <div class="btn-wrapper">
        <a href="#">All Notes</a>
        <a href="#">Favorites</a>
      </div>
    </div>
    <ul class="list">
      <li v-for="note in noteList">
        {{ note.title }}
      </li>
    </ul>
  </div>
</template>
<script>
  export default {
    name: 'NodeList',
    computed: {
      noteList(){
          return this.$store.state.notes
        }
  }
</script>

我们在这里先使用计算属性取得state下的notes数组,再对这个数据进行遍历,就能显示所有新建的笔记。接下来来看Editor中对标题和内容的处理

//Editor.vue
<template>
  <div id="Editor">
    <input type="text" id="EditorTitle" placeholder="请输入笔记标题"
           :value="activeNoteTitle" @input="updateTitle">
    <textarea name="editor" id="editorPanel"
              @input="updateContent" :value="activeNoteText">
    </textarea>
  </div>
</template>
<script>


  export default {
    name:'Editor',
    computed:{
      activeNoteText(){
         return this.$store.state.activeNote.content
      },
      activeNoteTitle(){
        return this.$store.state.activeNote.title
      }
    },
    methods:{
      updateContent(e){
        console.log(this.activeNoteText)
        this.$store.commit("EDIT_NOTE", e.target.value)
      },
      updateTitle(e){
        this.$store.commit("EDIT_TITLE",e.target.value)
      }
    }
  }

我们分别对两块输入区域都绑定了input事件,在每次输入的时候都会触发相应事件,让mutation进行响应的操作。重点是使用了:value而不是v-model进行输入框数据的操作,这是由于vuex本身的设计不建议使用双向绑定,在严格模式下使用v-model会报错。
依据以上的例子,大致就可以完成整个app了,其余的只是一些逻辑的处理,接下来我们来完成本地存储的功能。我们希望每次刷新页面数据都能保存到本地而不是全部清空,这样就要用到localStorage,它有如下的基本用法

window.localStorage.setItem('name',data) //保存数据,放在name键下
window.localStorage.getItem('name') // 取出name键的数据
window.localStorage.removeItem('name') //删除name字段的数据

接下来需要思考的是,我们改在什么时候存取数据呢?每次数据更新都保存显得有点傻,我决定在页面刷新之前来保存数据,在页面创建后就获取数据。所以进行如下处理

//Appd.vue
<script>
...
created(){

      window.onbeforeunload = ()=>{
        this.$store.commit('SAVE_DATA')
      }

      this.$store.commit('INIT_DATA')

    }
...
</script>
//store.js
...
const mutations = {
...
  INIT_DATA(state){
    if (window.localStorage.getItem('vue-note')) {
     this.state = window.localStorage.getItem('vue-note')

    }
  },
  SAVE_DATA(state){
    window.localStorage.setItem('vue-note', JSON.stringify(state))
  }
}
...

这样就实现了在页面刷新前保存数据,在页面载入后读取数据,看起来很美好,但是实际操作后发现问题。
虽然我们重写了state为保存的数据,但是视图并没有更新,这是为什么?四处寻找后终于找到了答案,就在vue的文档中
深入响应式原理
简单来讲就是,vue不能检测到对象属性的添加与删除,也不允许在已经创建的实例上动态添加新的根级响应式属性。如果需要修改以及实例化的属性,需要使用vue.set()方法。所以我们对store.js进行如下的修改

//store.js
  INIT_DATA(state){
    if (window.localStorage.getItem('vue-note')) {
      const oldState = JSON.parse(window.localStorage.getItem('vue-note'))
      Vue.set(state, 'notes', oldState.notes)
      Vue.set(state, 'activeNote', oldState.activeNote)
    }
  },
  SAVE_DATA(state){
    window.localStorage.setItem('vue-note', JSON.stringify(state))
  }

这样,就完美实现了本地存储功能。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,590评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 86,808评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,151评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,779评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,773评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,656评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,022评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,678评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,038评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,756评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,411评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,005评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,973评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,053评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,495评论 2 343

推荐阅读更多精彩内容