AndroidMVPHelper

AndroidMVPHelper
MVP на стероидах

Цели проекта
• Упростить интеграцию MVP паттерна;
• Избавиться от написания “рутинного” кода;
• Добавить дополнительный функционал.

Что такое MVP
View Presenter Model
● Представление (View) — реализует отображение данных, обращается к
представителю за обновлениями;
● Представитель (Presenter) — реализует взаимодействие между моделью
и представлением.
● Модель (Model) — содержит в себе бизнес-логику, получает данные из
хранилища.

Модули
base_mvp
mvp
mvp_presenter mvp_rx2_presenter
mvp_list
mvp_autosavable mvp_autosavable_annotation
mvp_view_wrap mvp_view_wrap_annotation

Модуль mvp
Основные классы:
• BaseMvpActivity
• BaseMvpFragment
• BaseMvpDialogFragment
Возможности:
• Управление жизненным циклом
компонентов
• Установка лейаута и инъекция вью-полей
• Зануление вью-полей
• LifeCycleObservable

Модуль mvp.  
Имплементация.
MVP component
IViewState IPresenter
Models

Модуль mvp.
Имплементация. ViewState.
public class ViewState implements IViewState<ViewState.IViewStateView> { 
public void save(@NotNull Bundle bundle)
public void restore(@NotNull Bundle bundle)
public void apply(@NotNull IViewStateView iViewStateView)
 
public interface IViewStateView { 
//Methods to provide data from ViewState to View 
} 
 
}

Модуль mvp.
Имплементация. Presenter.
public class Presenter extends BaseAsyncPresenter<Presenter.IPresenterView> { 
//BaseAsyncExecutorPresenter<Presenter.IPresenterView> 
//BaseAsyncRxSchedulerPresenter<Presenter.IPresenterView> 
//IAsyncPresenter<Presenter.IPresenterView> 
//IPresenter<Presenter.IPresenterView> 
 
 
public interface IPresenterView extends BaseAsyncPresenter.ITaskListener { 
//Methods to provide data from View to Presenter and backwards. 
} 
 
}

Модуль mvp.
interface IPresenter<in T> { 
 
fun onAttachView(view: T) 
 
fun onDetachView() 
 
}

Модуль mvp.
interface IAsyncPresenter<in T : IAsyncPresenter.ITaskListener> : IPresenter<T> { 
 
fun cancel() 
 
interface ITaskListener { 
 
fun onTaskStatusChanged(taskId: Int, status: Int) 
 
} 
 
}

