资讯专栏INFORMATION COLUMN

vue单页多页的开发环境配置+vue的开发思路

cnio / 1138人阅读

摘要:多个单页应用整合的工程的开发环境工程的目录设置本文内容的工程的目录设计基于的多个单页应用的开发环境搭建目录一开发环境使用二需求分析三开发思路四目录设计及思路五开发环境开发六整个开发环境的目录注释一开发环境使用多终端页面路径设置

vue-multi-device-single-page

多个单页应用整合的vue工程的开发环境
vue工程的目录设置

本文内容:

vue + vuex + vue-resuorce + vue-route 的工程 的目录设计

基于 vue-cli 的 多个vue单页应用的开发环境 搭建

目录:

一、开发环境使用

二、需求分析

三、开发思路

四、src目录设计及思路

五、开发环境开发

六、整个开发环境的目录注释

一、开发环境使用 多终端(页面)路径设置

在src/device/目录下添加终端(页面)路径,如:src/device/pc/

在新添加的文件下加入这个终端(页面)使用的打包模板,命名为index.html,如:src/device/pc/index.html

在新添加的文件下加入这个终端(页面)使用的入口文件,命名为index.js,如:src/device/pc/index.js

build 打包

打生产环境的包,会自动把不同终端的文件按终端名称分开

npm run build "device"

device : 接受的参数,在 /build/device-conf.js里面有限制

示例: npm run build pc 打一个pc端的包

npm run build-all

打所有终端的包

dev 开发

npm run dev

开始进行调试,基于vue-cli的,所以基本是vue-cli的

自动打开一个网页,从这里选择要调试的终端

开始调试

二、需求分析: 需求:

要开发pc端 + 移动端 + app混合开发的 页面,每个页面都是单页应用

为了节约开发成本,这几个端要共用一些组件,和 方法

打包要方便,调试要方便

vue应用

几个问题:

vue-cli提供了非常好的开发环境,我能否在这个基础上整一整,解决掉需求 2 和 3 呢?

vue + vuex + vue-resuorce +vue-route 的工程目录应该怎么设计呢?

面对这样的需求,我的理解是把多个单页应用融合到一个工程里面,下面是我的解决办法

这个工程是啥

github https://github.com/vincentmrlau/vue-multi-device-single-page,欢迎交流

多端(也可以是多页)的单页应用的vue工程的开发环境,本质上是多个单页应用

基于vue,整合了vuex vue-resuorece vue-router 的开发目录设计

整个基于vue-cli生成的目录进行修改,除了test(正在研究)外的功能均可使用

三、开发思路

1、设置公用组件的目录

2、抽离api,分为公用的api和属于各个页面自己的api

3、每个单页应用vuex管理状态

4、可能会被多人同时编辑,如何尽量减少merge

5、针对这样的需求的src下面的目录应该怎么设计(第三部分有写)

6、针对需求配置开发环境(从第 部门开始是关于这个开发环境的)

四、src目录设计及思路

介绍src的目录设置及其作用

介绍 界面-模板html-组件-store-接口 的关系

概况两图流

pc主页示意图

分析图(怎一个乱字了得)

目录设置及其作用
├─src            # 源文件目录
│  │  config.js
│  │  
│  ├─api        # 多端共用的 api
│  │      device-root.js
│  │      middleware.js
│  │      
│  ├─assets        # 多端共用的 资源
│  │      logo.png
│  │      
│  ├─components    # 多端共用的 组件
│  │      RootCommonComponent.vue
│  │      
│  └─device        # 设备入口 
│      ├─app    # 混合开发的放这里了,也可以分 ios 和 安卓
│      │      index.html    # app专用的html模板,打包好的东西会自动注入
│      │      index.js        # app的入口文件
│      │      
│      ├─mobile        # 这里放移动端的页面 ,下面的 index文件作用类似其他端
│      │      index.html    
│      │      index.js
│      │      
│      └─pc            # 这个目录下的都是pc端使用的,当然其他端要用也是可以的,哈哈
│          │  App.vue        # 入口组件
│          │  index.html    # 模板文件
│          │  index.js        # 入口文件
│          │  
│          ├─api            # 分离开接口
│          │      home.js    # home这个模块用的接口
│          │      middleware.js            # 一些公用的中间件
│          │      
│          ├─assets            # 资源
│          ├─components        # 组件
│          │  ├─commonComponents    # 公共组件
│          │  │      Header.vue
│          │  │      
│          │  ├─Home    # home这个模块用的组件
│          │  │      Body.vue
│          │  │      Index.vue
│          │  │      
│          │  └─Page404    # 404这个模块用的组件
│          │          Index.vue
│          │          
│          ├─router        # 路由
│          │      index.js
│          │      
│          ├─store        # vuex 的store
│          │  │  index.js    # 根级别的store + 模块组装
│          │  │  
│          │  └─modules        # store 模块
│          │          home.js    # home这个模块使用的store
│          │          
│          └─types            # 放类型名称
│                  home.js    # home这个模块使用的 types
│                  root.js    # 公用的types
界面-模板-组件 的关系

