阿里百川HotFix的接入步骤

2016-12-20 本文已影响2596人梦止惰

一、注册阿里百川账号

1，如果有淘宝账号可以直接登陆，没有就申请
2，申请开发者（有个人开发者和企业开发者）

二、创建百川应用

1，如果您已经创建过百川应用，可以直接在指定应用上使用HotFix产品。
2，如果您尚未创建过百川应用，点击创建应用

Paste_Image.png

三、申请产品权限

Paste_Image.png

四、android studio的接入

1，添加gradle坐标版本依赖：

dependencies {
compile 'com.taobao.android:alisdk-hotfix:1.4.0'
}

2，
gradle远程仓库依赖, 打开项目找到app的build.gradle文件，添加如下配置：
添加maven仓库地址：

repositories {
maven {
url
"http://repo.baichuan-android.taobao.com/content/groups/BaichuanRepositories"
}
flatDir { dirs 'libs'}
}

注意事项：
1.1，1.4.0版本会传递性依赖utdid这个sdk, 所以不需要重复依赖.但是另一方面其它阿里系SDK也可能依赖了utdid这个SDK, 如果编译期间报utdid重复, 所以此时进行如下处理即可, 关闭传递性依赖:

compile ('com.taobao.android:alisdk-hotfix:1.4.0') {
transitive = false
}

2.1,如若仓库访问失败, 那么用本地依赖的方式进行依赖, SDK下载见“1.1 Android SDK及工具下载”节, 首先复制下载SDK文件夹下的.aar和.jar到libs目录下, 然后更新模块下的build.gradle文件

repositories {
...
flatDir {
dirs 'libs'
}
}
dependencies {
compile files('libs/utdid4all-1.1.5.3_proguard.jar')
compile(name:'alisdk-hotfix-1.4.0', ext:'aar')
}

3,HotFix SDK使用到以下权限

<! -- 网络权限 -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<! -- 外部存储读权限 -->
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

4, 配置AndroidManifest文件
在AndroidManifest.xml中间的application节点下添加如下配置：

<meta-data android:name="com.taobao.android.hotfix.APPKEY" android:value="your-app-key" />
<meta-data
android:name="com.taobao.android.hotfix.APPSECRET"
android:value="your-app-secret" />
<meta-data
android:name="com.taobao.android.hotfix.RSASECRET"
android:value="your-rsa-secret" />

4.1,获取APPKEY，APPSECRET，RSASECRET
4.1.1,选择你要使用的应用

Paste_Image.png

4.1.2，这里就得到了AppKey和AppSecret

Paste_Image.png

4.1.3，点击阿里百川HotFix,就进入到下面的这个界面

Paste_Image.png

在这个页面，选择你要用的应用，有android和ios，选择管理，appID也是在这里获取的，下面我们会用到

Paste_Image.png

五、SDK的使用范例

一般我们都写在Application：

    public static String appVersion;   
    public static String appId;    
   @Override  
  public void onCreate() {       
       super.onCreate();       
       initApp();       
       initHotfix();  
  }
private void initApp() {  
    this.appId = "82875-1"; //替换掉自己应用的appId   
    try {        
     this.appVersion = this.getPackageManager().getPackageInfo(this.getPackageName(), 0).versionName;  
      } catch (Exception e) {       
         this.appVersion = "1.0.0";   
 }}
/** * 建议在Application.onCreate方法中执行initialize和queryNewHotPatch操作, 
尽可能早的执行 * 本demo只是为了测试的方便, 所以把这两个操作放在了Activity中 */
private void initHotfix() {   
   //此处不再需要调用queryNewHotPatch方法, initialize方法内部会调用queryNewHotPatch方法.                        
       HotFixManager.getInstance().setContext(this)          
                                  .setAppVersion(appVersion)          
                                  .setAppId(appId)         
                                  .setAesKey(null)          
                                  .setSupportHotpatch(true)      
                                  .setEnableDebug(true)         
                                  .setPatchLoadStatusStub(new PatchLoadStatusListener() {     
                @Override               
     public void onload(final int mode, final int code, final String info, final int handlePatchVersion) {     
               // 补丁加载回调通知                
                 if (code == PatchStatusCode.CODE_SUCCESS_LOAD) {              
                                Log.e("TAG","--------更新成功---------->");                     
                                // TODO: 10/24/16 表明补丁加载成功                
                         } else if (code == PatchStatusCode.CODE_ERROR_NEEDRESTART) {       
                              Log.e("TAG","--------更新错误---------->");                     
                           // TODO: 10/24/16 表明新补丁生效需要重启. 
业务方可自行实现逻辑, 提示用户或者强制重启, 建议: 用户可以监听进入后台事件, 然后应用自杀           
                                    } else if (code == PatchStatusCode.CODE_ERROR_INNERENGINEFAIL) {     
                                    Log.e("TAG","--------清空---------->");                    
                      // 内部引擎加载异常, 推荐此时清空本地补丁, 但是不清空本地版本号, 防止失败补丁重复加载                        
                 HotFixManager.getInstance().cleanPatches(false);              
                                               } else {                 
                        Log.e("TAG","--------其他---------->");                
                           // TODO: 10/25/16 其它错误信息, 查看PatchStatusCode类说明            
                                                  }       
                        }    
        }).initialize();}

六、生成补丁

一）先看工程

Paste_Image.png

1，我在该目录下创建了一个patchtool_demo的文件夹，里面放了一个BCFixPatchTools-XXX.jar，如果没有该架包，请去官方网站下载，如果没有找到，它的官方demo里面有

Paste_Image.png

2，这两个apk，old.apk是修改前的，new.apk是修改后的，这里的apk最好不要用运行时的apk

二）怎么生成baichuan-hotfix-patch.jar

1，在patchtool_demo 下运行cmd命令
2，参数说明

-c, -cmd: 值为patch: 打补丁命令值为help: 查看使用说明
-s, -src_apk：填写本地的原始APK（有问题的APK）. 必选
-f, -fixed_apk：已经修复过该问题APK. 必选
-w, -wp：输出patch的路径, 最后如果打补丁成功会在wp目录下自动创建的hotfix-working目录生成baichuan-hotfix-patch.jar补丁文件. 必选
-k, -sign_file_url：本地的签名文件的路径，不输入则不做签名. 可选
-p, -sign_file_pass: 证书文件的密码, 可选
-a, -sign_alias: 证书的别名. 可选
-e, -sign_alias_pass: 证书别名的密码. 可选
-y, -aes_key: 自定义aes秘钥, 必须是16位. 可选
-l, -filterClassFilePath：本地的白名单类列表文件的路径，放进去的类不会再计算patch，文件格式: 一行一个类名. 可选
3，命令例子示范：

java -jar BCFixPatchTools-1.3.0.jar -c patch -s old.apk -f new .apk -w patch-out -k test.keystore -p test123 -a test123 -e test123 -y 1234567891234567 -l filterClass.txt

最终就会生成一个patch-out文件夹，补丁就在该文件夹下