com.taobao.android.builder.tools.multidex.FastMultiDexer.java Source code

Java tutorial

Introduction

Here is the source code for com.taobao.android.builder.tools.multidex.FastMultiDexer.java

Source

/*
 *
 *
 *
 *                                   Apache License
 *                             Version 2.0, January 2004
 *                          http://www.apache.org/licenses/
 *
 *     TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 *
 *     1. Definitions.
 *
 *        "License" shall mean the terms and conditions for use, reproduction,
 *        and distribution as defined by Sections 1 through 9 of this document.
 *
 *        "Licensor" shall mean the copyright owner or entity authorized by
 *        the copyright owner that is granting the License.
 *
 *        "Legal Entity" shall mean the union of the acting entity and all
 *        other entities that control, are controlled by, or are under common
 *        control with that entity. For the purposes of this definition,
 *        "control" means (i) the power, direct or indirect, to cause the
 *        direction or management of such entity, whether by contract or
 *        otherwise, or (ii) ownership of fifty percent (50%) or more of the
 *        outstanding shares, or (iii) beneficial ownership of such entity.
 *
 *        "You" (or "Your") shall mean an individual or Legal Entity
 *        exercising permissions granted by this License.
 *
 *        "Source" form shall mean the preferred form for making modifications,
 *        including but not limited to software source code, documentation
 *        source, and configuration files.
 *
 *        "Object" form shall mean any form resulting from mechanical
 *        transformation or translation of a Source form, including but
 *        not limited to compiled object code, generated documentation,
 *        and conversions to other media types.
 *
 *        "Work" shall mean the work of authorship, whether in Source or
 *        Object form, made available under the License, as indicated by a
 *        copyright notice that is included in or attached to the work
 *        (an example is provided in the Appendix below).
 *
 *        "Derivative Works" shall mean any work, whether in Source or Object
 *        form, that is based on (or derived from) the Work and for which the
 *        editorial revisions, annotations, elaborations, or other modifications
 *        represent, as a whole, an original work of authorship. For the purposes
 *        of this License, Derivative Works shall not include works that remain
 *        separable from, or merely link (or bind by name) to the interfaces of,
 *        the Work and Derivative Works thereof.
 *
 *        "Contribution" shall mean any work of authorship, including
 *        the original version of the Work and any modifications or additions
 *        to that Work or Derivative Works thereof, that is intentionally
 *        submitted to Licensor for inclusion in the Work by the copyright owner
 *        or by an individual or Legal Entity authorized to submit on behalf of
 *        the copyright owner. For the purposes of this definition, "submitted"
 *        means any form of electronic, verbal, or written communication sent
 *        to the Licensor or its representatives, including but not limited to
 *        communication on electronic mailing lists, source code control systems,
 *        and issue tracking systems that are managed by, or on behalf of, the
 *        Licensor for the purpose of discussing and improving the Work, but
 *        excluding communication that is conspicuously marked or otherwise
 *        designated in writing by the copyright owner as "Not a Contribution."
 *
 *        "Contributor" shall mean Licensor and any individual or Legal Entity
 *        on behalf of whom a Contribution has been received by Licensor and
 *        subsequently incorporated within the Work.
 *
 *     2. Grant of Copyright License. Subject to the terms and conditions of
 *        this License, each Contributor hereby grants to You a perpetual,
 *        worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *        copyright license to reproduce, prepare Derivative Works of,
 *        publicly display, publicly perform, sublicense, and distribute the
 *        Work and such Derivative Works in Source or Object form.
 *
 *     3. Grant of Patent License. Subject to the terms and conditions of
 *        this License, each Contributor hereby grants to You a perpetual,
 *        worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *        (except as stated in this section) patent license to make, have made,
 *        use, offer to sell, sell, import, and otherwise transfer the Work,
 *        where such license applies only to those patent claims licensable
 *        by such Contributor that are necessarily infringed by their
 *        Contribution(s) alone or by combination of their Contribution(s)
 *        with the Work to which such Contribution(s) was submitted. If You
 *        institute patent litigation against any entity (including a
 *        cross-claim or counterclaim in a lawsuit) alleging that the Work
 *        or a Contribution incorporated within the Work constitutes direct
 *        or contributory patent infringement, then any patent licenses
 *        granted to You under this License for that Work shall terminate
 *        as of the date such litigation is filed.
 *
 *     4. Redistribution. You may reproduce and distribute copies of the
 *        Work or Derivative Works thereof in any medium, with or without
 *        modifications, and in Source or Object form, provided that You
 *        meet the following conditions:
 *
 *        (a) You must give any other recipients of the Work or
 *            Derivative Works a copy of this License; and
 *
 *        (b) You must cause any modified files to carry prominent notices
 *            stating that You changed the files; and
 *
 *        (c) You must retain, in the Source form of any Derivative Works
 *            that You distribute, all copyright, patent, trademark, and
 *            attribution notices from the Source form of the Work,
 *            excluding those notices that do not pertain to any part of
 *            the Derivative Works; and
 *
 *        (d) If the Work includes a "NOTICE" text file as part of its
 *            distribution, then any Derivative Works that You distribute must
 *            include a readable copy of the attribution notices contained
 *            within such NOTICE file, excluding those notices that do not
 *            pertain to any part of the Derivative Works, in at least one
 *            of the following places: within a NOTICE text file distributed
 *            as part of the Derivative Works; within the Source form or
 *            documentation, if provided along with the Derivative Works; or,
 *            within a display generated by the Derivative Works, if and
 *            wherever such third-party notices normally appear. The contents
 *            of the NOTICE file are for informational purposes only and
 *            do not modify the License. You may add Your own attribution
 *            notices within Derivative Works that You distribute, alongside
 *            or as an addendum to the NOTICE text from the Work, provided
 *            that such additional attribution notices cannot be construed
 *            as modifying the License.
 *
 *        You may add Your own copyright statement to Your modifications and
 *        may provide additional or different license terms and conditions
 *        for use, reproduction, or distribution of Your modifications, or
 *        for any such Derivative Works as a whole, provided Your use,
 *        reproduction, and distribution of the Work otherwise complies with
 *        the conditions stated in this License.
 *
 *     5. Submission of Contributions. Unless You explicitly state otherwise,
 *        any Contribution intentionally submitted for inclusion in the Work
 *        by You to the Licensor shall be under the terms and conditions of
 *        this License, without any additional terms or conditions.
 *        Notwithstanding the above, nothing herein shall supersede or modify
 *        the terms of any separate license agreement you may have executed
 *        with Licensor regarding such Contributions.
 *
 *     6. Trademarks. This License does not grant permission to use the trade
 *        names, trademarks, service marks, or product names of the Licensor,
 *        except as required for reasonable and customary use in describing the
 *        origin of the Work and reproducing the content of the NOTICE file.
 *
 *     7. Disclaimer of Warranty. Unless required by applicable law or
 *        agreed to in writing, Licensor provides the Work (and each
 *        Contributor provides its Contributions) on an "AS IS" BASIS,
 *        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 *        implied, including, without limitation, any warranties or conditions
 *        of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
 *        PARTICULAR PURPOSE. You are solely responsible for determining the
 *        appropriateness of using or redistributing the Work and assume any
 *        risks associated with Your exercise of permissions under this License.
 *
 *     8. Limitation of Liability. In no event and under no legal theory,
 *        whether in tort (including negligence), contract, or otherwise,
 *        unless required by applicable law (such as deliberate and grossly
 *        negligent acts) or agreed to in writing, shall any Contributor be
 *        liable to You for damages, including any direct, indirect, special,
 *        incidental, or consequential damages of any character arising as a
 *        result of this License or out of the use or inability to use the
 *        Work (including but not limited to damages for loss of goodwill,
 *        work stoppage, computer failure or malfunction, or any and all
 *        other commercial damages or losses), even if such Contributor
 *        has been advised of the possibility of such damages.
 *
 *     9. Accepting Warranty or Additional Liability. While redistributing
 *        the Work or Derivative Works thereof, You may choose to offer,
 *        and charge a fee for, acceptance of support, warranty, indemnity,
 *        or other liability obligations and/or rights consistent with this
 *        License. However, in accepting such obligations, You may act only
 *        on Your own behalf and on Your sole responsibility, not on behalf
 *        of any other Contributor, and only if You agree to indemnify,
 *        defend, and hold each Contributor harmless for any liability
 *        incurred by, or claims asserted against, such Contributor by reason
 *        of your accepting any such warranty or additional liability.
 *
 *     END OF TERMS AND CONDITIONS
 *
 *     APPENDIX: How to apply the Apache License to your work.
 *
 *        To apply the Apache License to your work, attach the following
 *        boilerplate notice, with the fields enclosed by brackets "[]"
 *        replaced with your own identifying information. (Don't include
 *        the brackets!)  The text should be enclosed in the appropriate
 *        comment syntax for the file format. We also recommend that a
 *        file or class name and description of purpose be included on the
 *        same "printed page" as the copyright notice for easier
 *        identification within third-party archives.
 *
 *     Copyright 2016 Alibaba Group
 *
 *     Licensed under the Apache License, Version 2.0 (the "License");
 *     you may not use this file except in compliance with the License.
 *     You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 *     Unless required by applicable law or agreed to in writing, software
 *     distributed under the License is distributed on an "AS IS" BASIS,
 *     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *     See the License for the specific language governing permissions and
 *     limitations under the License.
 *
 *
 */

