一个 Android MVVM 工具库,想接触 MVVM 的同学收藏起来,可能有可用之处....

4,967 阅读2分钟

A toolkit help to build Android MVVM Application,We have more attributes for Data Binding of View(like Uri for ImageView) ,we create some command for deal with event( like click of Button),also have a global message pipe to communicate with other ViewModel.

Download

 compile 'com.kelin.mvvmlight:library:1.0.0'
requires at least android gradle plugin 1.5.0.

Usage


中文文档:MVVM Light Toolkit使用指南

引申阅读:如何构建Android MVVM应用程序

Data Binding

Binding URI to the ImageView with bind:uri will make it loading bitmap from URI and render to ImageView automatically.
   
Fresco.initialize(this) is require,because of loading image use Fresco default).
     public class MyApp extends Application {
       @Override
       public void onCreate() {
           super.onCreate();
           Fresco.initialize(this);
      }

Example image.gif
AdapterView like ListView、RecyclerView 、ViewPager is convenient, bind it to the collection view with app:items and app:itemView,You should use an ObservableList to automatically update your view based on list changes.
    
In ViewModel define itemViewModel and itemView
    public final ObservableList itemViewModel = new ObservableArrayList<>();
    public final ItemView itemView = ItemView.of(BR.viewModel, R.layout.layoutitem_list_view);
Adapter,ViewHolder ..is Not Required:
Example listview_databinding.gif
Other attributes supported:
  • ImageView
     
     
     
     
     
     
  • ListViewViewPagerRecyclerView
     
     
     
     
     
     
     
     
     
     
     
  • ViewGroup
     
     
     
     
  • EditText
     
     
  • SimpleDraweeView
     
     
  • WebView
     
     

Command Binding


When RecyclerView scroll to end of list,we have onLoadMoreCommand to deal with event.
      
In ViewModel define a ReplyCommand field to deal with this event.
     public final ReplyCommand loadMoreCommand = new ReplyCommand<>(
        (count) -> {
            /*count: count of list items*/
             int page=count / LIMIT +1;
             loadData(page)
        });

Example listview load more
Deal with click event of View is more convenient:
   
In ViewModel define a ReplyCommand btnClickCommand will be call when click event occur.
   public ReplyCommand btnClickCommand = new ReplyCommand(() -> {
         do something...
      });

Example clickCommand.gif
onRefreshCommand to SwipeRefreshLayout refresh.gif
More command binding is supported:
  • View
    
    
    
    ReplyCommand would has params which means if view hasFocus.-->
    
    
    
  • ListViewRecyclerView
    
    
    
    
    
    
  • ViewPager
    
    
    
    
    
    
  • EditText
    
    
    
    
    
    
  • ImageView
     
     
     
     
  • ScrollViewNestedScrollView
    
    
    
    
  • SwipeRefreshLayout
    
    

Messenger


simplifies the communication between ViewModel(major) or any components
Example Messenger
  • global message broadcast without deliver data
     /* TOKEN: like Action of broadcast with who register this token will be notified when event occur.*/
       Messenger.Default().sendNoMsg(TOKEN);
       /*context: it usually to be a activity ,this parameter is represent to
               a receiver which is mean for convenient when unregister message.
       TOKEN: like Action of broadcast with who register this token will be notified when event occur.
       (data)->{ }:Action to deal with event. */
       Messenger.Default().register(context, TOKEN, () -> { });
  • global message broadcast (carry data to receiver)
      Messenger.getDefault().send(data, TOKEN)
      /*context:
      TOKEN:
      Data.class: type of deliver data.
     (data)->{ }: function to deal with event which has data is deliver by sender.*/
      Messenger.getDefault().register(context, TOKEN, Data.class, (data) -> { });
  • send to specify target (inactive)
     Messenger.getDefault().sendToTarget(T message, R target)
     Messenger.getDefault().sendNoMsgToTargetWithToken(Object token,R target)
     Messenger.getDefault().sendNoMsgToTarget(Object target)
  • cancel register
      Messenger.getDefault().unregister(Object recipient)"
      /* Usually Usage*/
      @Override
      protected void onDestroy() {
              super.onDestroy();
              Messenger.getDefault().unregister(this);
       }

License

    Copyright 2016 Kelin Hong

    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.