淺談Android Studio導出javadoc文檔操作及問題的解決
1、在Android studio中進行打開一個項目的文件之后,然后進行點擊Android stuio中菜單中的“tools”的選項。在彈出了下拉菜單中,進行選中下拉菜單中的“Generate JavaDoc”的選項。
2、在彈出界面中 Output directory是你即將生產的javadoc文件的存儲位置,圖中1指示的位置;正常點擊ok即可;
但是如果有異常情況 比如空指針異常或者文檔亂碼
java.lang.NullPointerException 或者 java.nio.BufferOverflowException
等情況可在圖中2的位置即 Other command line arguments 后面輸入
-bootclasspath /Users/xiedingyuan/Documents/AndroidStudio/android-sdk-macosx/platforms/android-21/android.jar
jar指定你項目android.jar的位置就行。在Other command line arguments后輸入(參數之間勿忘空格)
-encoding utf-8 -charset utf-8
即可解決亂碼問題。
這樣設置后在點擊ok即可生產javadoc文檔。
補充知識:android 原apk替換androidManifest.xml的metaData的多渠道自動打包
在已經編譯出一個apk的情況下,其他的渠道只是改變androidManifest.xml的metaData信息,在這個情況下不需要再編譯apk,只需要修改androidManifest.xml;
實現的思路如下:
1.獲取源androidManifest.xml;因為apk里的androidManifest.xml是已經編譯為二進制的文件,不好修改;可以使用apktool把源apk反編譯得到androidManifest.xml的文本;
當然上面可以二進制的可以通過AXMLEditor.jar來修改,但這個修改metadata有點吃力,先簡單開始直接使用apktool。
2.修改metaData:反編譯得到androidManifest.xml的文本修改metaData信息;
3.得到二進制的androidManifest.xml:通過apktool再次編譯為apk,解壓androidManifest.xml出來即可;
3.替換原apk的二進制的androidManifest.xml,這樣得到是全新的apk;
4.簽名:刪除apk的META-INF,使用jarsigner進行簽名;
5.字節對齊:通過zipalign進行字節對齊;
利用android studio的product多渠道腳本、簽名等信息可實現修改androidManifest.xml;腳本代碼如下:
class ChannelBuildPlugin implements Plugin<Project> { String mSourceApkPath String mOutPutDir String mApkToolPath String mZip7ToolPath String mZipalignToolPath String mKeystore String mAlia String mStorepass String mSourceApkName String mProductName String mApplicationId void apply(Project project) { project.extensions.create('buildparam', ChannelBuildPluginExtension) project.task(’autoBuildChannelProduct’) << { println 'autoBuildChannelProduct start ' if (project.buildparam.sourceApkPath == null) {println 'error !!!sourceApkPath == null'return } mSourceApkPath = project.buildparam.sourceApkPath File fp = new File(mSourceApkPath) if (!fp.exists()){throw new FileNotFoundException(mSourceApkPath) } mSourceApkName = fp.getName() mOutPutDir = project.buildparam.outPutDir File outDir = new File(mOutPutDir) if (!outDir.exists()){outDir.mkdirs() } mApkToolPath = project.buildparam.apkToolPath mZipalignToolPath = project.buildparam.zipalignToolPath mZip7ToolPath = project.buildparam.zip7ToolPath mKeystore = project.buildparam.keystore mAlia = project.buildparam.alia mStorepass = project.buildparam.storepass def signingConfigs project.copy {from '$mSourceApkPath'into '$mOutPutDir/workdir/sorceapk' } decodeApk() project.android.applicationVariants.all { variant -
if (variant.name.contains('Release')){ mProductName = variant.flavorName; signingConfigs = variant.getSigningConfig() def metaConfig mApplicationId = variant.productFlavors.applicationId[0] println 'applicationId:'+ mApplicationId for (def item:variant.productFlavors.manifestPlaceholders){ metaConfig = item; } modifyMetaDataXML(metaConfig) packageApk() unzipAndroidManifest() replaceApkAndroidManifest() signCusApk(signingConfigs) zipalign(project) project.copy { String targetApk = '$mOutPutDir/workdir/sorceapk/'+mProductName +'_app-release_aligned'+'.apk' if (mApkMd5 != null && !mApkMd5.equals('')){ targetApk = '$mOutPutDir/workdir/sorceapk/'+mProductName +'_app-release_$mApkMd5'+'.apk' } from '$targetApk' into '$mOutPutDir' }}
} //重新簽名 project.task(’signApk’) << { } } public void zipalign(Project project) { def apkFile = new File('$mOutPutDir/workdir/sorceapk/'+mProductName +'_app-release_aligned'+'.apk') if (apkFile.exists()){ apkFile.delete() } apkFile = new File('$mOutPutDir/workdir/sorceapk/$mSourceApkName') if (apkFile.exists()) { def sdkDir Properties properties = new Properties() File localProps = project.rootProject.file('local.properties') if (localProps.exists()) {properties.load(localProps.newDataInputStream())sdkDir = properties.getProperty('sdk.dir') } else {sdkDir = System.getenv('ANDROID_HOME') } if (sdkDir) {Properties prop = System.getProperties();String os = prop.getProperty('os.name');def cmdExt = os.contains('Windows') ? ’.exe’ : ’’def argv = []argv << ’-f’ //overwrite existing outfile.zip// argv << ’-z’ //recompress using Zopfliargv << ’-v’ //verbose outputargv << ’4’ //alignment in bytes, e.g. ’4’ provides 32-bit alignmentargv << '$mOutPutDir/workdir/sorceapk/$mSourceApkName'argv << '$mOutPutDir/workdir/sorceapk/'+mProductName +'_app-release_aligned'+'.apk' //outputproject.exec { commandLine '${sdkDir}/build-tools/${project.android.buildToolsVersion}/zipalign${cmdExt}' args argv}apkFile = new File('$mOutPutDir/workdir/sorceapk/'+mProductName +'_app-release_aligned'+'.apk')if (!apkFile.exists()) { throw new FileNotFoundException('$mOutPutDir/workdir/sorceapk/'+mProductName +'_app-release_aligned'+'.apk')} } else {throw new InvalidUserDataException(’$ANDROID_HOME is not defined’) } } } //對齊 void alignApk() { println 'alignApk' def fp = new File('$mOutPutDir/workdir/sorceapk/'+mProductName +'_app-release_aligned'+'.apk') if (fp.exists()){ fp.delete() } def args = [mZipalignToolPath, ’-f’, ’-v’, ’4’, '$mOutPutDir/workdir/sorceapk/$mSourceApkName', '$mOutPutDir/workdir/sorceapk/'+mProductName +'_app-release_aligned'+'.apk'] println('zipalign...'); def proc = args.execute() println '${proc.text}' } //簽名 void signCusApk(def signingConfigs){ println 'signApk' println 'delete META-INF start' def args = [mZip7ToolPath.replaceAll(’/’,’’), ’d’, ('$mOutPutDir/workdir/sorceApk/'+mSourceApkName).replaceAll(’/’,’’), 'META-INF'] def proc = args.execute() println '${proc.text}' println 'delete META-INF end' args = [JavaEnvUtils.getJdkExecutable(’jarsigner’), ’-verbose’, ’-sigalg’, ’MD5withRSA’, ’-digestalg’, ’SHA1’, ’-sigfile’, ’CERT’, ’-tsa’, ’http://timestamp.comodoca.com/authenticode’, ’-keystore’, signingConfigs.storeFile, ’-keypass’, signingConfigs.keyPassword, ’-storepass’, signingConfigs.storePassword, '$mOutPutDir/workdir/sorceApk/$mSourceApkName', signingConfigs.keyAlias] println('JavaEnvUtils.getJdkExecutable...'); proc = args.execute() println '${proc.text}' } //替換原始的二進制化AndroidManifest void replaceApkAndroidManifest() { println 'replaceApkAndroidManifest' def args = [mZip7ToolPath.replaceAll(’/’,’’), ’u’, ’-y’, ('$mOutPutDir/workdir/sorceApk/'+mSourceApkName).replaceAll(’/’,’’), ('$mOutPutDir/workdir/tempDir/AndroidManifest.xml').replaceAll(’/’,’’)] def proc = args.execute() println '${proc.text}' } //提取二進制化AndroidManifest void unzipAndroidManifest() { println 'unzipAndroidManifest' String apkPath = '$mOutPutDir/workdir/tempDir/app-modify-temp.apk'; // apk文件路徑 ZipFile zf = new ZipFile(apkPath); // 建立zip文件 InputStream is = zf.getInputStream(zf.getEntry('AndroidManifest.xml')); // 得到AndroidManifest.xml文件 File targetFile = new File('$mOutPutDir/workdir/tempDir/AndroidManifest.xml'); if (targetFile.exists()){ targetFile.delete() } targetFile.createNewFile(); FileOutputStream out = new FileOutputStream(targetFile); int length = 0; byte[] readByte =new byte[1024]; try { while((length=is.read(readByte,0,1024))!=-1){out.write(readByte, 0, length); } } catch (Exception e2) { println '解壓文件失敗!' // logger.error('解壓文件失敗!',e2); }finally { is.close(); out.close(); zf.close() } if (targetFile.length() <= 0){ throw new Throwable('$mOutPutDir/workdir/tempDir/AndroidManifest.xml unzipAndroidManifest error!!!') } } //打包apk,主要是實現AndroidManifest二進制化 void packageApk(){ println 'packageApk' def o = new File('$mOutPutDir/workdir/tempDir'); o.deleteDir() o.mkdirs() Process p='$mApkToolPath b $mOutPutDir/workdir/decodeapk -o $mOutPutDir/workdir/tempDir/app-modify-temp.apk'.execute() println '${p.text}' def fp = new File('$mOutPutDir/workdir/tempDir/app-modify-temp.apk') if (!fp.exists()){ throw new Throwable('$mOutPutDir/workdir/tempDir/app-modify-temp.apk' + 'not found !! packageApk error!!!') } } //修改AndroidManifest.xml的配置metaData boolean modifyMetaDataXML(Map<String,String> metaData) { println 'modifyAMXML' println 'metaData:'+metaData.toMapString() println 'metaData:'+metaData.toMapString() if (metaData.size() <= 0) { println 'mMetaSet size<= 0' return false; } DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); // 如果創建的解析器在解析XML文檔時必須刪除元素內容中的空格,則為true,否則為false dbf.setIgnoringElementContentWhitespace(false); try { /* * 創建文件對象 */ DocumentBuilder db = dbf.newDocumentBuilder();// 創建解析器,解析XML文檔 Document doc = db.parse('$mOutPutDir/workdir/decodeapk/AndroidManifest.xml'); // 使用dom解析xml文件 /* * 歷遍列表,進行XML文件的數據提取 */ // 根據節點名稱來獲取所有相關的節點org.w3c.dom. org.w3c.dom.NodeList sonlist = doc.getElementsByTagName('meta-data');// println 'sonlist:' + sonlist.length // println 'getAttributeNode:' + doc.getElementsByTagName('meta-data').getAttributeNode('android:name'); for (org.w3c.dom.Node ne : sonlist) {//org.w3c.dom.org.w3c.dom.NamedNodeMap nnm = ne.attributesorg.w3c.dom.Node metaKey = nnm.getNamedItem('android:name')// println 'metaKey: $metaKey'if (metaKey != null) { // println 'metaKey: '+metaKey.getNodeValue() String value = metaData.get(metaKey.getNodeValue()) if (value == null){ value = metaData.get(metaKey.getNodeValue().toLowerCase()) } // println 'mMetaSet: $value' if (value != null) { org.w3c.dom.Node metaValue = nnm.getNamedItem('android:value') metaValue.setNodeValue(value) println 'modify $metaKey to $value' }} } try {TransformerFactory transformerFactory = TransformerFactory .newInstance();javax.xml.transform.Transformer transformer = transformerFactory.newTransformer();DOMSource source = new DOMSource(doc);StreamResult streamResult = new StreamResult(new File( '$mOutPutDir/workdir/decodeapk/AndroidManifest.xml'));transformer.transform(source, streamResult); } catch (Exception e) {e.printStackTrace();throw e; } } catch (Exception e) { e.printStackTrace(); throw e; } } void decodeApk(){ println 'decodeApk' def outDir = new File('$mOutPutDir/workdir/decodeapk') outDir.deleteDir() Process p='$mApkToolPath d -f $mSourceApkPath -o $mOutPutDir/workdir/decodeapk'.execute() println '${p.text}' File fp = new File('$mOutPutDir/workdir/decodeapk/AndroidManifest.xml') if (!fp.exists()){ throw Exception('$mOutPutDir/workdir/decodeapk/AndroidManifest.xml not exist!!!error') } }}class ChannelBuildPluginExtension { String sourceApkPath String outPutDir String apkToolPath String zip7ToolPath String zipalignToolPath Map<String,String> metaSet String keystore String alia String storepass String channelConfig void channel(Closure clos){ closure = clos }}
下面是在主工程的腳本配置:
apply plugin:ChannelBuildPlugin buildparam{ sourceApkPath = 'F:/svn/tv/app/app-release.apk' outPutDir = 'F:/svn/tv/app' apkToolPath = 'F:/svn/tv/app/apktool.bat' zip7ToolPath = 'C:/Program Files/7-Zip/7z.exe'}
這樣可以直接使用autoBuildChannelProduct這個任務即可編譯所有的渠道的包。
說明:
1.AndroidManifest.xml的metaData的key與manifestPlaceholders的key要對應,可以大小寫不同;
2.android studio配置了自動簽名,不然需要手動配置簽名信息。
使用的場景特別是需要熱修復的情況,在多渠道的基準包中,必須要保持基準包的類及資源除AndroidManifest外都必須一樣的環境,這樣能保證所有渠道包均能熱修復;
后續改進點:
1.不能修改applicationId、版本號等
2.不能使用默認配置的,每個渠道都必須配置完所有的metaData信息
以上這篇淺談Android Studio導出javadoc文檔操作及問題的解決就是小編分享給大家的全部內容了,希望能給大家一個參考,也希望大家多多支持好吧啦網。
相關文章:
