Hippy 跨端开发框架

English | 简体中文 | 官网 | 文章专栏 | QQ群：784894901

💡 介绍

Hippy 是一个新生的跨端开发框架，目标是使开发者可以只写一套代码就直接运行于多个平台（iOS、Android 和 Web等）。Hippy 的设计是面向传统 Web 开发者的，特别是之前有过 React 和 Vue 开发经验的开发者用起来会更为顺手，Hippy 致力于让前端开发跨端 App 更加容易。

到目前为止，腾讯公司内已经有 27+ 款主流 App 在使用 Hippy 框架，包括手机QQ、QQ浏览器、腾讯视频、QQ音乐、腾讯新闻等，每日触达数亿用户。

https://user-images.githubusercontent.com/12878546/126472924-650c3ca1-62ca-4bc1-bb6e-739dbe21a277.mp4

💯 特征

• 为传统 Web 前端开发者设计，官方支持 React 和 Vue 两种主流前端框架。
• 不同的平台保持了相同的接口。
• 通过 JS 引擎 binding 模式实现的前端-终端通讯，具备超强性能。
• 提供了高性能的可复用列表。
• 皆可平滑迁移到 Web 浏览器。
• 完整支持 Flex 的布局引擎。

🔨 开始

准备环境

确保你本地已经安装 git 和 npm 。

运行 git clone https://github.com/Tencent/Hippy.git，然后在项目根目录运行 npm install。

Hippy 仓库使用 git-lfs 来管理 so,gz,otf 文件, 请确保你已经安装 git-lfs。

macOS 用户需要以下软件：

• Xcode 和 iOS SDK: 用以编译 iOS 终端 app。
• Android Studio 和 NDK: 用以编译 Android app。
• Node.JS: 用以运行前端编译脚本。

我们推荐使用 homebrew 来安装依赖。

Windows 用户者需要以下软件:

• Android Studio 和 NDK: 用以编译 Android app。
• Node.JS: 用以运行前端编译脚本。

Windows 用户受条件所限，暂时无法进行 iOS app 开发。

使用 JS 范例来构建 iOS App

我们推荐 iOS 开发者使用模拟器来进行开发和调试工作。当然如果你熟悉 iOS 开发，也可以通过修改配置将 Hippy app 安装到 iPhone 手机上。

1. 在根目录运行 npm run init。

   该命令由 npm install && npx lerna bootstrap && npm run build 组成。

   npm install：安装项目构建脚本的依赖。

   npx lerna bootstrap：安装前端每一个 package 依赖。（Hippy 采用 Lerna 管理多 JS SDK 包仓库，如果出现 lerna command is not found, 先执行 npm install lerna -g 全局安装 Lerna。）

   npm run build：编译每一个 JS SDK 包。

2. 选择一个前端范例项目来进行编译，在项目根目录运行 npm run buildexample [hippy-react-demo|hippy-vue-demo]。

3. 启动 Xcode 并且开始编译终端 App：open examples/ios-demo/HippyDemo.xcodeproj。

如果步骤2出现错误，可以先 cd 到 examples hippy-react-demo 或者 hippy-vue-demo 目录下，执行 npm install --legacy-peer-deps，提前将 demo 的 NPM 包依赖先安装好。

更多信息请参考 iOS SDK 集成。

使用 JS 范例来构建 Android App

我们推荐 Android 开发者使用真机，因为 Hippy 使用的 X5 JS 引擎没有提供 x86 的库以至于无法支持 x86 模拟器，同时使用 ARM 模拟器也比较慢。

在开始前请确认好 SDK 和 NDK 都安装了范例的指定版本，并且请勿更新编译工具链。

1. 在根目录运行 npm run init。

   该命令由 npm install && npx lerna bootstrap && npm run build 组成。

   npm install：安装项目构建脚本的依赖。

   npx lerna bootstrap：安装前端每一个 package 依赖。（Hippy 采用 Lerna 管理多 JS SDK 包仓库，如果出现 lerna command is not found, 先执行 npm install lerna -g 全局安装 Lerna。）

   npm run build：编译每一个 JS SDK 包。

2. 选择一个前端范例项目来进行编译，在项目根目录运行 npm run buildexample [hippy-react-demo|hippy-vue-demo]。
3. 用 Android Studio 来打开终端范例工程 examples/android-demo。
4. 用 USB 数据线插上你的 Android 手机，需要确认手机已经打开 USB 调试模式（可通过在电脑 Terminal 执行 adb devices 判断手机是否已经连上了电脑）。
5. 运行工程，并安装 APK。

