koin-java

Koin

License	License The Apache Software License, Version 2.0
Categories	Categories Java Languages
GroupId	GroupId co.touchlab
ArtifactId	ArtifactId koin-java
Last Version	Last Version 2.1.5-mp
Release Date	Release Date Jul 12, 2019
Type	Type jar
Description	Description koin-java Koin
Project URL	Project URL https://github.com/touchlab/koin
Source Code Management	Source Code Management https://github.com/touchlab/koin

Download koin-java

Filename	Size
koin-java-2.1.5-mp.pom
koin-java-2.1.5-mp.jar	3 KB
koin-java-2.1.5-mp-sources.jar	1 KB
koin-java-2.1.5-mp-javadoc.jar	261 bytes
Browse

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/co.touchlab/koin-java/ -->
<dependency>
    <groupId>co.touchlab</groupId>
    <artifactId>koin-java</artifactId>
    <version>2.1.5-mp</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/co.touchlab/koin-java/
implementation 'co.touchlab:koin-java:2.1.5-mp'

Gradle Kotlin

// https://jarcasting.com/artifacts/co.touchlab/koin-java/
implementation ("co.touchlab:koin-java:2.1.5-mp")

Apache Buildr

'co.touchlab:koin-java:jar:2.1.5-mp'

Apache Ivy

<dependency org="co.touchlab" name="koin-java" rev="2.1.5-mp">
  <artifact name="koin-java" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='co.touchlab', module='koin-java', version='2.1.5-mp')
)

Scala SBT

libraryDependencies += "co.touchlab" % "koin-java" % "2.1.5-mp"

Leiningen

[co.touchlab/koin-java "2.1.5-mp"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

What is KOIN?

A pragmatic lightweight dependency injection framework for Kotlin developers.

Written in pure Kotlin, using functional resolution only: no proxy, no code generation, no reflection.

Koin is a DSL, a light container and a pragmatic API

Official Website 👉 https://insert-koin.io

Latest News 🌐

Follow us on Twitter for latest news: @insertkoin_io
Koin developers on Medium: koin developers hub

Getting Help 🚒

Documentation:

Any question about Koin usage?

Come talk on slack #koin channel
Post your question on Stackoverflow - #koin tag

Articles, Videos & other resources 🎉

Online resources about Koin - Talking about Koin

Reporting issues 🚑

Found a bug or a problem on a specific feature? Open an issue on Github issues

Contributing 🛠

Want to help or share a proposal about Koin? problem on a specific feature?

Open an issue to explain the issue you want to solve Open an issue
Come talk on slack #koin-dev channel
After discussion to validate your ideas, you can open a PR or even a draft PR if the contribution is a big one Current PRs

Additional readings about basic setup: https://github.com/InsertKoinIO/koin/blob/master/CONTRIBUTING.adoc

Setup

Current Version

// latest stable
koin_version = '2.1.0'

Gradle

Jcenter

Check that you have the jcenter repository.

// Add Jcenter to your repositories if needed
repositories {
	jcenter()    
}

Dependencies

Pick one of your Koin dependency:

Gradle Plugin

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath "org.koin:koin-gradle-plugin:$koin_version"
    }
}

apply plugin: 'koin'

Core features

// Koin for Kotlin
implementation "org.koin:koin-core:$koin_version"
// Koin extended & experimental features
implementation "org.koin:koin-core-ext:$koin_version"
// Koin for Unit tests
testImplementation "org.koin:koin-test:$koin_version"
// Koin for Java developers
implementation "org.koin:koin-java:$koin_version"

Android

// Koin for Android
implementation "org.koin:koin-android:$koin_version"
// Koin Android Scope features
implementation "org.koin:koin-android-scope:$koin_version"
// Koin Android ViewModel features
implementation "org.koin:koin-android-viewmodel:$koin_version"
// Koin Android Experimental features
implementation "org.koin:koin-android-ext:$koin_version"

AndroidX

// Koin AndroidX Scope features
implementation "org.koin:koin-androidx-scope:$koin_version"
// Koin AndroidX ViewModel features
implementation "org.koin:koin-androidx-viewmodel:$koin_version"
// Koin AndroidX Fragment features
implementation "org.koin:koin-androidx-fragment:$koin_version"
// Koin AndroidX Experimental features
implementation "org.koin:koin-androidx-ext:$koin_version"

Ktor

// Koin for Ktor Kotlin
implementation "org.koin:koin-ktor:$koin_version"

Quickstart

Declare a Koin module

Write with the Koin DSL what you need to assemble:

// Given some classes 
class Controller(val service : BusinessService) 
class BusinessService() 

// just declare it 
val myModule = module { 
  single { Controller(get()) } 
  single { BusinessService() } 
}

Starting Koin

Use the startKoin() function to start Koin in your application.

In a Kotlin app:

fun main(vararg args : String) { 
  // start Koin!
  startKoin {
    // your modules
    modules(myModule)
  }
}

In an Android app:

class MyApplication : Application() {
  override fun onCreate(){
    super.onCreate()
    // start Koin!
    startKoin {
      // Android context
      androidContext(this@MyApplication)
      // modules
      modules(myModule)
    }
  } 
}