资讯专栏INFORMATION COLUMN

浅谈使用 Vue 构建前端 10w+ 代码量的单页面应用开发底层

Backache / 2200人阅读

摘要:其实就是我们开始挂载上去的我们在这里出去,我们就可以在回调里面只处理我们的业务逻辑,而其他如断网超时服务器出错等均通过拦截器进行统一处理。

开始之前

随着业务的不断累积,目前我们 ToC 端主要项目,除去 node_modulesbuild 配置文件dist 静态资源文件的代码量为 137521 行,后台管理系统下各个子应用代码,除去依赖等文件的总行数也达到 100万 多一点。

</>复制代码

  1. 代码量意味不了什么,只能证明模块很多,但相同两个项目,在运行时性能相同情况下,你的 10 万行代码能容纳并维护 150 个模块,并且开发顺畅,我的项目中 10 万行代码却只能容纳 100 个模块,添加功能也好,维护起来也较为繁琐,这就很值得思考

本文会在主要描述以 Vue 技术栈技术主体ToC 端项目业务主体,在构建过程中,遇到或者总结的点(也会提及一些 ToB 项目的场景),可能并不适合你的业务场景(仅供参考),我会尽可能多的描述问题与其中的思考,最大可能的帮助到需要的同学,也辛苦开发者发现问题或者不合理/不正确的地方及时向我反馈,会尽快修改,欢迎有更好的实现方式来 pr

Git 地址

vue-develop-template 完善中,可以运行

React 项目

可以参考蚂蚁金服数据体验技术团队编写的文章:

如何管理好10万行代码的前端单页面应用

本文并不是基于上面文章写的,不过当时在看到他们文章之后觉得有相似的地方,相较于这篇文章,本文可能会枯燥些,会有大量代码,同学可以直接用上仓库看。

① 单页面,多页面

首先要思考我们的项目最终的构建主体单页面,还是多页面,还是单页 + 多页,通过他们的优缺点来分析:

单页面(SPA)

优点:体验好,路由之间跳转流程,可定制转场动画,使用了懒加载可有效减少首页白屏时间,相较于多页面减少了用户访问静态资源服务器的次数等。

缺点:初始会加载较大的静态资源,并且随着业务增长会越来越大,懒加载也有他的弊端,不做特殊处理不利于 SEO 等。

多页面(MPA)

优点:对搜索引擎友好,开发难度较低。

缺点:资源请求较多,整页刷新体验较差,页面间传递数据只能依赖 URLcookiestorage 等方式,较为局限。

SPA + MPA

这种方式常见于较老 MPA 项目迁移至 SPA 的情况,缺点结合两者,两种主体通信方式也只能以兼容MPA 为准

不过这种方式也有他的好处,假如你的 SPA 中,有类似文章分享这样(没有后端直出,后端返 HTML 串的情况下),想保证用户体验在 SPA 中开发一个页面,在 MPA 中也开发一个页面,去掉没用的依赖,或者直接用原生 JS 来开发,分享出去是 MPA 的文章页面,这样可以加快分享出去的打开速度,同时也能减少静态资源服务器的压力,因为如果分享出去的是 SPA 的文章页面,那 SPA 所需的静态资源至少都需要去进行协商请求,当然如果服务配置了强缓存就忽略以上所说。

我们首先根据业务所需,来最终确定构建主体,而我们选择了体验至上的 SPA,并选用 Vue 技术栈。

② 目录结构

其实我们看开源的绝大部分项目中,目录结构都会差不太多,我们可以综合一下来个通用的 src 目录:

</>复制代码

  1. src
  2. ├── assets // 资源目录 图片,样式,iconfont
  3. ├── components // 全局通用组件目录
  4. ├── config // 项目配置,拦截器,开关
  5. ├── plugins // 插件相关,生成路由、请求、store 等实例,并挂载 Vue 实例
  6. ├── directives // 拓展指令集合
  7. ├── routes // 路由配置
  8. ├── service // 服务层
  9. ├── utils // 工具类
  10. └── views // 视图层
③ 通用组件

components 中我们会存放 UI 组件库中的那些常见通用组件了,在项目中直接通过设置别名来使用,如果其他项目需要使用,就发到 npm 上。

结构

</>复制代码

  1. // components 简易结构
  2. components
  3. ├── dist
  4. ├── build
  5. ├── src
  6. ├── modal
  7. ├── toast
  8. └── ...
  9. ├── index.js
  10. └── package.json
项目中使用

如果想最终编译成 es5,直接在 html 中使用或者部署 CDN 上,在 build 配置简单的打包逻辑,搭配着 package.json 构建 UI组件 的自动化打包发布,最终部署 dist 下的内容,并发布到 npm 上即可。

而我们也可直接使用 es6 的代码:

</>复制代码

  1. import "Components/src/modal"
其他项目使用

假设我们发布的 npm 包bm-ui,并且下载到了本地 npm i bm-ui -S:

修改项目的最外层打包配置,在 rules 里 babel-loaderhappypack 中添加 includenode_modules/bm-ui