package com.taobao.android.builder.tools.multidex;

import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.jar.JarOutputStream;
import java.util.zip.ZipEntry;

import com.android.build.gradle.internal.api.AppVariantContext;
import com.android.build.gradle.internal.core.GradleVariantConfiguration;
import com.android.build.gradle.internal.transforms.JarMerger;
import com.android.builder.core.AtlasBuilder.MultiDexer;
import com.android.dex.Dex;
import com.android.dex.DexIndexOverflowException;
import com.android.dex.FieldId;
import com.android.dex.MethodId;
import com.android.dx.command.dexer.DxContext;
import com.android.dx.merge.CollisionPolicy;
import com.android.dx.merge.DexMerger;
import com.google.common.base.Joiner;
import com.taobao.android.builder.extension.MultiDexConfig;
import com.taobao.android.builder.extension.TBuildConfig;
import com.taobao.android.builder.tools.FileNameUtils;
import com.taobao.android.builder.tools.concurrent.ExecutorServicesHelper;
import com.taobao.android.builder.tools.manifest.ManifestFileUtils;
import javassist.ClassPool;
import javassist.CtClass;
import javassist.NotFoundException;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.gradle.api.GradleException;
import org.jetbrains.annotations.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import proguard.obfuscate.MappingReader;

import static com.android.builder.model.AndroidProject.FD_OUTPUTS;

/**
 * Created by wuzhong on 2017/5/8.
 */
public class FastMultiDexer implements MultiDexer {

    public static final int MAX_FIELD_IDS = 65530;

    private static final Logger logger = LoggerFactory.getLogger(FastMultiDexer.class);

    private final AppVariantContext appVariantContext;

    private final MultiDexConfig multiDexConfig;

    public FastMultiDexer(AppVariantContext appVariantContext) {
        this.appVariantContext = appVariantContext;
        this.multiDexConfig = (MultiDexConfig) appVariantContext.getAtlasExtension().getMultiDexConfigs()
                .findByName(appVariantContext.getVariantConfiguration().getBuildType().getName());
    }

    public boolean isFastMultiDexEnabled() {
        if (null == multiDexConfig) {
            return false;
        }
        boolean fastMultiDex = multiDexConfig.isFastMultiDex();
        if (fastMultiDex) {

            if (appVariantContext.getVariantData().getVariantConfiguration().isMultiDexEnabled()) {
                throw new GradleException(
                        "atlas fast multi dex must close android's default multi dex , please `multiDexEnabled false`");
            }

            if (appVariantContext.getAtlasExtension().getTBuildConfig().isAtlasMultiDex()) {
                logger.error("atlasMultiDex is ignored");
            }
        }
        return fastMultiDex;
    }