界面:最后展现在用户面前的

模板:用来注入打包的html文件

组件:编写的vue组件

他们的关系如图:

组件-store(vuex)-api(vue-resuorce) 的关系

组件使用store:

通过辅助函数(mapGetters,mapActions等)把store的属性映射到组件中使用

组件通过action来提交mutation修改状态

也可以通过$store来使用

组件使用api:

组件通过store的action使用api

store内部安排

由mutation来修改状态

由action来提交mutation

由store的action来调用api

api里面分离开中间件,按需调用

看图看图 ↓↓↓

五、开发环境开发

在vue-cli v2.8.2生产的开发环境的基础上进行修改

新增加:build/device-conf.js 用来出路多终端(页面)开发相关问题
var chalk = require("chalk")
var glob = require("glob")

// 获取deviceList
var deviceList = []
var deviceSrcArray = glob.sync("./src/device/*")
for(var x in deviceSrcArray){
  deviceList.push(deviceSrcArray[x].split("/")[3])
}

// 检测是否在输入的参数是否在允许的list中
var checkDevice = function () {
  var device = process.env.DEVICE_ENV
  var result = false
  // 检查deviceList是否有重复
  var hash = {}
  var repeatList = []
  for(var l = 0;l < deviceList.length; l++){
    if(hash[deviceList[l]]){
      repeatList.push(deviceList[l])
    }
    hash[deviceList[l]] = true
  }
  if(repeatList.length > 0){
    console.log(chalk.bgRed("deviceList 有重复:"))
    console.log(chalk.bgRed(repeatList.toString()))
    return result
  }
  for(var i in deviceList){
    if(device === deviceList[i]){
      result = device
      break
    }
  }
  if(result === false){
    console.log(chalk.bgRed("参数错误,允许的参数为:"))
    console.log(chalk.bgRed(deviceList.toString()))
  }
  return result
}

exports.deviceList = deviceList
exports.checkDevice = checkDevice
// 其他依赖
exports.polyfills = ["babel-polyfill"]
添加:/build/build-all.js

内部根据 deviceList 产生运行build.js子进程,完成打包

var execFileSync = require("child_process").execFileSync;
var path = require("path")
var deviceList = require("./device-conf").deviceList || []

var buildFile = path.join(__dirname, "build.js")

for( var x in deviceList){
  console.log("building :",deviceList[x])
  execFileSync( "node", [buildFile, deviceList[x]], {

  })
}

修改/build/build.js

添加设置环境变量并检查参数代码

var chalk = require("chalk")
// 设置process.env.DEVICE_ENV参数
// 没有则返回错误
var device = process.argv[2]
var checkDevice = require("./device-conf").checkDevice
if(device){
  process.env.DEVICE_ENV = device
  if(!checkDevice()){
    return false
  }
}else {
  console.log(chalk.bgRed("  错误:缺少参数,详情请看readme.md  "))
  return false
}
修改/build/build.js

添加一个路由(在使用中间件connect-history-api-fallback之前添加),把可调试的入口展示出来

