mpx

[mpx-logo]

Mpx, 一款具有优秀开发体验和深度性能优化的增强型跨端框架，支持小程序、Web 与 React Native（iOS / Android / Harmony）输出。

[test-status] [docs-status]

官网及文档

欢迎访问https://mpxjs.cn，跟随我们提供的文档指南使用 Mpx 进行跨端开发。

近期更新

基于 Mpx 的移动端基础组件库 mpx-cube-ui 已经开源，更多详情查看这里。

Mpx 2.9 版本正式发布，支持原子类、SSR和构建产物体积优化，更多详情查看这里，迁移指南查看这里，相关指南及 API 参考文档已更新。

简介

Mpx 是一款致力于提升开发体验和用户体验的增强型跨端框架，通过 Mpx，我们能够以类 Vue 的开发体验高效优雅地构筑出高性能跨端应用，在所有开放的小程序平台、Web 平台以及 React Native（iOS / Android / Harmony）环境中运行。

输出平台支持

Harmony（鸿蒙）属于 React Native 输出链路，与 iOS、Android 并列，不是独立的小程序输出形态。

Mpx具有以下功能特性：

• 数据响应 (赋值响应 / watch / computed)
• 组合式 API
• 增强模板语法 (动态组件 / 样式绑定 / 类名绑定 / 内联事件函数 / 双向绑定 / refs)
• 极致性能 (运行时性能优化 / 包体积优化 / 框架运行时体积14KB)
• 高效强大的编译构建 (基于webpack5 / 支持持久化缓存 / 兼容webpack生态 / 兼容原生小程序 / 完善支持npm场景下的分包输出 / 高效调试)
• 单文件组件开发
• 渐进接入 / 原生组件支持
• 状态管理 (Vuex规范 / 支持多实例Store)
• 跨团队开发 (packages)
• 逻辑复用 (mixins)
• 周边能力 (fetch / api增强 / mock / webview-bridge)
• 脚手架支持
• 多平台增强 (支持在微信、支付宝、百度、qq、头条小程序平台中进行增强开发)
• 跨平台编译 (一套代码跨端输出到微信、支付宝、百度、字节、QQ、京东、快应用(web)、Web 平台 和 React Native（iOS / Android / Harmony）中运行)
• 跨端输出 React Native (支持输出到 iOS、Android 与 Harmony，延续 Mpx 单文件组件、模板、样式、运行时和 API 适配能力)
• TypeScript支持 (基于ThisType实现了完善的类型推导)
• I18n国际化
• 单元测试
• E2E测试
• 原子类
• SSR
• 运行时渲染方案

快速开始

# 安装mpx脚手架工具
npm i -g @mpxjs/cli

# 初始化项目
mpx create mpx-project

# 进入项目目录
cd mpx-project

# 安装依赖
npm i

# development
npm run serve

# production
npm run build

使用小程序开发者工具打开项目文件夹下 dist 中对应平台的文件夹即可预览效果。

React Native 快速开始

创建项目时选择支持 React Native 的模板后，可按目标平台开发与构建（具体脚本名以脚手架生成为准）：

# 开发调试
npm run serve:ios
npm run serve:android
npm run serve:harmony

# 生产构建
npm run build:ios
npm run build:android
npm run build:harmony

Mpx 负责将业务源码编译为 RN JS bundle 与资源，产物通常输出到 dist/react-native/（或项目内 RN 容器工程的约定目录）。iOS / Android / Harmony 三端共用同一套 Mpx 源码与编译配置，差异通过 mode 与条件编译（.ios.mpx / .android.mpx / .harmony.mpx）处理。

跨端输出 React Native

Mpx 已支持将同一套基于微信增强语法编写的业务源码输出为 React Native 应用，覆盖 iOS、Android 与 Harmony 三类运行环境。RN 输出会尽量保留 Mpx 原有的开发体验，包括单文件组件、数据响应、组合式 API、条件编译、基础组件、样式编译、路由和 @mpxjs/api-proxy 环境 API 适配等能力。

需要特别说明的是，Mpx 对 Harmony 的支持属于 React Native 输出链路的一部分：开发者使用 harmony 作为编译目标时，Mpx 负责生成可被 Harmony 侧 React Native / RNOH 工程消费的 JS 与资源产物；原生工程创建、打包、签名和发布仍由对应的 Harmony RN 容器与工具链完成。这意味着 Harmony 不是一套独立的小程序输出形态，而是与 iOS、Android 并列的 RN 运行目标。

在 RN 平台（ios / android / harmony）中，文件维度条件编译也提供兜底逻辑：当 android 或 harmony 目标没有命中对应平台文件时，会自动兜底查找 .ios 文件。因此在多数业务场景下可以先编写一份 RN 通用实现（如 index.ios.mpx），再针对 Android 或 Harmony 的差异补充 .android.mpx / .harmony.mpx 文件。更多内容可查看 RN 快速开始 和 RN 平台文件兜底逻辑。

使用示例

