uni-app跨端兼容之条件编译(个人笔记)

uni-app 已将常用的组件、JS API 封装到框架中，开发者按照 uni-app 规范开发即可保证多平台兼容，大部分业务均可直接满足。
但每个平台有自己的一些特性，因此会存在一些无法跨平台的情况。

条件编译

条件编译是用特殊的注释作为标记，在编译时根据这些特殊的注释，将注释里面的代码编译到不同平台。

写法：以 #ifdef 或 #ifndef 加%PLATFORM% 开头，以 #endif 结尾。

• #ifdef：if defined 仅在某平台存在
• #ifndef：if not defined 除了某平台均存在
• %PLATFORM%：平台名称

image.png

更多%PLATFORM%可取值请查阅官方文档：https://uniapp.dcloud.io/platform

条件编译支持的文件

.vue
.js
.css
pages.json
各预编译语言文件，如：.scss、.less、.stylus、.ts、.pug

条件编译是利用注释实现的，在不同语法里注释写法不一样，js使用 // 注释、css 使用 /* 注释 */、vue/nvue 模板里使用 ；

条件编译写法

js代码中：

示例，如下代码不会在 H5 平台上出现：

image.png

除了支持单个平台的条件编译外，还支持多平台同时编译，使用 || 来分隔平台名称。
示例，如下代码会在 App 和 H5 平台上出现：

image.png

html代码中

示例，如下公众号关注组件仅会在微信小程序中出现：

<view>
    <view>微信公众号关注组件</view>
    <view>
        <!-- #ifdef MP-WEIXIN -->
            <official-account></official-account>
        <!-- #endif -->
    </view>
</view>

样式代码中

注意： 样式的条件编译，无论是 css 还是 sass/scss/less/stylus 等预编译语言中，必须使用 /*注释*/ 的写法。
正确写法：

image

错误写法：

image

pages.json代码中

下面的页面，只有运行至 App 时才会编译进去。

image

不同平台下的特有功能，以及小程序平台的分包，都可以通过 pages.json 的条件编译来更好地实现。这样，就不会在其它平台产生多余的资源，进而减小包体积。

static目录的条件编译

在不同平台，引用的静态资源可能也存在差异，通过 static 的的条件编译可以解决此问题，static 目录下新建不同平台的专有目录（目录名称同 %PLATFORM% 值域,但字母均为小写），专有目录下的静态资源只有在特定平台才会编译进去。

如以下目录结构，a.png 只有在微信小程序平台才会编译进去，b.png 在所有平台都会被编译。

┌─static                
│  ├─mp-weixin
│  │  └─a.png     
│  └─b.png
├─main.js        
├─App.vue      
├─manifest.json 
└─pages.json     

整体目录条件编译

如果想把各平台的页面文件更彻底的分开，也可以在uni-app项目根目录创建platforms目录，然后在下面进一步创建app-plus、mp-weixin等子目录，存放不同平台的文件。

注意

• platforms目录下只支持放置页面文件（即页面vue文件），如果需要对其他资源条件编译建议使用static 目录的条件编译

HBuilderX支持

HBuilderX 为 uni-app 的条件编译提供了丰富的支持:

代码块支持

在 HBuilderX 中开发 uni-app 时，通过输入 ifdef 可快速生成条件编译的代码片段

注意

• Android 和 iOS 平台不支持通过条件编译来区分，如果需要区分 Android、iOS 平台，请通过调用 uni.getSystemInfo 来获取平台信息。支持ifios、ifAndroid代码块，可方便编写判断。

更多详细内容请查阅官方文档：https://uniapp.dcloud.io/platform