// 写个小路由,打开浏览器的时候可以选一个开发路径
var deviceList = require("./device-conf").deviceList || []
var sentHref = ""
for(var x in deviceList){
  sentHref += "点我调试终端:"+ deviceList[x].toString() +" 
" } app.get("/devDeviceList", (req, res, next) => { res.send(sentHref) })

修改打开的默认连接

opn(uri + "/devDeviceList")
修改/config/index.js 主要修改模板入口,打包出口等
// see http://vuejs-templates.github.io/webpack for documentation.
var path = require("path")
var device = process.env.DEVICE_ENV || "undefined"


// 入口模板路径
var htmlTemplate =  "./src/device/" + device + "/index.html"

module.exports = {
  build: {
    env: require("./prod.env"),
    // 加入html入口
    htmlTemplate: htmlTemplate,
    index: path.resolve(__dirname, "../dist" , device , "index.html"),
    assetsRoot: path.resolve(__dirname, "../dist" , device),
    assetsSubDirectory: "static",
    // 这里的路径改成相对路径
    // 原来是: assetsPublicPath: "/",
    assetsPublicPath: "",
    productionSourceMap: true,
    // Gzip off by default as many popular static hosts such as
    // Surge or Netlify already gzip all static assets for you.
    // Before setting to `true`, make sure to:
    // npm install --save-dev compression-webpack-plugin
    productionGzip: false,
    productionGzipExtensions: ["js", "css"],
    // Run the build command with an extra argument to
    // View the bundle analyzer report after build finishes:
    // `npm run build --report`
    // Set to `true` or `false` to always turn it on or off
    bundleAnalyzerReport: process.env.npm_config_report
  },
  dev: {
    env: require("./dev.env"),
    port: 8080,
    autoOpenBrowser: true,
    assetsSubDirectory: "static",
    assetsPublicPath: "/",
    proxyTable: {},
    // CSS Sourcemaps off by default because relative paths are "buggy"
    // with this option, according to the CSS-Loader README
    // (https://github.com/webpack/css-loader#sourcemaps)
    // In our experience, they generally work as expected,
    // just be aware of this issue when enabling this option.
    cssSourceMap: false
  }
}
修改 /build/webpack.dev.conf.js

主要修改了入口配置,出口配置,以及模板文件配置

// 获取device
var device = process.env.DEVICE_ENV

var utils = require("./utils")
var webpack = require("webpack")
var config = require("../config")
var merge = require("webpack-merge")
var baseWebpackConfig = require("./webpack.base.conf")
var HtmlWebpackPlugin = require("html-webpack-plugin")
var FriendlyErrorsPlugin = require("friendly-errors-webpack-plugin")

// 设置设备相关信息引入
var deviceList = require("./device-conf").deviceList
// 其他依赖
var extraPolyfill = require("./device-conf").polyfills || []

// 设置入口
var entry = {}
// 设置html插件模板入口和依赖
var htmlPluginConf = []
for(var x in deviceList){
  // 设置 入口
  entry[deviceList[x]] = extraPolyfill.concat(
    ["./build/dev-client"],
    "./src/device/" + deviceList[x] + "/index.js"
  )
  var _htmlPlugin = new HtmlWebpackPlugin({
    filename: deviceList[x]+"/index.html",
    template: "./src/device/" + deviceList[x] + "/index.html",
    chunks: [deviceList[x]]
  })
  htmlPluginConf.push(_htmlPlugin)
}




// add hot-reload related code to entry chunks
// 把热重载所需的代码也打包进去
// Object.keys(baseWebpackConfig.entry).forEach(function (name) {
//   baseWebpackConfig.entry[name] = ["./build/dev-client"].concat(baseWebpackConfig.entry[name])
// })

// 删除的entry和output
try {
  delete baseWebpackConfig.entry
}catch (e){
  console.log(e)
}
try{
  delete baseWebpackConfig.output
}catch (e){
  console.log(e)
}

module.exports = merge(baseWebpackConfig, {
  // 设置入口
  entry: entry,
  // 设置出口
  output: {
    path: "/",
    filename: "[name].js",
    publicPath: config.dev.assetsPublicPath
  },
  module: {
    rules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap })
  },
  // cheap-module-eval-source-map is faster for development
  devtool: "#cheap-module-eval-source-map",
  plugins: [
    new webpack.DefinePlugin({
      "process.env": config.dev.env
    }),
    // https://github.com/glenjamin/webpack-hot-middleware#installation--usage
    new webpack.HotModuleReplacementPlugin(),
    new webpack.NoEmitOnErrorsPlugin(),
    // https://github.com/ampedandwired/html-webpack-plugin
    // new HtmlWebpackPlugin({
    //   filename: "index.html",
    //   template: config.dev.htmlTemplate,
    //   inject: true
    // }),
    new FriendlyErrorsPlugin()
  ].concat(htmlPluginConf)
})
修改 /build/webpack.prod.conf.js