</>复制代码

  1. // webpack.base.conf
  2. ...
  3. rules: [{
  4. test: /.vue$/,
  5. loader: "vue-loader",
  6. options: vueLoaderConfig
  7. },
  8. {
  9. test: /.js$/,
  10. loader: "babel-loader",
  11. // 这里添加
  12. include: [resolve("src"), resolve("test"), resolve("node_modules/bm-ui")]
  13. },{
  14. ...
  15. }]
  16. ...

然后搭配着 babel-plugin-import 直接在项目中使用即可:

</>复制代码

  1. import { modal } from "bm-ui"
多个组件库

同时有多个组件库的话,又或者有同学专门进行组件开发的话,把 `components
内部细分`一下,多一个文件分层。

</>复制代码

  1. components
  2. ├── bm-ui-1
  3. ├── bm-ui-2
  4. └── ...

你的打包配置文件可以放在 components 下,进行统一打包,当然如果要开源出去还是放在对应库下。

④ 全局配置,插件与拦截器

这个点其实会是项目中经常被忽略的,或者说很少聚合到一起,但同时我认为是整个项目中的重要之一,后续会有例子说道。

全局配置,拦截器目录结构

</>复制代码

  1. config
  2. ├── index.js // 全局配置/开关
  3. ├── interceptors // 拦截器
  4. ├── index.js // 入口文件
  5. ├── axios.js // 请求/响应拦截
  6. ├── router.js // 路由拦截
  7. └── ...
  8. └── ...
全局配置

我们在 config/index.js 可能会有如下配置:

</>复制代码

  1. // config/index.js
  2. // 当前宿主平台 兼容多平台应该通过一些特定函数来取得
  3. export const HOST_PLATFORM = "WEB"
  4. // 这个就不多说了
  5. export const NODE_ENV = process.env.NODE_ENV || "prod"
  6. // 是否强制所有请求访问本地 MOCK,看到这里同学不难猜到,每个请求也可以多带带控制是否请求 MOCK
  7. export const AJAX_LOCALLY_ENABLE = false
  8. // 是否开启监控
  9. export const MONITOR_ENABLE = true
  10. // 路由默认配置,路由表并不从此注入
  11. export const ROUTER_DEFAULT_CONFIG = {
  12. waitForData: true,
  13. transitionOnLoad: true
  14. }
  15. // axios 默认配置
  16. export const AXIOS_DEFAULT_CONFIG = {
  17. timeout: 20000,
  18. maxContentLength: 2000,
  19. headers: {}
  20. }
  21. // vuex 默认配置
  22. export const VUEX_DEFAULT_CONFIG = {
  23. strict: process.env.NODE_ENV !== "production"
  24. }
  25. // API 默认配置
  26. export const API_DEFAULT_CONFIG = {
  27. mockBaseURL: "",
  28. mock: true,
  29. debug: false,
  30. sep: "/"
  31. }
  32. // CONST 默认配置
  33. export const CONST_DEFAULT_CONFIG = {
  34. sep: "/"
  35. }
  36. // 还有一些业务相关的配置
  37. // ...
  38. // 还有一些方便开发的配置
  39. export const CONSOLE_REQUEST_ENABLE = true // 开启请求参数打印
  40. export const CONSOLE_RESPONSE_ENABLE = true // 开启响应参数打印
  41. export const CONSOLE_MONITOR_ENABLE = true // 监控记录打印

可以看出这里汇集了项目中所有用到的配置,下面我们在 plugins 中实例化插件,注入对应配置,目录如下:

插件目录结构

</>复制代码

  1. plugins
  2. ├── api.js // 服务层 api 插件
  3. ├── axios.js // 请求实例插件
  4. ├── const.js // 服务层 const 插件
  5. ├── store.js // vuex 实例插件
  6. ├── inject.js // 注入 Vue 原型插件
  7. └── router.js // 路由实例插件
实例化插件并注入配置

这里先举出两个例子,看我们是如何注入配置,拦截器并实例化的

实例化 router

</>复制代码

  1. import Vue from "vue"
  2. import Router from "vue-router"
  3. import ROUTES from "Routes"
  4. import {ROUTER_DEFAULT_CONFIG} from "Config/index"
  5. import {routerBeforeEachFunc} from "Config/interceptors/router"
  6. Vue.use(Router)
  7. // 注入默认配置和路由表
  8. let routerInstance = new Router({
  9. ...ROUTER_DEFAULT_CONFIG,
  10. routes: ROUTES
  11. })
  12. // 注入拦截器
  13. routerInstance.beforeEach(routerBeforeEachFunc)
  14. export default routerInstance

实例化 axios

</>复制代码

  1. import axios from "axios"
  2. import {AXIOS_DEFAULT_CONFIG} from "Config/index"
  3. import {requestSuccessFunc, requestFailFunc, responseSuccessFunc, responseFailFunc} from "Config/interceptors/axios"
  4. let axiosInstance = {}
  5. axiosInstance = axios.create(AXIOS_DEFAULT_CONFIG)
  6. // 注入请求拦截
  7. axiosInstance
  8. .interceptors.request.use(requestSuccessFunc, requestFailFunc)
  9. // 注入响应拦截
  10. axiosInstance
  11. .interceptors.response.use(responseSuccessFunc, responseFailFunc)
  12. export default axiosInstance

