https://github.com/beyama/winter
Kotlin Dependency Injection
https://github.com/beyama/winter
android annotation-processor dependency-injection kotlin kotlin-dependency-injection
Last synced: 10 months ago
JSON representation
Kotlin Dependency Injection
- Host: GitHub
- URL: https://github.com/beyama/winter
- Owner: beyama
- License: apache-2.0
- Created: 2017-10-20T06:46:30.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2024-07-31T08:53:13.000Z (over 1 year ago)
- Last Synced: 2025-03-24T08:12:14.321Z (10 months ago)
- Topics: android, annotation-processor, dependency-injection, kotlin, kotlin-dependency-injection
- Language: Kotlin
- Homepage: https://winter.jentz.io
- Size: 1.91 MB
- Stars: 12
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Winter
[](http://kotlinlang.org)
[](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.jentz.winter%22)
[](https://travis-ci.org/beyama/winter/builds)
[](https://github.com/beyama/winter/blob/master/LICENSE)
[](https://github.com/beyama/winter/issues)
## Kotlin Dependency Injection
Winter is a fast and intuitive dependency injection library for Kotlin on Android and the JVM.
It offers an idiomatic Kotlin API as well as optional JSR-330 support
with annotation processor.
**[Winter documentation](https://winter.jentz.io/)**
## Installation
```groovy
dependencies {
// Core
implementation 'io.jentz.winter:winter:0.7.0'
// AndroidX support
implementation 'io.jentz.winter:winter-androidx:0.7.0'
// RxJava 2 disposable plugin
implementation 'io.jentz.winter:winter-rxjava2:0.7.0'
// Java support
implementation 'io.jentz.winter:winter-java:0.7.0'
// JUnit 4 test support
testImplementation 'io.jentz.winter:winter-junit4:0.7.0'
// JUnit 5 test support
testImplementation 'io.jentz.winter:winter-junit5:0.7.0'
// Optional JSR-330 support
kapt 'io.jentz.winter:winter-compiler:0.7.0'
}
```
## Quickstart Android
Given is an Android application with an application component, a presentation subcomponent that
survives orientation changes and an activity subcomponent.
```kotlin
class MyApplication : Application() {
override fun onCreate() {
// define application component
Winter.component(ApplicationScope::class) {
singleton { HttpClientImpl() }
singleton { GitHubApiImpl(instance()) }
// define presentation subcomponent
subcomponent(PresentationScope::class) {
singleton { RepolistViewModel(instance()) }
// define activity subcomponent
subcomponent(ActivityScope::class) {
singleton { Glide.with(instance()) }
}
}
}
// Configure the injection adapter to use
Winter.useAndroidPresentationScopeAdapter()
// Create application dependency graph
Winter.inject(this)
}
}
class MyActivity : Activity() {
private val viewModel: RepoListViewModel by inject()
private val glide: RequestManager by inject()
override fun onCreate(savedInstanceState: Bundle?) {
Winter.inject(this)
super.onCreate(savedInstanceState)
}
}
```
## Read more
Winter is used in production since end of 2017. The API is considered mostly stable but there will
be no guarantee before version 1.x.
Winter supports only Android and JVM right now but support for native (iOS) and JavaScript is planed.
**[Winter documentation](https://winter.jentz.io/)**
## License
Copyright 2017 Alexander Jentz
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.