主要修改了入口配置,出口配置,以及模板文件配置

var path = require("path")
var utils = require("./utils")
var webpack = require("webpack")
var config = require("../config")
var merge = require("webpack-merge")
var baseWebpackConfig = require("./webpack.base.conf")
var CopyWebpackPlugin = require("copy-webpack-plugin")
var HtmlWebpackPlugin = require("html-webpack-plugin")
var ExtractTextPlugin = require("extract-text-webpack-plugin")
var OptimizeCSSPlugin = require("optimize-css-assets-webpack-plugin")

var env = process.env.NODE_ENV === "testing"
  ? require("../config/test.env")
  : config.build.env

// 设置device相关变量
var device = process.env.DEVICE_ENV
//设置入口
var extraPolyFill = require("./device-conf").polyfills ||[]
var entry = {
  index: extraPolyFill.concat("./src/device/" + device + "/index.js")
}

console.log(config.build.htmlTemplate)
var webpackConfig = merge(baseWebpackConfig, {
  module: {
    rules: utils.styleLoaders({
      sourceMap: config.build.productionSourceMap,
      extract: true
    })
  },
  // 写入prod的入口
  entry: entry,
  devtool: config.build.productionSourceMap ? "#source-map" : false,
  output: {
    path: config.build.assetsRoot,
    filename: utils.assetsPath("js/[name].[chunkhash].js"),
    chunkFilename: utils.assetsPath("js/[id].[chunkhash].js")
  },
  plugins: [
    // http://vuejs.github.io/vue-loader/en/workflow/production.html
    new webpack.DefinePlugin({
      "process.env": env
    }),
    new webpack.optimize.UglifyJsPlugin({
      compress: {
        warnings: false
      },
      sourceMap: true
    }),
    // extract css into its own file
    new ExtractTextPlugin({
      filename: utils.assetsPath("css/[name].[contenthash].css")
    }),
    // Compress extracted CSS. We are using this plugin so that possible
    // duplicated CSS from different components can be deduped.
    new OptimizeCSSPlugin({
      cssProcessorOptions: {
        safe: true
      }
    }),
    // generate dist pc.html with correct asset hash for caching.
    // you can customize output by editing /pc.html
    // see https://github.com/ampedandwired/html-webpack-plugin
    new HtmlWebpackPlugin({
      filename: process.env.NODE_ENV === "testing"
        ? "index.html"
        : config.build.index,
      // template: "index.html",
      template: config.build.htmlTemplate,
      inject: true,
      minify: {
        removeComments: true,
        collapseWhitespace: true,
        removeAttributeQuotes: true
        // more options:
        // https://github.com/kangax/html-minifier#options-quick-reference
      },
      // necessary to consistently work with multiple chunks via CommonsChunkPlugin
      chunksSortMode: "dependency"
    }),
    // split vendor js into its own file
    new webpack.optimize.CommonsChunkPlugin({
      name: "vendor",
      minChunks: function (module, count) {
        // any required modules inside node_modules are extracted to vendor
        return (
          module.resource &&
          /.js$/.test(module.resource) &&
          module.resource.indexOf(
            path.join(__dirname, "../node_modules")
          ) === 0
        )
      }
    }),
    // extract webpack runtime and module manifest to its own file in order to
    // prevent vendor hash from being updated whenever app bundle is updated
    new webpack.optimize.CommonsChunkPlugin({
      name: "manifest",
      chunks: ["vendor"]
    }),
    // copy custom static assets
    new CopyWebpackPlugin([
      {
        from: path.resolve(__dirname, "../static"),
        to: config.build.assetsSubDirectory,
        ignore: [".*"]
      }
    ])
  ]
})

