学习:掘金程序媛花花-开箱即用 vue-cli4 vant rem 移动端框架方案
vue-h5-template
基于 vue-cli4.0 + webpack 4 + vant ui + sass+ rem 适配方案+axios 封装,构建手机端模板脚手架
掘金: vue-cli4 vant rem 移动端框架方案
查看 demo 建议手机端查看
Node 版本要求
Vue CLI 需要 Node.js 8.9 或更高版本 (推荐 8.11.0+)。你可以使用 nvm 或 nvm-windows 在同一台电脑中管理多个 Node 版本。
本示例 Node.js 12.14.1
启动项目
git clone https://github.com/sunniejs/vue-h5-template.gitcd vue-h5-templatenpm installnpm run serve
目录
- √ Vue-cli4
- √ 配置多环境变量
- √ rem 适配方案
- √ VantUI 组件按需加载
- √ Sass 全局样式
- √ Vuex 状态管理
- √ Vue-router
- √ Axios 封装及接口管理
- √ Webpack 4 vue.config.js 基础配置
- √ 配置 alias 别名
- √ 配置 proxy 跨域
- √ 配置 打包分析
- √ 配置 externals 引入 cdn 资源
- √ 去掉 console.log
- √ splitChunks 单独打包第三方模块
- √ 添加 IE 兼容
-
✅ 配置多环境变量
package.json里的scripts配置servestagebuild,通过--mode xxx来执行不同环境 通过
npm run serve启动本地 , 执行development- 通过
npm run stage打包测试 , 执行staging 通过
npm run build打包正式 , 执行production"scripts": {"serve": "vue-cli-service serve --open","stage": "vue-cli-service build --mode staging","build": "vue-cli-service build",}
配置介绍
以
VUE_APP_开头的变量,在代码中可以通过process.env.VUE_APP_访问。
比如,VUE_APP_ENV = 'development'通过process.env.VUE_APP_ENV访问。
除了VUE_APP_*变量之外,在你的应用代码中始终可用的还有两个特殊的变量NODE_ENV和BASE_URL
在项目根目录中新建.env.*.env.development 本地开发环境配置
NODE_ENV='development'# must start with VUE_APP_VUE_APP_ENV = 'development'
.env.staging 测试环境配置
NODE_ENV='production'# must start with VUE_APP_VUE_APP_ENV = 'staging'
.env.production 正式环境配置
NODE_ENV='production'# must start with VUE_APP_VUE_APP_ENV = 'production'
这里我们并没有定义很多变量,只定义了基础的 VUE_APP_ENV
developmentstaging``production
变量我们统一在src/config/env.*.js里进行管理。
这里有个问题,既然这里有了根据不同环境设置变量的文件,为什么还要去 config 下新建三个对应的文件呢?
修改起来方便,不需要重启项目,符合开发习惯。
config/index.js// 根据环境引入不同配置 process.env.NODE_ENVconst config = require('./env.' + process.env.VUE_APP_ENV)module.exports = config
配置对应环境的变量,拿本地环境文件
env.development.js举例,用户可以根据需求修改// 本地环境配置module.exports = {title: 'vue-h5-template',baseUrl: 'http://localhost:9018', // 项目地址baseApi: 'https://test.xxx.com/api', // 本地api请求地址APPID: 'xxx',APPSECRET: 'xxx'}
根据环境不同,变量就会不同了
// 根据环境不同引入不同baseApi地址import {baseApi} from '@/config'console.log(baseApi)
✅ rem 适配方案
不用担心,项目已经配置好了
rem适配, 下面仅做介绍:
Vant 中的样式默认使用px作为单位,如果需要使用rem单位,推荐使用以下两个工具:postcss-pxtorem 是一款
postcss插件,用于将单位转化为remlib-flexible 用于设置
rem基准值PostCSS 配置
下面提供了一份基本的
postcss配置,可以在此配置的基础上根据项目需求进行修改// https://github.com/michael-ciniawsky/postcss-load-configmodule.exports = {plugins: {autoprefixer: {overrideBrowserslist: ['Android 4.1', 'iOS 7.1', 'Chrome > 31', 'ff > 31', 'ie >= 8']},'postcss-pxtorem': {rootValue: 37.5,propList: ['*']}}}
更多详细信息: vant
新手必看,老鸟跳过
很多小伙伴会问我,适配的问题。
我们知道1rem等于html根元素设定的font-size的px值。Vant UI 设置rootValue: 37.5,你可以看到在 iPhone 6 下 看到 (1rem 等于 37.5px):<html data-dpr="1" style="font-size: 37.5px;"></html>
切换不同的机型,根元素可能会有不同的
font-size。当你写 css px 样式时,会被程序换算成rem达到适配。
因为我们用了 Vant 的组件,需要按照rootValue: 37.5来写样式。
举个例子:设计给了你一张 750px * 1334px 图片,在 iPhone6 上铺满屏幕,其他机型适配。当
rootValue: 70, 样式width: 750px;height: 1334px;图片会撑满 iPhone6 屏幕,这个时候切换其他机型,图片也会跟着撑 满。- 当
rootValue: 37.5的时候,样式width: 375px;height: 667px;图片会撑满 iPhone6 屏幕。
也就是 iphone 6 下 375px 宽度写 CSS。其他的你就可以根据你设计图,去写对应的样式就可以了。
当然,想要撑满屏幕你可以使用 100%,这里只是举例说明。
<img class="image" src="https://imgs.solui.cn/weapp/logo.png" /><style>/* rootValue: 75 */.image {width: 750px;height: 1334px;}/* rootValue: 37.5 */.image {width: 375px;height: 667px;}</style>
✅ VantUI 组件按需加载
项目采 用Vant 自动按需引入组件 (推荐)下 面安装插件介绍:
babel-plugin-import 是一款 babel 插件,它会在编译过程中将 import 的写法自动转换为按需引入的方式
安装插件
npm i babel-plugin-import -D
在babel.config.js 设置
// 对于使用 babel7 的用户,可以在 babel.config.js 中配置const plugins = [['import',{libraryName: 'vant',libraryDirectory: 'es',style: true},'vant']]module.exports = {presets: [['@vue/cli-plugin-babel/preset', {useBuiltIns: 'usage', corejs: 3}]],plugins}
使用组件
项目在 src/plugins/vant.js 下统一管理组件,用哪个引入哪个,无需在页面里重复引用
// 按需全局引入 vant组件import Vue from 'vue'import {Button, List, Cell, Tabbar, TabbarItem} from 'vant'Vue.use(Button)Vue.use(Cell)Vue.use(List)Vue.use(Tabbar).use(TabbarItem)
✅ Sass 全局样式
首先 你可能会遇到 node-sass 安装不成功,别放弃多试几次!!!
目录结构,在 src/assets/css/文件夹下包含了三个文件
├── assets│ ├── css│ │ ├── index.scss # 全局通用样式│ │ ├── mixin.scss # 全局mixin│ │ └── variables.scss # 全局变量
每个页面自己对应的样式都写在自己的 .vue 文件之中
<style lang="scss">/* global styles */</style><style lang="scss" scoped>/* local styles */</style>
vue.config.js 配置注入 sass 的 mixin variables 到全局,不需要手动引入 ,配置$cdn通过变量形式引入 cdn 地址
const IS_PROD = ['production', 'prod'].includes(process.env.NODE_ENV)const defaultSettings = require('./src/config/index.js')module.exports = {css: {extract: IS_PROD,sourceMap: false,loaderOptions: {scss: {// 注入 `sass` 的 `mixin` `variables` 到全局, $cdn可以配置图片cdn// 详情: https://cli.vuejs.org/guide/css.html#passing-options-to-pre-processor-loadersprependData: `@import "assets/css/mixin.scss";@import "assets/css/variables.scss";$cdn: "${defaultSettings.$cdn}";`}}}}
在 main.js 中引用全局样式(发现在上面的,prependData 里设置@import "assets/css/index.scss";并没有应用全局样式这里在 main.js 引入)
设置 js 中可以访问 $cdn,.vue 文件中使用this.$cdn访问
// 引入全局样式import '@/assets/css/index.scss'// 设置 js中可以访问 $cdn// 引入cdnimport {$cdn} from '@/config'Vue.prototype.$cdn = $cdn
在 css 和 js 使用
<script>console.log(this.$cdn)</script><style lang="scss" scoped>.logo {width: 120px;height: 120px;background: url($cdn + '/weapp/logo.png') center / contain no-repeat;}</style>
✅ Vuex 状态管理
目录结构
├── store│ ├── modules│ │ └── app.js│ ├── index.js│ ├── getters.js
main.js 引入
import Vue from 'vue'import App from './App.vue'import store from './store'new Vue({el: '#app',router,store,render: h => h(App)})
使用
<script>import {mapGetters} from 'vuex'export default {computed: {...mapGetters(['userName'])},methods: {// Action 通过 store.dispatch 方法触发doDispatch() {this.$store.dispatch('setUserName', '真乖,赶紧关注公众号,组织都在等你~')}}}</script>
✅ Vue-router
本案例采用 hash 模式,开发者根据需求修改 mode base
注意:如果你使用了 history 模式,vue.config.js 中的 publicPath 要做对应的修改
前往:vue.config.js 基础配置
import Vue from 'vue'import Router from 'vue-router'Vue.use(Router)export const router = [{path: '/',name: 'index',component: () => import('@/views/home/index'), // 路由懒加载meta: {title: '首页', // 页面标题keepAlive: false // keep-alive 标识}}]const createRouter = () =>new Router({// mode: 'history', // 如果你是 history模式 需要配置 vue.config.js publicPath// base: '/app/',scrollBehavior: () => ({y: 0}),routes: router})export default createRouter()
更多:Vue Router
▲ 回顶部
✅ Axios 封装及接口管理
utils/request.js 封装 axios ,开发者需要根据后台接口做修改。
service.interceptors.request.use里可以设置请求头,比如设置tokenconfig.hideloading是在 api 文件夹下的接口参数里设置,下文会讲service.interceptors.response.use里可以对接口返回数据处理,比如 401 删除本地信息,重新登录import axios from 'axios'import store from '@/store'import {Toast} from 'vant'// 根据环境不同引入不同api地址import {baseApi} from '@/config'// create an axios instanceconst service = axios.create({baseURL: baseApi, // url = base api url + request urlwithCredentials: true, // send cookies when cross-domain requeststimeout: 5000 // request timeout})// request 拦截器 request interceptorservice.interceptors.request.use(config => {// 不传递默认开启loadingif (!config.hideloading) {// loadingToast.loading({forbidClick: true})}if (store.getters.token) {config.headers['X-Token'] = ''}return config},error => {// do something with request errorconsole.log(error) // for debugreturn Promise.reject(error)})// respone拦截器service.interceptors.response.use(response => {Toast.clear()const res = response.dataif (res.status && res.status !== 200) {// 登录超时,重新登录if (res.status === 401) {store.dispatch('FedLogOut').then(() => {location.reload()})}return Promise.reject(res || 'error')} else {return Promise.resolve(res)}},error => {Toast.clear()console.log('err' + error) // for debugreturn Promise.reject(error)})export default service
接口管理
在
src/api文件夹下统一管理接口你可以建立多个模块对接接口, 比如
home.js里是首页的接口这里讲解user.jsurl接口地址,请求的时候会拼接上config下的baseApimethod请求方法data请求参数qs.stringify(params)是对数据系列化操作hideloading默认false,设置为true后,不显示 loading ui 交互中有些接口不需要让用户感知import qs from 'qs'// axiosimport request from '@/utils/request'//user api// 用户信息export function getUserInfo(params) {return request({url: '/user/userinfo',method: 'post',data: qs.stringify(params),hideloading: true // 隐藏 loading 组件})}
如何调用
▲ 回顶部// 请求接口import {getUserInfo} from '@/api/user.js'const params = {user: 'sunnie'}getUserInfo(params).then(() => {}).catch(() => {})
✅ Webpack 4 vue.config.js 基础配置
如果你的Vue Router模式是 hash
如果你的publicPath: './',
Vue Router模式是 history 这里的 publicPath 和你的Vue Routerbase保持一直publicPath: '/app/',
▲ 回顶部const IS_PROD = ['production', 'prod'].includes(process.env.NODE_ENV)module.exports = {publicPath: './', // 部署应用包时的基本 URL。 vue-router hash 模式使用// publicPath: '/app/', // 部署应用包时的基本 URL。 vue-router history模式使用outputDir: 'dist', // 生产环境构建文件的目录assetsDir: 'static', // outputDir的静态资源(js、css、img、fonts)目录lintOnSave: false,productionSourceMap: false, // 如果你不需要生产环境的 source map,可以将其设置为 false 以加速生产环境构建。devServer: {port: 9020, // 端口号open: false, // 启动后打开浏览器overlay: {// 当出现编译器错误或警告时,在浏览器中显示全屏覆盖层warnings: false,errors: true}// ...}}
✅ 配置 alias 别名
▲ 回顶部const path = require('path')const resolve = dir => path.join(__dirname, dir)const IS_PROD = ['production', 'prod'].includes(process.env.NODE_ENV)module.exports = {chainWebpack: config => {// 添加别名config.resolve.alias.set('@', resolve('src')).set('assets', resolve('src/assets')).set('api', resolve('src/api')).set('views', resolve('src/views')).set('components', resolve('src/components'))}}
✅ 配置 proxy 跨域
如果你的项目需要跨域设置,你需要打来vue.config.jsproxy注释 并且配置相应参数
!!!注意:你还需要将**src/config/env.development.js**里的**baseApi**设置成 ‘/‘
使用 例如:module.exports = {devServer: {// ....proxy: {//配置跨域'/api': {target: 'https://test.xxx.com', // 接口的域名// ws: true, // 是否启用websocketschangOrigin: true, // 开启代理,在本地创建一个虚拟服务端pathRewrite: {'^/api': '/'}}}}}
src/api/home.js
▲ 回顶部export function getUserInfo(params) {return request({url: '/api/userinfo',method: 'post',data: qs.stringify(params)})}
✅ 配置 打包分析
const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPluginmodule.exports = {chainWebpack: config => {// 打包分析if (IS_PROD) {config.plugin('webpack-report').use(BundleAnalyzerPlugin, [{analyzerMode: 'static'}])}}}
▲ 回顶部npm run build
✅ 配置 externals 引入 cdn 资源
这个版本 CDN 不再引入,我测试了一下使用引入 CDN 和不使用,不使用会比使用时间少。网上不少文章测试 CDN 速度块,这个开发者可 以实际测试一下。
另外项目中使用的是公共 CDN 不稳定,域名解析也是需要时间的(如果你要使用请尽量使用同一个域名)
因为页面每次遇到<script>标签都会停下来解析执行,所以应该尽可能减少<script>标签的数量HTTP请求存在一定的开销,100K 的文件比 5 个 20K 的文件下载的更快,所以较少脚本数量也是很有必要的
暂时还没有研究放到自己的 cdn 服务器上。
在 public/index.html 中添加const defaultSettings = require('./src/config/index.js')const name = defaultSettings.title || 'vue mobile template'const IS_PROD = ['production', 'prod'].includes(process.env.NODE_ENV)// externalsconst externals = {vue: 'Vue','vue-router': 'VueRouter',vuex: 'Vuex',vant: 'vant',axios: 'axios'}// CDN外链,会插入到index.html中const cdn = {// 开发环境dev: {css: [],js: []},// 生产环境build: {css: ['https://cdn.jsdelivr.net/npm/vant@2.4.7/lib/index.css'],js: ['https://cdn.jsdelivr.net/npm/vue@2.6.11/dist/vue.min.js','https://cdn.jsdelivr.net/npm/vue-router@3.1.5/dist/vue-router.min.js','https://cdn.jsdelivr.net/npm/axios@0.19.2/dist/axios.min.js','https://cdn.jsdelivr.net/npm/vuex@3.1.2/dist/vuex.min.js','https://cdn.jsdelivr.net/npm/vant@2.4.7/lib/index.min.js']}}module.exports = {configureWebpack: config => {config.name = name// 为生产环境修改配置...if (IS_PROD) {// externalsconfig.externals = externals}},chainWebpack: config => {/*** 添加CDN参数到htmlWebpackPlugin配置中*/config.plugin('html').tap(args => {if (IS_PROD) {args[0].cdn = cdn.build} else {args[0].cdn = cdn.dev}return args})}}
▲ 回顶部<!-- 使用CDN的CSS文件 --><% for (var i inhtmlWebpackPlugin.options.cdn&&htmlWebpackPlugin.options.cdn.css) { %><link href="<%= htmlWebpackPlugin.options.cdn.css[i] %>" rel="preload" as="style" /><link href="<%= htmlWebpackPlugin.options.cdn.css[i] %>" rel="stylesheet" /><% } %><!-- 使用CDN加速的JS文件,配置在vue.config.js下 --><% for (var i inhtmlWebpackPlugin.options.cdn&&htmlWebpackPlugin.options.cdn.js) { %><script src="<%= htmlWebpackPlugin.options.cdn.js[i] %>"></script><% } %>
✅ 去掉 console.log
保留了测试环境和本地环境的console.log
在 babel.config.js 中配置npm i -D babel-plugin-transform-remove-console
▲ 回顶部// 获取 VUE_APP_ENV 非 NODE_ENV,测试环境依然 consoleconst IS_PROD = ['production', 'prod'].includes(process.env.VUE_APP_ENV)const plugins = [['import',{libraryName: 'vant',libraryDirectory: 'es',style: true},'vant']]// 去除 console.logif (IS_PROD) {plugins.push('transform-remove-console')}module.exports = {presets: [['@vue/cli-plugin-babel/preset', {useBuiltIns: 'entry'}]],plugins}
✅ splitChunks 单独打包第三方模块
▲ 回顶部module.exports = {chainWebpack: config => {config.when(IS_PROD, config => {config.plugin('ScriptExtHtmlWebpackPlugin').after('html').use('script-ext-html-webpack-plugin', [{// 将 runtime 作为内联引入不单独存在inline: /runtime\..*\.js$/}]).end()config.optimization.splitChunks({chunks: 'all',cacheGroups: {// cacheGroups 下可以可以配置多个组,每个组根据test设置条件,符合test条件的模块commons: {name: 'chunk-commons',test: resolve('src/components'),minChunks: 3, // 被至少用三次以上打包分离priority: 5, // 优先级reuseExistingChunk: true // 表示是否使用已有的 chunk,如果为 true 则表示如果当前的 chunk 包含的模块已经被抽取出去了,那么将不会重新生成新的。},node_vendors: {name: 'chunk-libs',chunks: 'initial', // 只打包初始时依赖的第三方test: /[\\/]node_modules[\\/]/,priority: 10},vantUI: {name: 'chunk-vantUI', // 单独将 vantUI 拆包priority: 20, // 数字大权重到,满足多个 cacheGroups 的条件时候分到权重高的test: /[\\/]node_modules[\\/]_?vant(.*)/}}})config.optimization.runtimeChunk('single')})}}
✅ 添加 IE 兼容
之前的方式 会报@babel/polyfillis deprecated. Please, use required parts ofcore-jsandregenerator-runtime/runtimeseparately@babel/polyfill废弃,使用core-js和regenerator-runtime
在npm i --save core-js regenerator-runtime
main.js中添加
配置// 兼容 IE// https://github.com/zloirock/core-js/blob/master/docs/2019-03-19-core-js-3-babel-and-a-look-into-the-future.md#babelpolyfillimport 'core-js/stable'import 'regenerator-runtime/runtime'
babel.config.js
▲ 回顶部const plugins = []module.exports = {presets: [['@vue/cli-plugin-babel/preset', {useBuiltIns: 'usage', corejs: 3}]],plugins}
✅ Eslint+Pettier 统一开发规范
在文件.prettierrc里写 属于你的 pettier 规则
▲ 回顶部{"printWidth": 120,"tabWidth": 2,"singleQuote": true,"trailingComma": "none","semi": false,"wrap_line_length": 120,"wrap_attributes": "auto","proseWrap": "always","arrowParens": "avoid","bracketSpacing": false,"jsxBracketSameLine": true,"useTabs": false,"overrides": [{"files": ".prettierrc","options": {"parser": "json"}}]}
鸣谢
vue-cli4-config vue-element-admin关于我
获取更多技术相关文章,关注公众号”前端女塾“。
回复加群,即可加入”前端仙女群“
扫描添加下方的微信并备注 Sol 加交流群,交流学习,及时获取代码最新动态。
如果对你有帮助送我一颗小星星(づ ̄3 ̄)づ╭❤~
