Reading classes

Streaming classes from a jar file

You can read classes from class files and various types of (nested) jar files or jmod files, with some convenient utility classes and visitors. For example, you can read all classes from all jar files in a given directory and print them out in a streaming fashion, while they are read, without collecting their representations:

DataEntrySource source =
    new DirectorySource(
    new File(inputDirectoryName));

source.pumpDataEntries(
    new FilteredDataEntryReader(new DataEntryNameFilter(new ExtensionMatcher(".jar")),
    new JarReader(
    new ClassFilter(
    new ClassReader(false, false, false, false, null,
    new ClassPrinter())))));

Note the constructor-based dependency injection, to create a chain of visitor classes. We typically use a slightly unconventional indentation to make this construct easy to read.

Complete example: PrintClasses.java

Streaming classes from a dex/apk file

With the addition of proguard-core-android, you can read classes from dex/apk files just like you would with jar files. A small example showing how to use DexClassReader() to read classes from a dex/apk file:

DataEntrySource source = 
    new DirectorySource(
    new File(inputDirectoryName));

DataEntryReader classReader =
    new NameFilteredDataEntryReader("**.class",
    new ClassReader(false, false, false, false, null,
    new ClassNameFilter("**", null)));

// Convert dex files to a jar first
classReader =
    new NameFilteredDataEntryReader("classes*.dex",
    new DexClassReader(true,
    new ClassPrinter()),
    classReader);

source.pumpDataEntries(classReader);

Do note that in order to use dex/apk file reading functionalities within your project, you must import proguard-core-android in the build.gradle file:

build.gradle

dependencies {
  ...
  implementation project('com.guardsquare:proguard-core')
  implementation project('com.guardsquare:proguard-core-android')
  ...
}

A complete example for reading from dex, apk and jar files can be found in: JarUtil.java

Writing out streamed classes

You can read classes, optionally perform some small modifications, and write them out right away, again in a streaming fashion.

JarWriter jarWriter =
    new JarWriter(
    new ZipWriter(
    new FixedFileWriter(
    new File(outputJarFileName))));

DataEntrySource source =
    new FileSource(
    new File(inputJarFileName));

source.pumpDataEntries(
    new JarReader(
    new ClassFilter(
    new ClassReader(false, false, false, false, null,
    new DataEntryClassWriter(jarWriter)))));

jarWriter.close();

Complete example: ApplyPeepholeOptimizations.java

Collecting classes

Alternatively, you may want to collect the classes in a so-called class pool first, so you can perform more extensive analyses on them:

ClassPool classPool = new ClassPool();

DataEntrySource source =
    new FileSource(
    new File(jarFileName));

source.pumpDataEntries(
    new JarReader(false,
    new ClassFilter(
    new ClassReader(false, false, false, false, null,
    new ClassPoolFiller(classPool)))));

Complete example: Preverify.java

Writing out a set of classes

If you've collected a set of classes in a class pool, you can write them out with the same visitors as before.

JarWriter jarWriter =
    new JarWriter(
    new ZipWriter(
    new FixedFileWriter(
    new File(outputJarFileName))));

classPool.classesAccept(
    new DataEntryClassWriter(jarWriter));

jarWriter.close();

Complete example: Preverify.java