【译】优雅的监听RecyclerView Item的单击、长按事件

原文链接:http://www.littlerobots.nl/blog/Handle-Android-RecyclerView-Clicks/

RecyclerView是一个非常强大的组件类,相对于ListView来说你应该考虑使用RecyclerView来构建列表界面展现数据。它提供了很多灵活且已内置的回调接口让你易于实现动效功能和定制布局管理器。

不幸的是RecyclerView并没有像ListView那样提供当单击item时触法一个OnItemClickListener事件的功能。RecyclerView允许你通过给Adapter传递一个OnClickListener对象,随后在adapter中传递给ViewHolder,为了捕获一个单击事件这种方式稍显复杂。

[译者本人曾经踩过一个坑:在给Adapter传递OnClickListener对象时,将该字段设置成了类变量(static修饰符)随后在ViewHolder中通过 Adapter.xxxListener 的方式调用,奇葩的bug诞生了,单击item时偶发性无响应。解决方法* — 改成实例字段再传递给ViewHolder*]

幸运的是RecyclerView提供了一个addOnItemTouchListener
来捕获item的所有触摸事件。你可以在OnItemTouchListener的逻辑代码中使用GestureDetector计算出单击、长按等事件。在你的计算代码中稍有不慎GestureDetector会拦截触摸事件并搞砸事情,在这种情况下item view实际上是接受不到触摸事件以致于用户得不到视觉和听觉上的反馈。

下边给出一段代码来说明使用GestureDetector的糟糕情况,也是译者曾经踩过的坑

/**
 * Created by artshell on 2015/5/24 0024.
 * 872780008@qq.com
 */
public class PopularCityAdapter extends RecyclerView.Adapter<PopularCityAdapter.PopularCityViewHolder> {
    public static final String TAG = "PopularCityAdapter";

    // code ...
    private OnItemClickListener mOnItemClickListener;
   
    public interface OnItemClickListener {
        /**
         * @param pView     child view of RecyclerView's layout
         * @param pPosition {@link RecyclerView#getChildAdapterPosition(View)}
         * @see {@link RecyclerView.ViewHolder#getAdapterPosition()}
         */
        void onRecyclerItemClick(View pView, int pPosition);
    }

    /**
     * @param pOnItemClickListener 单击事件监听器
     */
    public void setOnItemClickListener(OnItemClickListener pOnItemClickListener) {
        mOnItemClickListener = pOnItemClickListener;
    }

    // 其它 Adapter 实现代码省略 ...

    public static class RecyclerViewItemClickListener implements RecyclerView.OnItemTouchListener {
        private OnItemClickListener mItemClickListener;
        private GestureDetector mGestureDetector;

        public RecyclerViewItemClickListener(Context pContext, OnItemClickListener pItemClickListener) {
            mItemClickListener = pItemClickListener;
            mGestureDetector = new GestureDetector(pContext, new GestureDetector.SimpleOnGestureListener() {
                @Override
                public boolean onSingleTapUp(MotionEvent e) {
                    return true;
                }
            });
        }

        @Override
        public boolean onInterceptTouchEvent(RecyclerView rv, MotionEvent e) {
            View childView = rv.findChildViewUnder(e.getX(), e.getY());
            int position = rv.getChildAdapterPosition(childView);
            if (childView != null && position != RecyclerView.NO_POSITION && mItemClickListener != null && mGestureDetector.onTouchEvent(e)) {
                mItemClickListener.onRecyclerItemClick(childView, position);
            }
            return false; /* 这里应该返回false,应该让事件继续传递下去,否则只是处理了Touch事件,而click事件得不到执行 */
        }

        @Override
        public void onTouchEvent(RecyclerView rv, MotionEvent e) {
        }

        @Override
        public void onRequestDisallowInterceptTouchEvent(boolean disallowIntercept) {
        }
    }
}

我想到一个方案,就是通过RecyclerView item中的view,确切的说像ViewHolder.getItemView()获取view来处理单击事件。作者在卖关子

封装后,像这样:

    ItemClickSupport.addTo(mRecyclerView).setOnItemClickListener(new ItemClickSupport.OnItemClickListener() {
        @Override
        public void onItemClicked(RecyclerView recyclerView, int position, View v) {
            // do it
        }
    });

