集成腾讯bugly的热修复功能sdk步骤

本文转载自：点击打开链接

首先为什么要集成bugly热修复。市面上有其他的热修复框架，为什么就用bugly?这里给出2张图大家就明白了。

引用腾讯bugly官网的一段话：
•无需关注Tinker是如何合成补丁的
•无需自己搭建补丁管理后台
•无需考虑后台下发补丁策略的任何事情
•无需考虑补丁下载合成的时机，处理后台下发的策略
•我们提供了更加方便集成Tinker的方式
•我们提供应用升级一站式解决方案
进入正题：接入流程主要是以下几个步骤：•打基准包安装并上报联网（注：填写唯一的tinkerId）
•对基准包的bug修复（可以是Java代码变更，资源的变更）
•修改基准包路径、填写补丁包tinkerId、mapping文件路径、resId文件路径
•执行tinkerPatchRelease打Release版本补丁包
•选择app/build/outputs/patch目录下的补丁包并上传（注：不要选择tinkerPatch目录下的补丁包，不然上传会有问题）
•编辑下发补丁规则，点击立即下发
•重启基准包，请求补丁策略（SDK会自动下载补丁并合成）
•再次重启基准包，检验补丁应用结果

1：新建基准包工程项目(人为制造有BUG的app版本)

[java] view plain copy
1.btn.setOnClickListener(new View.OnClickListener() {

2. @Override
3. public void onClick(View view) {
   4./ String str = LoadBugClass.getBugString();
4. String str = BugClass.bug();
5. Toast.makeText(MainActivity.this,str,Toast.LENGTH_SHORT).show();;
6. }
7. });

[java] view plain copy
1.public class BugClass {

3. public static String bug(){
4. String str = null;
5. int str_length = str.length();
6. return "this is bug class";
7. }
   8.}
   这个可以看出点击一个按钮会报空指针异常。
   2：接着就是配置相关属性和添加一个插件依赖了。

官方教程地址：点击打开链接

下面也给出我自己配置的过程。

首先在最外层的build.gradle文件中添加依赖,看下图：

其次新建sampleapplication和sampleapplicationLike两个java类

[java] view plain copy
1.package com.henry.testappbugly;

2. 3.import android.annotation.TargetApi;
   4.import android.app.Application;
   5.import android.content.Context;
   6.import android.content.Intent;
   7.import android.content.res.AssetManager;
   8.import android.content.res.Resources;
   9.import android.os.Build;
   10.import android.support.multidex.MultiDex;

3. 12.import com.tencent.bugly.Bugly;
   13.import com.tencent.bugly.beta.Beta;
   14.import com.tencent.tinker.loader.app.DefaultApplicationLike;

4. 16./**

5. • Created by W61 on 2016/11/29.
6. */

7. 20.public class SampleApplicationLike extends DefaultApplicationLike {

9. public static final String TAG = "Tinker.SampleApplicationLike";
11. public SampleApplicationLike(Application application, int tinkerFlags,
12. boolean tinkerLoadVerifyFlag, long applicationStartElapsedTime,
13. long applicationStartMillisTime, Intent tinkerResultIntent, Resources[] resources,
14. ClassLoader[] classLoader, AssetManager[] assetManager) {
15. super(application, tinkerFlags, tinkerLoadVerifyFlag, applicationStartElapsedTime,
16. applicationStartMillisTime, tinkerResultIntent, resources, classLoader,
17. assetManager);
18. }
21. @Override
22. public void onCreate() {
23. super.onCreate();
24. // 这里实现SDK初始化，appId替换成你的在Bugly平台申请的appId
25. Bugly.init(getApplication(), "", true);
26. }
29. @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
30. @Override
31. public void onBaseContextAttached(Context base) {
32. super.onBaseContextAttached(base);
33. // you must install multiDex whatever tinker is installed!
34. MultiDex.install(base);
36. // 安装tinker
37. // TinkerManager.installTinker(this); 替换成下面Bugly提供的方法
38. Beta.installTinker(this);
39. }
41. @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
42. public void registerActivityLifecycleCallback(Application.ActivityLifecycleCallbacks callbacks) {
43. getApplication().registerActivityLifecycleCallbacks(callbacks);
44. }

45. 59.}

[java] view plain copy
1.package com.henry.testappbugly;

2. 3.import com.tencent.tinker.loader.app.TinkerApplication;
   4.import com.tencent.tinker.loader.shareutil.ShareConstants;

3. 6./**

4. • Created by W61 on 2016/11/29.
5. */

6. 10.public class SampleApplication extends TinkerApplication {

7. public SampleApplication() {
8. super(ShareConstants.TINKER_ENABLE_ALL, "SampleApplicationLike所在的包名路径",
9. "com.tencent.tinker.loader.TinkerLoader", false);
10. }
    15.}

