vue koa 应用脚手架
样式: scss.库管理: npm,bower框架: vue2.模板引擎: handlebars4.打包: webpack4
框架:koa2, nodejs>=7
.
├── build # 使用 vue-cli 2.9.3(有修改)
├── config # 使用 vue-cli 2.9.3(有修改)
├── server # 服务端(koa,nodejs)
│ ├── api # 接口
│ ├── controller # 控制器
│ ├── lib # 库
│ ├── mock # 模拟数据
│ ├── router # 路由(koa-router,或前端用vue-router)
│ ├── view # 视图
│ ├── server.js # 服务端入口
├── dist # 生产目录
├── public # 公共资源(例如访问http://localhost:3333/public/img/bg.jpg)
│ ├── img # 图片
│ └── vendor # 第三方插件
├── web # 前端(vue,js,css...)
│ ├── components # 组件
│ ├── directives # 指令
│ ├── entry # 入口
│ ├── filters # 过滤
│ ├── global # 全局设置
│ ├── mock # 模拟数据
│ ├── pages # 页面
│ ├── styles # 样式
│ ├── vendor # 第三方插件
│ ├── webpack.entry.conf.js # 入口配置文件
│ ├── webpack.dev.conf.js # 开发模式配置文件
│ └── webpack.prod.conf.js # 生产模式配置文件
│ config.yml # 通用配置文件,整个脚手架很多功能都与它有关
npm install # npm 安装
bower install # bower 安装npm run dev # 启动开发模式(dev)
npm run build # 构建项目
npm run prod # 启动生产模式(prod)/server/router/app/index.js
const mainCtrl = require('../controller/index');
module.exports.default = module.exports = [
{path: '', ctrl: mainCtrl.pageHome},
{path: 'main', ctrl: mainCtrl.pageHome},
{path: 'api/list', ctrl: mainCtrl.list, method: 'post'}
];/server/controller/index.js
const api = require('../api/index');
const pageHome = async (ctx, _next) => {
let locals = {
title: 'home-page'
};
//appName开发模式下不会加载生产后的css,只有在路由对应的控制器设置
ctx.state.appName = 'app';
await ctx.render('pages/home', locals);
};
const list = async (ctx, _next) => {
//不需要设置ctx.state.appName
let locals = {
list: await api.getList(ctx)
};
ctx.body = locals;
};
module.exports.default = module.exports = {
pageHome,
list
};ctx.state.appName
默认值:'',开发模式下不会加载生产后的css,parseUrl有解释.
/server/view/pages/home.hbs
/server/view/layout/**.hbs 以文件名注册为handlebars partial.
解析url, handlebars自定义helpers.结合ctx.state.appName,根据当前开发环境返回正确的url.
dev
ctx.state.appName='app'
{{{parseUrl 'app.css' 'app.js'}}}↓↓↓
<script web="app.js"></script>ctx.state.appName=''; 或不设置
↓↓↓
<link href="/dist/static/css/app.[chunkhash].css" type="text/css" rel="stylesheet">
<script web="app.js"></script>prod
<link href="/dist/static/css/app.[chunkhash].css" type="text/css" rel="stylesheet">
<script web="/dist/static/js/app.[chunkhash].js"></script>如果没有build过,dev模式不会加载app.css,只加载app.js.即使加载build过的css也不影响dev模式下的样式应用.
/web/pages/app/home.vue
...
<script>
export default {
data () {
return {
list: ''
}
},
mounted(){
this.$http.post('/api/list').then(response => {
console.log(response);
this.list = response.data.list
}, response => {
console.log(response);
})
}
}
</script>
.../web/pages/app/index.js
import homeApp from './home.vue';
new Vue({
el: '#home-app',
template: '<homeApp/>',
components: {homeApp}
});/webpack.entry.conf.js
任何模式都引用的配置文件
** 作为全局通用的入口文件,处在不同位置.在开发,生产模式webapck构建时自动合并引入webpack.entry.(不做其他属性合并).一般情况不作修改.**
module.exports ={
header: './web/entry/header.js', //全局头部通用文件(引用vue,全局样式...)
footer: './web/entry/footer.js', //全局底部通用文件(比如统计数据...)
};header.js:不支持删除,在生产模式时,紧接着插入manifest.js,vendor.js.
footer.js:支持删除.
/webpack.dev.conf.js
开发模式时所引用的配置文件,构建会合并所有属性.
module.exports ={
entry: {
'app': './web/pages/app/index.js',
},
//devtool: '#cheap-module-eval-source-map'
...
};合并后的实际入口(多入口)
entry: {
'app': [
'./web/entry/header.js',
'./web/entry/footer.js' ,
'./web/pages/app/index.js' ,
'webpack-hot-client/client'
],
'app2': [
'./web/entry/header.js',
'./web/entry/footer.js' ,
'./web/pages/app/index.js' ,
'webpack-hot-client/client'
]
}webpack-hot-client/client(hot-reload): 开发模式时每个入口自动加入.
/webpack.prod.conf.js
生产模式时所引用的配置文件,构建会合并所有属性.
module.exports ={
...
new ManifestPlugin({
publicPath: 'http://localhost:3030/app'
})
...
};合并后的实际入口(多入口)
entry: {
'app': ['./web/pages/app/index.js'],
'app2': ['./web/pages/app2/index.js'],
header: ['./web/entry/header.js'],
footer: ['./web/entry/footer.js']
}/web/pages/**/index.js 都是app. 这里,app, app2 2个app,甚至更多,即多页应用.
app, app2,分别叫主app,其他app,还可以有另外app...等. 名字随你.
项目只保留1个app,多app需另建.
/config.yml
...
#多语言路由前缀
locales: ['zh', 'en'[,.]]
#webpack构建路径(entry)
buildPath:
-
#多语言入口
name: './web/locale'
...缺一不可
/web/locale/zh.js
window.locale = {
'desc': 'vue koa 多页应用脚手架'
};/web/locale/en.js
window.locale = {
'desc': 'vue koa scaffold'
};多语言文件会在header.js之前插入.
/web/utils/locale.js
/**
* 获取locale对应的值
*/
window.getLocale = function (key) {
if (window.locale) {
return window.locale[key] || '';
}
else {
return key;
}
};...
data() {
return {
list: '',
desc: getLocale('desc')
}
}
...路由则支持
/config.yml
...
# 是否使用模拟数据api(dev模式有效)
isMockAPI : true
# apiServer api服务器
apiServer : 'http://localhost:3030'
...isMockAPI:true
在页面渲染时在/header/index.js前插入/public/vender/mock-min.js.
<script src="/public/vendor/mockjs/dist/mock-min.js"></script><script src="header.js"></script>/server/mock/api/list.json
现在请求 /api/list
isMockAPI:true
服务端返回 /server/mock/api/list.json.
isMockAPI:false
服务端返回 http://localhost:3030/api/list.
/web/mock/index.js
Mock.mock('/api/list', 'post', function () {
return Mock.mock({
"list|1-10": [{
'name': '@cname',
'imageUrl': 'https://placeholdit.imgix.net/~text?txtsize=50&bg=323232&txtclr=ffffff&txt=150%C3%97300&w=300&h=150',
'description': '@cname'
}]
});
});优先级:前端Mock文件>后端Mock文件.否则报500.
/config.yml
...
# webpack构建路径(prod模式有效)
buildPath:
# name entry路径
# isIndexEntry 是否使用index.js作为webpack.entry.
# isIndexEntry = true
# './web/pages/app/index.js' --> /dist/static/js/app[chunkhash].js
# 使用index.js上一级目录名作为打包文件名(example.js).
# isIndexEntry = false
# './web/locale/zh.js' --> /dist/static/js/zh[chunkhash].js
# 使用当前文件作为打包文件名(zh.js).
-
name: './web/pages'
isIndexEntry : 'true'
-
name: './web/locale'
...
一般情况每一个应用都建立在 /web/pages/**/index.js,以index.js作为打包入口.
否则,如果有/web/pages/app/index.js,/web/pages/app2/index.js,/web/pages/app3/index.js.就会最终构建出以排序最后的index.js.
所以,/web/pages/**,只要目录不重名,并且以index.js作为入口.就不会冲突.
dev
从这些配置文件打包 /webpack.base.conf , /webpack.entry.conf.js , /webpack.dev.conf.js
主要从/webpack.dev.conf.js配置打包开发需要的entry.
prod
从这些配置文件打包 /webpack.base.conf , /webpack.entry.conf.js , /webpack.prod.conf , /web/pages/**/index.js
主要从/web/pages/**/index.js打包所有js.