# 集成指南
## 前置准备
- 权限开通：提供飞书账号，联系飞书项目经理开通权限，并获取服务域名
- 原生集成插件下载：[飞书原生集成工具IDE下载更新文档](http://feishu.feishu.cn/docx/OtX9dXCqYoA9njxawAKcnTd7nob)
## 工程创建指南
### 账号登录
1. 从上面列表中下载对应的飞书原生集成工具插件安装，并重启Android studio
2. 打开Android studio，进入功能列表页
1. 功能列表页展示当前账号所有的工程。
1. 点击工程，可进入代码开发
3. 在未登录的情况下，Android有两个入口可触发登录流程
1. 工程列表页，点击「New Feishu Project」触发登录流程，
1. 工程列表页，打开已有工程，侧边栏点击「飞书原生集成工具」后，点击「登录飞书」触发登录流程
4. 触发登录流程后，首先填写服务域名。具体域名可联系对应飞书技术支持同学获取
4. 域名填写后，点击「校验域名」
1. 校验成功后可进行下一步；
1. 校验失败时，需要重新填写正确的域名
6. 域名校验通过后，登录开通权限的飞书账号。飞书账号登录成功后点击“下一步”
7. 下拉选择对应要交付的客户名称及客户channel。
### 新工程创建
1. 登录完成后，在工程列表页，点击「新建飞书工程」新建工程
1. 工程列表页展示当前域名+飞书账号下的所有工程。
1. 同一个工程可以推送给多个客户（channel)，以当前登录的客户为准。可在右上角点击切换客户
1. 点击具体存储路径，可查看具体文件夹中的工程内容。点击可进入Android Studio中进行代码开发
2. 第一步：选择基线版本、需要开发调用的的组件
2. 未选择的组件，可在后续开发时继续获取
4. 第二步：填写工程名称及存储路径等基本信息
4. 同一存储路径下，工程名称不可重复
6. 创建完成后进入到工程内
1. 左侧展示已经创建出来的工程内容；
1. 点击右侧「飞书原生集成工具」，可以查看具体的组件能力
7. 工程创建完成后，支持切换客户及channel，支持退出登录
warning
注意：飞书原生集成开发模式分为在线模式、离线模式两种，根据登录的账号、域名、客户判断。**离线模式和在线模式不可混用。**
- 不可在离线工程里面，切换在线模式的客户及channel
- 不可在在线工程里面，切换离线模式的客户及channel
### 历史工程迁移
历史工程需要按照文档迁移，迁移后才可使用本地构建相关功能[历史工程迁移](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/native-integration/open-scene-introduction/android-development/historical-project-migration)
飞书原生集成根据客户的实际情况，提供了多种构建形式
- 在线模式：开发阶段，通过集成单将一个或多个本地模块、远端组件，在飞书环境下构建出调试包，支持本地构建、远端构建，支持自主打客户包调试，支持单工程支持交付多家客户，并且可提前构建含客户全部SDK的测试包，提前避免多SDK冲突。开发完成后，基于集成单将组件发布到飞书环境，在飞书环境完成最终飞书包构建。
- 离线模式：开发阶段，通过飞书集成工具提供的服务，在开发者工程完成开发者部分代码的构建，并在本地环境完成与飞书母包的融合，产出最终的飞书包。开发完成，在客户私有化环境，自行搭建 CI 流程完成最终飞书包构建。
## 在线模式构建
### **【组件列表】**
1. 组件分为协议组件、能力组件
1. 协议组件：客户提供实现，飞书调用。此组件可以获取，并发布
1. 能力组件：飞书提供实现，客户调用 **。** 此组件不可发布
2. 当基线组件有新版本时，点击 **升级** ，会升级到当前组件最新的版本号
2. 组件支持 **模块管理** ，可以将组件关联到本地模块中，整体一起集成构建
1. 默认为空，点击 **添加本地模块** 可创建模块
1. **勾选** 模块并确认保存，即可将组件关联到本地模块上；**取消勾选**，则组件不再关联到对应的本地模块上。组件与本地模块的关联关系为多对多
1. 已经勾选关联的本地模块，支持点击 **创建实现类**，在模块子工程创建协议的实现类，用来添加开发者实现
1. 此处不支持删除已创建的本地模块。若有删除诉求，可直接在代码里面操作删除，从而避免在此处直接删除影响代码开发
4. 点击 **查看本地模块，** 可以查看所有创建完成的本地模块，以及模块下关联的所有组件
5. 点击 **集成** 可以将所有已经开发的一个或多个本地模块、远端组件创建为集成单。本质为一组模块的版本组合，后续可基于该组合完成构建
1. 输入集成单名称，选择兼容的飞书版本范围，选择要集成的本地模块、远端组件
1. 支持自定义已选择的本地模块名称，支持删除已选择的本地模块
1. 集成单创建完成后，可直接 **去构建**，进入**集成单列表** - **构建详情**页；也可取消，后续按需构建
### 【集成单列表】
1. 所有创建的集成单，都会进入到 **集成单列表**
1. 点击 **集成单详情**，可以查看集成单内容，包含集成单名称、兼容的飞书版本、集成的远端组件
1. 支持基于集成单内的组件，去构建测试包。点击 **去构建**，进入 **构建详情** 页面
1. 点击 **编辑**，支持编辑修改集成单名称、兼容飞书版本、远端组件
1. 验证通过的集成单组件，可以点击 **发布** 去发布所有组件。发布成功的组件会进入到 **发布列表**，同时会进入到[原生集成控制台](https://delivery.feishu.cn/page/console/micro-app/alchemy-web/product-list/list?pageNum=1)，用于后续的出包配置测试交付
3. 点击 **构建详情** ，可选择参数发起构建测试包
1. 包版本：构建的组件支持的飞书测试包版本
1. 包类型：32位、64位
1. 构建环境：选择所需要构建测试包的客户环境
1. 其他SDK：客户会集成其他家的SDK，可能与当前厂商功能互斥。可通过构建带客户所有SDK的测试包验证
1. 加速构建：
1. 开启加速构建时，会使用老代码构建，但是会提升构建速度到分钟级别
1. 关闭加速构建时，会使用最新代码构建，但是会降低构建速度到小时级别
所有参数选择完成后，点击 **本地构建** 触发构建测试包。构建列表会缓存最近两周构建的测试包数据，开发者可按需下载；点击 **查看详情** 可查看构建的测试包的具体参数配置
### **【发布列表】**
1. **集成单详情** 页面里点击 **发布** 并发布成功的组件，会进入到 **发布列表**，支持按照发布状态筛选
1. 发布成功：安全合规、兼容性检测通过的组件，显示发布成功；
1. 发布中：操作发布的组件，飞书侧会进行自动化安全合规、兼容性检测，检测过程中为发布中状态
1. 发布失败：安全合规、兼容性检测不通过的组件，显示发布失败，点击发布详情里的「检测不通过」支持查看具体不通过的代码原因
注意：发布中、发布失败状态的组件是集成单上线前发布的历史组件；集成单上线后，发布列表只展示发布成功的组件，不展示发布中、发布失败的过程数据。
发布成功的组件会进入到[原生集成控制台](https://delivery.feishu.cn/page/console/micro-app/alchemy-web/product-list/list?pageNum=1)，用于组装产品及交付客户等后续流程
### 【调试】
本地构建包为可调试的包。通过 Android Studio 的 Attach Debugger to Android Process 功能可断点调试本地的代码。勾选 Show all processes 然后再选中相应进程即可。
## 离线模式构建
离线模式面向私有化客户，如有需要，请联系飞书项目经理
1. 组件列表分为协议组件、能力组件
1. 协议组件：客户提供实现，飞书调用。
1. 能力组件：飞书提供实现，客户调用 **。**
1. 当基线组件有新版本时，点击 **升级** ，会升级到当前组件最新的版本号
1. 组件支持 **模块管理** ，可以将组件关联到本地模块中，整体一起集成构建
1. 默认为空，点击 **添加本地模块** 可创建模块
1. **勾选** 模块并确认保存，即可将组件关联到本地模块上；**取消勾选**，则组件不再关联到对应的本地模块上。组件与本地模块的关联关系为多对多
1. 此处不支持删除已创建的本地模块。若有删除诉求，可直接在代码里面操作删除，从而避免在此处直接删除影响代码开发
4. 组件获取并开发完成后，可以根据包类型（Debug包/Release包）、包位数（32位/64位）构建飞书母包，并进行自动化冲突检测
1. 点击「开始构建」支持根据选项构建飞书母包，构建后的包会在客户的环境下进行集成
1. 点击「冲突检测」会进行自动化的冲突检测
构建出来的飞书母包，会在客户的环境下进行后续的集成、测试等交付流程