    @Override
    public Collection<File> repackageJarList(Collection<File> files) throws IOException {

        List<String> mainDexList = getMainDexList(files);

        List<File> jarList = new ArrayList<>();
        List<File> folderList = new ArrayList<>();
        for (File file : files) {
            if (file.isDirectory()) {
                folderList.add(file);
            } else {
                jarList.add(file);
            }
        }

        File dir = new File(appVariantContext.getScope().getGlobalScope().getIntermediatesDir(),
                "fastmultidex/" + appVariantContext.getVariantName());
        FileUtils.deleteDirectory(dir);
        dir.mkdirs();

        if (!folderList.isEmpty()) {
            File mergedJar = new File(dir, "jarmerging/combined.jar");
            mergedJar.getParentFile().mkdirs();
            mergedJar.delete();
            mergedJar.createNewFile();
            JarMerger jarMerger = new JarMerger(mergedJar);
            for (File folder : folderList) {
                jarMerger.addFolder(folder);
            }
            jarMerger.close();
            if (mergedJar.length() > 0) {
                jarList.add(mergedJar);
            }
        }

        List<File> result = new ArrayList<>();
        File maindexJar = new File(dir, "fastmaindex.jar");

        JarOutputStream mainJarOuputStream = new JarOutputStream(
                new BufferedOutputStream(new FileOutputStream(maindexJar)));
        for (File jar : jarList) {
            File outJar = new File(dir, FileNameUtils.getUniqueJarName(jar) + ".jar");
            result.add(outJar);
            JarFile jarFile = new JarFile(jar);
            JarOutputStream jos = new JarOutputStream(new BufferedOutputStream(new FileOutputStream(outJar)));
            Enumeration<JarEntry> jarFileEntries = jarFile.entries();
            while (jarFileEntries.hasMoreElements()) {
                JarEntry ze = jarFileEntries.nextElement();
                String pathName = ze.getName();
                if (mainDexList.contains(pathName)) {
                    copyStream(jarFile.getInputStream(ze), mainJarOuputStream, ze, pathName);
                } else {
                    copyStream(jarFile.getInputStream(ze), jos, ze, pathName);
                }
            }
            jarFile.close();
            IOUtils.closeQuietly(jos);
        }
        IOUtils.closeQuietly(mainJarOuputStream);

        Collections.sort(result, new NameComparator());

        result.add(0, maindexJar);

        return result;
    }

    protected void copyStream(InputStream inputStream, JarOutputStream jos, JarEntry ze, String pathName) {
        try {

            ZipEntry newEntry = new ZipEntry(pathName);
            // Make sure there is date and time set.
            if (ze.getTime() != -1) {
                newEntry.setTime(ze.getTime()); // If found set it into output file.
            }
            jos.putNextEntry(newEntry);
            IOUtils.copy(inputStream, jos);
            IOUtils.closeQuietly(inputStream);
        } catch (Exception e) {
            throw new GradleException("copy stream exception", e);
        }
    }

