Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/misfitlabsdev/kotlin-guice
Guice DSL extensions for Kotlin
https://github.com/misfitlabsdev/kotlin-guice
dependency-injection guice kotlin
Last synced: 4 months ago
JSON representation
Guice DSL extensions for Kotlin
- Host: GitHub
- URL: https://github.com/misfitlabsdev/kotlin-guice
- Owner: misfitlabsdev
- License: apache-2.0
- Created: 2017-06-15T15:23:51.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-06-26T14:43:13.000Z (over 1 year ago)
- Last Synced: 2024-10-01T17:05:48.301Z (5 months ago)
- Topics: dependency-injection, guice, kotlin
- Language: Kotlin
- Homepage:
- Size: 376 KB
- Stars: 66
- Watchers: 3
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
kotlin-guice
============
Guice extensions for Kotlin. This provides extension wrappers and extension methods for providing a better Guice DSL experience from Kotlin. It takes advantage of reified types to reduce class references like `bind(MyResource::class.java)` to `bind()`.
## Download
Download the latest JAR via Maven:
```xml
dev.misfitlabs.kotlinguice4
kotlin-guice
3.0.0
```
or Gradle:
```gradle
compile 'dev.misfitlabs.kotlinguice4:kotlin-guice:3.0.0'
```
## Getting Started
### KotlinModule
Use `KotlinModule` for Guice modules instead of `AbstractModule` to take advantage of the enhanced Kotlin Guice DSL.
```kotlin
import dev.misfitlabs.kotlinguice4.KotlinModule
class MyModule : KotlinModule() {
override fun configure() {
bind().to().`in`()
bind>().to()
bind().annotatedWith().to()
}
}
```
The `KotlinPrivateModule` can also be used if only some bindings need to be exposed.
```kotlin
import dev.misfitlabs.kotlinguice4.KotlinPrivateModule
class MyPrivateModule : KotlinPrivateModule() {
override fun configure() {
bind().to().`in`()
bind>().to()
bind().annotatedWith().to()
expose>()
}
}
```
### Injector
The Guice injector has been enhanced with extension methods to make direct use of the injector better from Kotlin.
```kotlin
import dev.misfitlabs.kotlinguice4.annotatedKey
import dev.misfitlabs.kotlinguice4.getInstance
fun main(args: Array) {
val injector = Guice.createInjector(MyModule(), MyPrivateModule())
val paymentService = injector.getInstance>()
// Use the annotatedKey to get an annotated instance
val payPalProcessor = injector.getInstance(annotatedKey())
}
```
### Key and TypeLiteral
Package level functions are included to enhance creating `Key` and `TypeLiteral` instances from kotlin.
```kotlin
import dev.misfitlabs.kotlinguice4.annotatedKey
import dev.misfitlabs.kotlinguice4.key
import dev.misfitlabs.kotlinguice4.typeLiteral
val key = key()
val annotatedKey = annotatedKey()
val sameAnnotatedDifferentKey = annotatedKey.getType()
val listType = typeLiteral>()
```
### Multibindings
As of version 1.4.1 the kotlin-guice-multibindings module is gone and the functionality has been merged into kotlin-guice.
#### Usage
```kotlin
val multibinder = KotlinMultibinder.newSetBinder(kotlinBinder)
multibinder.addBinding().to()
val mapbinder = KotlinMapBinder.newMapBinder(kotlinBinder)
mapbinder.addBinding("twix").to()
```
With Guice 4.2+, scanning for methods with the multibinding annotations `ProvidesIntoSet`, `ProvidesIntoMap`, and `ProvidesIntoOptional` is enabled by default. However, the default scanner only provides bindings for Java collection types. In order to get bindings for Kotlin collection types, install the `KotlinMultibindingsScanner`.
```kotlin
install(KotlinMultibindingsScanner.asModule())
```
## License
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.