if (config.build.productionGzip) {
  var CompressionWebpackPlugin = require("compression-webpack-plugin")

  webpackConfig.plugins.push(
    new CompressionWebpackPlugin({
      asset: "[path].gz[query]",
      algorithm: "gzip",
      test: new RegExp(
        ".(" +
        config.build.productionGzipExtensions.join("|") +
        ")$"
      ),
      threshold: 10240,
      minRatio: 0.8
    })
  )
}

if (config.build.bundleAnalyzerReport) {
  var BundleAnalyzerPlugin = require("webpack-bundle-analyzer").BundleAnalyzerPlugin
  webpackConfig.plugins.push(new BundleAnalyzerPlugin())
}

module.exports = webpackConfig
六、整个开发环境的目录注释
│  .babelrc
│  .editorconfig
│  .eslintignore
│  .eslintrc.js
│  .gitignore
│  .postcssrc.js
│  index.html
│  npm-debug.log
│  package.json
│  README.md
│  tree.txt
│          
├─build   # 这里是打包工具相关的
│      build-all.js # 通过打包所有端的代码
│      build.js        # 这里设定进程的环境变量
│      check-versions.js
│      dev-client.js  
│      dev-server.js    # 这里也需要对进程的环境变量进行设定
│      device-conf.js    # 这里面有关于多端开发、打包的相关设定
│      utils.js
│      vue-loader.conf.js
│      webpack.base.conf.js        # 修改了入口、出口等
│      webpack.dev.conf.js        # 修改了入口、出口等
│      webpack.prod.conf.js        # 修改了入口出口等
│      webpack.test.conf.js        # 测试相关还未完善
│      
├─config
│      dev.env.js
│      index.js                    # 打包的入口和出口
│      prod.env.js
│      test.env.js
│      
├─dist        # 最后打包的目录 分端储存
│  ├─app
│  │  │  index.html
│  │  │  
│  │  └─static
│  │      └─js
│  │              index.0142f89e3523b3b0d16b.js
│  │              index.0142f89e3523b3b0d16b.js.map
│  │              manifest.57f6691c595e842abc95.js
│  │              manifest.57f6691c595e842abc95.js.map
│  │              vendor.cce790f63359fc27fa7d.js
│  │              vendor.cce790f63359fc27fa7d.js.map
│  │              
│  ├─mobile
│  │  │  index.html
│  │  │  
│  │  └─static
│  │      └─js
│  │              index.0142f89e3523b3b0d16b.js
│  │              index.0142f89e3523b3b0d16b.js.map
│  │              manifest.57f6691c595e842abc95.js
│  │              manifest.57f6691c595e842abc95.js.map
│  │              vendor.cce790f63359fc27fa7d.js
│  │              vendor.cce790f63359fc27fa7d.js.map
│  │              
│  └─pc
│      │  index.html
│      │  
│      └─static
│          ├─css
│          │      index.1e809171f3a961de951e3c8e6644435f.css
│          │      index.1e809171f3a961de951e3c8e6644435f.css.map
│          │      
│          └─js
│                  0.f3e74a76d92b3f6ca5ec.js
│                  0.f3e74a76d92b3f6ca5ec.js.map
│                  1.fb471d3425df8c16ac54.js
│                  1.fb471d3425df8c16ac54.js.map
│                  index.a2ba631673923f812cf1.js
│                  index.a2ba631673923f812cf1.js.map
│                  manifest.ab6461111db19541d04b.js
│                  manifest.ab6461111db19541d04b.js.map
│                  vendor.aeee805b1efff3748018.js
│                  vendor.aeee805b1efff3748018.js.map
│                  
├─images         # 这个放点文档写文档用的图片                        
├─sever            # 这里写点服务端程序,用于测试等
│      prod-view-server.js
│      
├─src            # 源文件目录
│  │  config.js
│  │  
│  ├─api        # 多端共用的 api
│  │      device-root.js
│  │      middleware.js
│  │      
│  ├─assets        # 多端共用的 资源
│  │      logo.png
│  │      
│  ├─components    # 多端共用的 组件
│  │      RootCommonComponent.vue
│  │      
│  └─device        # 设备入口 
│      ├─app    # 混合开发的放这里了,也可以分 ios 和 安卓
│      │      index.html    # app专用的html模板,打包好的东西会自动注入
│      │      index.js        # app的入口文件
│      │      
│      ├─mobile        # 这里放移动端的页面 ,下面的 index文件作用类似其他端
│      │      index.html    
│      │      index.js
│      │      
│      └─pc            # 这个目录下的都是pc端使用的,当然其他端要用也是可以的,哈哈
│          │  App.vue        # 入口组件
│          │  index.html    # 模板文件
│          │  index.js        # 入口文件
│          │  
│          ├─api            # 分离开接口
│          │      home.js    # home这个模块用的接口
│          │      middleware.js            # 一些公用的中间件
│          │      
│          ├─assets            # 资源
│          ├─components        # 组件
│          │  ├─commonComponents    # 公共组件
│          │  │      Header.vue
│          │  │      
│          │  ├─Home    # home这个模块用的组件
│          │  │      Body.vue
│          │  │      Index.vue
│          │  │      
│          │  └─Page404    # 404这个模块用的组件
│          │          Index.vue
│          │          
│          ├─router        # 路由
│          │      index.js
│          │      
│          ├─store        # vuex 的store
│          │  │  index.js    # 根级别的store + 模块组装
│          │  │  
│          │  └─modules        # store 模块
│          │          home.js    # home这个模块使用的store
│          │          
│          └─types            # 放类型名称
│                  home.js    # home这个模块使用的 types
│                  root.js    # 公用的types
│                  
├─static
│      .gitkeep
│      
└─test    # 测试相关 TODO
    

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

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