Модуль mvp.
open class BaseAsyncPresenter<T : IAsyncPresenter.ITaskListener> : BasePresenter<T>(),
IAsyncPresenter<T> {
fun <T> execute(callable: Callable<T>, executor: AbstractExecutorService, id: Int): Future<T>
fun execute(runnable: Runnable, executor: AbstractExecutorService, id: Int): Future<Unit>

Модуль mvp.
fun waitForViewIfNeeded(): T
protected fun checkIfInterruptedException(ex: Throwable?): Boolean
 
protected fun isInMainThread(): Boolean
protected inline fun postOnMainThread(crossinline body: () -> Unit)

Модуль mvp.
protected fun notifyTaskAdded(task: Int)
protected fun notifyTaskFinished(task: Int)
fun isTaskRunning(task: Int): Boolean
fun isAnyOfTasksRunning(vararg tasks: Int): Boolean
fun hasRunningTasks(): Boolean

Модуль mvp.
abstract class BaseAsyncExecutorPresenter<T : IAsyncPresenter.ITaskListener>
: BaseAsyncPresenter<T>(), IAsyncPresenter<T> {
protected abstract fun createExecutor(): ThreadPoolExecutor
fun <T> execute(callable: Callable<T>, id: Int): Future<T>
fun execute(runnable: Runnable, id: Int): Future<Unit>
protected fun useSaveThreadFactory(): Boolean = true

Модуль mvp.
abstract class BaseAsyncRxSchedulerPresenter<T : IAsyncPresenter.ITaskListener>
:
BaseAsyncExecutorPresenter<T>() {
fun <T> execute(observable: Observable<T>, 
subscribeOn: Scheduler, 
observeOn: Scheduler, 
id: Int, 
onNext: Consumer<T>? = null, 
onError: Consumer<Throwable>? = null, 
onComplete: Action? = null, 
provideInterruptedException: Boolean = false): Disposable

Модуль mvp.
fun <T> execute(observable: Observable<T>, 
taskId: Int, 
onNext: Consumer<T>? = null, 
onError: Consumer<Throwable>? = null, 
onComplete: Action? = null, 
provideInterruptedException: Boolean = false): Disposable

Модуль mvp.
Имплементация. View.
public interface IView extends Presenter.IPresenterView,
ViewState.IViewStateView {
//Other methods
}

Модуль mvp.
Имплементация. Activity.
public class Activity extends BaseMvpActivity<IView, Presenter, ViewState> implements IView {
public IView getMvpView() { return this;}
public ViewState createViewState() { return new ViewState();}
public Presenter createPresenter() { return new Presenter();}
public void createView()
public void onInitialized(Presenter presenter, ViewState viewState)
public void onTaskStatusChanged(int taskId, int status)
}

Модуль mvp.
Имплементация. Fragment.
public class Fragment extends BaseMvpFragment<IView, Presenter, ViewState> implements IView {
public IView getMvpView() { return this;}
public ViewState createViewState() { return new ViewState();}
public Presenter createPresenter() { return new Presenter();}
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
public void onInitialized(Presenter presenter, ViewState viewState)
public void onTaskStatusChanged(int taskId, int status)
}

Сохранение компонентов.
@Override 
public boolean retainPresenter() { 
return true; 
} 
 
@Override 
public boolean retainViewState() { 
return true; 
}
}

Вью инъекция и зануление.
@Layout(R.layout.fragment_layout) 
public class Fragment extends BaseMvpFragment<IView, Presenter, ViewState> implements IView { 
 
@InjectView(R.id.text_view) 
protected TextView textView; 
 
@Override 
public boolean nullViews() { 
return true; 
} 
 
}

Activity
• ON_CREATE
• ON_START
• ON_RESUME
• ON_PAUSE
• ON_STOP
• ON_SAVE_INSTANCE
• ON_DESTROY
Fragment
• ON_ATTACH
• ON_CREATE
• ON_VIEW_CREATED
• ON_ACTIVITY_CREATED
• ON_START
• ON_RESUME
• ON_PAUSE
• ON_STOP
• ON_SAVE_INSTANCE
• ON_DESTROY_VIEW
• ON_DESTROY
• ON_DETACH
Модуль mvp.
Подписка на жизненный цикл.

Модуль mvp.
Подписка на жизненный цикл. Activity.
object ActivityLifecycle {
//Constants for supported activity lifecycle events
@Target(AnnotationTarget.FUNCTION) 
@Retention(AnnotationRetention.RUNTIME) 
@Inherited 
annotation class OnLifecycleEvent(@ActivityEvent val event: Int)
}

Модуль mvp.
Подписка на жизненный цикл. Fragment.
object FragmentLifecycle {
//Constants for supported fragment lifecycle events
@Target(AnnotationTarget.FUNCTION) 
@Retention(AnnotationRetention.RUNTIME) 
@Inherited 
annotation class OnLifecycleEvent(@FragmentEvent val event: Int)
}

Модуль mvp.
public class CameraManager { 
 
@FragmentLifecycle.OnLifecycleEvent(event = FragmentLifecycle.ON_VIEW_CREATED) 
public void onViewCreated() 
 
public void onViewCreated(Fragment fragment) 
 
public void onViewCreated(Fragment fragment, View view) 
 
public void onViewCreated(Fragment fragment, View view, Bundle savedInstance) 
 
}

Модуль mvp.
private CameraManager cameraManager; 
 
public Fragment() { 
cameraManager = new CameraManager(); 
subscribe(cameraManager); 
}
}

Модуль mvp_autosavable.
Назначение:
• Сохранение полей ViewState в Bundle и
восстановление их оттуда.

Использование.
@AutoSavable(includeSuper = false) 
public class ViewState implements IViewState<ViewState.IViewStateView> { 
 
private ArrayList<Integer> integers; 
 
@Ignore 
private boolean ignoredField = false; 
 
public ArrayList<Integer> getIntegers() { 
return integers; 
} 
 
public void setIntegers(ArrayList<Integer> integers){ 
this.integers = integers; 
}

@Override 
public void save(@NotNull Bundle bundle) { 
ViewStateSaver.save(this, bundle); 
} 
 
@Override 
public void restore(@NotNull Bundle bundle) { 
ViewStateSaver.restore(this, bundle); 
}
}

Сгенерированный класс.
public final class ViewStateSaver {
 
public static void save(ViewState state, Bundle inState) { 
inState.putSerializable("integers", (Serializable) state.getIntegers()); 
} 
 
public static void restore(ViewState state, Bundle outState) { 
state.setIntegers((ArrayList<Integer>) outState.getSerializable("integers")); 
}
 
}

Модуль mvp_view_wrap.
Назначение:
• Упрощает вызов методов в главном потоке из рабочих
потоков;
• Позволяет вызывать методы в главном потоке,
синхронно с работающим.

@Wrap 
public interface IView extends Presenter.IPresenterView,
ViewState.IViewStateView { 
 
void foo(); 
 
Object bar(); 
 
@Ignore 
void ignoredMethod(); 
 
}

Сгенерированный класс.
public final class IViewWrap implements IView {
private final IView wrappedView; 
 
private final Handler mainHandler = new Handler((Looper.getMainLooper())); 
 
public IViewWrap(IView wrappedView) { 
this.wrappedView = wrappedView; 
}

Сгенерированный класс. foo()
final Object lockObject = new Object(); 
synchronized(lockObject) { 
mainHandler.post(new Runnable() { 
@Override 
public void run() { 
wrappedView.foo(); 
lockObject.notify(); 
}} 
}); 
try { 
lockObject.wait(); 
} catch (InterruptedException ex) { 
ex.printStackTrace(); 
throw new RuntimeException(ex); 
} 
}

Сгенерированный класс. bar()
final Object lockObject = new Object(); 
final Object[] returnValueArray = new Object[1]; 
mainHandler.post(new Runnable() { 
@Override 
public void run() { 
returnValueArray[0] = wrappedView.bar(); 
lockObject.notify(); 
}} 
}); 
try { 
lockObject.wait(); 
} catch (InterruptedException ex) { 
ex.printStackTrace(); 
throw new RuntimeException(ex); 
} 
} 
return (Object) returnValueArray[0];

