从零开始搭建包含多个子系统的Vue工程项目

本文以windows为例,介绍支持多个子系统的Vue工程项目的搭建过程,相对于单一系统的工程,多个子系统引入了如下一些问题:

  • 项目目录结构设计
  • 打包结果设计:每个子系统可以独立发布上线
  • 多布局实现:多种页面布局并存
  • 公共组件的分层组织

一、     Vue环境搭建和项目初始化(windows)

详细过程参见《Vue环境搭建和项目初始化(windows)

PS:npm建议V5.4.2以上,保证package-lock.json起作用,保证可重复构建,详解见相关文档

二、     npm模块安装和使用

1.    所有子系统通用的npm模块

这里是比较通用的模块,支持一个系统运行最基本的模块,基本上是最小组合(除ElementUI)

a)     axios

基于promise的HTTP库,可以用在浏览器和node.js中

   i.          安装
npm install axios –save

  

b)     mockjs

模拟数据生成器,让前端独立于后端进行开发,返回模拟的响应数据。

i.          安装

npm install mockjs --save

 

c)     在vue2中使用mockjs与axios

全局使用axios避免引入麻烦https://zhuanlan.zhihu.com/p/29102204

i.          根据数据模板生成模拟数据。

 

 ii.          生成响应数据

当拦截到匹配‘/msg’的 Ajax 请求时,函数msg.getMsg将被执行,并把执行结果作为响应数据返回

 

iii.          要在main中引入该项目所有请求使用mockjs模拟(重要

 

iv.          组件中使用axios调接口

 

d)     开发环境代理配置:(根据各自需要

config/index.js文件中

{
  dev:
    proxyTable: {}
}

 

e)     element

组件库

   i.          安装

npm install element-ui –save

 

 ii.          使用

在 main.js 中写入以下内容:

import Vue from 'vue';
import ElementUI from 'element-ui';
import 'element-ui/lib/theme-chalk/index.css';
import App from './App.vue';

Vue.use(ElementUI);

new Vue({
  el: '#app',
  render: h => h(App)
});

f)      vuex

状态管理模式,记录登录状态,用户信息

   i.          安装

npm install vuex –save

 

 ii.          注册到根组件

 

iii.          store组织,拆分modules

 

2.    子系统特有npm

各个子系统由于业务不同可能包含各自单独需要的模块,这个根据具体业务需要决定

a)     子系统A

……

b)     子系统B

……

三、     同一个项目目录下包含多个子系统

1.    一个项目应该包含的内容

单页面的vue项目由main.js、App.vue、index.html三个核心文件组织构成,针对每个子系统单独建立这三个核心文件,最终单独打包,使每个子系统独立成为一个单页面vue工程。

文件名

说明

main.js

入口文件

App.vue

根组件template,每个具体页面均由APP.vue+路由指向的子组件构成

index.html

生成html入口文件模板

2.    vue项目中的webpack配置文件

使用脚手架创建的webpack标准模板项目中,webpack的配置文件位于项目/build目录下,结构如下:

 

文件

说明

webpack.base.conf.js

基础配置信息,开发、测试、生产环境共用。包含入口文件配置

webpack.dev.conf.js

开发环境配置信息。包含开发环境下html入口文件的配置

webpack.prod.conf.js

生产环境配置信息。包含生产环境下html入口文件的配置,以及公共库的打包配置

webpack.test.conf.js

测试环境配置信息

3.    基础配置:入口文件

 

以任务中心、个人中心两个子系统为例,分别配置两个子系统的入口文件,如上图

4.    生产环境配置

a)     配置html入口文件

针对每一个子系统生成其对应的一个html入口文件,直接位于dist目录下。

这里有个坑,在每个HtmlWebpackPlugin的chunks中一定要加入'vendor'和'manifest'两个公共模块,这样webpack才能正确识别项目的依赖关系,自动将公共模块引入到单页html中

 

HtmlWebpackPlugin插件的具体配置项含义参考官方文档

http://www.css88.com/doc/webpack2/plugins/html-webpack-plugin/

https://github.com/jantimon/html-webpack-plugin#configuration