    public List<String> getMainDexList(Collection<File> files) {

        GradleVariantConfiguration config = appVariantContext.getVariantConfiguration();

        Set<String> mainDexList = new HashSet<String>();

        //map
        //Map<String, String> classMap = getClassObfMap(config);

        File manifest = appVariantContext.getVariantData().getOutputs().get(0).manifestProcessorTask
                .getManifestOutputFile();

        String applicationName = ManifestFileUtils.getApplicationName(manifest);

        ClassPool classPool = new ClassPool();

        try {
            for (File file : files) {
                if (file.isFile()) {
                    classPool.insertClassPath(file.getAbsolutePath());
                } else {
                    classPool.appendClassPath(file.getAbsolutePath());
                }
            }
        } catch (NotFoundException e) {
            throw new GradleException(e.getMessage(), e);
        }

        TBuildConfig tBuildConfig = appVariantContext.getAtlasExtension().getTBuildConfig();

        HashSet handleList = new HashSet<String>();
        Set<String> headClasses = new HashSet<>();

        headClasses.add(applicationName);
        headClasses.add("android.taobao.atlas.bridge.BridgeApplicationDelegate");
        headClasses.addAll(multiDexConfig.getFirstDexClasses());

        String preLaunchStr = tBuildConfig.getPreLaunch();
        if (!org.apache.commons.lang3.StringUtils.isEmpty(preLaunchStr)) {
            String[] launchArray = preLaunchStr.split("\\|");
            if (launchArray.length > 0) {
                for (String launchItem : launchArray) {
                    String[] launchInfo = launchItem.split(":");
                    String clazzName = launchInfo[0];
                    headClasses.add(clazzName);
                }
            }
        }

        for (String headClass : headClasses) {
            addRefClazz(classPool, headClass, mainDexList, handleList);
        }

        //get manifest
        List<String> maindexListClazz = new ArrayList<String>();
        for (String newLine : mainDexList) {
            newLine = newLine.replaceAll("\\.", "/") + ".class";
            maindexListClazz.add(newLine);
        }

        try {
            FileUtils.writeLines(new File(appVariantContext.getProject().getBuildDir(), "outputs/maindexlist.txt"),
                    mainDexList);
        } catch (IOException e) {
            e.printStackTrace();
        }

        return maindexListClazz;
    }

    private Map<String, String> getClassObfMap(GradleVariantConfiguration config) {
        Map<String, String> classMap = new HashMap<String, String>();
        boolean isMinifyEnabled = config.isMinifyEnabled();
        File proguardOut = new File(Joiner.on(File.separatorChar).join(
                String.valueOf(appVariantContext.getScope().getGlobalScope().getBuildDir()), FD_OUTPUTS, "mapping",
                appVariantContext.getScope().getVariantConfiguration().getDirName()));
        File mappingFile = new File(proguardOut, "mapping.txt");
        // ?mapping,?mainDexListFile
        if (isMinifyEnabled && mappingFile.exists()) {
            MappingReader mappingReader = new MappingReader(mappingFile);
            MappingReaderProcess process = new MappingReaderProcess();
            try {
                mappingReader.pump(process);
            } catch (IOException e) {
                throw new GradleException(e.getMessage(), e);
            }
            classMap = process.classMapping;
        }
        return classMap;
    }

    @Nullable
    private String getRealClazz(Map<String, String> classMap, String line) {
        String realClazz = classMap.isEmpty() ? line : classMap.get(line);
        if (null == realClazz) {
            realClazz = line;
        }
        return realClazz;
    }

    private void addRefClazz(ClassPool classPool, String clazz, Set<String> classList, Set<String> handleList) {

        if (handleList.contains(clazz)) {
            return;
        }

        //???
        if (!multiDexConfig.getMainDexBlackList().isEmpty()) {
            for (String blackItem : multiDexConfig.getMainDexBlackList()) {
                if (clazz.startsWith(blackItem)) {
                    return;
                }
            }
        }

        try {

            CtClass ctClass = classPool.get(clazz);

            if (null != ctClass) {

                logger.info("[MainDex] add " + clazz + " to main dex list");
                classList.add(clazz);
                handleList.add(clazz);

                Collection<String> references = ctClass.getRefClasses();

                if (null == references) {
                    return;
                }

                for (String clazz2 : references) {
                    addRefClazz(classPool, clazz2, classList, handleList);
                }
            }
        } catch (Throwable e) {
        }
    }