我们在 main.js 注入插件

</>复制代码

  1. // main.js
  2. import Vue from "vue"
  3. GLOBAL.vbus = new Vue()
  4. // import "Components"// 全局组件注册
  5. import "Directives" // 指令
  6. // 引入插件
  7. import router from "Plugins/router"
  8. import inject from "Plugins/inject"
  9. import store from "Plugins/store"
  10. // 引入组件库及其组件库样式
  11. // 不需要配置的库就在这里引入
  12. // 如果需要配置都放入 plugin 即可
  13. import VueOnsen from "vue-onsenui"
  14. import "onsenui/css/onsenui.css"
  15. import "onsenui/css/onsen-css-components.css"
  16. // 引入根组件
  17. import App from "./App"
  18. Vue.use(inject)
  19. Vue.use(VueOnsen)
  20. // render
  21. new Vue({
  22. el: "#app",
  23. router,
  24. store,
  25. template: "",
  26. components: { App }
  27. })

axios 实例我们并没有直接引用,相信你也猜到他是通过 inject 插件引用的,我们看下 inject

</>复制代码

  1. import axios from "./axios"
  2. import api from "./api"
  3. import consts from "./const"
  4. GLOBAL.ajax = axios
  5. export default {
  6. install: (Vue, options) => {
  7. Vue.prototype.$api = api
  8. Vue.prototype.$ajax = axios
  9. Vue.prototype.$const = consts
  10. // 需要挂载的都放在这里
  11. }
  12. }

这里可以挂载你想在业务中( vue 实例中)便捷访问的 api,除了 $ajax 之外,apiconst 两个插件是我们服务层中主要的功能,后续会介绍,这样我们插件流程大致运转起来,下面写对应拦截器的方法。

请求,路由拦截器

ajax 拦截器中(config/interceptors/axios.js):

</>复制代码

  1. // config/interceptors/axios.js
  2. import {CONSOLE_REQUEST_ENABLE, CONSOLE_RESPONSE_ENABLE} from "../index.js"
  3. export function requestSuccessFunc (requestObj) {
  4. CONSOLE_REQUEST_ENABLE && console.info("requestInterceptorFunc", `url: ${requestObj.url}`, requestObj)
  5. // 自定义请求拦截逻辑,可以处理权限,请求发送监控等
  6. // ...
  7. return requestObj
  8. }
  9. export function requestFailFunc (requestError) {
  10. // 自定义发送请求失败逻辑,断网,请求发送监控等
  11. // ...
  12. return Promise.reject(requestError);
  13. }
  14. export function responseSuccessFunc (responseObj) {
  15. // 自定义响应成功逻辑,全局拦截接口,根据不同业务做不同处理,响应成功监控等
  16. // ...
  17. // 假设我们请求体为
  18. // {
  19. // code: 1010,
  20. // msg: "this is a msg",
  21. // data: null
  22. // }
  23. let resData = responseObj.data
  24. let {code} = resData
  25. switch(code) {
  26. case 0: // 如果业务成功,直接进成功回调
  27. return resData.data;
  28. case 1111:
  29. // 如果业务失败,根据不同 code 做不同处理
  30. // 比如最常见的授权过期跳登录
  31. // 特定弹窗
  32. // 跳转特定页面等
  33. location.href = xxx // 这里的路径也可以放到全局配置里
  34. return;
  35. default:
  36. // 业务中还会有一些特殊 code 逻辑,我们可以在这里做统一处理,也可以下方它们到业务层
  37. !responseObj.config.noShowDefaultError && GLOBAL.vbus.$emit("global.$dialog.show", resData.msg);
  38. return Promise.reject(resData);
  39. }
  40. }
  41. export function responseFailFunc (responseError) {
  42. // 响应失败,可根据 responseError.message 和 responseError.response.status 来做监控处理
  43. // ...
  44. return Promise.reject(responseError);
  45. }

定义路由拦截器(config/interceptors/router.js):

</>复制代码

  1. // config/interceptors/router.js
  2. export function routerBeforeFunc (to, from, next) {
  3. // 这里可以做页面拦截,很多后台系统中也非常喜欢在这里面做权限处理
  4. // next(...)
  5. }

最后在入口文件(config/interceptors/index.js)中引入并暴露出来即可:

</>复制代码

  1. import {requestSuccessFunc, requestFailFunc, responseSuccessFunc, responseFailFunc} from "./ajax"
  2. import {routerBeforeEachFunc} from "./router"
  3. let interceptors = {
  4. requestSuccessFunc,
  5. requestFailFunc,
  6. responseSuccessFunc,
  7. responseFailFunc,
  8. routerBeforeEachFunc
  9. }
  10. export default interceptors

请求拦截这里代码都很简单,对于 responseSuccessFunc 中 switch default 逻辑做下简单说明:

responseObj.config.noShowDefaultError 这里可能不太好理解

我们在请求的时候,可以传入一个 axios 中并没有意义的 noShowDefaultError 参数为我们业务所用,当值为 false 或者不存在时,我们会触发全局事件 global.dialog.showglobal.dialog.show我们会注册在 app.vue 中:

</>复制代码

  1. // app.vue
  2. export default {
  3. ...
  4. created() {
  5. this.bindEvents
  6. },
  7. methods: {
  8. bindEvents() {
  9. GLOBAL.vbus.$on("global.dialog.show", (msg) => {
  10. if(msg) return
  11. // 我们会在这里注册全局需要操控试图层的事件,方便在非业务代码中通过发布订阅调用
  12. this.$dialog.popup({
  13. content: msg
  14. });
  15. })
  16. }
  17. ...
  18. }
  19. }

</>复制代码

  1. 这里也可以把弹窗状态放入 Store 中,按团队喜好,我们习惯把公共的涉及视图逻辑的公共状态在这里注册,和业务区分开来

GLOBAL 是我们挂载 window 上的全局对象,我们把需要挂载的东西都放在 window.GLOBAL 里,减少命名空间冲突的可能。

vbus 其实就是我们开始 new Vue() 挂载上去的

</>复制代码

  1. GLOBAL.vbus = new Vue()

我们在这里 Promise.reject 出去,我们就可以在 error 回调里面只处理我们的业务逻辑,而其他如断网超时服务器出错等均通过拦截器进行统一处理。

拦截器处理前后对比

对比下处理前后在业务中的发送请求的代码

拦截器处理前

</>复制代码

  1. this.$axios.get("test_url").then(({code, data}) => {
  2. if( code === 0 ) {
  3. // 业务成功
  4. } else if () {}
  5. // em... 各种业务不成功处理,如果遇到通用的处理,还需要抽离出来
  6. }, error => {
  7. // 需要根据 error 做各种抽离好的处理逻辑,断网,超时等等...
  8. })

拦截器处理后

</>复制代码

  1. // 业务失败走默认弹窗逻辑的情况
  2. this.$axios.get("test_url").then(({data}) => {
  3. // 业务成功,直接操作 data 即可
  4. })
  5. // 业务失败自定义
  6. this.$axios.get("test_url", {
  7. noShowDefaultError: true // 可选
  8. }).then(({data}) => {
  9. // 业务成功,直接操作 data 即可
  10. }, (code, msg) => {
  11. // 当有特定 code 需要特殊处理,传入 noShowDefaultError:true,在这个回调处理就行
  12. })
为什么要如此配置与拦截器?

</>复制代码

  1. 在应对项目开发过程中需求的不可预见性时,让我们能处理的更快更好

到这里很多同学会觉得,就这么简单的引入判断,可有可无,
就如我们最近做的一个需求来说,我们 ToC 端项目之前一直是在微信公众号中打开的,而我们需要在小程序中通过 webview 打开大部分流程,而我们也没有时间,没有空间在小程序中重写近 100 + 的页面流程,这是我们开发之初并没有想到的。这时候必须把项目兼容到小程序端,在兼容过程中可能需要解决以下问题:

请求路径完全不同。

需要兼容两套不同的权限系统。

有些流程在小程序端需要做改动,跳转到特定页面。

有些公众号的 api ,在小程序中无用,需要调用小程序的逻辑,需要做兼容。

很多也页面上的元素,小程序端不做展示等。

</>复制代码

  1. 可以看出,稍微不慎,会影响公众号现有逻辑。

添加请求拦截 interceptors/minaAjax.jsinterceptors/minaRouter.js,原有的换更为 interceptors/officalAjax.jsinterceptors/officalRouter.js,在入口文件interceptors/index.js根据当前宿主平台,也就是全局配置 HOST_PLATFORM,通过代理模式策略模式,注入对应平台的拦截器minaAjax.js中重写请求路径和权限处理,在 minaRouter.js 中添加页面拦截配置,跳转到特定页面,这样一并解决了上面的问题 1,2,3

问题 4 其实也比较好处理了,拷贝需要兼容 api 的页面,重写里面的逻辑,通过路由拦截器一并做跳转处理

问题 5 也很简单,拓展两个自定义指令 v-mina-show 和 v-mina-hide ,在展示不同步的地方可以直接使用指令。

最终用最少的代码,最快的时间完美上线,丝毫没影响到现有 toC 端业务,而且这样把所有兼容逻辑绝大部分聚合到了一起,方便二次拓展和修改。

虽然这只是根据自身业务结合来说明,可能没什么说服力,不过不难看出全局配置/拦截器 虽然代码不多,但却是整个项目的核心之一,我们可以在里面做更多 awesome 的事情。

⑤ 路由配置与懒加载

directives 里面没什么可说的,不过很多难题都可以通过他来解决,要时刻记住,我们可以再指令里面操作虚拟 DOM。

路由配置

而我们根据自己的业务性质,最终根据业务流程来拆分配置:

</>复制代码

  1. routes
  2. ├── index.js // 入口文件
  3. ├── common.js // 公共路由,登录,提示页等
  4. ├── account.js // 账户流程
  5. ├── register.js // 挂号流程
  6. └── ...

最终通过 index.js 暴露出去给 plugins/router 实例使用,这里的拆分配置有两个注意的地方:

