关于个人开源项目(vue app)的一些总结

项目地址

https://github.com/BYChoo/record

项目简介

此项目名叫:Record。是以Vue全家桶(vue,vue-router,vuex) + axios + express + mongodb技术栈开发的一个校园考勤网站,专门为老师定制的。网站目前实现了登录注册、日历、导入文件(csv)、考勤、导出缺勤名单等核心功能。

关于项目结构

刚开始着手做此项目的时候,考虑到项目本身并不复杂,以视图层来说撑死了也就六七个视图层,我就把所有视图层组件都放在components文件夹中,再在components文件夹中新建一个common文件夹来放置复用的组件。这对于小型项目来说并没有什么问题(like this)。但是考虑到此站往后可能会部署上线,为了方便维护,我还是花了些时间对整个项目结构进行了重整:

组件:新建一个views文件夹放置视图层的组件,如果每个视图层需要用到的子组件多的话,还可以以此视图层为核心建一个文件夹,在此文件夹中再建一个childrens文件夹放置子组件

image.png

复用组件:项目中凡是复用到的子组件统一放在components中

http请求:新建一个APIs文件夹,以视图层面为出发点创建每个视图层需要用到的.js文件

image.png

全局方法:新建一个utils文件夹,放置方法.js文件
静态资源:关于静态资源,基于vue-cil构建的项目中有两个可以放置静态资源的文件夹:static和src文件夹下的assets,放置在static文件夹中的静态资源是不会被webpack打包的,而src文件夹下的静态资源则会,该放哪还是酌情考虑吧

关于http请求

不知道大家有没有这样子写过http请求

// 这条http请求是请求xxx
this.$http.get('/api/demo')
  .then((res) => {
    // do something  
  })
  .catch((err) => {
    // throw err
  })

这样写请求是没问题的,但如果这条http请求是需要多次被使用到呢?每次都要写这样一长串的代码未免有点不优雅了。针对这个问题,我决定采用把请求抽离出来,以每个视图层为每个.js文件,把每个http请求封装成函数然后导出,like this:


/**
 * index.js
 */

const getCaledarDay = function(params) {
  return new fetch({      // fetch是http请求实例
    url: '/api/get_caledarDay',
    method: 'get',
    params
  })
}

export { getCaledarDay }; // 把函数导出

/**
 * index.vue
 */

...
import { getCaledarDay } from 'api/index.js'; // 引入函数
...

这样子写的话就能有效的规避了http请求复用的问题了

关于状态管理

关于数据状态管理一直是我开发Vue项目是都要考虑的问题,一般考虑是否要用vux的状态管理(vuex)都离不开这个考虑点:跨组件之间数据共享问题。如果跨组件之间需要共享到的数据多且庞大,那么直接vuex一把梭就好了,不要再考虑了。但如果跨组件之间共享数据不多(酌情考虑多的概念),那么可以通过父子组件间和非父子组件的prop、$emit、$on等事件来传值也是可以的。

vuex编译后的大小25kb

关于csv文件上传与导出功能

csv文件上传导出可以说是此项目最关键的点了。在开发过程csv文件上传过程中,我发现了几个可以解析csv文件的包:

  • node-csv
  • line-reader
  • fs

其中我采用了node-csv这个类库来开发,毕竟是node中专门来用解析csv文件的包。此外,我还用了formidable包来模拟解析前端上传的form表单,如果不这样做的话,前端post得csv文件会接受不到。有了formidablenode-csv开发起来就很美滋滋了。

导出csv文件部分,我采用了file-saver包来模拟csv文件的导出下载,怎么使用可以去github上翻阅,那里都写的很详细了。

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

推荐阅读更多精彩内容