如果步骤2出现错误，可以先 cd 到 examples hippy-react-demo 或者 hippy-vue-demo 目录下，执行 npm install --legacy-peer-deps，提前将 demo 的 NPM 包依赖先安装好。

如果 Android Studio 报了这个错误 No toolchains found in the NDK toolchains folder for ABI with prefix: mips64el-linux-android，这里有解决办法。

更多信息请参考 Android SDK 集成。

调试前端 Demo

1. 先按照 [使用 JS 范例来构建 iOS App] 和 [使用 JS 范例来构建 Android App] 步骤执行。
2. 根目录执行 npm run init:example [hippy-react-demo|hippy-vue-demo]。
3. 根目录执行 npm run debugexample [hippy-react-demo|hippy-vue-demo] debug。
4. 根目录执行 npm run debugexample [hippy-react-demo|hippy-vue-demo] dev。

你也可以 cd 到 examples/hippy-react-demo 或者 examples/hippy-vue-demo 目录去分别执行 npm run hippy:debug 和 npm run hippy:dev。

在 example 调试模式下，@hippy/react、@hippy/vue 等 npm 模块会直接链接到 packages > [different package] > dist 目录下面的 js 文件(非 node_modules)，所以如果你修改了 packages 下的 JS 源代码并且想让其在 example 中生效，请重新在根目录执行 npm run build。

更多关于调试的说明请浏览 Hippy Debug Document。

构建前端生产环境 Demo

1. 先按照 [使用 JS 范例来构建 iOS App] 和 [使用 JS 范例来构建 Android App] 步骤执行。
2. cd 到 examples hippy-react-demo 或者 hippy-vue-demo 目录。
3. 执行 npm install 安装相应 js demo 的依赖包。
4. 依次执行 npm run hippy:vendor 和 npm run hippy:build 构建出生产模式的 vendor.[android|ios].js 和 index.[android|ios].js。

Hippy 的 Demo 使用 DllPlugin 来分离 common chunk 和 app chunk.

📁 文档

参考 hippy examples 下的代码和浏览官网 hippyjs.org。

📅 更新日志

每个发布版本的详细更新日志会记录在 project release notes。

🧱 项目结构

Hippy
├── examples                          # 前终端范例代码。
│   ├── hippy-react-demo              # hippy-react 前端范例代码。
│   ├── hippy-vue-demo                # hippy-vue 前端范例代码。
│   ├── ios-demo                      # iOS 终端范例代码。
│   └── android-demo                  # Android 终端范例代码。
├── packages                          # 前端 npm 包。
│   ├── hippy-debug-server            # Hippy 的前终端调试服务。
│   ├── hippy-react                   # Hippy 的 React 语法绑定。
│   ├── hippy-react-web               # hippy-react 转 Web 的库。
│   ├── hippy-vue                     # Hippy 的 Vue 语法绑定。
│   ├── hippy-vue-css-loader          # 用来将 CSS 文本转换为 JS 语法树以供解析的 Webpack loader。
│   ├── hippy-vue-loader              # Fork 自 vue-loader 并针对 hippy 做定制化。
│   ├── hippy-vue-native-components   # hippy-vue 中浏览器中所没有的，额外的，终端定制组件。
│   ├── hippy-vue-router              # 在 hippy-vue 中运行的 vue-router。
│   └── types                         # 全局 Typescript 类型
├── ios
│   └── sdk                           # iOS SDK。
├── android
│   ├── support_ui                    # Android 终端实现的组件。
│   └── sdk                           # Android SDK。
├── core                              # C++ 实现的 JS 模块，通过 Binding 方式运行在 JS 引擎中。
├── docker                            # 发布 Native 的 Docker 镜像和构建脚本
├── layout                            # Hippy 布局引擎。
├── static                            # 全局静态资源存储目录。
└── scripts                           # 项目编译脚本。

🤝 贡献

欢迎开发人员为腾讯的开源做出贡献，我们将持续激励他们并感谢他们。我们提供了腾讯对开源贡献的说明，每个项目的具体贡献规则由项目团队制定。开发人员可以选择适当的项目并根据相应的规则参与。腾讯项目管理委员会将定期汇报合格的贡献者，奖项将由官方联络人颁发。在发起 Pull Request 或者 issue 前, 请确保你已经阅读 Contributing Guide。

所有曾经参与 Hippy 项目贡献的开发者都会记录在 Contributors 和 Authors File 。

❤️ 追星数

📄 许可协议

Hippy 遵守 Apache-2.0 licensed 协议。

🔗 链接

Hippy 生态

Taitank 布局引擎