需要根据自己业务性质来决定,有的项目可能适合业务线划分,有的项目更适合以 功能 划分。

在多人协作过程中,尽可能避免冲突,或者减少冲突。

懒加载

文章开头说到单页面静态资源过大,首次打开/每次版本升级后都会较慢,可以用懒加载来拆分静态资源,减少白屏时间,但开头也说到懒加载也有待商榷的地方:

如果异步加载较多的组件,会给静态资源服务器/ CDN 带来更大的访问压力的同时,如果当多个异步组件都被修改,造成版本号的变动,发布的时候会大大增加 CDN 被击穿的风险。

懒加载首次加载未被缓存的异步组件白屏的问题,造成用户体验不好。

异步加载通用组件,会在页面可能会在网络延时的情况下参差不齐的展示出来等。

这就需要我们根据项目情况在空间和时间上做一些权衡。

以下几点可以作为简单的参考:

对于访问量可控的项目,如公司后台管理系统中,可以以操作 view 为单位进行异步加载,通用组件全部同步加载的方式。

对于一些复杂度较高,实时度较高的应用类型,可采用按功能模块拆分进行异步组件加载。

如果项目想保证比较高的完整性和体验,迭代频率可控,不太关心首次加载时间的话,可按需使用异步加载或者直接不使用。

</>复制代码

  1. 打包出来的 main.js 的大小,绝大部分都是在路由中引入的并注册的视图组件。
⑥ Service 服务层

服务层作为项目中的另一个核心之一,“自古以来”都是大家比较关心的地方。

不知道你是否看到过如下组织代码方式:

</>复制代码

  1. views/
  2. pay/
  3. index.vue
  4. service.js
  5. components/
  6. a.vue
  7. b.vue

service.js 中写入编写数据来源

</>复制代码

  1. export const CONFIAG = {
  2. apple: "苹果",
  3. banana: "香蕉"
  4. }
  5. // ...
  6. // ① 处理业务逻辑,还弹窗
  7. export function getBInfo ({name = "", id = ""}) {
  8. return this.$ajax.get("/api/info", {
  9. name,
  10. id
  11. }).then({age} => {
  12. this.$modal.show({
  13. content: age
  14. })
  15. })
  16. }
  17. // ② 不处理业务,仅仅写请求方法
  18. export function getAInfo ({name = "", id = ""}) {
  19. return this.$ajax.get("/api/info", {
  20. name,
  21. id
  22. })
  23. }
  24. ...

简单分析:

① 就不多说了,拆分的不够单纯,当做二次开发的时候,你还得去找这弹窗到底哪里出来的。

② 看起来很美好,不掺杂业务逻辑,但不知道你与没遇到过这样情况,经常会有其他业务需要用到一样的枚举,请求一样的接口,而开发其他业务的同学并不知道你在这里有一份数据源,最终造成的结果就是数据源的代码到处冗余

我相信②在绝大多数项目中都能看到。

那么我们的目的就很明显了,解决冗余,方便使用,我们把枚举和请求接口的方法,通过插件,挂载到一个大对象上,注入 Vue 原型,方面业务使用即可。

目录层级(仅供参考)

</>复制代码

  1. service
  2. ├── api
  3. ├── index.js // 入口文件
  4. ├── order.js // 订单相关接口配置
  5. └── ...
  6. ├── const
  7. ├── index.js // 入口文件
  8. ├── order.js // 订单常量接口配置
  9. └── ...
  10. ├── store // vuex 状态管理
  11. ├── expands // 拓展
  12. ├── monitor.js // 监控
  13. ├── beacon.js // 打点
  14. ├── localstorage.js // 本地存储
  15. └── ... // 按需拓展
  16. └── ...
抽离模型

首先抽离请求接口模型,可按照领域模型抽离 (service/api/index.js):

</>复制代码

  1. {
  2. user: [{
  3. name: "info",
  4. method: "GET",
  5. desc: "测试接口1",
  6. path: "/api/info",
  7. mockPath: "/api/info",
  8. params: {
  9. a: 1,
  10. b: 2
  11. }
  12. }, {
  13. name: "info2",
  14. method: "GET",
  15. desc: "测试接口2",
  16. path: "/api/info2",
  17. mockPath: "/api/info2",
  18. params: {
  19. a: 1,
  20. b: 2,
  21. b: 3
  22. }
  23. }],
  24. order: [{
  25. name: "change",
  26. method: "POST",
  27. desc: "订单变更",
  28. path: "/api/order/change",
  29. mockPath: "/api/order/change",
  30. params: {
  31. type: "SUCCESS"
  32. }
  33. }]
  34. ...
  35. }

定制下需要的几个功能:

请求参数自动截取。

请求参数不传,则发送默认配置参数。

得需要命名空间。

通过全局配置开启调试模式。

通过全局配置来控制走本地 mock 还是线上接口等。

插件编写

定制好功能,开始编写简单的 plugins/api.js 插件:

