1. 跨端兼容
uni-app 已将常用的组件、JS API 封装到框架中,开发者按照 uni-app 规范开发即可保证多平台兼容,大部分业务均可直接满足。
但每个平台有自己的一些特性,因此会存在一些无法跨平台的情况。
- 大量写 if else,会造成代码执行性能低下和管理混乱。
- 编译到不同的工程后二次修改,会让后续升级变的很麻烦。
在 C 语言中,通过 #ifdef、#ifndef 的方式,为 windows、mac 等不同 os 编译不同的代码。uni-app
参考这个思路,为uni-app
提供了条件编译手段,在一个工程里优雅的完成了平台个性化实现。
2. 条件编译
(1)条件编译:是用特殊的注释作为标记,在编译时根据这些特殊的注释,将注释里面的代码编译到不同平台。
注意
:Android 和 iOS 平台不支持通过条件编译来区分,如果需要区分 Android、iOS 平台,请通过调用 uni.getSystemInfo 来获取平台信息。
(2)写法:以 #ifdef 或 #ifndef 加 %PLATFORM% 开头,以 #endif 结尾。
#ifdef:if defined 仅在某平台存在
#ifndef:if not defined 除了某平台均存在
%PLATFORM%:平台名称
(3)支持的文件
- .vue
- .js
- .css
- pages.json
- 各预编译语言文件,如:.scss、.less、.stylus、.ts、.pug
注意
: 条件编译是利用注释实现的,在不同语法里注释写法不一样,js使用 // 注释、css 使用 /* 注释 */、vue/nvue 模板里使用 ;
2.1 API 的条件编译
// #ifdef %PLATFORM%
平台特有的API实现
// #endif
(1)如下代码仅在 5+App 下出现
(2)如下代码不会在 H5 平台上出现
(3)如下代码会在 5+App 和 H5 平台上出现
除了支持单个平台的条件编译外,还支持多平台同时编译,使用 || 来分隔平台名称。
2.2 组件的条件编译
<!-- #ifdef %PLATFORM% -->
平台特有的组件
<!-- #endif -->
(1)如下广告组件仅会在微信小程序中出现
2.3 样式的条件编译
/* #ifdef %PLATFORM% */
平台特有样式
/* #endif */
注意
: 样式的条件编译,无论是 css 还是 sass/scss/less/stylus 等预编译语言中,必须使用 /注释/ 的写法。
(1)正确写法
(2)错误写法
2.4 pages.json的条件编译
下面的页面,只有运行至 5+App 时才会编译进去。
备注
:不同平台下的特有功能,以及小程序平台的分包,都可以通过 pages.json 的条件编译来更好地实现。这样,就不会在其它平台产生多余的资源,进而减小包体积。
2.5 static目录的条件编译
在不同平台,引用的静态资源可能也存在差异,通过 static 的的条件编译可以解决此问题,static 目录下新建不同平台的专有目录(目录名称同 %PLATFORM% 值域,但字母均为小写),专有目录下的静态资源只有在特定平台才会编译进去。
如以下目录结构,a.png 只有在微信小程序平台才会编译进去,b.png 在所有平台都会被编译。
┌─static
│ ├─mp-weixin
│ │ └─a.png
│ └─b.png
├─main.js
├─App.vue
├─manifest.json
└─pages.json
2.6 HBuilderX小技巧
HBuilderX 为 uni-app 的条件编译提供了丰富的支持:
(1)代码块支持:通过输入 ifdef 可快速生成条件编译的代码片段
(2)语法高亮:对条件编译的代码注释部分提供了语法高亮
(3)正确注释和快速选中:ctrl+alt+/ 即可生成正确注释(js:// 注释、css:/* 注释 */、vue/nvue模板: )。点击 ifdef 或 endif 可快速选中条件编译部分;点击左侧的折叠图标,可折叠条件编译部分代码。