Moxy 2 is out! Check out the migration guide and give it a try!

Moxy is a library that helps to use MVP pattern when you do the Android Application. Without problems of lifecycle and boilerplate code!

The main idea of using Moxy:

Moxy has a few killer features in other ways:

• Presenter stay alive when Activity recreated(it simplifies work with multithreading)
• Automatically restore everything user sees when Activity recreated(including cases, when dynamic content is added)
• Capability to change many Views from one Presenter

View interface

interface MainView : MvpView {

    @StateStrategyType(AddToEndSingleStrategy::class)
    fun printLog(msg: String)
}

class MainActivity : MvpAppCompatActivity(), MainView {

    @InjectPresenter
    internal lateinit var presenter: MainPresenter

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
    }

    override fun printLog(msg: String) {
        Log.e(TAG, "printLog : msg : $msg activity hash code : ${hashCode()}")
    }

    companion object {
        const val TAG = "MoxyDebug"
    }
}

Presenter

@InjectViewState
class MainPresenter : MvpPresenter<MainView>() {
    override fun onFirstViewAttach() {
        super.onFirstViewAttach()
        Log.e(MainActivity.TAG, "presenter hash code : ${hashCode()}")
        viewState.printLog("TEST")
    }
}

@Inject
lateinit var daggerPresenter: Lazy<MainPresenter>

@InjectPresenter
lateinit var presenter: MainPresenter

@ProvidePresenter
fun providePresenter(): MainPresenter = daggerPresenter.get()

We will change this template in future In order to avoid boilerplate code creating for binding activity, fragments and its presentation part, we propose to use Android Studio templates for Moxy.

Telegram channels from original moxy community

Telegram channel (en)
Telegram channel (ru)

(Please replace moxyVersion with the latest version number: )

implementation "com.github.moxy-community:moxy:$moxyVersion"

annotationProcessor "com.github.moxy-community:moxy-compiler:$moxyVersion"

apply plugin: 'kotlin-kapt'

kapt "com.github.moxy-community:moxy-compiler:$moxyVersion"

For additional base view classes MvpActivity and MvpFragment add this:

implementation "com.github.moxy-community:moxy-android:$moxyVersion"

If you use AppCompat, use MvpAppCompatActivity and MvpAppCompatFragment add this:

implementation "com.github.moxy-community:moxy-app-compat:$moxyVersion"

If you use AndroidX, use MvpAppCompatActivity and MvpAppCompatFragment add this:

implementation "com.github.moxy-community:moxy-androidx:$moxyVersion"

If you use google material, use MvpBottomSheetDialogFragment add this:

implementation "com.github.moxy-community:moxy-material:$moxyVersion"

If you use kotlin, you can declare presenters in your views using property delegate:

class MyFragment: MvpFragment() {
    ...
    private val presenter by moxyPresenter { presenterProvider.get() }
    ...
}

To use MvpDelegateHolder.moxyPresenter, add this:

implementation "com.github.moxy-community:moxy-ktx:$moxyVersion"

By default, each MvpView method must have an annotation @StateStrategyType. In the old version of Moxy, it was allowed to omit strategy for methods. In this case, the default strategy was applied.

You can fallback to the old behavior. To do this, set the disableEmptyStrategyCheck parameter to true.

disableEmptyStrategyCheck : ‘true’

In this case, the default strategy will be AddToEndSingleStrategy. In old version default strategy was AddToEndStrategy.

To change default strategy, provide defaultMoxyStrategy parameter with the full qualified class name of new default strategy.

defaultMoxyStrategy : 'moxy.viewstate.strategy.OneExecutionStateStrategy'

If compiler finds MvpView method without annotation @StateStrategyType, compilation will fail with clarifying error message. To ease migration from older versions there is additional mechanism you can optionally enable. It collects all the errors associated with an empty strategy in one generated class called EmptyStrategyHelper. Using this class, you can easily navigate to all methods with a missing strategy.

To turn on generation of this class, enable this compiler option:

enableEmptyStrategyHelper : 'true'

To see, how to correctly use compilation flags, check out sample-app build.gradle file

If you using any of moxy-android, moxy-appcompat, moxy-androidx or moxy-material artifacts, no additional configuration required. If you use only moxy, you need to manually include rules from this file.

• [✓] Provide a migration tool from com.arello-mobile.moxy and its default strategy
• [✓] Kotlin incremental compilation support
• [✓] Remove reflectors
• [✓] Add delivery module support
• [х] Add separate Annotation Processor for migration
• Provide Runtime Implementation
• Research possibility of removing @InjectViewState annotation

Brave people, who created this library

@senneco @jordan1997 @xanderblinov @asitnkova @alaershov @bejibx @katkoff @ekursakov @SavinMike @sychyow @AlexeyKorshun @dmdevgo @rsajob @terrakok @mohaxspb @CherryPerry @fl1pflops @phoenixxt @Dosssik @AcoustickSan @seven332 @v-grishechko @sbogolepov @A-Zaiats @lion4ik

You may also find them in contributors page of old project

Install code style to your IntelliJ or Android Studio. MoxyAndroid.xml For import file use or Mac OS: Preferences -> Editor -> Code style -> Scheme -> Import Scheme -> IntelliJ IDEA code style XML -> choose the MoxyAndroid.xml file in finder

The MIT License (MIT)

Copyright (c) 2019 Moxy Community

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.