毛腿
毛腿
  • 发布:2020-03-25 01:33
  • 更新:2022-03-17 13:40
  • 阅读:6427

pages.json 解耦 助力 uni-app 模块化编程---uni-dev-tools

分类:uni-app

uni-dev-tools 是什么

uni-dev-tools是一个辅助开发 uni-app 的旁路辅助开发工具。对uni-app原目录设计只做优化,不做侵入。他不是开发框架,也不是插件。
该工具只为简化开发人员工作,优化多人开发模式,负责将pages.json中的配置分解再合并的自动化工作。
解决pages.json混乱的问题。因此pages.json不需要提交,pages.json 将会由其他文件自动合并生成。

pages.json 痛点

1.公有、私有混合,造成模块化开发,移植困难
2.团队开发,多人同时编辑该文件,代码提交,签出遇到若干问题
3.假若系统有50个view,那么pages.json 将会有1公里那么长,问谁能维护?

uni-dev-tools 的愿望

1.满足系统功能模块化;
2.全局与私有解耦合;
3.避免团队开发同时编辑一个文件;
4.方便模块移植;
5.我希望的uni-app框架结构为:pages文件夹为各模块的根目录,其中一个文件夹就是一个模块,里面包含视图层,逻辑层,私有路由配置文件。各功能模块的私有化配置,仅局限在各自的目录下,不与框架目录产生耦合关系。各开发人员的工作空间仅限于当前模块的工作目录。

使用 uni-dev-tools 后,你的 uni-app 目录结构可以这样

目录结构不限于以上,您可以按照自己的习惯,进行构建。如果您需要改造uni-app的目录,请注意下面

uni-dev-tools 监控以下目录

pages config workers sub-packages

uni-dev-tools 监控以下文件

router.json,condition.json,easy-com.json,global-style.json,config.json,tab-bar.json,preload-rule.json,sub-packages.json

所以,只要您的目录是以上目录,并且文件名是以上所列,无论你在json文件中方什么,都会自动合并到pages.json,所以目录结构您可以自己发挥。

因此 uni-dev-tools 干了以下这些事

1.应用根目录下增加了 config 目录,里面存放系统的全局配置文件,比如:condition.json,easy-com.json,global-style.json,tab-bar.json,通过各json文件的文件名可以看出,是对应pages.json 中的 各配置节点。

2.如果存在workers目录,在该目录下生成 config.json ,对应 pages.json 中的 workers 属性配置。

3.应用根目录下创建分包目录 sub-packages,并生成 preload-rule.json 对应 pages.json 中的preloadRule 分包下载规则 属性。今后所有分包都放在这个文件夹下,一个目录一个包,在该包下创建router.json文件,可对应pages.json 中的subPackages属性配置。

4.pages目录中存放主包页面模块,一个文件夹一个模块,该文件夹下的router.json 对应 pages.json 中的 pages 属性配置。

5.如果您对于以上的目录设计不满意,您可以自己进行精简,uni-dev-tools 监控的目录为"pages config workers sub-packages",监控的文件名为"router.json,condition.json,easy-com.json,global-style.json,config.json,tab-bar.json,preload-rule.json",

只要你确保是这项文件名和目录名,配置文件放置的层级结构你可以自定。比如你可以只创建config文件夹,并包配置都放在这个文件夹下,也是可以的啦。不需要强制按照我的目录编排。

6.监控以上各目录文件,发生新建或修改时,自动拉取配置,合并生成 pages.json

你要如何做

转到应用根目录下,运行

npm install uni-dev-tools  

//对应用进行初始化,从pages.json 中分解各个属性节点,生成各个配置文件  
npx uni-dev-tools init  

//对文件进行监控,自动将各文件中的配置信息合并到pages.json中  
npx uni-dev-tools watch  

第一次

请先进行初始化,将pages.json中的配置分解到各个配置文件,如果不这么做,直接 watch,您的pages.json 有可能会被您创建的空json文件覆盖。

下一步,你可以做什么

删除 pages.json

bug 提交 新需求提交

https://github.com/try520/uni-dev-tools/issues

2 关注 分享
1***@qq.com 1***@qq.com

要回复文章请先登录注册

9***@qq.com

9***@qq.com

回复 毛腿 :
估计官方未来会提吧,pages.js还不完善,不会热更新,即便强引入到main.js里也不会触发app.json的内容更新,只有触发pages.json的更改(更改个乱七八糟的注释就行),才会触发app.json根据pages.js的内容更新,不过基本上每次构建一次就已经帮助很大了,毕竟这块不会经常改,或者自己写个node脚本watch一下pages.js和相关的依赖,去动态触发一下pages.json的修改
2020-04-07 10:36
毛腿

毛腿 (作者)

回复 9***@qq.com :
厉害了,兄弟,官方没提过这个鬼啊
2020-04-07 10:28
毛腿

毛腿 (作者)

回复 芳华 :
那是我的理想,好的我改一下 谢谢
2020-04-07 10:15
9***@qq.com

9***@qq.com

兄弟,你可以了解一下pages.js,这是uni-app自带的彩蛋,项目根目录下创建pages.js之后,pages.json就会失效,但是pages.json仍然需要存在,返回一个空的json即可(比如{}),pages.js不能使用import只能使用require(因为不是webpack运行时),要求module.exports一个函数,并且函数要求返回的是pages.json的内容,这样在这个js里,你可以任意依赖其他的js,可以自由发挥了
pages.js
```
const module1=require('./src/pages/aaa')
const module2=require('./src/pages/bbb')
const module3=require('./src/pages/ccc')
module.exports=function(){
return {
"pages": [
{
"path": "pages/about/about",
"style": {
"navigationBarTitleText": "dddd"
}
},
...module1,
...module2
],
"subPackages":[{
"root": "pages/test",
"pages": [{
"path": "about",
"style": {
"navigationBarTitleText": "测试"
}
}]},
...module3
],
}
}
```
2020-04-07 03:19
芳华

芳华

git上给你提了分包bug
2020-04-04 11:58
芳华

芳华

回复 芳华 :
更新一下自己的错误,防止误导他人,在未做分包加载时,静态资源只能放在根目录的static中,做了分包加载,被分配的包里可以建独立的static文件夹
2020-04-04 11:58
芳华

芳华

用了,还不错,可惜私有静态资源目录实行不了,官方文档上说静态资源必须放在根目录的static中,我放在其他地方,小程序中没有被编译出来
2020-04-03 15:20