</>复制代码

  1. import axios from "./axios"
  2. import _pick from "lodash/pick"
  3. import _assign from "lodash/assign"
  4. import _isEmpty from "lodash/isEmpty"
  5. import { assert } from "Utils/tools"
  6. import { API_DEFAULT_CONFIG } from "Config"
  7. import API_CONFIG from "Service/api"
  8. class MakeApi {
  9. constructor(options) {
  10. this.api = {}
  11. this.apiBuilder(options)
  12. }
  13. apiBuilder({
  14. sep = "|",
  15. config = {},
  16. mock = false,
  17. debug = false,
  18. mockBaseURL = ""
  19. }) {
  20. Object.keys(config).map(namespace => {
  21. this._apiSingleBuilder({
  22. namespace,
  23. mock,
  24. mockBaseURL,
  25. sep,
  26. debug,
  27. config: config[namespace]
  28. })
  29. })
  30. }
  31. _apiSingleBuilder({
  32. namespace,
  33. sep = "|",
  34. config = {},
  35. mock = false,
  36. debug = false,
  37. mockBaseURL = ""
  38. }) {
  39. config.forEach( api => {
  40. const {name, desc, params, method, path, mockPath } = api
  41. let apiname = `${namespace}${sep}${name}`,// 命名空间
  42. url = mock ? mockPath : path,//控制走 mock 还是线上
  43. baseURL = mock && mockBaseURL
  44. // 通过全局配置开启调试模式。
  45. debug && console.info(`调用服务层接口${apiname},接口描述为${desc}`)
  46. debug && assert(name, `${apiUrl} :接口name属性不能为空`)
  47. debug && assert(apiUrl.indexOf("/") === 0, `${apiUrl} :接口路径path,首字符应为/`)
  48. Object.defineProperty(this.api, `${namespace}${sep}${name}`, {
  49. value(outerParams, outerOptions) {
  50. // 请求参数自动截取。
  51. // 请求参数不穿则发送默认配置参数。
  52. let _data = _isEmpty(outerParams) ? params : _pick(_assign({}, params, outerParams), Object.keys(params))
  53. return axios(_normoalize(_assign({
  54. url,
  55. desc,
  56. baseURL,
  57. method
  58. }, outerOptions), _data))
  59. }
  60. })
  61. })
  62. }
  63. }
  64. function _normoalize(options, data) {
  65. // 这里可以做大小写转换,也可以做其他类型 RESTFUl 的兼容
  66. if (options.method === "POST") {
  67. options.data = data
  68. } else if (options.method === "GET") {
  69. options.params = data
  70. }
  71. return options
  72. }
  73. // 注入模型和全局配置,并暴露出去
  74. export default new MakeApi({
  75. config: API_CONFIG,
  76. ...API_DEFAULT_CONFIG
  77. })["api"]

挂载到 Vue 原型上,上文有说到,通过 plugins/inject.js

</>复制代码

  1. import api from "./api"
  2. export default {
  3. install: (Vue, options) => {
  4. Vue.prototype.$api = api
  5. // 需要挂载的都放在这里
  6. }
  7. }
使用

这样我们可以在业务中愉快的使用业务层代码:

</>复制代码

  1. // .vue 中
  2. export default {
  3. methods: {
  4. test() {
  5. this.$api["order/info"]({
  6. a: 1,
  7. b: 2
  8. })
  9. }
  10. }
  11. }

即使在业务之外也可以使用:

</>复制代码

  1. import api from "Plugins/api"
  2. api["order/info"]({
  3. a: 1,
  4. b: 2
  5. })

当然对于运行效率要求高的项目中,避免内存使用率过大,我们把命名空间支持成驼峰,直接用解构的方式引入使用,最终利用 webpacktree-shaking 减少打包体积即可。

</>复制代码

  1. import {orderInfo as getOrderInfo} from "Plugins/api"
  2. getOrderInfo({
  3. a: 1,
  4. b: 2
  5. })

</>复制代码

  1. 一般来说,多人协作时候大家都可以先看 api 是否有对应接口,当业务量上来的时候,也肯定会有人出现找不到,或者找起来比较费劲,这时候我们完全可以在 请求拦截器中,把当前请求的 urlapi 中的请求做下判断,如果有重复接口请求路径,则提醒开发者已经配置相关请求,根据情况是否进行二次配置即可。

最终我们可以拓展 Service 层的各个功能:

基础

api异步与后端交互

const常量枚举

storeVuex 状态管理

拓展

localStorage:本地数据,稍微封装下,支持存取对象即可

monitor监控功能,自定义搜集策略,调用 api 中的接口发送

beacon打点功能,自定义搜集策略,调用 api 中的接口发送

...

constlocalStoragemonitorbeacon 根据业务自行拓展暴露给业务使用即可,思想也是一样的,下面着重说下 store(Vuex)

</>复制代码

  1. 插一句:如果看到这里没感觉不妥的话,想想上面 plugins/api.js 有没有用单例模式?该不该用?
⑦ 状态管理与视图拆分

Vuex 源码分析可以看我之前写的文章。

我们是不是真的需要状态管理?

</>复制代码

  1. 答案是否定的,就算你的项目达到 10 万行代码,那也并不意味着你必须使用 Vuex,应该由业务场景决定。
业务场景

