用RecyclerView實現(xiàn)Form表單 靈活可復用 給你一個新思路-MultiItem進階

前言

本文是MultiItem系列的進階文章,講解如何利用RecyclerView實現(xiàn)Form表單,在日常開發(fā)中多數(shù)人還是使用普通布局方式實現(xiàn),這種方案比較直觀也很簡單,但是如果表單業(yè)務較多,并且易變,很多弊端就會顯現(xiàn),不過這正是使用RecyclerView實現(xiàn)的優(yōu)勢所在,可以自定義一套通用的輸入類型的ItemInput組件,既靈活又可復用。MultiItem特點:

  • 直接使用業(yè)務中的實體類為RecyclerView Adapter設置數(shù)據(jù)源,不需要做任何封裝
  • RecyclerView Adapter零編碼,解放了復雜的Adapter
  • 支持DataBinding,讓你清爽的編寫列表代碼
  • 支持Form表單錄入,懶加載易復用,支持DataBinding、隱藏域、輸入內(nèi)容驗證及是否變化

源碼地址

Github地址:https://github.com/free46000/MultiItem,請大家多多關注。

系列文章

效果截圖

Form表單效果
Form表單效果

Form表單提交
Form表單提交

用法

使用方法

首先初始化InputItemAdapter,然后添加實現(xiàn)ItemInput接口的數(shù)據(jù)源,相關代碼:
注:類庫中已提供了一些實現(xiàn)接口的基類如:BaseItemInput DataBindItemInput,使用時直接繼承基類就可以,

protected void initViews() {
    //初始化adapter
    adapter = new InputItemAdapter();
    List<Object> list = new ArrayList<>();
    
    //姓名和性別錄入Item,一個錄入item對應多個提交的值{"name":"","sex":""}
    list.add(new ItemNameAndSex());
    
    //普通的EditText錄入Item
    list.add(new ItemEdit("height").setName("身高:"));
    list.add(new ItemEdit("weight").setName("體重:"));
    list.add(new ItemEdit("age").setName("年齡:"));
    list.add(new ItemEdit("default").setName("國家:").setDefValue("中國"));
    
    //利用DataBinding的錄入Item
    list.add(new ItemInfoDataBind("info").setName("介紹:"));
    
    //添加user id對應的隱藏域的Item(用戶不可見)
    adapter.addHiddenItem("id", "隱藏域中攜帶id");
    adapter.setDataItems(list);
    
    recyclerView.setAdapter(adapter);
}

接下來展示提交表單的相關代碼,提交時可以自動組裝數(shù)據(jù),另外還提供了一些有用的api,詳見代碼注釋:

public void submit() {
    //通過adapter.isValueChange()判斷表單內(nèi)容是否改變
    //通過adapter.isValueValid()判斷表單內(nèi)容是否有效
    //通過adapter.getInputJson()直接獲取表單錄入Json,還有獲取錄入Map的方法
    String tipTxt = "表單內(nèi)容" + (adapter.isValueChange() ? " 已經(jīng) " : " 沒有 ") +
            "被用戶改變!\n表單  " + (adapter.isValueValid() ? " 已經(jīng) " : " 沒有 ") +
            "通過驗證!\n自動組裝的表單內(nèi)容為:\n";
    
    //表單內(nèi)容json字符串,也可以通過Gson或FastJson等對字符串反序列化成實體對象
    String valueTxt = adapter.getInputJson().toString(4);
    new AlertDialog.Builder(this).setTitle("提交").setMessage(tipTxt + valueTxt)
            .setPositiveButton(R.string.confirm, null).show();
}

ItemInput普通錄入ItemEdit

我們先來看看普通的錄入ItemEdit的編寫方式,它繼承了BaseItemInput基類,下面貼出一些關鍵的需要覆寫的方法,作用詳見注釋:

public class ItemEdit extends BaseItemInput<ItemEdit> {
    /**
     * @param key 錄入對應key
     */
    public ItemEdit(String key) {
        super(key);
    }
    
    @Override
    public String getValue() {
        //返回錄入的值,和{@link #getKey()}一起組裝為Map  如果為null則不組裝
        return editText == null ? defValue : editText.getText().toString();
    }
    
    @Override
    public boolean isValueValid() {
        //錄入的值不為空則有效;其它無效
        return !TextUtils.isEmpty(getValue());
    }
    