<template>
  <!--动态样式-->
  <view class="container" wx:style="{{dynamicStyle}}">
    <!--数据绑定-->
    <view class="title">{{title}}</view>
    <!--计算属性数据绑定-->
    <view class="title">{{reversedTitle}}</view>
    <view class="list">
      <!--循环渲染，动态类名，事件处理内联传参-->
      <view wx:for="{{list}}" wx:key="id" class="list-item" wx:class="{{ {active:item.active} }}"
            bindtap="handleTap(index)">
        <view>{{item.content}}</view>
        <!--循环内部双向数据绑定-->
        <input type="text" wx:model="{{list[index].content}}"/>
      </view>
    </view>
    <!--自定义组件获取实例，双向绑定，自定义双向绑定属性及事件-->
    <custom-input wx:ref="ci" wx:model="{{customInfo}}" wx:model-prop="info" wx:model-event="change"/>
    <!--动态组件，is传入组件名字符串，可使用的组件需要在json中注册，全局注册也生效-->
    <component is="{{current}}"></component>
    <!--显示/隐藏dom-->
    <view class="bottom" wx:show="{{showBottom}}">
      <!--模板条件编译，__mpx_mode__为框架注入的环境变量，条件判断为false的模板不会生成到dist-->
      <view wx:if="{{__mpx_mode__ === 'wx'}}">wx env</view>
      <view wx:if="{{__mpx_mode__ === 'ali'}}">ali env</view>
      <!-- RN 输出时 __mpx_mode__ 可取 ios / android / harmony -->
      <view wx:if="{{__mpx_mode__ === 'harmony'}}">harmony env</view>
    </view>
  </view>
</template>

<script>
  import { createPage } from '@mpxjs/core'

  createPage({
    data: {
      // 动态样式和类名也可以使用computed返回
      dynamicStyle: {
        fontSize: '16px',
        color: 'red'
      },
      title: 'hello world',
      list: [
        {
          content: '全军出击',
          id: 0,
          active: false
        },
        {
          content: '猥琐发育，别浪',
          id: 1,
          active: false
        }
      ],
      customInfo: {
        title: 'test',
        content: 'test content'
      },
      current: 'com-a',
      showBottom: false
    },
    computed: {
      reversedTitle () {
        return this.title.split('').reverse().join('')
      }
    },
    watch: {
      title: {
        handler (val, oldVal) {
          console.log(val, oldVal)
        },
        immediate: true
      }
    },
    handleTap (index) {
      // 处理函数直接通过参数获取当前点击的index，清晰简洁.
      this.list[index].active = !this.list[index].active
    },
    onReady () {
      setTimeout(() => {
        // 更新数据，同时关联的计算属性reversedTitle也会更新
        this.title = '你好，世界'
        // 此时动态组件会从com-a切换为com-b
        this.current = 'com-b'
      }, 1000)
    }
  })
</script>

<script type="application/json">
  {
    "usingComponents": {
      "custom-input": "../components/custom-input",
      "com-a": "../components/com-a",
      "com-b": "../components/com-b"
    }
  }
</script>

<style lang="stylus">
  .container
    position absolute
    width 100%
</style>

更多示例请查看官方示例项目

设计思路

Mpx的核心设计思路为增强，不同于业内大部分小程序框架将web MVVM框架迁移到小程序中运行的做法，Mpx以小程序原生的语法和技术能力为基础，借鉴参考了主流的web技术设计对其进行了扩展与增强，并在此技术上实现了以微信增强语法为base的同构跨平台输出，该设计带来的好处如下：

• 良好的开发体验：在方便使用框架提供的便捷特性的同时，也能享受到媲美原生开发的确定性和稳定性，完全没有框架太多坑，不如用原生的顾虑；不管是增强输出还是跨平台输出，最终的dist代码可读性极强，便于调试排查；
• 极致的性能：得益于增强的设计思路，Mpx框架在运行时不需要做太多封装抹平转换的工作，框架的运行时部分极为轻量简洁，压缩+gzip后仅占用14KB；配合编译构建进行的包体积优化和基于模板渲染函数进行的数据依赖跟踪，Mpx框架在性能方面做到了业内最优(小程序框架运行时性能评测报告)；
• 完整的原生兼容：同样得益于增强的设计思路，Mpx框架能够完整地兼容小程序原生技术规范，并且做到实时跟进。在Mpx项目中开发者可以方便地使用业内已有的小程序生态，如组件库、统计工具等；原生开发者们可以方便地进行渐进迁移；甚至可以将框架的跨平台编译能力应用在微信的原生小程序组件当中进行跨平台输出。

生态周边

开发团队

核心团队: hiyuki, Blackgan3, anotherso1a, CommanderXL, yandadaFreedom, wangxiaokou, OnlyProbie, pagnkelly, thuman, theniceangel, dolymood

外部贡献者：sky-admin, pkingwa, httpsxiao, lsycxyj, okxiaoliang4, tangminFE, codepan, zqjimlove, xuehebinglan, zhaoyiming0803, ctxrr, JanssenZhang, heiye9, lj0812, SuperHuangXu, twtylkmrh, NineSwordsMonster

成功案例

微信小程序

其他平台小程序：

更多案例，若你也在使用Mpx框架开发小程序，并想分享给大家，请填在此issue中。

交流

提供 微信群 / QQ群 两种交流方式

添加MPX入群小助手等待受邀入群

[微信]

扫码进入QQ群

[QQ]

图片因github网络问题导致不可见的朋友可以点击该链接：https://s.didi.cn/rod