Сгенерированный класс. ignoredMethod()
public void ignoredMethod() { 
wrappedView.ignoredMethod(); 
}

public class Activity 
extends BaseMvpActivity<IView, Presenter, ViewState> 
implements IView { 
 
private IViewWrap wrap = new IViewWrap(this); 
 
@NotNull 
@Override 
public IView getMvpView() { 
return wrap; 
}

Модуль mvp_list.
Быстрая имплементация экранов со списком на основе
RecyclerView c
• Пейджингом
• Поиском
• Swipe to refresh
• Прогресс бары в списке и на весь экран
• Заглушки «нет контента» и «произошла ошибка»

MVP component
IViewState IPresenter
Models
Delegate

Имплементация. IPagingResponse.
interface IPagingResponse { 
 
val data: MutableList 
 
val canLoadMore: Boolean 
 
}

public class PagingViewState
extends BasePagingSearchableViewState<AwesomeEntity, PagingViewState.IViewStateView> { 
public List<AwesomeEntity> getItems() 
 
public void setItems(@Nullable List<AwesomeEntity> list) 
 
public void save(@NotNull Bundle out) 
 
public void restore(@NotNull Bundle inState) 
 
public interface IViewStateView
extends BasePagingSearchableViewState.IViewStateView<AwesomeEntity> 
 
}

abstract class BasePagingSearchableViewState<I,
in V : BasePagingSearchableViewState.IViewStateView> : IViewState<V> {
companion object { 
@JvmField val NO_ERROR_CODE = -1 
} 
 
var query = "" 
 
abstract var items: MutableList? 
 
var canLoadMore = false 
 
var nextPageFailed = false 
 
var errorCode = NO_ERROR_CODE

interface IViewStateView { 
 
fun setQuery(query: String) 
 
fun setItems(items: MutableList, canLoadMore: Boolean, isSearch: Boolean) 
 
fun setNextPageLoadFailed(code: Int) 
 
fun setFirstPageLoadFailed(code: Int) 
 
}

public class PagingPresenter
extends BaseAsyncRxSchedulerPresenter<PagingPresenter.IPresenterView>
implements IPagingSearchablePresenter {
fun isFirstPageLoading(): Boolean 
 
fun isNextPageLoading(): Boolean 
 
fun cancelFirstPages() 
 
fun cancelNextPages() 
 
fun cancelAllPageRequests()

public interface IPresenterView
extends IPagingSearchablePresenter.IPresenterView<AwesomeEntity,
PagingResponse<AwesomeEntity>> { 
fun onFirstPageLoaded(response: PR) 
 
fun onNextPageLoaded(response: PR) 
 
fun onNextPageLoadFailed(code: Int) 
 
fun onFirstPageLoadFailed(code: Int)
 
}

Имплементация. Adapter.
public class PagingAdapter 
extends BasePagingAdapter<AwesomeEntity, PagingAdapter.PagingAdapterListener> { 
 
@Override 
public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) 
 
@Override 
public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) 
 
public interface PagingAdapterListener extends BasePagingAdapter.AdapterListener { 
 
} 
 
}

interface AdapterListener { 
 
fun loadNextPageClicked() 
 
}

public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) { 
switch (viewType) { 
case BasePagingAdapter.TYPE_ITEM: { 
return new ItemViewHolder(getInflater().inflate(R.layout.list_item, parent, false)); 
} 
case BasePagingAdapter.TYPE_LOAD_MANUALLY: { 
return new LoadFailedViewHolder(getInflater()
.inflate(R.layout.list_item_load_failed, parent, false)); 
} 
case BasePagingAdapter.TYPE_LOADER: { 
return new RecyclerView.ViewHolder(getInflater()
.inflate(R.layout.list_item_loader, parent, false)) { }; 
} 
default: { 
throw new IllegalArgumentException("Unsupported view type " + viewType); 
} 
} 
}