使用过TwoWayView这个开源项目的用户可能注意到了ItemClickSupport与项目中的实现方式很像,实际上在此之前我在Bundle这个app中使用TwoWayViews时踩了些坑,里边用的技术就是上边提到的RecyclerView.OnItemTouchListener。当我实现ItemClickSupport后,去查看TwoWayView 发现两种实现方式类似,我觉得TwoWayView中api的实现方式很优雅而没有多次传递 xxxListener。

相对于TwoWayView 中的实现方式我使用的是OnChildAttachStateChangeListener传递一个OnClickListener对象给ViewHolder中的itemView而不是定制OnTouchListener来达到目的。

代码如下:

public class ItemClickSupport {
    private final RecyclerView mRecyclerView;
    private OnItemClickListener mOnItemClickListener;
    private OnItemLongClickListener mOnItemLongClickListener;
    private View.OnClickListener mOnClickListener = new View.OnClickListener() {
        @Override
        public void onClick(View v) {
            if (mOnItemClickListener != null) {
                RecyclerView.ViewHolder holder = mRecyclerView.getChildViewHolder(v);
                mOnItemClickListener.onItemClicked(mRecyclerView, holder.getAdapterPosition(), v);
            }
        }
    };
    private View.OnLongClickListener mOnLongClickListener = new View.OnLongClickListener() {
        @Override
        public boolean onLongClick(View v) {
            if (mOnItemLongClickListener != null) {
                RecyclerView.ViewHolder holder = mRecyclerView.getChildViewHolder(v);
                return mOnItemLongClickListener.onItemLongClicked(mRecyclerView, holder.getAdapterPosition(), v);
            }
            return false;
        }
    };
    private RecyclerView.OnChildAttachStateChangeListener mAttachListener
            = new RecyclerView.OnChildAttachStateChangeListener() {
        @Override
        public void onChildViewAttachedToWindow(View view) {
            if (mOnItemClickListener != null) {
                view.setOnClickListener(mOnClickListener);
            }
            if (mOnItemLongClickListener != null) {
                view.setOnLongClickListener(mOnLongClickListener);
            }
        }

        @Override
        public void onChildViewDetachedFromWindow(View view) {

        }
    };

    private ItemClickSupport(RecyclerView recyclerView) {
        mRecyclerView = recyclerView;
        mRecyclerView.setTag(R.id.item_click_support, this);
        mRecyclerView.addOnChildAttachStateChangeListener(mAttachListener);
    }

    public static ItemClickSupport addTo(RecyclerView view) {
        ItemClickSupport support = (ItemClickSupport) view.getTag(R.id.item_click_support);
        if (support == null) {
            support = new ItemClickSupport(view);
        }
        return support;
    }

    public static ItemClickSupport removeFrom(RecyclerView view) {
        ItemClickSupport support = (ItemClickSupport) view.getTag(R.id.item_click_support);
        if (support != null) {
            support.detach(view);
        }
        return support;
    }

    public ItemClickSupport setOnItemClickListener(OnItemClickListener listener) {
        mOnItemClickListener = listener;
        return this;
    }

    public ItemClickSupport setOnItemLongClickListener(OnItemLongClickListener listener) {
        mOnItemLongClickListener = listener;
        return this;
    }

    private void detach(RecyclerView view) {
        view.removeOnChildAttachStateChangeListener(mAttachListener);
        view.setTag(R.id.item_click_support, null);
    }

    public interface OnItemClickListener {

        void onItemClicked(RecyclerView recyclerView, int position, View v);
    }

    public interface OnItemLongClickListener {

        boolean onItemLongClicked(RecyclerView recyclerView, int position, View v);
    }
}

当你在使用这个工具类的时候需要在 ids.xml文件中定义一个R.id.item_click_support

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <item name="item_click_support" type="id" />
</resources>

代码可以自由使用,法律咨询事宜单击这儿。here
我比较喜欢使用此方法,而不是通过传递OnClickListeners,当然这种情况仅仅是针对item需要处理单击事件。下次你的需求中遇到此类情况,可以考虑使用这个技术。
感谢Mike Wolfson和*Dave Smith *两位作者对本篇文章的校审.

你可以通过Discuss this post on Google+提交你的问题,评论,反馈等.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,717评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,501评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,311评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,417评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,500评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,538评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,557评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,310评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,759评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,065评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,233评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,909评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,548评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,172评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,420评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,103评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,098评论 2 352

推荐阅读更多精彩内容