Merge pull request #562 from Tencent/dev

Update README & Samples

Author: gryamy

.gitignore

@@ -11,6 +11,7 @@
 /gradle/oss-android-template.gradle
 build_macos
 build_ios
+reports
 
 ## compatibility with Xcode 8 and earlier (ignoring not required starting Xcode 9)
 *.xcscmblueprint

README.md

@@ -1,6 +1,6 @@
 ![Matrix-icon](assets/img/readme/header.png)
 
-[![license](http://img.shields.io/badge/license-BSD3-brightgreen.svg?style=flat)](https://github.com/Tencent/matrix/blob/master/LICENSE)[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/matrix/pulls)[![WeChat Approved](https://img.shields.io/badge/Wechat%20Approved-0.6.6-red.svg)](https://github.com/Tencent/matrix/wiki)
+[![license](http://img.shields.io/badge/license-BSD3-brightgreen.svg?style=flat)](https://github.com/Tencent/matrix/blob/master/LICENSE)[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/matrix/pulls)[![WeChat Approved](https://img.shields.io/badge/Wechat%20Approved-0.8.0-red.svg)](https://github.com/Tencent/matrix/wiki)
 
 (中文版本请参看[这里](#matrix_cn))  
 
@@ -169,10 +169,11 @@ At this point, Matrix has been integrated into the app and is beginning to colle
 - **Compatible with Android P.**
 
 ## Getting Started
+***The JCenter repository will stop service on February 1, 2022. So we uploaded Matrix(since 0.8.0) to the MavenCentral repository.***
 
 1. Configure `MATRIX_VERSION` in gradle.properties.
 ``` gradle
-  MATRIX_VERSION=0.6.6
+  MATRIX_VERSION=0.8.0
 ```
 
 2. Add `matrix-gradle-plugin` in your build.gradle:
@@ -225,6 +226,8 @@ At this point, Matrix has been integrated into the app and is beginning to colle
 }
 ```
 
+Matrix gradle plugin could work with Android Gradle Plugin 3.5.0/4.0.0/4.1.0 currently.
+
 5. Implement `DynamicConfig` to change parameters of Matrix.
 ``` java
   public class DynamicConfigImplDemo implements IDynamicConfig {
@@ -289,11 +292,11 @@ You can get more about Matrix output at the wiki [The output of Matrix](https://
 
 #### APK Checker Usage
 
-APK Checker can run independently in Jar ([matrix-apk-canary-0.6.6.jar](https://jcenter.bintray.com/com/tencent/matrix/matrix-apk-canary/0.6.6/matrix-apk-canary-0.6.6.jar)）  mode, usage:
+APK Checker can run independently in Jar ([matrix-apk-canary-0.8.0.jar](https://repo.maven.apache.org/maven2/com/tencent/matrix/matrix-apk-canary/0.8.0/matrix-apk-canary-0.8.0.jar)）  mode, usage:
 
 
 ```shell
-java -jar matrix-apk-canary-0.6.6.jar
+java -jar matrix-apk-canary-0.8.0.jar
 Usages: 
     --config CONFIG-FILE-PATH
 or
@@ -352,7 +355,7 @@ Matrix is under the BSD license. See the [LICENSE](https://github.com/Tencent/Ma
 
 # <a name="matrix_cn">Matrix</a>
 ![Matrix-icon](assets/img/readme/header.png)
-[![license](http://img.shields.io/badge/license-BSD3-brightgreen.svg?style=flat)](https://github.com/Tencent/matrix/blob/master/LICENSE)[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/matrix/pulls)  [![WeChat Approved](https://img.shields.io/badge/Wechat%20Approved-0.6.6-red.svg)](https://github.com/Tencent/matrix/wiki)
+[![license](http://img.shields.io/badge/license-BSD3-brightgreen.svg?style=flat)](https://github.com/Tencent/matrix/blob/master/LICENSE)[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/matrix/pulls)  [![WeChat Approved](https://img.shields.io/badge/Wechat%20Approved-0.8.0-red.svg)](https://github.com/Tencent/matrix/wiki)
 
 **Matrix** 是一款微信研发并日常使用的应用性能接入框架，支持iOS, macOS和Android。
 Matrix 通过接入各种性能监控方案，对性能监控项的异常数据进行采集和分析，输出相应的问题分析、定位与优化建议，从而帮助开发者开发出更高质量的应用。
@@ -470,7 +473,6 @@ Matrix-android 当前监控范围包括：应用安装包大小，帧率变化
 - IO Canary:
   检测文件 IO 问题，包括：文件 IO 监控和 Closeable Leak 监控
 
-
 ## 特性
 
 与常规的 APM 工具相比，Matrix 拥有以下特点：
@@ -507,10 +509,11 @@ Matrix-android 当前监控范围包括：应用安装包大小，帧率变化
 - 兼容到 Android P
 
 ## 使用方法
+***由于 JCenter 服务将于 2022 年 2 月 1 日下线，我们已将 Matrix 新版本（>= 0.8.0) maven repo 发布至 MavenCentral。***
 
 1. 在你项目根目录下的 gradle.properties 中配置要依赖的 Matrix 版本号，如：
 ``` gradle
-  MATRIX_VERSION=0.6.6
+  MATRIX_VERSION=0.8.0
 ```
 
 2. 在你项目根目录下的 build.gradle 文件添加 Matrix 依赖，如：
@@ -519,6 +522,7 @@ Matrix-android 当前监控范围包括：应用安装包大小，帧率变化
       classpath ("com.tencent.matrix:matrix-gradle-plugin:${MATRIX_VERSION}") { changing = true }
   }
 ```
+
 3. 接着，在 app/build.gradle 文件中添加 Matrix 各模块的依赖，如：
 ``` gradle
   dependencies {
@@ -541,6 +545,8 @@ Matrix-android 当前监控范围包括：应用安装包大小，帧率变化
   }
 ```
 
+目前 Matrix gradle plugin 支持 Android Gradle Plugin 3.5.0/4.0.0/4.1.0。
+
 4. 实现 PluginListener，接收 Matrix 处理后的数据, 如：
 ``` java
   public class TestPluginListener extends DefaultPluginListener {
@@ -624,10 +630,10 @@ Matrix 分析后的输出字段的含义请查看 [Matrix 输出内容的含义
 
 #### APK Checker
 
-APK Check 以独立的 jar 包提供 ([matrix-apk-canary-0.6.6.jar](https://jcenter.bintray.com/com/tencent/matrix/matrix-apk-canary/0.6.6/matrix-apk-canary-0.6.6.jar)），你可以运行：
+APK Check 以独立的 jar 包提供 ([matrix-apk-canary-0.8.0.jar](https://repo.maven.apache.org/maven2/com/tencent/matrix/matrix-apk-canary/0.8.0/matrix-apk-canary-0.8.0.jar)），你可以运行：
 
 ```cmd
-java -jar matrix-apk-canary-0.6.6.jar
+java -jar matrix-apk-canary-0.8.0.jar
 ```
 
 查看 Usages 来使用它。

matrix/matrix-android/build.gradle

@@ -4,47 +4,59 @@ buildscript {
 
         mavenLocal()
         google()
-        jcenter()
+        mavenCentral()
 
+        jcenter()   // Need 'org.jetbrains.trove4j:trove4j:20160824'
     }
 
     gradle.ext.KOTLIN_VERSION = "1.3.72"
 
     dependencies {
         // classpath
-        classpath 'com.android.tools.build:gradle:3.2.1'
-        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7.3'
+        classpath 'com.android.tools.build:gradle:4.1.0'
         classpath 'digital.wup:android-maven-publish:3.6.2'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$gradle.KOTLIN_VERSION"
     }
 
 }
 
-//for upload
-//apply from: rootProject.file('gradle/oss-android-template.gradle')
-
+Properties localProperties = new Properties()
+localProperties.load(project.rootProject.file('local.properties').newDataInputStream())
+def SigningFromLocalProperties(properties, project, String prop) {
+    if (properties.getProperty(prop)) {
+        project.ext[prop] = properties.getProperty(prop)
+    }
+}
 allprojects {
     repositories {
 
         mavenLocal()
         google()
-        jcenter()
+        mavenCentral()
 
+        jcenter() // Need 'com.tencent.tinker:tinker-ziputils:1.9.2'
     }
 
     tasks.withType(Javadoc).all {
         enabled = false // TODO:
         options.setEncoding('UTF-8')
     }
+
+    SigningFromLocalProperties(localProperties, project, 'REPOSITORY_USERNAME' as String)
+    SigningFromLocalProperties(localProperties, project, 'REPOSITORY_PASSWORD' as String)
+    SigningFromLocalProperties(localProperties, project, 'signing.keyId' as String)
+    SigningFromLocalProperties(localProperties, project, 'signing.password' as String)
+    SigningFromLocalProperties(localProperties, project, 'signing.secretKeyRingFile' as String)
+
 }
 
 
 ext {
     // For android sub-projects
     minSdkVersion = 19
     targetSdkVersion = 23
-    compileSdkVersion = 28
-    buildToolsVersion = '28.0.3'
+    compileSdkVersion = 29
+    buildToolsVersion = '29.0.2'
 
     javaVersion = JavaVersion.VERSION_1_8
 
@@ -53,7 +65,8 @@ ext {
     PUBLISH_CHANNEL = "${PUBLISH_CHANNEL}"
 
     POM_PACKAGING = "pom"
-    POM_DESCRIPTION = "matrix"
+    POM_NAME = "Matrix for Android"
+    POM_DESCRIPTION = "Matrix is an APM (Application Performance Manage) used in Wechat to monitor, locate and analyse performance problems. It is a plugin style, non-invasive solution and is currently available on iOS, macOS and Android."
 
     POM_URL = "https://github.com/Tencent/Matrix"
     POM_SCM_URL = "https://github.com/Tencent/Matrix.git"

matrix/matrix-android/checkstyle.xml

@@ -88,13 +88,13 @@
         <!-- Checks for whitespace                               -->
         <!-- See http://checkstyle.sf.net/config_whitespace.html -->
         <module name="GenericWhitespace"/>
-        <module name="EmptyForIteratorPad"/>
+<!--        <module name="EmptyForIteratorPad"/>-->
         <module name="MethodParamPad"/>
 
 
         <module name="NoWhitespaceAfter"/>
         <module name="NoWhitespaceBefore"/>
-        <module name="OperatorWrap"/>
+<!--        <module name="OperatorWrap"/>-->
         <module name="ParenPad"/>
         <module name="TypecastParenPad"/>
         <module name="WhitespaceAfter"/>

matrix/matrix-android/gradle.properties

@@ -15,7 +15,7 @@ org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryErro
 #Tue Jun 20 10:24:33 CST 2017
 
 
-VERSION_NAME_PREFIX=0.8.0
+VERSION_NAME_PREFIX=0.8.1
 VERSION_NAME_SUFFIX=
-## two options: Internal (for wechat),  External (for outsize person)
+## two options: Internal (for wechat),  External (for public repo)
 PUBLISH_CHANNEL=Internal

matrix/matrix-android/gradle/WeChatNativeDepend.gradle

@@ -210,13 +210,30 @@ def getExtractedNativeDependenciesDir() {
     return new File(getNativeDependencyRoot(), EXTRACTED_NATIVE_DEPENDENCIES_DIR_NAME)
 }
 
+def cleanDirectory(directory) {
+    if (!directory.exists()) {
+        return
+    } else if (!directory.isDirectory()) {
+        return
+    } else {
+        File[] files = directory.listFiles();
+        if (files == null) {
+            return
+        }
+
+        for (File file: files) {
+            org.gradle.util.GFileUtils.forceDelete(file)
+        }
+    }
+}
+
 def copyExportedHeaders(targetVariant) {
     def exportedArtifactsDir = getExportedNativeArtifactsDir(targetVariant)
     def exportedHeadersDir = new File(exportedArtifactsDir, HEADERS_DIR_NAME)
     if (!exportedHeadersDir.exists()) {
         exportedHeadersDir.mkdirs()
     } else {
-        org.gradle.util.GFileUtils.cleanDirectory(exportedHeadersDir)
+        cleanDirectory(exportedHeadersDir)
     }
     def headerFilters = getExportedHeaderFilters(targetVariant)
     copy {
@@ -262,7 +279,7 @@ def mountCopyNativePrebuiltsAction(targetVariant) {
     def bundleTask = targetVariant.getPackageLibrary() as Zip
     targetVariant.getExternalNativeBuildTasks().each { nativeBuildTask ->
         nativeBuildTask.doLast {
-            org.gradle.util.GFileUtils.cleanDirectory(exportedPrebuiltsDir)
+            cleanDirectory(exportedPrebuiltsDir)
             copy {
                 duplicatesStrategy DuplicatesStrategy.FAIL
                 includeEmptyDirs = false
@@ -462,7 +479,7 @@ def generateBuildInfoModule() {
     if (!buildInfoModuleDir.exists()) {
         buildInfoModuleDir.mkdirs()
     } else {
-        org.gradle.util.GFileUtils.cleanDirectory(buildInfoModuleDir)
+        cleanDirectory(buildInfoModuleDir)
     }
 
     def hasBuildVersion = project.extensions.findByName('wechatPublish') != null

matrix/matrix-android/gradle/android-publish-private.gradle

@@ -133,11 +133,6 @@ android.libraryVariants.all { variant ->
 
     }
 
-    // require gradle 4.x +
-    if (GradleVersion.current() < GradleVersion.version('4.0')) {
-        throw new GradleException('android-publish.gradle need Gradle 4.0 or newer')
-    }
-
     def publicationName = "component${variant.name.capitalize()}"
 
     // Declare publications

matrix/matrix-android/gradle/android-publish.gradle

@@ -9,8 +9,6 @@
 apply plugin: 'maven-publish'
 apply plugin: 'digital.wup.android-maven-publish'
 apply plugin: 'signing'
-apply plugin: 'com.jfrog.bintray'
-
 
 def isReleaseBuild() {
     return version.contains("SNAPSHOT") == false
@@ -42,14 +40,6 @@ def getRepositoryPassword() {
     return hasProperty('REPOSITORY_PASSWORD') ? REPOSITORY_PASSWORD : readPropertyFromLocalProperties('REPOSITORY_PASSWORD')
 }
 
-def getBintrayUser() {
-    return hasProperty('BINTRAY_USER') ? BINTRAY_USER : readPropertyFromLocalProperties('BINTRAY_USER')
-}
-
-def getBintrayKey() {
-    return hasProperty('BINTRAY_APIKEY') ? BINTRAY_APIKEY : readPropertyFromLocalProperties('BINTRAY_APIKEY')
-}
-
 def pomConfig = {
     scm {
         url POM_SCM_URL
@@ -70,9 +60,11 @@ def pomConfig = {
             name POM_DEVELOPER_NAME
         }
     }
+
+    name POM_NAME
+    url POM_URL
 }
 
-def bintrayPublicationNames = []
 android.libraryVariants.all { variant ->
     // Skipped debug variants
     if (variant.buildType.name == "debug") {
@@ -143,14 +135,7 @@ android.libraryVariants.all { variant ->
         }
     }
 
-    // require gradle 4.x +
-    if (GradleVersion.current() < GradleVersion.version('4.0')) {
-        throw new GradleException('android-publish.gradle need Gradle 4.0 or newer')
-    }
-
-    // For bintrayUpload
     def publicationName = "component${variant.name.capitalize()}"
-    bintrayPublicationNames.add(publicationName)
 
     // Declare publications
     publishing.publications {
@@ -168,11 +153,22 @@ android.libraryVariants.all { variant ->
             // append additional configurations
             pom.withXml {
                 asNode().children().last() + pomConfig
+                asNode().appendNode('description', POM_DESCRIPTION) // Needed by MavenCentral
             }
         }
     }
 }
 
+if (project.hasProperty("signing.keyId")) {
+    signing {
+        publishing.publications.all { publication ->
+            sign publication
+        }
+    }
+} else {
+    println "[W] No signing configurations."
+}
+
 /**
  * Setup custom maven repo
  */
@@ -186,30 +182,6 @@ publishing.repositories {
     }
 }
 
-/**
- * Then update bintray configurations
- */
-afterEvaluate {
-    bintray {
-        user = getBintrayUser()
-        key = getBintrayKey()
-        publications = bintrayPublicationNames
-
-        pkg {
-            repo = 'maven'
-            userOrg = BINTRAY_ORGANIZATION
-            name = "${GROUP}:${POM_ARTIFACT_ID}"
-            licenses = BINTRAY_LICENCE
-            vcsUrl = POM_SCM_URL
-            websiteUrl = POM_URL
-            issueTrackerUrl = POM_ISSUE_URL
-            publicDownloadNumbers = true
-            publish = true
-            dryRun = false
-        }
-    }
-}
-
 if (JavaVersion.current().isJava8Compatible()) {
     allprojects {
         tasks.withType(Javadoc) {
@@ -248,12 +220,4 @@ task buildAndPublishRepo(type: Copy, dependsOn: ['build', 'publish']) {
     }
 }
 
-tasks.getByName("bintrayUpload") {
-    it.doFirst {
-        if (!isReleaseBuild()) {
-            throw new GradleException("bintrayUpload only support release version")
-        }
-    }
-}
-
 apply from: rootProject.file('gradle/check.gradle')