在在Androidmanifest.xml文件中配置权限及application类名

[java] view plain copy
1.
2.

3. package="com.henry.testappbugly">
6. android:name=".SampleApplication"
7. android:allowBackup="true"
8. android:icon="@mipmap/ic_launcher"
9. android:label="@string/app_name"
10. android:supportsRtl="true"
11. android:theme="@style/AppTheme">
23. android:name="android.support.v4.content.FileProvider"
24. android:authorities="com.tencent.bugly.hotfix.fileProvider"
25. android:exported="false"
26. android:grantUriPermissions="true">
28. android:name="android.support.FILE_PROVIDER_PATHS"
29. android:resource="@xml/provider_paths"/>

42. 43.

在到res目录下：

[java] view plain copy
1.
2.;

7. 
   8.

在到app目录下新建：
[java] view plain copy
1.# you can copy the tinker keep rule at
2.# build/intermediates/tinker_intermediates/tinker_multidexkeep.pro

3. 4.-keep class com.tencent.tinker.loader.** {

4. *;
   6.}

5. 8.-keep class com.tencent.bugly.hotfix.SampleApplication {

6. *;
   10.}

7. 12.-keep public class * implements com.tencent.tinker.loader.app.ApplicationLifeCycle {

8. *;
   14.}

9. 16.-keep public class * extends com.tencent.tinker.loader.TinkerLoader {

10. *;
    18.}

11. 20.-keep public class * extends com.tencent.tinker.loader.app.TinkerApplication {

12. *;
    22.}

13. 24.# here, it is your own keep rules.
    25.# you must be careful that the class name you write won't be proguard
    26.# but the tinker class above is OK, we have already keep for you!

然后在混淆文件.pro中添加这几句代码(bugly都有说明解释)

[java] view plain copy
1.-dontwarn com.tencent.bugly.
2.-keep public class com.tencent.bugly.{*;}

最后就是app目录下的build.gradle文件配置了：

[java] view plain copy
1.apply plugin: 'com.android.application'

2. 3.dependencies {

3. compile fileTree(include: ['*.jar'], dir: 'libs')
4. compile 'com.android.support:appcompat-v7:24.1.1'
6. // 多dex配置
7. compile "com.android.support:multidex:1.0.1"
8. // 集成Bugly热更新aar（灰度时使用方式）
   10.// compile(name: 'bugly_crashreport_upgrade-1.2.0', ext: 'aar')
9. compile "com.tencent.bugly:crashreport_upgrade:1.2.0"
   12.}

11. 15.android {

12. compileSdkVersion 23
13. buildToolsVersion "23.0.2"
15. // 编译选项
16. compileOptions {
17. sourceCompatibility JavaVersion.VERSION_1_7
18. targetCompatibility JavaVersion.VERSION_1_7
19. }
21. // recommend
22. dexOptions {
23. jumboMode = true
24. }
25. // 签名配置
26. signingConfigs {
27. // 签名配置
28. signingConfigs {
29. release {
30. try {
31. storeFile file("./keystore/release.keystore")
32. storePassword "testres"
33. keyAlias "testres"
34. keyPassword "testres"
35. } catch (ex) {
36. throw new InvalidUserDataException(ex.toString())
37. }
38. }
40. debug {
41. storeFile file("./keystore/debug.keystore")
42. }
43. }
44. }
46. defaultConfig {
47. applicationId "com.henry.testappbugly"
48. minSdkVersion 14
49. targetSdkVersion 23
50. versionCode 2
51. versionName "2.0"
53. // 开启multidex
54. multiDexEnabled true
55. // 以Proguard的方式手动加入要放到Main.dex中的类
56. multiDexKeepProguard file("keep_in_main_dex.txt")
57. }
58. buildTypes {
60. release {
61. minifyEnabled true
62. signingConfig signingConfigs.release
63. proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
64. }
65. debug {
66. debuggable true
67. minifyEnabled false
68. signingConfig signingConfigs.debug
69. }
70. }
71. sourceSets {
72. main {
73. jniLibs.srcDirs = ['libs']
74. }
75. }
77. repositories {
78. flatDir {
79. dirs 'libs'
80. }
81. }
83. lintOptions {
84. checkReleaseBuilds false
85. abortOnError false
86. }
    91.}

88. 94.def gitSha() {

89. try {
90. String gitRev = 'git rev-parse --short HEAD'.execute(null, project.rootDir).text.trim()
91. if (gitRev == null) {
92. throw new GradleException("can't get git rev, you should add git to system path or just input test value, such as 'testTinkerId'")
93. }
94. return gitRev
95. } catch (Exception e) {
96. throw new GradleException("can't get git rev, you should add git to system path or just input test value, such as 'testTinkerId'")
97. }
    104.}

