这是一篇使用开源小工具miniprogram-to-uniapp 的使用心得记录,因为工作需要,自己尝试过手动搬页面,但觉得重复性搬运实在繁琐,而且耗费时间,所以在网上找了找有没有现成的工具,终于看见这么个小工具,感谢开源的作者。
转换工具文档:miniprogram-to-uniapp使用指南
源码粗略分析
主要命令: 【wtu -i "你的小程序项目路径" -o "输出目录,可不填"】
wtu这个命令是作者通过node的commander来实现了自己的全局命令,输入命令后执行了transform这个函数。
核心代码如下:
async function transform(sourceFolder, targetFolder) {
fileData = {};
routerData = {};
imagesFolderArr = [];
let miniprogramRoot = sourceFolder;
if (!targetFolder) targetFolder = sourceFolder + "_uni";
//读取小程序项目配置
const configData = wxProjectParse(miniprogramRoot, sourceFolder);
//小程序项目目录,不一定就等于输入目录,有无云开发的目录结构是不相同的。
miniprogramRoot = configData.miniprogramRoot;
//定义全局变量,之前传来传去的,过于麻烦
global.miniprogramRoot = miniprogramRoot;
global.sourceFolder = sourceFolder;
global.targetFolder = targetFolder;
global.globalUsingComponents = {}; //后面添加的全局组件
global.props = {}; //存储wxml组件页面里面,需要对外开放的参数(本想不做全局的,然而传参出现问题,还是全局一把梭)
global.wxsInfo = {}; //存储页面里的wxs信息,数据格式如上所示
if (fs.existsSync(targetFolder)) {
//清空output目录
fs.emptyDirSync(targetFolder);
} else {
//不存在就创建
fs.mkdirSync(targetFolder);
}
traverseFolder(miniprogramRoot, miniprogramRoot, targetFolder, () => {
//处理文件组
filesHandle(fileData, miniprogramRoot).then(() => {
//处理配置文件
configHandle(configData, routerData, miniprogramRoot, targetFolder);
//输出提示
setTimeout(()=>{
log('注意:当看到"image漏网之鱼",意味着您需要手动调整对应代码,表示image标签的src属性是含变量或表达式,工具还无法做到100%转换,需要手动修改为相对/static目录的路径\r\n'+
'另外,代码<template is="abc" data=""/>里data参数仅支持键值对{key:value}的形式,望知悉!')
}, 700);
});
});
}
这个函数主要的作用如下:
- 读取需要转换的文件路径,如果没有指定输出目录,就在同级目录下新建一个以_uni为后缀的文件夹
- 读取小程序项目配置,也就是project.config.json,package.json
- 遍历目录:(遇到文件夹则继续向下遍历)
- images或者image文件夹复制到static目录里,(workers目录也复制到static目录中,不过不是很清楚workers目录是用来干什么的)
- 处理js,wxml,wxss,json这四种文件,并暂存到fileData对象中,这个对象包括js,wxml,wxss,folder,json,fileName,isAppFile作为key值,
- 如果是.wxs文件,需要先使用js解析器JavascriptParser转换一下,
- 如果是属于图片类的文件,判断当前文件的上层目录,如果存在同级文件属于js,wxml,wxss中的一种,就直接复制到static目录里;否则连同上一级目录复制到static目录里(这种情况处理的是比如取名为img文件夹,会被整个copy到static目录下资源整合)
- 其他情况下直接copy整个文件,例如README文件,会直接复制到根目录下
- 处理文件组,即上面traverseFolder函数返回的fileData对象,(js、wxml、wxss),使用该对象中的fileName组装vue文件名
- isAppFile判断是否是app.js,单独命名为App.vue,
- 解析json,判断有没有引用自定义组件
- 配置routerData对象,存储这个page的路由样式等信息,(注意,小程序每个page文件里的配置在uni-app里面都配置到了pages.json里,这样跳转小程序还是会报错,我之前使用uni-app时把"navigateToMiniProgramAppIdList"配置写在app.json里同样不生效,开发过程中需要在manifest.json文件对应的mp-weixin下配置)
- wxml文件处理,以及wxml里面的wxs信息需要提取并转换,涉及到词法分析(这个还没有进一步学习过,具体以后有时间可以研究研究)
- js文件处理,
- wxss文件处理,图片路径区分(本地资源、网络资源)
- 写入文件,上面步骤返回的最后都是字符串
- 处理配置文件,app.json(还需要检测里面有没有全局组件)
- 将pages节点里的数据,提取routerData对应的标题,写入到pages节点里
- 加上tabBar节点
- 写入pages.json
- 写入template/manifest.json,(这是uni-app特有的配置),通过之前存储的configData写入manifest.json模版中(工具中先定义好模版)
- 全局引入自定义组件
- 写入main.js
到这个地方,这个开源小工具也就完成了它的功能,但转换后还有不少bug是需要自己手动调试发现的。
需要手动调试部分(自己测验到的问题)
配置eslint文件并修复报错信息,使用HBuilderX运行,根据报错信息修正
- wx:for转v-for遗留的问题,wx:for="{{ list }}"改为`v-for="(item,index) in list"
- 文件路径问题(组件、资源文件),全局替换
- 动态class问题
- 小程序的方法和vue中的methods
- 事件绑定的方式
- 小程序使用setData设置数据,跟vue中的数据单向流不一样,需要注意一下,这个工具对setData进行了重写,所以使用setData不会报错,但在onLoad中使用会提示错误
- globalData,这个工具里已经转化过了,只是额外提一下这个坑,在uni-app的app.vue文件中不可以直接使用this.globalData,会报错找不到,而应该使用this.$options.globalData
- image、input标签需要手动转换成<img />和<input />
- 自定义组件使用的时候如果是驼峰式命名,由于js里面的驼峰式被转成了小写(不知道是不是bug或者遗漏的地方),所以在使用该组件时会看不到内容,把名称替换一下就好了
- 小程序中有部分bind:绑定的方法,需要手动换成@
- 例如bindinput,bindblur等事件,需要手动改为@的形式
- 有关
wx.
的API,哪些需要替换成uni.
还需要仔细核查一遍,因为有的wx的api是微信独有的,替换为uni后,反而在微信下没法用了。如果后续要转为h5,需要自己调研是否须平台编译 - 登陆、支付、推送、定位、地图等相关功能,需要视平台而定,可能需要单独处理
- 原有的编译模式condition被放到了project.config.json文件中,运行不生效,需要放到pages.json文件中
- "navigateToMiniProgramAppIdList"配置写在app.json里不生效,开发过程中需要在manifest.json文件对应的mp-weixin下配置,这里属于微信小程序特有配置
顺便推荐一篇小程序转uni-app的指南:
微信小程序转换uni-app详细指南、小程序转uni-app转换器、wepy转uni-app