Vue基础项目模板搭建
背景:做业务,总是免不了面对那些快速开发的需求,快速开发意味着给开发者的时间不多,如果有一套基础的模板存在,就可以省掉不少前期的工作,而专心于业务的开发
为什么需要一个基础模板
这个问题实际问的是,vue-cli本身提供的那一套模板不好么?是的,一般来讲我们都会通过vue-cli去快速启动一个项目,但问题是创建出来的那套项目模板过于基础简单,而我们实际业务开发场景需要更多的基础设施——比如请求工具等常用的配套设施。如果每一次的项目在创建完之后,还需要花费一些时间去新增一些配套设施,无疑是浪费了宝贵的开发时间(毕竟产品和项目经理并没有算上你搭建基础框架的时间),而且理论上这部分工作是重复性的,是可以被抽离出来的。当然,每个公司的业务场景都不同,以下介绍只是一部分业务需要的基础项目模板。
基础模板应该包含哪些功能
vue-cli创建的项目模板已经包含了很多基本的配置,如ESLint等,我们仅需进行简单的扩展即可。扩展内容如下:
- 默认启用ESLint
- 基础CSS类添加
- 图标icon添加
- http请求工具
在以上的四个配置添加后,基本就可以填补默认脚手架生成模板的空缺了。有些人可能会问,为啥没有包含路由的配置项?我认为路由未必是每个项目都需要的,很多的项目只是一个简单的活动页面,没有太多的页面跳转,而且添加路由本身的成本也不高,所以没有配置上去。接下来便展开来讲这四个配置分别要做什么。
默认启用ESLint
ESLint可以在vue-cli生成时进行指定启用,这里出现的问题是,想要大部分遵循已有的规则,少部分修改。什么意思呢?按照Standard
的方案,缩进是两个空格,但团队里面都是使用4个空格进行缩进的,这个时候就要进行覆盖了,这就是部分修改的地方。本次基础模板扩展中,ESLint的部分使用了Standard的集成方案,并进行了部分规则重写,具体可以按照团队的规则来走。
基础CSS类添加
一个web项目搭建过程中,肯定会碰到样式布局的一部分,一般来讲会包括以下两个方面:
- css初始化,目的是统一各浏览器差异
- 通用css类添加,比如主题颜色等定义
其中通用的css类我们可以通过预处理语言来形成,比如使用 SCSS/SASS
。引入预处理语言后,便可以定义一些基本变量如颜色值,并通过webpack配置注入到所有组件中,如下所示:
有一些经常使用的样式也可以独立成一个类,方便随时使用,比如内外边距、字体、颜色以及宽高等,这个都可以提前定义好,想调用的时候直接调用即可,比如
.ml10 { margin-left: 10px; }
,直接使用而无需另外在单文件组件中去定义。这么做的好处就是方便,有时候一段文字标签只需要设置一个字体大小,开发却要面临两个问题:
- 想一个css 类名
- 新建一个style标签/在原有的style标签下编写
.class-name { font-size: 18px; }
图标icon添加
icon其实并不是所有的项目都会用到,但考虑到要配置还是需要花一点时间的原因,便也加入基础模板的范围。这里主要采用svg-icon,详细的介绍可以参考大佬文章《手摸手,带你优雅使用icon》。大概介绍一下svg icon的配置,需要编写一个简单的svg组件+svg-sprite配置+自动化导入svg设置,这些都可以集成到基础模板中,使用只需要导入相应的svg图标即可。
HTTP请求工具
相信90%以上的页面都会与接口交互,所以HTTP请求工具我们也可以内置在模板中。这里使用axios
作为HTTP请求的库,当然你也可以使用原生的fetch
API,按团队喜好来就是了。对于HTTP请求工具,常见的有以下几个需求:
- 根据不同的环境,切换不同的接口URL前缀
- 统一超时处理
- 请求/响应拦截
- 封装
GET/POST
方法
这些配置都不难,可以在axios的文档中找到。其中,对于 请求/响应拦截
这块,通常会做的是根据接口定义的不同状态码进行成功/失败的判断,个人会将所有失败的情况都抛到reject
方法中处理,而且成功时只抛出关键数据,这样在使用.then
获取接口数据时,就能少了一些状态码的判断,且直接就能获取关键数据。
请求拦截里面也可以加入权限字段等请求头部信息。具体的axios配置可以参考大佬文章《vue中Axios的封装和API接口的管理》
优化基础项目模板
细心的同学可能会发现按照这个方式去启用的项目会有一些问题,比如在基础CSS类添加的步骤中,产生了很多很多的类冗余,毕竟不是每一个生成出来的快捷css类开发中都会使用到,完整的写下来会发现build出来的css文件特别大,这就是一个必须要优化的点了。再比如说,svg图标是否可以进行压缩体积,这也是一个可以优化的点。
去除冗余的css
知道要做什么,网上搜一下大概就会有答案了,这里我们采用PurgeCSS
webpack插件来处理冗余的css。这个插件方便的地方在于,已经集成到了vue-cli脚手架中,只需要按照教程来处理即可,以下是使用vue ui工具来添加,安装完毕后即已配置好。
压缩svg
压缩svg我们当然是采用svgo
啦,一键集成到npm script
中,构建时即可进行压缩。关于svgo
的介绍可以看官方文档,上面的介绍svg icon
时的大佬文章也有介绍,这里就不再过多描述。
// 安装
npm i -g svgo
// 运行指定目录your_svg
svgo -f your_svg
// 集成到命令,在package.json中的script写入
"svgo": "svgo -f your_svg"
结语
经过以上的配置,基本上开发就可以免掉一些前期的工作了,当然了还做不到开箱即用的程度,比如我们少了移动端适配的一些工作,这个我们留待下期再进行展开。