99. 107.def bakPath = file("${buildDir}/bakApk/")

100. 109./**

101. • you can use assembleRelease to build you base apk
102. • use tinkerPatchRelease -POLD_APK= -PAPPLY_MAPPING= -PAPPLY_RESOURCE= to build patch
103. • add apk from the build/bakApk
104. */
     114.ext {
105. // for some reason, you may want to ignore tinkerBuild, such as instant run debug build?
106. tinkerEnabled = true
108. // for normal build
109. // old apk file to build patch apk
110. tinkerOldApkPath = "${bakPath}/app-release-1201-09-46-25.apk"
111. // proguard mapping file to build patch apk
112. tinkerApplyMappingPath = "${bakPath}/app-release-1201-09-46-25-mapping.txt"
113. // resource R.txt to build patch apk, must input if there is resource changed
114. tinkerApplyResourcePath = "${bakPath}/app-release-1201-09-46-25-R.txt"
116. // only use for build all flavor, if not, just ignore this field
117. tinkerBuildFlavorDirectory = "${bakPath}/app-release-1201-09-46-25"
     128.}

118. 130.def getOldApkPath() {

119. return hasProperty("OLD_APK") ? OLD_APK : ext.tinkerOldApkPath
     132.}

120. 134.def getApplyMappingPath() {

121. return hasProperty("APPLY_MAPPING") ? APPLY_MAPPING : ext.tinkerApplyMappingPath
     136.}

122. 138.def getApplyResourceMappingPath() {

123. return hasProperty("APPLY_RESOURCE") ? APPLY_RESOURCE : ext.tinkerApplyResourcePath
     140.}

124. 142.def getTinkerIdValue() {

125. return hasProperty("TINKER_ID") ? TINKER_ID : gitSha()
     144.}

126. 146.def buildWithTinker() {

127. return hasProperty("TINKER_ENABLE") ? TINKER_ENABLE : ext.tinkerEnabled
     148.}

128. 150.def getTinkerBuildFlavorDirectory() {

129. return ext.tinkerBuildFlavorDirectory
     152.}

130. 154./**

131. • 更多Tinker插件详细的配置，参考：https://github.com/Tencent/tinker/wiki
132. */
     157.if (buildWithTinker()) {
133. // 依赖tinker插件
134. apply plugin: 'com.tencent.tinker.patch'
135. apply plugin: 'com.tencent.bugly.tinker-support'
137. tinkerSupport {
138. }
140. // 全局信息相关配置项
141. tinkerPatch {
142. oldApk = getOldApkPath() //必选， 基准包路径
144. ignoreWarning = false // 可选，默认false
146. useSign = true // 可选，默认true， 验证基准apk和patch签名是否一致
148. // 编译相关配置项
149. buildConfig {
150. applyMapping = getApplyMappingPath() // 可选，设置mapping文件，建议保持旧apk的proguard混淆方式
151. applyResourceMapping = getApplyResourceMappingPath() // 可选，设置R.txt文件，通过旧apk文件保持ResId的分配
152. tinkerId = "可以是签名版本号字符串等等比如：assdhfkdshfksdhfuksfhuk" // 必选，默认为null
153. }
155. // dex相关配置项
156. dex {
157. dexMode = "jar" // 可选，默认为jar
158. usePreGeneratedPatchDex = true // 可选，默认为false
159. pattern = ["classes*.dex",
160. "assets/secondary-dex-?.jar"]
161. // 必选
162. loader = ["com.tencent.tinker.loader.*",
163. "SampleApplication所在的全路径",
164. ]
165. }
167. // lib相关的配置项
168. lib {
169. pattern = ["lib/armeabi/*.so"]
170. }
172. // res相关的配置项
173. res {
174. pattern = ["res/", "assets/", "resources.arsc", "AndroidManifest.xml"]
175. ignoreChange = ["assets/sample_meta.txt"]
176. largeModSize = 100
177. }
179. // 用于生成补丁包中的'package_meta.txt'文件
180. packageConfig {
181. configField("patchMessage", "tinker is sample to use")
183. configField("platform", "all")
185. configField("patchVersion", "1.0")
186. }
188. // 7zip路径配置项，执行前提是useSign为true
189. sevenZip {
190. zipArtifact = "com.tencent.mm:SevenZip:1.1.10" // optional
191. // path = "/usr/local/bin/7za" // optional
192. }
193. }
195. List flavors = new ArrayList<>();
196. project.android.productFlavors.each { flavor ->
197. flavors.add(flavor.name)
198. }
199. boolean hasFlavors = flavors.size() > 0
200. /**
201. • bak apk and mapping
202. */
203. android.applicationVariants.all { variant ->
204. /**
205. • task type, you want to bak
206. */
207. def taskName = variant.name
208. def date = new Date().format("MMdd-HH-mm-ss")
210. tasks.all {
211. if ("assemble${taskName.capitalize()}".equalsIgnoreCase(it.name)) {
213. it.doLast {
214. copy {
215. def fileNamePrefix = "${project.name}-${variant.baseName}"
216. def newFileNamePrefix = hasFlavors ? "${fileNamePrefix}" : "${fileNamePrefix}-${date}"
218. def destPath = hasFlavors ? file("${bakPath}/${project.name}-${date}/${variant.flavorName}") : bakPath
219. from variant.outputs.outputFile
220. into destPath
221. rename { String fileName ->
222. fileName.replace("${fileNamePrefix}.apk", "${newFileNamePrefix}.apk")
223. }
225. from "${buildDir}/outputs/mapping/${variant.dirName}/mapping.txt"
226. into destPath
227. rename { String fileName ->
228. fileName.replace("mapping.txt", "${newFileNamePrefix}-mapping.txt")
229. }
231. from "${buildDir}/intermediates/symbols/${variant.dirName}/R.txt"
232. into destPath
233. rename { String fileName ->
234. fileName.replace("R.txt", "${newFileNamePrefix}-R.txt")
235. }
236. }
237. }
238. }
239. }
240. }
241. project.afterEvaluate {
242. //sample use for build all flavor for one time
243. if (hasFlavors) {
244. task(tinkerPatchAllFlavorRelease) {
245. group = 'tinker'
246. def originOldPath = getTinkerBuildFlavorDirectory()
247. for (String flavor : flavors) {
248. def tinkerTask = tasks.getByName("tinkerPatch${flavor.capitalize()}Release")
249. dependsOn tinkerTask
250. def preAssembleTask = tasks.getByName("process${flavor.capitalize()}ReleaseManifest")
251. preAssembleTask.doFirst {
252. String flavorName = preAssembleTask.name.substring(7, 8).toLowerCase() + preAssembleTask.name.substring(8, preAssembleTask.name.length() - 15)
253. project.tinkerPatch.oldApk = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-release.apk"
254. project.tinkerPatch.buildConfig.applyMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-release-mapping.txt"
255. project.tinkerPatch.buildConfig.applyResourceMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-release-R.txt"
257. }
259. }
260. }
261. task(tinkerPatchAllFlavorDebug) {
262. group = 'tinker'
263. def originOldPath = getTinkerBuildFlavorDirectory()
264. for (String flavor : flavors) {
265. def tinkerTask = tasks.getByName("tinkerPatch${flavor.capitalize()}Debug")
266. dependsOn tinkerTask
267. def preAssembleTask = tasks.getByName("process${flavor.capitalize()}DebugManifest")
268. preAssembleTask.doFirst {
269. String flavorName = preAssembleTask.name.substring(7, 8).toLowerCase() + preAssembleTask.name.substring(8, preAssembleTask.name.length() - 13)
270. project.tinkerPatch.oldApk = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-debug.apk"
271. project.tinkerPatch.buildConfig.applyMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-debug-mapping.txt"
272. project.tinkerPatch.buildConfig.applyResourceMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-debug-R.txt"
273. }
275. }
276. }
277. }
278. }

280. 306.}

最后run as生成有bug的基准包app
在去腾讯bugly官网将这个基准包上传上去即可。

接下来，制作补丁包。

由于刚才点击按钮报空指针，下面将代码稍做改动如下：

[java] view plain copy

1. protected void onCreate(Bundle savedInstanceState) {
2. super.onCreate(savedInstanceState);
3. setContentView(R.layout.activity_main);
5. btn = (Button) findViewById(R.id.btn);
6. btn.setOnClickListener(new View.OnClickListener() {
7. @Override
8. public void onClick(View view) {
9. String str = LoadBugClass.getBugString();
   10.// String str = BugClass.bug();
10. Toast.makeText(MainActivity.this,str,Toast.LENGTH_SHORT).show();;
11. }
12. });
13. }

[java] view plain copy
1.public class LoadBugClass {

2. /**
3. • 获取bug字符串.
5. • @return 返回bug字符串
6. */
7. public static String getBugString() {
   8.// BugClass bugClass = new BugClass();
8. return "iS OK";
9. }
   11.}
   这样点击按钮就会弹出is ok了不会报错。
   修改配置文件：
   这里注意点，补丁包是基于基准包所生成的patch文件并不是版本升级，所以此处补丁包不需要修改versioncode，versionname

然后双击下图中所指地方：
稍等片刻就会出现下图中类容：
其中的patch_signed_7zip.apk就是补丁包了。将这个补丁包上传到腾讯bugly即可。

注意：上传完补丁包点击了立即下发，就需要重新启动基准包策略。从有bug版本的app到修复有一个时间差的。估计1到2分钟左右才能看到效果。