README.md 11.2 KB

Raw Blame History Permalink



vue-h5-template

基于 vue-cli3.0+webpack 4+vant ui + sass+ rem 适配方案+axios 封装，构建手机端模板脚手架

关于项目介绍

demo建议手机端查看


Node 版本要求

Vue CLI 需要 Node.js 8.9 或更高版本 (推荐 8.11.0+)。你可以使用 nvm 或
nvm-windows 在同一台电脑中管理多个 Node 版本。

本示例 Node.js 12.14.1

目录


√ Vue-cli4
√ 配置多环境变量
√ rem 适配方案
√ VantUI 组件按需加载
√ Sass
√ Webpack 4
√ Vuex
√ Axios 封装
√ Vue-router
√ vue.config.js 基础配置
√ vue.config.js 配置 proxy 跨域
√ vue.config.js 配置 proxy 跨域
Vuex
Axios 封装
生产环境 cdn 优化首屏加速
babel 低版本浏览器兼容
Eslint+Pettier 统一开发规范


 配置多环境变量 


  NODE_ENV 和 BASE_URL 是两个特殊变量，在代码中始终可用

package.json 里的 scripts 配置 serve stage build，通过 --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 development staging production

变量我们统一在 src/config/env.*.js 里进行管理。修改起来方便，不需要重启项目，符合开发习惯。

config/index.js

// 根据环境引入不同配置 process.env.NODE_ENV
const 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 插件，用于将单位转化为 rem


lib-flexible 用于设置 rem 基准值


PostCSS 配置

下面提供了一份基本的 postcss 配置，可以在此配置的基础上根据项目需求进行修改

// https://github.com/michael-ciniawsky/postcss-load-config
module.exports = {
  plugins: {
    autoprefixer: {
      overrideBrowserslist: ['Android 4.1', 'iOS 7.1', 'Chrome > 31', 'ff > 31', 'ie >= 8']
    },
    'postcss-pxtorem': {
      rootValue: 37.5,
      propList: ['*']
    }
  }
}


更多详细信息： vant

新手必看，老鸟跳过

很多小伙伴会问我，适配的问题。

举个例子：设计给了你一张 750px * 1334px 图片，在 iPhone6 上铺满屏幕,其他机型适配。


当rootValue: 70 , 样式 width: 750px;height: 1334px; 图片会撑满 iPhone6 屏幕，这个时候切换其他机型，图片也会跟着撑
满。
当rootValue: 37.5 的时候，样式 width: 375px;height: 667px; 图片会撑满 iPhone6 屏幕。


本案例采用 Vant 是基于 375 设计稿 , rootValue: 37.5。其他的你就可以根据你设计图，去做对应的设置了。

当然，想要撑满屏幕你可以使用 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

// 对于使用 babel7 的用户，可以在 babel.config.js 中配置
module.exports = {
  presets: [['@vue/cli-plugin-babel/preset', {useBuiltIns: 'entry'}]],
  plugins: [
    [
      'import',
      {
        libraryName: 'vant',
        libraryDirectory: 'es',
        style: true
      },
      'vant'
    ]
  ]
}


使用组件

项目在 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/文件夹下包含了三个文件


index.scss 主入口，主要引入其他两个 scss 文件，和公共样式

variables.scss 定义变量

mixin.scss 定义 mixin 方法


你可以直接在 vue 文件下写 sass 语法

<style lang="scss" scoped>
  .demo {
    .title {
      font-size: 12px;
    }
  }
</style>


▲ 回顶部


 Sass 


首先 你可能会遇到 node-sass 安装不成功，别放弃多试几次！！！

在 src/assets/css/文件夹下包含了三个文件


index.scss 主入口，主要引入其他两个 scss 文件，和公共样式

variables.scss 定义变量

mixin.scss 定义 mixin 方法


你可以直接在 vue 文件下写 sass 语法

<style lang="scss" scoped>
  .demo {
    .title {
      font-size: 12px;
    }
  }
</style>


▲ 回顶部


 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

▲ 回顶部


 vue.config.js 基础配置 


如果你的 Vue Router 模式是 hash

publicPath: './',


如果你的 Vue Router 模式是 history 这里的 publicPath 和你的 Vue Router base 保持一直

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: !IS_PROD, // 生产环境的 source map
  devServer: {
    port: 9020, // 端口号
    open: false, // 启动后打开浏览器
    overlay: {
      //  当出现编译器错误或警告时，在浏览器中显示全屏覆盖层
      warnings: false,
      errors: true
    }
    // ...
  }
}


▲ 回顶部


 vue.config.js 配置 proxy 跨域 


module.exports = {
  devServer: {
    // ....
    proxy: {
      //配置跨域
      '/api': {
        target: 'https://test.xxx.com', // 接口的域名
        ws: true, // 是否启用websockets
        changOrigin: true, // 开启代理，在本地创建一个虚拟服务端
        pathRewrite: {
          '^/api': '/'
        }
      }
    }
  }
}


使用

<script>
import axios from "axios"
export default {
  mounted() {
    axios.get("/api/1").then(res => {
    });
  }
};
</script>


▲ 回顶部


 vue.config.js 配置 proxy 跨域 


 publicPath: './', // 署应用包时的基本 URL router hash 模式使用
  // publicPath: process.env.NODE_ENV === 'development' ? '/' : '/app/', //router history模式使用 需要区分生产环境和开发环境，不然build会报错
  outputDir: 'dist',   //  生产环境构建文件的目录
  assetsDir: 'static', //  outputDir的静态资源(js、css、img、fonts)目录
  lintOnSave: false,
  productionSourceMap: !IS_PROD, // 生产环境的 source map


▲ 回顶部


总结

因为项目刚刚构建起来，后面还会持续更新，实际使用过程中一定还有很多问题，如果文章中有错误希望能够被指正，一起成长


关于我

获取更多技术相关文章，关注公众号”前端女塾“。

回复加群，即可加入”前端仙女群“


扫描添加下方的微信并备注 Sol 加交流群，交流学习，及时获取代码最新动态。


如果对你有帮助送我一颗小星星（づ￣3￣）づ╭～