vue 项目总结一文件夹结构配置

时间 2019-11-07

标签 vue 项目总结文件夹结构配置繁體版

原文原文链接

以前一段时间都在使用 vue 开发后台管理系统，在摸索的过程当中对 vue 自己和模块化、规范化开发有了更深的认知，如今记录下来，但愿对其余须要开发项目的人有帮助。

项目配置

首先，在肯定好使用的框架和组件库后，先要大体了解它们，作到文档基本熟悉。本次开发使用到的有： vue ， vuex ， axios ， elementUI 。 css

而后能够按官方指引，使用 vue-cli 搭建 vue 的项目，在项目里按照上面的文档尝试修改，加深理解：html

# 安装依赖库，建议指定 vue 和 element 版本，避免版本升级带来意料以外的 bug

$ npm install vue@2.1.6  element-ui@1.4.6 vuex axios

#全局安装脚手架

$ npm install -g vue-cli 

# 建立一个基于 webpack 模板的新项目my-project

$ vue init webpack my-project

# 进入项目目录

$ cd my-project

# 安装依赖

$ npm install

# 运行项目

$ npm run dev

运行以后，看到如下页面代表项目环境搭建成功：vue

项目结构

搭建成功后，使用编辑器打开项目目录，大体是这样的结构：node

相关文件和文件夹的含义：webpack

build 文件夹: 里面是对 webpack 开发和打包的相关设置，包括入口文件、输出文件、使用的模块等；ios

config 文件夹: 主要是指定开发和打包中的静态资源路径、要压缩的文件类型、开发使用的端口号、开发使用虚拟服务器跨域请求 api 等。git

node_modules: 项目的依赖库；web

src 文件夹：咱们主要操做的地方，组件的增长修改等都在这个文件夹里操做，下文会有详细介绍；vuex

static 文件夹: 静态资源文件夹，放置不会变更的资源，直接被复制到最终的打包目录（默认是dist/static）下；vue-cli

.babelrc: 使用 babel 的配置文件，用来设置转码规则和插件；

.editorconfig: 代码的规范文件，规定使用空格或 tab 缩进，缩进的长度是两位仍是四位之类的代码风格，使用的话须要在编辑器里下载对应的插件；

.eslintignore: 指定 eslint 忽略的文件；

.eslintrc: 配置 eslint 的检测规则，强制按照规则书写代码；

.gitignore: 指定 git 忽略的文件，全部 git 操做均不会对其生效；

.postcssrc: 指定使用的 css 预编译器，里面默认配置了 autoprefixer ，自动补全浏览器前缀；

favicon.ico: 浏览器标签页 title 旁边的小图标，这是须要咱们本身粘贴过来的；

index.html: 首页文件，项目运行的时候，会自动将咱们在 src 文件夹里生成的组件插入这个文件里；

LICENSE: 项目声明的 license；

package-lock.json: 当 node_modules 或 package.json 发生变化时自动生成的文件。这个文件主要功能是肯定当前安装的包的依赖，以便后续从新安装的时候生成相同的依赖，而忽略项目开发过程当中有些依赖已经发生的更新；

package.json: 指定项目开发和生成环境中须要使用的依赖库；

README.md: 至关因而一个备注文件，对项目开发过程当中须要注意的地方进行一些说明。

src 文件夹结构

src 文件夹里的文件夹设置是灵活的，能够根据本身的习惯进行，没必要雷同。下面是此次项目的结构：

assets: 放置静态资源，包括公共的 css 文件、 js 文件、iconfont 字体文件、img 图片文件以及其余资源类文件。之因此强调是公共的 css 文件，是由于要在组件的 css 标签里加入 ‘scoped‘ 标记，将其做用范围限制在此组件以及调用它的父级组件中，避免污染全局样式；

components: 放置通用模块组件。项目里总会有一些复用的组件，例如弹出框、发送手机验证码、图片上传等，将它们做为通用组件，避免重复工做；

http: 放置与后台 api 相关的文件。这里面有 axios 库的实例配置文件、使用配置的 axios 实例接入 api 获取数据的函数的集合的文件；

mixins: 放置混合选项的文件。具体来讲，至关因而公用函数的集合，在组件中引用时，能够做用于组件而没必要书写重复的方法；

pages: 放置主要页面的组件。例如登陆页、用户信息页等。一般是这里的组件自己写入一些结构，再引入通用模块组件，造成完整的页面；

router: 放置路由设置文件，指定路由对应的组件；

store: 放置 vuex 须要的状态关联文件，设置公共的 state、mutations 等；

App.vue: 入口组件，pages 里的组件会被插入此组件中，此组件再插入 index.html 文件里，造成单页面应用；

main.js: 入口 js 文件，影响全局，做用是引入全局使用的库、公共的样式和方法、设置路由等。

对文件夹配置的总结先到此为止，下一篇文章会是对 src 文件夹里具体文件的配置和例子总结，有须要的能够去 https://segmentfault.com/a/11... 看看。