/napt

Alternative to KAPT that skips Java stub generation and therefore is as efficient as Java APT but with Kotlin

Primary LanguageKotlinMIT LicenseMIT

NAPT

Plugin License

What is it?

An alternative to KAPT that skips stub generation and hence runs up to 50% faster

Usage

JDK 9+ is required to run this particular set of tools

Once applied, you can't reference generated code in Kotlin code anymore, so you'd have to write Java bridge classes in order to reference Java generated code in Kotlin sources.

For example, assume we have the following Kotlin Dagger 2 Component:

@Component
interface Component {

    @Component.Factory
    interface Factory {

        fun create(): Component
    }
}

then, in order to reference the generated component from Kotlin code we have to write Java bridge that would look like this:

class ComponentBridge {

    static Component.Factory factory() {
        return DaggerComponent.factory();
    }
}

That's it, now you can easily reference this bridge from your Kotlin code wherever you'd like to

Sample

You could see an example of usage in sample

Download

  • javac plugin is distributed through Maven Central
  • Gradle plugin is distributed through Gradle Plugin Portal

Add plugin

Remove your old

plugins {
    kotlin("kapt")
}

and replace it with

plugins {
    id("com.sergei-lapin.napt") version("{latest-version}")
}

then you can replace all of your

dependencies {
    kapt("some dependency")
}

with

dependencies {
    annotationProcessor("some dependency")
}

That's it. Enjoy speed the speed-up of your annotation processing by ~50%.

Conflitcting NaptTrigger classes

By default, Gradle plugin will generate NaptTrigger with module-named package so the FQ names won't clash, but, just in case, the prefix of NaptTrigger package can be specified like that:

napt {
    naptTriggerPackagePrefix.set("com.slapin.napt")
}

Assume we're in module named sample, will result in the following NaptTrigger.java:

package com.slapin.napt.sample;
class NaptTrigger {
}

Disabling NaptTrigger generation

NaptTrigger.java generation can be disabled (e.g. when you already have java sources in your module) by setting corresponding property to false:

napt {
    generateNaptTrigger.set(false)
}

Supplying custom JVM arguments to Java compiler

In order for napt to work, Java compilation runs in forked process with arguments defined by com.slapin.napt.JvmArgsStrongEncapsulation. These arguments could be extended by setting corresponding property in napt extension.

napt {
    forkJvmArgs.set(listOf("your_custom_arg"))
}

Generating NaptTrigger within additional source sets

Sometimes you might need to trigger annotation processing in additional source sets (e.g. test). In such cases you can use corresponding property from napt extension:

napt {
    additionalSourceSetsForTriggerGeneration.set(listOf("test"))
}