    @Override
    protected void initInputView(BaseViewHolder holder) {
        //初始化Input視圖,由于Input視圖不可以復用,所以直接在初始化視圖時設置好相關內(nèi)容即可
        TextView nameText = getView(holder.itemView, R.id.text);
        nameText.setText(name);
    
        editText = getView(holder.itemView, R.id.editText);
        editText.setHint(hint);
        editText.setText(defValue);
    }
    
    ...
}

ItemInput一對多錄入ItemNameAndSex

上面我們已經(jīng)看了普通錄入的實現(xiàn),一對多錄入的方式需要在上面的基礎上,增加一些定制化的實現(xiàn),所以和普通錄入重復的代碼就不貼出來了,只貼出一些關鍵的需要覆寫的方法,作用詳見注釋:

public class ItemNameAndSex extends BaseItemInput<ItemNameAndSex> {
    //本例中需要返回兩組key-value所以去覆寫getValueMap()
     @Override
    public Object getValue() {
        //在本方法中返回兩個值的組合,作用是為判斷表單的值是否被改變提供依據(jù)
        if (nameEdit == null) {
            return null;
        }
        return nameEdit.getText().toString() + sexRadio.getCheckedRadioButtonId();
    }

    @Override
    public boolean isValueValid() {
        //如果名字輸入框錄入的值不為空則有效;其它無效
        return nameEdit != null && !TextUtils.isEmpty(nameEdit.getText().toString());
    }

    @Override
    public Map<String, Object> getValueMap() {
        if (nameEdit == null) {
            return null;
        }

        //此處自己組裝Map{name:name,sex:sex}并返回,這樣可以達到一個Item返回兩組值的效果
        Map<String, Object> valueMap = new HashMap<>(2);
        valueMap.put("name", nameEdit.getText().toString());
        int sexStrResId = sexRadio.getCheckedRadioButtonId() == R.id.man ? R.string.man : R.string.woman;
        valueMap.put("sex", nameEdit.getContext().getString(sexStrResId));

        return valueMap;
    }
    
    ...
}    

ItemInput 數(shù)據(jù)綁定錄入ItemInfoDataBind

接下來我們看看數(shù)據(jù)綁定方式,貼出關鍵代碼:

public class ItemInfoDataBind extends DataBindItemInput<ItemInfoDataBind> {
    
     @Override
    protected void initInputView(ViewDataBinding dataBinding) {
        //把自身實例對象通過ViewDataBinding綁定到視圖中
        dataBinding.setVariable(BR.itemData, this);
    }    
    ...
}

通過以上代碼我們不難發(fā)現(xiàn)數(shù)據(jù)綁定技術對代碼的改善,java代碼中已經(jīng)沒有了和View層相關的邏輯代碼,直接在xml布局中就可以完成,下面貼出xml布局的關鍵代碼:

<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <data>
        <variable
            name="itemData"
            type="com.freelib.multiitem.demo.input.ItemInfoDataBind"/>
    </data>

    <LinearLayout ...>
    
        <TextView
            ...
            android:text="@{itemData.name}"/>

        <EditText
            ...
            //@={}為雙向綁定用法,即EditText的變化會實時更新到itemData.info屬性上
            android:text="@={itemData.info}"/>
            
    </LinearLayout>

</layout>

數(shù)據(jù)綁定的xml布局和普通寫法也沒什么差別,所以在這里再次安利下,大家要多多使用DataBinding,提高開發(fā)效率,降低耦合度。

詳解

復用詳解

拿我們上面貼出代碼的ItemEdit來說,在正常情況下所有EditText相關的錄入項都可以使用本類即可,這樣就做到了復用。所以我們在項目中封裝一些公用組件的錄入Item后,即使碰到大量到表單業(yè)務,變化再多都不需要擔心,只是在InputItemAdapter添加刪除一些組件Item或者把原有組件Item的順序調(diào)整一下即可,在這個過程中都不需要去碰到xml布局文件,在邏輯上也會比較清晰。

流程解析

這次實現(xiàn)相當于在原有功能的基礎上封裝了一些新的api,所以并沒有太多可以講解的地方,所以花了一個流程圖供大家參考:

Form表單流程
Form表單流程

總結

前言中也說利用RecyclerView實現(xiàn)Form表單了并不是一種主流的實現(xiàn)方式,當然會存在一些不足之處,但是比較適用于大量表單業(yè)務的客戶端中,希望大家多多交流!
最后擴展一下大家的思路,其實我們可以約定好表單格式數(shù)據(jù),通過服務端下發(fā),在客戶端做到動態(tài)表單錄入

最后編輯于
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容