Toothpick (a.k.a T.P. like a teepee)

Visit TP wiki !

What is Toothpick ?

Toothpick is a scope tree based Dependency Injection (DI) library for Java.

It is a full-featured, runtime based, but reflection free, implementation of JSR 330.

What does Toothpick offer ?

//a typical Toothpick scope tree during the execution of an Android app.

       @ApplicationSingleton 
         /              |    \  
        /               |     \
       /                |      \
   @PresenterSingleton  |   Service 2
         /              | 
        /            Service 1  
       /            
Activity 1
    /   \
   /   Fragment 2
  /
Fragment 1

Toothpick is :

pure java (and Android helped is provided: "Smoothie")
fast, it doesn't use reflection but annotation processing
simple, flexible, extensible & powerful, robust & tested
thread safe
documented & Open Source
scope safe : it enforces leak free apps
test oriented : it makes tests easier
it works very well with Android or any other context based framework (such as web containers)

Hey, Android Devs, you can use TP to create MVP apps so easily !

Examples

Currently Toothpick has 2 sets of examples :

one in pure Java
one for Android

Setup

The latest version of TP is provided by a badge at the top of this page.

For Android :

#android setup using gradle 3.3.0
buildscript {
  repositories {
    google()
    jcenter()
  }
  dependencies {
    classpath 'com.android.tools.build:gradle:3.3.0'
  }
}

...

dependencies {
  implementation 'com.github.stephanenicolas.toothpick:toothpick-runtime:2.x'
  // and for android -> implementation 'com.github.stephanenicolas.toothpick:smoothie-androidx:2.x'
  annotationProcessor 'com.github.stephanenicolas.toothpick:toothpick-compiler:2.x'

  //highly recommended
  testImplementation 'com.github.stephanenicolas.toothpick:toothpick-testing-junit5:2.x'
  testImplementation 'mockito or easymock'
}

For java:

<!--java setup with maven -->
  <dependencies>
    <dependency>
      <groupId>com.github.stephanenicolas.toothpick</groupId>
      <artifactId>toothpick-compiler</artifactId>
      <version>2.x</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>com.github.stephanenicolas.toothpick</groupId>
      <artifactId>toothpick-runtime</artifactId>
      <version>2.x</version>
      <scope>compile</scope>
    </dependency>
    
    <!-- highly recommended-->
    <dependency> 
      <groupId>com.github.stephanenicolas.toothpick</groupId>
      <artifactId>toothpick-testing</artifactId>
      <version>2.x</version>
      <scope>test</scope>
    </dependency>
    <dependency>
    <easymock or mockito>
    </dependency>
  </dependencies>

Support

TP is actively maintained and we provide support to questions via the Toothpick-di tag on Stack Over Flow.

Ask questions on Stack Over Flow while keeping the GitHub issue board for real issues. Thx in advance !

Talks & Articles

How I learned to love unit testing with Toothpick - Groupon's medium blog article
Droidcon, Boston 2017 - Slides & Video
Migrating off RoboGuice 3 (to Toothpick) - Part 1 & Part 2
Mobius, Saint Petersburg 2017 - Slides
Mobius, Saint Petersburg 2017 - DI frameworks & Internals Slides
Android Makers, Paris 2017 - Slides & Video
DroidCon, Kaigi 2017 - Slides
Andevcon, San Francisco 2016 - Slides
DroidCon, Krakow 2016 - TP Vs Dagger 2 Talk from Danny Preussler slides
Mobile Era, Oslo 2016 - Slides
Droidcon, Berlin 2016 - Slides - Sketch notes
Android Leaks 2016 - podcast in French
DevFest Belgium 2016 - video in French
DevFest Siberia 2017 - video in Russian
DevFest North 2017 - video in Russian

Wanna know more ?

Visit Toothpick's wiki !

Alternative Dependency Injection (DI) engines for Android

~~RoboGuice~~ (deprecated)
~~Dagger 1~~ (deprecated)
Dagger 2
transfuse
lightsaber
tiger
feather
proton

Libs using TP

Okuki is a simple, hierarchical navigation bus and back stack for Android, with optional Rx bindings, and Toothpick DI integration.
KotlinWeather is a simple example of using ToothPick with Kotlin and gradle integration using kapt.

Credits

Most of the effort on version 2 has been actively supported by Groupon. Thanks for this awesome OSS commitment !

lukaville / toothpick