相关文章

  • webpack4+vue2+axios+vue-router多页+单页混合应用框架

    摘要:适用于主要入口页面生成多页,子页面和次要页面使用单页形式的项目。文件用来存放固定的数据,而文件可更加自由的处理并返回数据。 VUE2的单页应用框架有人分享了,多页应用框架也有人分享了,这里分享一个单页+多页的混合应用框架吧,node.js写了一个简单的mock服务也集成在里面,整体初现雏形,还有很多需要优化和改善的地方。。。 项目结构 │ ├─build ...

    whatsns 评论0 收藏0
  • [使用 Weex 和 Vue 开发原生应用] 6 使用 vue-router

    摘要:使用值来作路由。原生应用本身就是多页的场景,页面间状态的隔离比共享更重要一些。使用开发的是原生应用,页面栈的管理使用的也是原生的特性,没有但是有模块可以实现页面的前进和后退等操作。 系列文章的目录在 ? 这里 (由于 我比较懒 最近一段时间在忙其他事,系列文章拖了好久终于又更新了。。。) 什么是 vue-router ? vue-router 官方文档 vue-router 是针对 V...

    leonardofed 评论0 收藏0
  • 【敲黑板】手把手教你vue-cli单页多页应用

    摘要:到多页应用前言我有一个创建的项目,但是我想做成多页应用,怎么办,废话不多说,直接开撸约定新增代码部分在和中间删除注释代码部分在和中间,很多东西都写在注释里第一步一个项目新建一个项目官网默认使用的服务,这个服务是做不了单页的,需要手动建一 vue-cli到多页应用 前言:我有一个cli创建的vue项目,但是我想做成多页应用,怎么办,废话不多说,直接开撸~ 约定:新增代码部分在//add和...

    DC_er 评论0 收藏0
  • Weex系列(4) —— 老生常谈三端统一

    摘要:刚看到这仨页面的时候,我就想着可以用路由,做成三端统一。样式这部分真的三端基本是高度统一的,部分微调一下就可以了,也正是这样,我们后续才能迅速解决和。终于不是谈谈三端统一了,也是真的体验了一次,虽然最后有点出入,但是下次基本是没问题了。 目录 Weex系列(序) —— 总要知道原生的一点东东(iOS) Weex系列(序) —— 总要知道原生的一点东东(Android) Weex系列(...

    wzyplus 评论0 收藏0

发表评论

0条评论

cnio

|高级讲师

TA的文章

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