工程使用文档

工程目录结构

项目根目录
    ├── app                         // app主module
    │   ├── libs                    // ├── 基座及配置文件目录
    │       ├── PMUIFramework       //      ├── PMUI核心库
    │       └── WeexSDK             //      └── Weex核心库
    │   ├── src            
    │       ├── main     
    │           └── assets          // └── 基座及配置文件目录
    │   ├── pmui_dependency.gradle  // ├── PMUIFramework所需依赖
    ├── PMUI-Default.jks            // └── default签名文件
    └── settings.gradle             // └── 模块配置文件

开发工具

  • Android Studio 3.5.0+
  • Gradle 5.4.1+

配置相关

  • 解压好的Weex基座内容放置在工程assets/pmui文件夹下
  • config.json 配置文件需放置在工程assets/pmui文件夹下
  • config.json配置:
{
	"serviceUrl": "http://183.62.118.51:20032",     //客户端请求资源服务器地址
	"serviceAPI": {
		"app": "/app/issue/resource/getIssueValidLaunchImageAndWeexAndAppResourceByCondition",        //请求app资源版本信息接口
		"resource": "/app/issue/resource/getTheNewestIssueStaticPackageDetailByCondition"     //h5离线包信息接口
	},
	"projectId": "9D69E0207BFD464AA8C61B354E9BA9F5",        //项目id,用于云平台管理
	"homePage": "",     //主页的JS地址(可选)
	"homePageParams": {},       //主页其他参数(可选)
	"navigationBarStyle": {}, //全局配置导航栏默认样式(可选)
	"android": {
		"imageEngine": "picasso"        //安卓图片适配器(可选)
	},
	"socketHost": "",       //WiFi真机同步服务器 ip 地址(可选,dev自动生成)
	"socketPort": "",       //WiFi真机同步服务器端口(可选,dev自动生成)
}
  • config.json配置说明:
    • serviceUrl: 服务器地址,该地址是银河平台测试地址,可换成项目自行搭建地址
    • serviceAPI-app: 请求客户端所需启动图信息、app版本升级、Weex基座等信息
    • serviceAPI-resource: 获取h5静态资源包信息
    • projectId: 平台应用唯一标识
    • homePage: 主页的JS地址;一般情况下留空,默认为:index.js(可自定义,比如填写:login.js时默认首页将是login.js)。也可以把JS资源放到服务器上然后把JS地址填写到这里。还可以通过 pmui.setCustomConfig 动态设置主页。
    • homePageParams: 主页的其他参数,比如导航栏颜色等。详细设置请查阅 pmui.openPage params参数说明
    • navigationBarStyle:示例
"navigationBarStyle":{
        "titleColor": '#333333',
        "titleSize": 34,
        "titleBold": true,
        "barHeight":88,
        "subtitleColor":'#333333',
        "subtitleSize":24,
        "backgroundColor":"#FFFFFF",
        "left": {
            "title": '左边按钮',
            "titleColor": '#333333',
            "titleSize": 28,
            "titleBold": true,
            "icon": 'root:img/navi_back.png',
            "iconColor": '#0057FF',
            "iconSize": 36,
            "width": 75,
            "spacing":10
        },
        "right": {
            "title": '右边边按钮',
            "titleColor": '#333333',
            "titleSize": 28,
            "titleBold": true,
            "icon": 'root:img/navi_back.png',
            "iconColor": '#0057FF',
            "iconSize": 36,
            "width": 75,
            "spacing":10
        }
    }
+ **android-imageEngine:** 图片适配器ImageAdapter(可选:picasso、glide),留空默认:glide
+ **socketHost:** WiFi真机调试服务器 ip 地址;留空,可以debug模式下点击DEV--> WiFi真机同步手动填写
+ **socketPort:** WiFi真机调试服务器端口;留空,可以debug模式下点击DEV--> WiFi真机同步手动填写

安装插件

插件可根据自己的需求安装,插件库地址http://118.144.87.52:9988/PMUIDelivery

  • 拉取插件源码到本地(建议本地创建一个文件夹管理插件,工程中引入文件夹路径即可)
  • 配置settings.gradle和build.gradle(:app)
//settings.gradle 引入插件地址
include ':pmuiCitypicker'
project (":pmuiCitypicker").projectDir = new File("../插件放置的文件夹/PMUI-Citypicker/android")

//app build.gradle 引入插件module
//plugins start
/*城市选择器*/
implementation project(":pmuiCitypicker")

开发调试

实时预览

pmui 支持实时同步预览,即修改完代码可以立即查看效果

  • 开启开发服务

只需要在项目根目录中起开发服务:npm run dev 脚手架会在项目 common 目录下生成 dist 文件,存放 JS Bundle。

注:使用真机调试需要将手机与起服务的[pc|mac]连接到同一个局域网内!

  • 热刷新

pmui 支持热刷新,即修改完代码保存(command + s 或 ctrl + s)的时候,页面会自动刷新

点击App屏幕上的DEV–> WiFi真机同步按要求输入上文开启开发服务生成的IP地址、端口号即可完成同步刷新。

注:热刷新只有在npm run dev服务下才会生效。