Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 6966c9c

Browse filesBrowse files
committed
docs(readme): update document to 1.2.2
1 parent cd92116 commit 6966c9c
Copy full SHA for 6966c9c

File tree

Expand file treeCollapse file tree

3 files changed

+44
-7
lines changed
Filter options
Expand file treeCollapse file tree

3 files changed

+44
-7
lines changed

‎README.md

Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
### 一键集成SDK (推荐使用) [![Download](https://api.bintray.com/packages/simsun/maven/tinkerpatch-android-sdk/images/download.svg) ](https://bintray.com/simsun/maven/tinkerpatch-android-sdk/_latestVersion)
77
无需修改项目结构,集成简单、方便,
88

9-
[集成文档](docs/tinkerpatch-android-sdk.md)
9+
[集成文档](docs/tinkerpatch-turnkey-sdk.md)
1010

1111

1212

1313

1414
### 可定制化SDK [![Download](https://api.bintray.com/packages/simsun/maven/tinkerpatch-sdk/images/download.svg) ](https://bintray.com/simsun/maven/tinkerpatch-sdk/_latestVersion)
1515
需要修改项目结构代码,定制性较高,
1616

17-
[集成文档](docs/tinkerpatch-sdk.md)
17+
[集成文档](docs/tinkerpatch-custom-sdk.md)
1818

1919

2020

‎docs/tinkerpatch-sdk.md renamed to ‎docs/tinkerpatch-custom-sdk.md

Copy file name to clipboardExpand all lines: docs/tinkerpatch-custom-sdk.md
+3Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# 定制化SDK 接入
22

3+
**作者已不再维护此SDK,建议使用 一键集成SDK**
4+
5+
36
这里只是针对 TinkerPatch SDK的使用说明,对于 Tinker 的基本用法,可参考[ Tinker接入指南](https://github.com/Tencent/tinker/wiki/Tinker-%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97)
47

58
## 第一步 添加gradle依赖

‎docs/tinkerpatch-android-sdk.md renamed to ‎docs/tinkerpatch-turnkey-sdk.md

Copy file name to clipboardExpand all lines: docs/tinkerpatch-turnkey-sdk.md
+39-5Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ buildscript {
1717
}
1818
dependencies {
1919
// TinkerPatch 插件
20-
classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:1.1.7"
20+
classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:1.2.2"
2121
}
2222
}
2323
```
@@ -31,8 +31,8 @@ buildscript {
3131
```
3232
dependencies {
3333
// 若使用annotation需要单独引用,对于tinker的其他库都无需再引用
34-
provided("com.tinkerpatch.tinker:tinker-android-anno:1.7.11")
35-
compile("com.tinkerpatch.sdk:tinkerpatch-android-sdk:1.1.7")
34+
provided("com.tinkerpatch.tinker:tinker-android-anno:1.9.2")
35+
compile("com.tinkerpatch.sdk:tinkerpatch-android-sdk:1.2.2")
3636
}
3737
```
3838
**注意,若使用 annotation 自动生成 Application, 需要单独引入 Tinker 的 tinker-android-anno 库。除此之外,我们无需再单独引入 tinker 的其他库。**
@@ -48,13 +48,18 @@ apply from: 'tinkerpatch.gradle'
4848

4949
```
5050
tinkerpatchSupport {
51-
tinkerpatchSupport {
5251
/** 可以在debug的时候关闭 tinkerPatch **/
5352
tinkerEnable = true
5453
5554
/** 是否使用一键接入功能 **/
5655
reflectApplication = true
5756
57+
/** 是否开启加固模式,只有在使用加固时才能开启此开关 **/
58+
protectedApp = false
59+
60+
/** 补丁是否支持新增 Activity **/
61+
supportComponent = false
62+
5863
autoBackupApkPath = "${bakPath}"
5964
6065
/** 在tinkerpatch.com得到的appKey **/
@@ -84,7 +89,8 @@ tinkerpatchSupport {
8489
| baseProguardMappingFile | "" | `基准包的 Proguard mapping.txt 文件路径, 对应 tinker 插件 applyMapping 参数`;在编译新的 apk 时候,我们希望通过保持基准 apk 的 proguard 混淆方式,从而减少补丁包的大小。这是强烈推荐的,编译补丁包时,我们推荐输入基准 apk 生成的 mapping.txt 文件。 |
8590
| baseResourceRFile | "" | `基准包的资源 R.txt 文件路径, 对应 tinker 插件 applyResourceMapping 参数`;在编译新的apk时候,我们希望通基准 apk 的 R.txt 文件来保持 Resource Id 的分配,这样不仅可以减少补丁包的大小,同时也避免由于 Resource Id 改变导致 remote view 异常。 |
8691
| protectedApp | false | 是否开启支持加固,**注意:只有在使用加固时才能开启此开关**|
87-
92+
| supportComponent | false | 是否开启支持在补丁包中动态增加Activity |
93+
| backupFileNameFormat | '${appName}-${variantName}' | 格式化命名备份文件 **这里请使用单引号** |
8894

8995
**一般来说,我们无需修改引用 android 的编译配置,也不用修改 tinker 插件原来的配置**。针对特殊需求,具体的参数含义可参考 Tinker 文档:[Tinker 接入指南](https://github.com/Tencent/tinker/wiki/Tinker-%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97).
9096

@@ -266,3 +272,31 @@ TinkerPatch 的使用步骤非常简单,一般来说可以参考以下几个
266272

267273
1. 不能提前导入类;
268274
2. 在art平台若要编译oat文件,需要将内联取消。
275+
276+
### 3. 重命名备份文件
277+
278+
```
279+
/**
280+
* (可选)重命名备份文件的格式化字符串,默认为'${appName}-${variantName}'
281+
*
282+
* Available vars:
283+
* 1. projectName
284+
* 2. appName
285+
* 3. packageName
286+
* 4. buildType
287+
* 5. versionName
288+
* 6. versionCode
289+
* 7. buildTime
290+
* 8. fileSHA1
291+
* 9. flavorName
292+
* 10. variantName
293+
*
294+
* default value: '${appName}-${variantName}'
295+
* Note: plz use single-quotation wrapping this format string
296+
** /
297+
backupFileNameFormat = '${appName}-${variantName}'
298+
```
299+
300+
### 4. 对新增Activity的支持
301+
302+
基础包必须设置`supportComponent=true`

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.