Katana

Lightweight, minimalistic dependency injection library for Kotlin & Android

Description

Katana is a lightweight, minimalistic dependency injection library (similar to the service locator pattern) for Kotlin on the JVM, designed especially with Android in mind.

Programming language: Kotlin

License: MIT License

Tags: Dependency Injection     Kotlin     Library     Service-Locator     Kotlin Library    

Latest version: v1.15.0

README

‼️ This project is in maintenance mode and not actively developed anymore. For more information read this statement. ‼️

Katana

Katana is a lightweight, minimalistic dependency injection library (similar to the service locator pattern) for Kotlin on the JVM, designed especially with Android in mind.

• Extremely lightweight footprint (only ~15kB in classes and ~130 methods after ProGuard), plain Kotlin, no third-party dependencies
• It's [fast](./speed-comparison) (also see this comparison)
• "Less is more", therefore:
  • No global singleton state. Likelihood of memory leaks is greatly reduced unless YOU are doing something wrong ;P
  • No reflection (see this regarding type erasure)
  • No code generation (unless inline functions count)
  • No dependency overrides possible (see [Overrides](./Getting%20Started.md#overrides))

Getting Started

Want to know more? Please read [Getting Started](./Getting%20Started.md).

Artifacts

Katana consists of a core library and several additional libraries that extend Katana's functionality. All artifact are published in group org.rewedigital.katana. Here's a quick overview of all available artifacts:

Artifact	Description
katana-core	Provides core functionality. Suitable for plain Kotlin (JVM) and Android.
[katana-android](./android)	Android-specific extensions like modules for Activity and Fragment, KatanaFragment etc.
[katana-androidx-fragment](./androidx-fragment)	Additional support for androidx.fragment providing a Katana-based FragmentFactory.
[katana-androidx-viewmodel](./androidx-viewmodel)	Enables dependency injection for AndroidX ViewModel.
[katana-androidx-viewmodel-savedstate](./androidx-viewmodel-savedstate)	Support for AndroidX ViewModel with SavedState.

Help & Contribution

If you found a bug or want to suggest a feature, please create an issue.
If you need help, visit our Slack channel.

Further Reading

• Why we need yet another dependency injection framework for Kotlin & Android
• Leak free dependency injection in Android
• Android UI testing with Katana
• Android Fragments & dependency injection
• Dependency injection into Android ViewModels (with Savedstate)
• Multibindings with Katana
• Slides of a talk about Katana at the Kotlin User Group Cologne
• More Slides (German) of a Katana talk held at the 2019 Kotlin/Everywhere event at REWE Digital in Cologne.

License

The MIT license (MIT)

Copyright (c) 2018-2021 REWE Digital GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.