Имплементация. View.
@Wrap
public interface IPagingView
extends IPagingSearchableView<AwesomeEntity, PagingResponse<AwesomeEntity>>,
PagingPresenter.IPresenterView,
PagingViewState.IViewStateView,
PagingAdapter.PagingAdapterListener { 
 
}

Имплементация. Delegate.
public class PagingDelegate 
extends BasePagingSearchableDelegate<AwesomeEntity,
PagingResponse<AwesomeEntity>, 
IPagingView, 
PagingPresenter, 
PagingViewState> 
implements IPagingView

protected void loadFirstPage() 
 
protected void loadNextPage() 
 
public PagingAdapter createPagingAdapter(LayoutInflater inflater, List<AwesomeEntity> items)
public String getEmptyMessage(boolean isSearch)
public String getErrorMessage(boolean isSearch, int code)

var searchView: SearchView? = null
var swipeRefreshLayout: SwipeRefreshLayout? = null
var recyclerView: RecyclerView? = null
var waitView: View? = null
open fun setErrorView(vError: View, tvErrorMessage: TextView, retryButton: View?)
open fun setEmptyView(vEmpty: View, tvEmptyMessage: TextView)

@Layout(R.layout.view_paging_list) 
public class PagingFragment 
extends BaseMvpListFragment<AwesomeEntity,
PagingResponse<AwesomeEntity>,
PagingDelegate,
IPagingView,
PagingPresenter,
PagingViewState> {

private IPagingViewWrap delegateWrap = new IPagingViewWrap(getPagingDelegate()); 
 
public IPagingView getMvpView() { 
return delegateWrap; 
} 
 
public PagingDelegate createDelegate() { 
return new PagingDelegate(); 
}

public PagingPresenter createListPresenter() { 
return new PagingPresenter(); 
} 
 
public PagingViewState createListViewState() { 
return new PagingViewState(); 
}

@Override 
public void setupViewsToDelegate(@NotNull View view,
@NonNull PagingDelegate delegate) { 
delegate.setSwipeRefreshLayout(view.findViewById(R.id.swipeToRefresh)); 
delegate.setRecyclerView(view.findViewById(R.id.recycler)); 
delegate.setWaitView(view.findViewById(R.id.waitView)); 
}

Questions and Answers
https://github.com/Ufkoku

AndroidMVPHelper

More Related Content

What's hot (18)

More from DataArt (20)

AndroidMVPHelper