    @Override
    public void dexMerge(List<Dex> dexList, File outDexFolder) throws IOException {

        List<DexDto> dexDtos = new ArrayList<>();
        DexDto dexDto = new DexDto();
        for (Dex dex : dexList) {
            if (!dexDto.addDex(dex)) {
                dexDtos.add(dexDto);
                dexDto = new DexDto();
                dexDto.addDex(dex);
            }
        }
        dexDtos.add(dexDto);

        ExecutorServicesHelper executorServicesHelper = new ExecutorServicesHelper("dexmerge",
                LoggerFactory.getLogger(FastMultiDexer.class), dexDtos.size());
        List<Runnable> runnables = new ArrayList<>(dexDtos.size());

        Dex[] mergedList = new Dex[dexDtos.size()];
        for (int i = 0; i < dexDtos.size(); i++) {
            final List<Dex> dexes = dexDtos.get(i).dexs;
            final int index = i;
            runnables.add(new Runnable() {
                @Override
                public void run() {
                    try {
                        mergeDex(outDexFolder, dexes, index, mergedList);
                    } catch (Throwable e) {
                        throw new GradleException(e.getMessage(), e);
                    }
                }
            });
        }

        try {
            executorServicesHelper.execute(runnables);
        } catch (InterruptedException e) {
            throw new GradleException(e.getMessage(), e);
        }

        //todo
        //System.out.println(mergedList.length);
        //File[] files = outDexFolder.listFiles(new FilenameFilter() {
        //    @Override
        //    public boolean accept(File dir, String name) {
        //        return name.endsWith("dex");
        //    }
        //});

    }

    private void mergeDex(File outDexFolder, List<Dex> tmpList, int index, Dex[] mergedList) throws IOException {

        DexMerger dexMerger = new DexMerger(tmpList.toArray(new Dex[0]), CollisionPolicy.KEEP_FIRST,
                new DxContext());
        Dex dex = dexMerger.merge();

        mergedList[index] = dex;

        String name = "classes" + (0 == index ? "" : String.valueOf(index + 1)) + ".dex";

        File dexFile = new File(outDexFolder, name);

        dex.writeTo(dexFile);
    }

    public static class DexDto {

        public List<Dex> dexs = new ArrayList<>();

        public int methods = 0;

        public int fields = 0;

        public boolean addDex(Dex dex) {

            int ms = dex.getTableOfContents().methodIds.size;
            int fs = dex.getTableOfContents().fieldIds.size;

            if (fs >= MAX_FIELD_IDS) {
                throw new DexIndexOverflowException("field ID not in [0, 0xffff]: " + fs);
            }
            if (methods + ms >= 63000 || fields + fs >= MAX_FIELD_IDS) {
                return false;
            }

            dexs.add(dex);
            methods += ms;
            fields += fs;

            return true;
        }

        private Set<String> getMethods(Dex dex) {
            Set<String> sets = new HashSet<>();
            for (MethodId mi : dex.methodIds()) {
                sets.add(mi.toString());
            }
            return sets;
        }

        private Set<String> getFields(Dex dex) {
            Set<String> sets = new HashSet<>();
            for (FieldId filedId : dex.fieldIds()) {
                sets.add(filedId.toString());
            }
            return sets;
        }
    }

    public static class DexWrapper {

        public Dex dex;

        public boolean addDex(Dex newDex, int count) {

            int ms = dex.getTableOfContents().methodIds.size;
            int fs = dex.getTableOfContents().fieldIds.size;

            int ms2 = newDex.getTableOfContents().methodIds.size;
            int fs2 = newDex.getTableOfContents().fieldIds.size;

            if (ms + ms >= count || ms2 + fs >= count) {
                return false;
            }

            return true;
        }
    }
}