美文网首页Gradle
生成aar或Jar相关知识点详解

生成aar或Jar相关知识点详解

作者: Android开发_Hua | 来源:发表于2020-09-30 15:39 被阅读0次

            最近公司的项目需要把现在已有的项目打包成一个aar包给第三方合作方,在从原来的app生成一个apk文件,变为一个aar的输出过程中,遇到了一些问题,也随便根据网上的资料了解了关于生成一个aar包需要注意的相关知识点,下面就带大家一起看看一个已有项目,生成一个aar可能遇到的问题和项目知识点汇总吧。

    相关知识点汇总:

    一:打包相关的指令使用 

    二:生成aar需要注意的事项 

    三:混淆基础知识与aar与jar如何做混淆 

    四:遇到的问题汇总 

    五:扩展阅读

    一:打包相关的指令使用

    指令一:gradlew webpdecoder:aR(assemble Release)

    解析:编译webpdecoder Module release版本

    指令二:gradlew clean webpdecoder:aR(assemble Release)

    解析:清除webpdecoder Module的缓存数据

    指令三:gradlew webpdecoder:artifactoryPublish -P verName=1.0.0 -P verCode=1000000

    解析:编译webpdecoder的相关版本到远程artifactory库

    指令四:gradlew app:assembleZhaoxi

    解析:编译app Module的Zhaoxi版本

    备注:jar与aar的简单区别

    *.jar:只包含了class文件与清单文件,不包含资源文件,如图片等所有res中的文件。

    *.aar:包含所有资源 ,class以及res资源文件全部包含。

    二:生成aar需要注意的事项

    注意事项一:主项目需要依赖AAR中所依赖的远程库,否则会出现ClassNotFound异常

    这里也许某个依赖库你们的版本会发生冲突,这就需要你们协调了。

    注意事项二:资源命名最好统统加上你的项目名字前缀,比如图片资源、string、color、dimens、layout等等,反正res目录下所有文件最好都使用统一的加前缀命名,防止跟宿主app下的资源重复,因为aar引用跟源码引用起到的效果一样一样的,所有很容易出现资源重复引用的问题,所以加上前缀非常有必要。

    android {

        resourcePrefix "<前缀>"

    }

    需要说明的是,resourcePrefix 只是起约束作用,不会自动帮你修改资源的名称,我们需要手动加上前缀,否则报错。

    注意事项三:如果该aar包里面有微信支付,分享等第三方库,你要在主工程中使用,要记得在gradle里面替换applicationId,或者用你主工程的包名和key去获取第三方操作的key和id,以分享为例,如果你清单文件中的分享KEY与主项目中的build gradle文件中的分享KEY不同的话,就会报清单文件异常的。

    注意事项四:butterknife需要统一用8.4.0以上的版本,不然报错 ;依我的建议,最好不用,否则有你好受的。

    注意事项五:如果在aar的MyAppliction里面使用了类的管理器,那么在打包成aar的时候需要将代码抽出来做个独立的类管理器,记住一点,打包成aar之后所有和application有关的东西都要检查替换,避免出现空指针异常。

    注意事项六:AAR模块用butterknife需要把资源R改为R2(批量替换)

    注意事项七:布局文件不要重名,否则会报找不到Id的异常

    注意事项八:aar不能使用assets原始资源工具,不支持在库模块中使用原始资源文件(保存在 assets/ 目录中),使用的任何原始资源都必须存储在应用模块自身的assets/目录中。

    2.1、成型的项目(有依赖)如何快速打包AAR

    第一步:修改app下的bulid gradle文件,把apply plugin: 'com.android.application’修改成apply plugin: ‘com.android.library’

    第二步:注释调defaultConfig下的applicationId

    第三步:AndroidManifest.xml文件,修改application并且注释调首先启动的Activity启动的action

    第四步:如果你自己自定义了Application,需要去掉,因为AAR中是没有Application的,那问题来了,我们原来在Application中的初始化代码怎么办?这个简单,我们可以单独写一个Options类,提供给调用者,让他传递过来application,这样我们就可以在这个类中做一些初始化操作了。

    三:混淆基础知识与aar与jar如何做混淆

    3.1、ProGuard作用

    1、压缩(Shrinking):默认开启,用以减小应用体积,移除未被使用的类和成员,并且会在优化动作执行之后再次执行(因为优化后可能会再次暴露一些未被使用的类和成员)。如果想要关闭压缩,在proguard-rules.pro文件中加入:

    # 关闭压缩

    -dontshrink

    2、优化(Optimization):默认开启,在字节码级别执行优化,让应用运行的更快。同上,如果想要关闭优化,在proguard-rules.pro文件中加入:

    # 关闭优化

    -dontoptimize

    -optimizationpasses n 表示proguard对代码进行迭代优化的次数,Android一般为5

    3、混淆(Obfuscation):默认开启,增大反编译难度,类和类成员会被随机命名,除非用keep保护。

    # 关闭混淆

    -dontobfuscate

    备注:混淆后默认会在工程目录app/build/outputs/mapping/release下生成一个mapping.txt文件,这就是混淆规则,我们可以根据这个文件把混淆后的代码反推回源本的代码,所以这个文件很重要,注意保护好。

    3.2、实现保持不混淆的两种方法:

    方法一:使用@Keep注解

    在proguard-rules.pro配置文件中加入以下规则

    #手动启用support keep注解

    #http://tools.android.com/tech-docs/support-annotations

    -dontskipnonpubliclibraryclassmembers

    -printconfiguration

    -keep,allowobfuscation @interface android.support.annotation.Keep

    -keep @android.support.annotation.Keep class *

    -keepclassmembers class * {

    @android.support.annotation.Keep *;

    }

    方法二:proguard-rules.pro中添加不混淆规则

    添加相关配置:

    buildTypes {

    release {

    minifyEnabled true //true开启混淆配置,false关闭

    proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'

    signingConfig signingConfigs.duqian_android_keystore

    }

    debug{//省略}

    }

    proguard-rules.pro 文件来定义项目打包的混淆选项模板:

    #--------------------------1.实体类---------------------------------

    # 如果使用了Gson之类的工具要使被它解析的JavaBean类即实体类不被混淆。(这里填写自己项目中存放bean对象的具体路径)

    -keep class com.php.soldout.bean.**{*;}

    #--------------------------2.第三方包-------------------------------

    #Gson

    -keepattributes Signature

    -keepattributes *Annotation*

    -keep class sun.misc.Unsafe { *; }

    -keep class com.google.gson.stream.** { *; }

    -keep class com.google.gson.examples.android.model.** { *; }

    -keep class com.google.gson.* { *;}

    -dontwarn com.google.gson.**

    #butterknife

    -keep class butterknife.** { *; }

    -dontwarn butterknife.internal.**

    -keep class **$$ViewBinder { *; }

    #-------------------------3.与js互相调用的类------------------------

    #-------------------------4.反射相关的类和方法----------------------

    #-------------------------5.基本不用动区域--------------------------

    #指定代码的压缩级别

    -optimizationpasses 5

    #包明不混合大小写

    -dontusemixedcaseclassnames

    #不去忽略非公共的库类

    -dontskipnonpubliclibraryclasses

    -dontskipnonpubliclibraryclassmembers

    #混淆时是否记录日志

    -verbose

    #优化  不优化输入的类文件

    -dontoptimize

    #预校验

    -dontpreverify

    # 保留sdk系统自带的一些内容 【例如:-keepattributes *Annotation* 会保留Activity的被@override注释的onCreate、onDestroy方法等】

    -keepattributes Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,*Annotation*,EnclosingMethod

    # 记录生成的日志数据,gradle build时在本项根目录输出

    # apk 包内所有 class 的内部结构

    -dump proguard/class_files.txt

    # 未混淆的类和成员

    -printseeds proguard/seeds.txt

    # 列出从 apk 中删除的代码

    -printusage proguard/unused.txt

    # 混淆前后的映射

    -printmapping proguard/mapping.txt

    # 避免混淆泛型

    -keepattributes Signature

    # 抛出异常时保留代码行号,保持源文件以及行号

    -keepattributes SourceFile,LineNumberTable

    #-----------------------------6.默认保留区-----------------------

    # 保持 native 方法不被混淆

    -keepclasseswithmembernames class * {

    native <methods>;

    }

    -keepclassmembers public class * extends android.view.View {

    public <init>(android.content.Context);

    public <init>(android.content.Context, android.util.AttributeSet);

    public <init>(android.content.Context, android.util.AttributeSet, int);

    public void set*(***);

    }

    }

    #保持 Serializable 不被混淆

    -keepclassmembers class * implements java.io.Serializable {

    static final long serialVersionUID;

    private static final java.io.ObjectStreamField[] serialPersistentFields;

    !static !transient <fields>;

    !private <fields>;

    !private <methods>;

    private void writeObject(java.io.ObjectOutputStream);

    private void readObject(java.io.ObjectInputStream);

    java.lang.Object writeReplace();

    java.lang.Object readResolve();

    }

    # 保持自定义控件类不被混淆

    -keepclasseswithmembers class * {

    public <init>(android.content.Context,android.util.AttributeSet);

    }

    # 保持自定义控件类不被混淆

    -keepclasseswithmembers class * {

    public <init>(android.content.Context,android.util.AttributeSet,int);

    }

    # 保持自定义控件类不被混淆

    -keepclassmembers class * extends android.app.Activity {

    public void *(android.view.View);

    }

    # 保持枚举 enum 类不被混淆

    -keep classmembers enum * {

    public static **[] values();

    public static ** valueOf(java.lang.String);

    }

    # 保持 Parcelable 不被混淆

    -keep class * implements android.os.Parcelable {

    public static final android.os.Parcelable$Creator *;

    }

    # 不混淆R文件中的所有静态字段,我们都知道R文件是通过字段来记录每个资源的id的,字段名要是被混淆了,id也就找不着了。

    -keep classmembers class **.R$* {

    public static <fields>;

    }

    #如果引用了v4或者v7包

    -dontwarn android.support.**

    # 保持哪些类不被混淆

    -keep public class * extends android.app.Application

    -keep public class * extends android.app.Activity

    -keep public class * extends android.app.Fragment

    -keep public class * extends android.app.Service

    -keep public class * extends android.content.BroadcastReceiver

    -keep public class * extends android.content.ContentProvider

    -keep public class * extends android.preference.Preference

    -keep class com.zhy.http.okhttp.**{*;}

    -keep class com.wiwide.util.** {*;}

    # ============忽略警告,否则打包可能会不成功=============

    -ignorewarnings

    混淆的一些基本规则:

    规则一:一颗星

    解析:表示只是保持该包下的类名,而子包下的类名还是会被混淆;

    -keep class cn.hadcn.test.*

    规则二:两颗星

    解析:表示把本包和所含子包下的类名都保持;用以上方法保持类后,你会发现类名虽然未混淆,但里面的具体方法和变量命名还是变了。

    -keep class cn.hadcn.test.**

    规则三:既想保持类名,又想保持里面的内容不被混淆

    解析:-keep class cn.hadcn.test.* {*;}

    规则四:用extends,implements等这些Java规则,避免所有继承Activity的类被混淆

    解析:-keep public class * extends android.app.Activity

    规则五:保留一个类中的内部类不被混淆则需要用$符号,如下例子表示保持ScriptFragment内部类JavaScriptInterface中的所有public内容不被混淆。

    解析:-keepclassmembers class cc.ninty.chat.ui.fragment.ScriptFragment$JavaScriptInterface {

    public *;

    }

    规则六:保护类下的特定内容,<fields>或<methods>前面加上private 、public、native等来进一步指定不被混淆的内容

    解析:

    <init>;     //匹配所有构造器

    <fields>;   //匹配所有域

    <methods>;  //匹配所有方法

    -keep class cn.hadcn.test.One {

        public <methods>;

    }

    规则七:One类下的所有public方法都不会被混淆,还可以加入参数,比如以下表示用JSONObject作为入参的构造函数不会被混淆。

    解析:

    -keep class cn.hadcn.test.One {

        public <init>(org.json.JSONObject);

    }

    规则八:不需要保持类名,只需要把该类下的特定方法保持不被混淆,需要用keepclassmembers ,如此类名就不会被保持

    解析:

    Android混淆的方法和通配符对照表:

    Proguard关键字

    不需要混淆的类汇总:

    一:jni方法不可混淆,因为这个方法需要和native方法保持一致

    # 保持native方法不被混淆

    -keepclasseswithmembernames class * {

    native <methods>;

    }

    二:反射用到的类不混淆(否则反射可能出现问题)

    三:AndroidMainfest中的类不混淆,所以四大组件和Application的子类和Framework层下所有的类默认不会进行混淆,自定义的View默认也不会被混淆。所以像网上贴的很多排除自定义View,或四大组件被混淆的规则在Android Studio中是无需加入的

    四:与服务端交互时,使用GSON、fastjson等框架解析服务端数据时,所写的JSON对象类不混淆,否则无法将JSON解析成对应的对象

    五:使用第三方开源库或者引用其他第三方的SDK包时,如果有特别要求,也需要在混淆文件中加入对应的混淆规则

    六:有用到WebView的JS调用也需要保证写的接口方法不混淆

    七:Parcelable的子类和Creator静态成员变量不混淆,否则会产生Android.os.BadParcelableException异常

    # 保持Parcelable不被混淆

    -keep class * implements Android.os.Parcelable {

    public static final Android.os.Parcelable$Creator *;

    }

    八:使用enum类型时需要注意避免以下两个方法混淆,因为enum类的特殊性,以下两个方法会被反射调用

    -keepclassmembers enum * {

    public static **[] values();

    public static ** valueOf(java.lang.String);

    }

    备注:发布一款应用除了设minifyEnabled为ture,你也应该设置zipAlignEnabled为true,像Google Play强制要求开发者上传的应用必须是经过zipAlign的,zipAlign可以让安装包中的资源按4字节对齐,这样可以减少应用在运行时的内存消耗。

    四:遇到的问题汇总

    问题一:AAR 内部三方库依赖的问题

    解析:项目的开发过程中,发现一个问题:

    使用 Android Studio 打包出来的 AAR ,不会将其依赖的三方库打包进去。

    举个例子,library Test 依赖了 okhttp,打包成了 Test.aar ,app 使用本地方式引用了 Test.aar,但是无法使用 okhttp,为了不报错,app还需要添加 okhttp 依赖。

    Google Android Studio 的负责人在 stackoverflow 上解释了 为什么 Android Studio 不能将多个依赖打包进一个 AAR 文件的原因,是因为将不同的library打包在一起,涉及到资源和配置文件智能合并,所以是个比较复杂的问题,同时也容易造成相同的依赖冲突。

    这个问题可以通过使用 Maven依赖解决,因为library Module上传Maven后,会生成一个.pom 文件,记录library Module 的依赖。当 Gradle依赖Maven上的这个库时,会通过pom文件下载对应依赖。如果不想要对应依赖的话,可以通过下面的方法关闭 Gradle的依赖传递。

    举个例子如下:

    //正常依赖

    implementation 'com.chemao.android:chemao-sdk:1.2.3'

    //关闭全部依赖传递-方法1

    implementation 'com.chemao.android:chemao-sdk:1.2.3@aar'

    //关闭全部依赖传递-方法2

    implementation('com.chemao.android:chemao-sdk:1.2.3') {

        transitive = false

    }

    问题二:提示无法找到ninja相关指令

    解析:需要把SDK相关bin相关文件..Sdk\cmake\3.10.2.4988404\bin配置到环境变量中,添加到环境变量Path路径中。

    问题三:无法找到文件build\intermediates\proguard-files\proguard-android.txt-3.1.3文件

    解析:自己在项目中添加build等文件夹,并添加proguard-android.txt-3.1.3文件,proguard-android.txt文件的可以在

    Sdk\tools\proguard目录下找到。

    问题四:NDK的版本需要降级,否则无法编译

    解析:在tools菜单的SDK Manager中,下载旧版本的NDK。

    五:扩展阅读

    1、https://www.jianshu.com/p/f391d0a6691e(Android-打包AAR步骤以及最为关键的注意事项!)

    2、https://blog.csdn.net/fesdgasdgasdg/article/details/76560341(Android 中.aar文件生成方法与用法)

    3、https://www.jianshu.com/p/8f7e32015836(合并AAR踩坑之旅)

    4、https://blog.csdn.net/qq_32452623/article/details/79220522(Android-少不了的 AAR 文件常识,最好知道的注意事项)

    5、https://www.pianshen.com/article/9986545936/(Android SDK开发之aar从0到1 踩坑史)

    6、https://blog.csdn.net/p876643136/article/details/90668769(android打包混淆及语法规则详解)

    7、https://www.jianshu.com/p/be7ec1819d2f?utm_campaign=maleskine&utm_content=note&utm_medium=

    seo_notes&utm_source=recommendation(Android优雅的进行混淆——使用@Keep注解)

    8、https://www.cnblogs.com/renhui/p/9299786.html(Android代码混淆配置总结)

    相关文章

      网友评论

        本文标题:生成aar或Jar相关知识点详解

        本文链接:https://www.haomeiwen.com/subject/sbouuktx.html