http://www.cnblogs.com/wonyun/p/6030090.html

b)     修改js、css文件输出路径

各个子系统的js和css文件输出到以各自名称命名的目录下,即,dist/[name]/static下

 

c)     公共模块单独打包

默认配置将node_modules中的依赖单独打包到vendor,暂时不需要修改和做单独配置,简单标明配置项。后续各个子系统单独的依赖需考虑打包策略

 

5.    开发环境配置

a)     配置html入口文件

开发环境下需要修改html入口文件模板配置即可,同生产环境,不要忘了'vendor'和'manifest'两个公共模块

 

6.    打包结果

a)     多文件打包结果

经过上述配置后打包结果如下图所示,各个子系统单独部署时需将子系统文件、mainfest、vendor、子系统html一同部署,多个子系统部署在同一服务器时mianfest与vendor可只部署一次。

 

b)     多文件访问路径

格式:http://{服务器IP或域名}:{端口号}/{模板名}.html#/{具体路由}

服务器IP或域名:各个子系统部署位置

模板名:各个子系统不同,根据html入口配置项有关

具体路由:各个子系统各自管理内部路由

例如:http://localhost:8080/task.html#/app

http://localhost:8080/personal.html#/personal

c)     原单文件入口打包结果(仅供参考对比)

 

7.    最终项目目录

 

d)     项目主目录

目录名

说明

build

Webpack打包配置文件目录

config

项目配置信息

dist

打包结果目录

node_modules

依赖包安装目录

src

项目代码目录

static

静态文件目录

template

入口html文件目录

test

单元测试文件目录

e)     项目代码目录

目录名

说明

assets

公共js、css文件

components

公共组件目录,所有子系统共用

modules

子系统模块目录

f)      子系统列表

目录名

说明

task_center

任务中心子系统

personal_center

个人中心子系统

……

……

g)     子系统内部项目目录

目录名

说明

api

接口代理文件目录

asset

静态资源目录

common

公共函数目录:子系统公共逻辑处理函数

components

公共组件目录:子系统公共组件

data

数据处理:各个页面的数据处理方法

mock

Mock服务:拦截ajax请求,根据模板模拟生成并返回数据

pages

页面目录:每个页面对应一个pages下级目录,包含页面级组件

router

路由目录

store

Vuex状态管理目录

App.vue

子系统根组件文件

main.js

子系统入口文件

8.    后续任务

对于打包构建这块目前做的还不够细致,还有一些其他优化可以做,记下来先

  • 自动构建入口函数
  • 单独发布打包指定某一个子系统
  • 子系统特有依赖模块打包策略

四、     elementUI自定义主题

官网说明:http://element-cn.eleme.io/2.3/#/zh-CN/component/custom-theme

1.    安装工具(全局安装)

npm install element-theme –g

2.    安装默认主题

在项目目录下执行命令:

npm i element-theme-chalk –D

3.    初始化变量文件

et –i

产生element-variables.scss文件

4.    修改变量

修改element-variables.scss文件中的色值等变量

5.    编译主题

et

此时,项目目录下会产生主题样式目录theme

6.    引入自定义主题

import '../theme/index.css'
import ElementUI from 'element-ui'
import Vue from 'vue' 

Vue.use(ElementUI)

7.    说明

theme目录及element-variables.scss文件需提交

五、     多布局实现

vue-route中使用嵌套空的子路由。目前APP.vue只包含一个可以不使用命名视图,多个的情况考虑命名视图

 

布局属于平台级公共组件,位于srccomponentslayout目录下,以‘_layout.vue’结尾的文件是布局文件,布局组件位于comp子目录,具体结构见下图:

 

六、     公共组件怎么组织

组件层级归属详细划分见文档《云质量V4.0前端组件分析.xlsx》最后一个页签《组件层级及项目归属》

项目目录结构组织见下表:

组件级别

所在项目目录

平台级公共组件

srccomponents

子系统级组件

srcmodules子系统components

页面级组件

srcmodules子系统pages页面

原文地址:https://www.cnblogs.com/zs-note/p/8988918.html