第一类项目:业务/视图复杂度不高,不建议使用 Vuex,会带来开发与维护的成本,使用简单的 vbus 做好命名空间,来解耦即可。

</>复制代码

  1. let vbus = new Vue()
  2. vbus.$on("print.hello", () => {
  3. console.log("hello")
  4. })
  5. vbus.$emit("print.hello")

第二类项目:类似多人协作项目管理有道云笔记网易云音乐微信网页版/桌面版应用,功能集中,空间利用率高,实时交互的项目,无疑 Vuex 是较好的选择。这类应用中我们可以直接抽离业务领域模型

</>复制代码

  1. store
  2. ├── index.js
  3. ├── actions.js // 根级别 action
  4. ├── mutations.js // 根级别 mutation
  5. └── modules
  6. ├── user.js // 用户模块
  7. ├── products.js // 产品模块
  8. ├── order.js // 订单模块
  9. └── ...

当然对于这类项目,vuex 或许不是最好的选择,有兴趣的同学可以学习下 rxjs

第三类项目:后台系统或者页面之间业务耦合不高的项目,这类项目是占比应该是很大的,我们思考下这类项目:

全局共享状态不多,但是难免在某个模块中会有复杂度较高的功能(客服系统,实时聊天,多人协作功能等),这时候如果为了项目的可管理性,我们也在 store 中进行管理,随着项目的迭代我们不难遇到这样的情况:

</>复制代码

  1. store/
  2. ...
  3. modules/
  4. b.js
  5. ...
  6. views/
  7. ...
  8. a/
  9. b.js
  10. ...

试想下有几十个 module,对应这边上百个业务模块,开发者在两个平级目录之间调试与开发的成本是巨大的。

这些 module 可以在项目中任一一个地方被访问,但往往他们都是冗余的,除了引用的功能模块之外,基本不会再有其他模块引用他。

项目的可维护程度会随着项目增大而增大。

如何解决第三类项目的 store 使用问题?

先梳理我们的目标:

项目中模块可以自定决定是否使用 Vuex。(渐进增强)

从有状态管理的模块,跳转没有的模块,我们不想把之前的状态挂载到 store 上,想提高运行效率。(冗余)

让这类项目的状态管理变的更加可维护。(开发成本/沟通成本)

实现

我们借助 Vuex 提供的 registerModuleunregisterModule 一并解决这些问题,我们在 service/store 中放入全局共享的状态:

</>复制代码

  1. service/
  2. store/
  3. index.js
  4. actions.js
  5. mutations.js
  6. getters.js
  7. state.js

</>复制代码

  1. 一般这类项目全局状态不多,如果多了拆分 module 即可。

编写插件生成 store 实例

</>复制代码

  1. import Vue from "vue"
  2. import Vuex from "vuex"
  3. import {VUEX_DEFAULT_CONFIG} from "Config"
  4. import commonStore from "Service/store"
  5. Vue.use(Vuex)
  6. export default new Vuex.Store({
  7. ...commonStore,
  8. ...VUEX_DEFAULT_CONFIG
  9. })

对一个需要状态管理页面或者模块进行分层:

</>复制代码

  1. views/
  2. pageA/
  3. index.vue
  4. components/
  5. a.vue
  6. b.vue
  7. ...
  8. children/
  9. childrenA.vue
  10. childrenB.vue
  11. ...
  12. store/
  13. index.js
  14. actions.js
  15. moduleA.js
  16. moduleB.js

module 中直接包含了 gettersmutationsstate,我们在 store/index.js 中做文章:

</>复制代码

  1. import Store from "Plugins/store"
  2. import actions from "./actions.js"
  3. import moduleA from "./moduleA.js"
  4. import moduleB from "./moduleB.js"
  5. export default {
  6. install() {
  7. Store.registerModule(["pageA"], {
  8. actions,
  9. modules: {
  10. moduleA,
  11. moduleB
  12. },
  13. namespaced: true
  14. })
  15. },
  16. uninstall() {
  17. Store.unregisterModule(["pageA"])
  18. }
  19. }

最终在 index.vue 中引入使用, 在页面跳转之前注册这些状态和管理状态的规则,在路由离开之前,先卸载这些状态和管理状态的规则

</>复制代码

  1. import store from "./store"
  2. import {mapGetters} from "vuex"
  3. export default {
  4. computed: {
  5. ...mapGetters("pageA", ["aaa", "bbb", "ccc"])
  6. },
  7. beforeRouterEnter(to, from, next) {
  8. store.install()
  9. next()
  10. },
  11. beforeRouterLeave(to, from, next) {
  12. store.uninstall()
  13. next()
  14. }
  15. }

当然如果你的状态要共享到全局,就不执行 uninstall

</>复制代码

  1. 这样就解决了开头的三个问题,不同开发者在开发页面的时候,可以根据页面特性,渐进增强的选择某种开发形式。
其他

这里简单列举下其他方面,需要自行根据项目深入和使用。

打包,构建

这里网上已经有很多优化方法:dllhappypack多线程打包等,但随着项目的代码量级,每次 dev 保存的时候编译的速度也是会愈来愈慢的,而一过慢的时候我们就不得不进行拆分,这是肯定的,而在拆分之前尽可能容纳更多的可维护的代码,有几个可以尝试和规避的点:

优化项目流程:这个点看起来好像没什么用,但改变却是最直观的,页面/业务上的化简为繁会直接体现到代码上,同时也会增大项目的可维护,可拓展性等。

减少项目文件层级纵向深度。

减少无用业务代码,避免使用无用或者过大依赖(类似 moment.js 这样的库)等。

样式

尽可能抽离各个模块,让整个样式底层更加灵活,同时也应该尽可能的减少冗余。

如果使用的 sass 的话,善用 %placeholder 减少无用代码打包进来。

</>复制代码

  1. MPA 应用中样式冗余过大,%placeholder 也会给你带来帮助。
Mock

很多大公司都有自己的 mock 平台,当前后端定好接口格式,放入生成对应 mock api,如果没有 mock 平台,那就找相对好用的工具如 json-server 等。

代码规范

请强制使用 eslint,挂在 git 的钩子上。定期 diff 代码,定期培训等。

TypeScript

非常建议用 TS 编写项目,可能写 .vue 有些别扭,这样前端的大部分错误在编译时解决,同时也能提高浏览器运行时效率,可能减少 re-optimize 阶段时间等。

测试

这也是项目非常重要的一点,如果你的项目还未使用一些测试工具,请尽快接入,这里不过多赘述。

拆分系统

当项目到达到一定业务量级时,由于项目中的模块过多,新同学维护成本,开发成本都会直线上升,不得不拆分项目,后续会分享出来我们 ToB 项目在拆分系统中的简单实践。

最后

时下有各种成熟的方案,这里只是一个简单的构建分享,里面依赖的版本都是我们稳定下来的版本,需要根据自己实际情况进行升级。

项目底层构建往往会成为前端忽略的地方,我们既要从一个大局观来看待一个项目或者整条业务线,又要对每一行代码精益求精,对开发体验不断优化,慢慢累积后才能更好的应对未知的变化。

关于我,可以叫我 Zero,附上 Git 地址

文章标题图片地址

最后请允许我打一波小小的广告 EROS

如果前端同学想尝试使用 Vue 开发 App,或者熟悉 weex 开发的同学,可以来尝试使用我们的开源解决方案 eros,虽然没做过什么广告,但不完全统计,50 个在线 APP 还是有的,期待你的加入。

[[文章] 浅谈混合应用演进](https://juejin.im/post/5b189f...

[[文章] 深入了解 weex](https://juejin.im/post/5b18a0...

[[文章] weex-eros 入门指南](https://bmfe.github.io/eros-d...

项目地址

文档地址

最后附上部分产品截图~

(逃~)

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/95918.html

相关文章

  • 浅谈使用 Vue 构建前端 10w+ 代码的单页面应用开发底层

    摘要:其实就是我们开始挂载上去的我们在这里出去,我们就可以在回调里面只处理我们的业务逻辑,而其他如断网超时服务器出错等均通过拦截器进行统一处理。 showImg(https://segmentfault.com/img/remote/1460000015472616?w=845&h=622); 开始之前 随着业务的不断累积,目前我们 ToC 端主要项目,除去 node_modules, bu...

    rickchen 评论0 收藏0
  • 优秀博文收藏(不定期更新)

    摘要:我的书签我的书签谨慎导入,小心覆盖工具类版本管理快速切换源配置教程指南可视化工具前端工具集前端助手网络封包截取工具格式化工具标注工具模拟请求类深入浅出布局你所不知道的动画技巧与细节常用代码黑魔法小技巧,让你少写不必要的,代码更优雅一劳永 我的书签 我的书签(谨慎导入,小心覆盖) 工具类 nvm: node版本管理 nrm: 快速切换npm源 shell: zsh+on-my-zsh配...

    sunsmell 评论0 收藏0
  • 优秀博文收藏(不定期更新)

    摘要:我的书签我的书签谨慎导入,小心覆盖工具类版本管理快速切换源配置教程指南可视化工具前端工具集前端助手网络封包截取工具格式化工具标注工具模拟请求类深入浅出布局你所不知道的动画技巧与细节常用代码黑魔法小技巧,让你少写不必要的,代码更优雅一劳永 我的书签 我的书签(谨慎导入,小心覆盖) 工具类 nvm: node版本管理 nrm: 快速切换npm源 shell: zsh+on-my-zsh配...

    zhangfaliang 评论0 收藏0
  • 优秀文章收藏(慢慢消化)持续更新~

    摘要:整理收藏一些优秀的文章及大佬博客留着慢慢学习原文协作规范中文技术文档协作规范阮一峰编程风格凹凸实验室前端代码规范风格指南这一次,彻底弄懂执行机制一次弄懂彻底解决此类面试问题浏览器与的事件循环有何区别笔试题事件循环机制异步编程理解的异步 better-learning 整理收藏一些优秀的文章及大佬博客留着慢慢学习 原文:https://www.ahwgs.cn/youxiuwenzhan...

    JeOam 评论0 收藏0

发表评论

0条评论

Backache

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<