base-adapter-helper源码解析

泡在网上的日子 / 文 发表于2015-08-06 16:07 次阅读 adapter

虽然简化ListView adapter的项目早就已经出现,但是我一直没有用,都是用比较原始的方式。一个项目能有多少个adapter呢,大不了一个一个的写。

但是如果做的项目多了,就会感觉,简直不能忍。

说白了我只是想完成item数据与item布局之间的绑定而已,用得着那么费神?

每次我都要根据item数据的类构造一个ViewHolder。

每次我都要写绕了很多圈子的convertView.setTag ,new ViewHolder。

 

可不可以直接通过一种方式让开发者只用写item数据与item布局中绑定的代码呢?

base-adapter-helper

base-adapter-helper  是一个可以最大程度简化ListView adapter写法的库,它完全实现了我们期望的只写绑定代码的需求。

1438848743221441.png

看看他的使用方式:

ListView lv = (ListView) findViewById(R.id.lv);
QuickAdapter<Blog> adapter = new QuickAdapter<Blog>(this, R.layout.item) {

    @Override
    protected void convert(BaseAdapterHelper helper, Blog blog) {
        helper.setText(R.id.title, blog.getTitle());
        helper.setText(R.id.author, blog.getAuthor());
        helper.description(R.id.description, blog.getDescription());
        helper.setImageUrl(R.id.litPic, blog.getLitPic());
    }
};
adapter.addAll(bolgList);
lv.setAdapter(adapter);

 

new 一个QuickAdapter,重写convert()方法,再convert中使用helper的各种set方法完成数据的绑定。 注:helper是一个BaseAdapterHelper对象。

base-adapter-helper分析

通过研究 base-adapter-helper的代码,可以发现它:

  1. 它仍然是基于ViewHolder模式的。

  2. 它使用了泛型。

  3. 在绑定数据的过程上,它使用了抽象方法来把具体实现交给用户。

base-adapter-helper有四个类:

BaseAdapterHelper

BaseQuickAdapter

EnhancedQuickAdapter

QuickAdapter

其中后三个都是adapter,第一个是帮助类。

虽然我们通常 使用的是QuickAdapter,但是QuickAdapter里面并没有做什么事情,要了解 base-adapter-helper,只需研究两个类就可以了

BaseAdapterHelper

BaseQuickAdapter

BaseQuickAdapter

BaseQuickAdapter完成了adapter的绝大部分操作。代码不多就全贴在这里了:

/**
 * Copyright 2013 Joan Zapata
 *
 * 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.
 */
package com.joanzapata.android;

import android.content.Context;
import android.view.Gravity;
import android.view.View;
import android.view.ViewGroup;
import android.widget.BaseAdapter;
import android.widget.FrameLayout;
import android.widget.ProgressBar;

import java.util.ArrayList;
import java.util.List;

/**
 * Abstraction class of a BaseAdapter in which you only need
 * to provide the convert() implementation.
 * Using the provided BaseAdapterHelper, your code is minimalist.
 * @param <T> The type of the items in the list.
 */
public abstract class BaseQuickAdapter<T, H extends BaseAdapterHelper> extends BaseAdapter {

    protected static final String TAG = BaseQuickAdapter.class.getSimpleName();

    protected final Context context;

    protected final int layoutResId;

    protected final List<T> data;

    protected boolean displayIndeterminateProgress = false;

    /**
     * Create a QuickAdapter.
     * @param context     The context.
     * @param layoutResId The layout resource id of each item.
     */
    public BaseQuickAdapter(Context context, int layoutResId) {
        this(context, layoutResId, null);
    }

    /**
     * Same as QuickAdapter#QuickAdapter(Context,int) but with
     * some initialization data.
     * @param context     The context.
     * @param layoutResId The layout resource id of each item.
     * @param data        A new list is created out of this one to avoid mutable list
     */
    public BaseQuickAdapter(Context context, int layoutResId, List<T> data) {
        this.data = data == null ? new ArrayList<T>() : new ArrayList<T>(data);
        this.context = context;
        this.layoutResId = layoutResId;
    }

    @Override
    public int getCount() {
        int extra = displayIndeterminateProgress ? 1 : 0;
        return data.size() + extra;
    }

    @Override
    public T getItem(int position) {
        if (position >= data.size()) return null;
        return data.get(position);
    }

    @Override
    public long getItemId(int position) {
        return position;
    }

    @Override
    public int getViewTypeCount() {
        return 2;
    }

    @Override
    public int getItemViewType(int position) {
        return position >= data.size() ? 1 : 0;
    }

    @Override
    public View getView(int position, View convertView, ViewGroup parent) {
        if (getItemViewType(position) == 0) {
            final H helper = getAdapterHelper(position, convertView, parent);
            T item = getItem(position);
            helper.setAssociatedObject(item);
            convert(helper, item);
            return helper.getView();
        }

        return createIndeterminateProgressView(convertView, parent);
    }

    private View createIndeterminateProgressView(View convertView, ViewGroup parent) {
        if (convertView == null) {
            FrameLayout container = new FrameLayout(context);
            container.setForegroundGravity(Gravity.CENTER);
            ProgressBar progress = new ProgressBar(context);
            container.addView(progress);
            convertView = container;
        }
        return convertView;
    }

    @Override
    public boolean isEnabled(int position) {
        return position < data.size();
    }

    public void add(T elem) {
        data.add(elem);
        notifyDataSetChanged();
    }

    public void addAll(List<T> elem) {
        data.addAll(elem);
        notifyDataSetChanged();
    }

    public void set(T oldElem, T newElem) {
        set(data.indexOf(oldElem), newElem);
    }

    public void set(int index, T elem) {
        data.set(index, elem);
        notifyDataSetChanged();
    }

    public void remove(T elem) {
        data.remove(elem);
        notifyDataSetChanged();
    }

    public void remove(int index) {
        data.remove(index);
        notifyDataSetChanged();
    }

    public void replaceAll(List<T> elem) {
        data.clear();
        data.addAll(elem);
        notifyDataSetChanged();
    }

    public boolean contains(T elem) {
        return data.contains(elem);
    }

    /** Clear data list */
    public void clear() {
        data.clear();
        notifyDataSetChanged();
    }

    public void showIndeterminateProgress(boolean display) {
        if (display == displayIndeterminateProgress) return;
        displayIndeterminateProgress = display;
        notifyDataSetChanged();
    }

    /**
     * Implement this method and use the helper to adapt the view to the given item.
     * @param helper A fully initialized helper.
     * @param item   The item that needs to be displayed.
     */
    protected abstract void convert(H helper, T item);

    /**
     * You can override this method to use a custom BaseAdapterHelper in order to fit your needs
     * @param position    The position of the item within the adapter's data set of the item whose view we want.
     * @param convertView The old view to reuse, if possible. Note: You should check that this view
     *                    is non-null and of an appropriate type before using. If it is not possible to convert
     *                    this view to display the correct data, this method can create a new view.
     *                    Heterogeneous lists can specify their number of view types, so that this View is
     *                    always of the right type (see {@link #getViewTypeCount()} and
     *                    {@link #getItemViewType(int)}).
     * @param parent      The parent that this view will eventually be attached to
     * @return An instance of BaseAdapterHelper
     */
    protected abstract H getAdapterHelper(int position, View convertView, ViewGroup parent);

}


BaseQuickAdapter的成员变量只有四个:

protected final Context context;

protected final int layoutResId;

protected final List<T> data;

protected boolean displayIndeterminateProgress = false;

其中context仅仅是为了获得某些控件需要的上下文,layoutResId为资源文件的id,如:R.layout.item。

最关键的则是data变量。

为了让adapter支持不同类型的list,它使用了泛型来定义:

protected final List<T> data;

接下来定义了一些adapter都会定义的方法,比如getCount,getView等,然后是一些帮助添加数据的方法,如add,addAll,set,remove等,其实这些方法对于我们研究简化adapter来说并没有什么用。

这里最关键的还是getView方法

@Override
public View getView(int position, View convertView, ViewGroup parent) {
    if (getItemViewType(position) == 0) {
        final H helper = getAdapterHelper(position, convertView, parent);
        T item = getItem(position);
        helper.setAssociatedObject(item);
        convert(helper, item);
        return helper.getView();
    }

    return createIndeterminateProgressView(convertView, parent);
}

在这个方法中,getItemViewType(position) == 0条件下执行的才是正常情况的代码,其余的情况是用于显示加载进度的。

首先,调用getAdapterHelper获得一个BaseAdapterHelper对象

这个getAdapterHelper方法在本类中只是个抽象方法:

protected abstract H getAdapterHelper(int position, View convertView, ViewGroup parent);

具体的实现在QuickAdapter中,因为我们直接使用的其实是QuickAdapter,所以我们实际上调用的下面的代码:

protected BaseAdapterHelper getAdapterHelper(int position, View convertView, ViewGroup parent) {
    return get(context, convertView, parent, layoutResId, position);
}

在这个方法中又调用了get方法,这个get方法是怎么定义的呢?这里很容易误解,认为他是QuickAdapter或者BaseAdapterHelper的成员方法,它其实是BaseAdapterHelper的一个静态方法,用ide的代码跳转功能就能看出来。为什么会这样,因为在这个类的import中:

import static com.joanzapata.android.BaseAdapterHelper.get;

直接引入一个类的静态方法(通常我们都是引入一个类),这中用法我还是第一次看到(少见多怪了哈)。

这个get方法是一个工厂方法,产生一个BaseAdapterHelper对象,有趣的是这个get方法的实现其实和ViewHolder模式中,产生ViewHolder的方式类似

static BaseAdapterHelper get(Context context, View convertView, ViewGroup parent, int layoutId, int position) {
    if (convertView == null) {
        return new BaseAdapterHelper(context, parent, layoutId, position);
    }

    // Retrieve the existing helper and update its position
    BaseAdapterHelper existingHelper = (BaseAdapterHelper) convertView.getTag();
    existingHelper.position = position;
    return existingHelper;
}

判断convertView是否已经存在,不存在则新建一个BaseAdapterHelper对象,存在则直接从convertView的Tag中直接获取一个BaseAdapterHelper对象,所以说BaseAdapterHelper其实就是一个ViewHolder

上面分析了getView中getAdapterHelper的流程(其实已经涉及到部分BaseAdapterHelper的代码),接下来是

T item = getItem(position);
helper.setAssociatedObject(item);

这两行代码用处不大。

下面关键的地方来了,convert方法

convert(helper, item);

它传入了helper和item两个参数。

convert方法是一个抽象方法。具体实现取决于BaseQuickAdapter的子类。

convert方法也是我们使用这个库时会直接操作的方法,在文章最开头我就用到了:

QuickAdapter<Blog> adapter = new QuickAdapter<Blog>(this, R.layout.item) {

    @Override
    protected void convert(BaseAdapterHelper helper, Blog blog) {
        helper.setText(R.id.title, blog.getTitle());
        helper.setText(R.id.author, blog.getAuthor());
        helper.description(R.id.description, blog.getDescription());
        helper.setImageUrl(R.id.litPic, blog.getLitPic());
    }
};

它要完成的任务是数据的绑定工作。

convert方法调用之后,返回相应绑定完数据的view:

return helper.getView();

可见是通过helper的getView返回的。下面会讲到。


到这里BaseQuickAdapter的代码就基本分析完了。从上面的分析中,可以看到BaseAdapterHelper才是关键。


BaseAdapterHelper

就如上面提到的,BaseAdapterHelper的作用相当于ViewHolder。我们在分析getAdapterHelper部分也提到了BaseAdapterHelper的get方法,其实这个方法也是我们切入BaseAdapterHelper的入口。

我们再来看看这个get方法:

static BaseAdapterHelper get(Context context, View convertView, ViewGroup parent, int layoutId, int position) {
    if (convertView == null) {
        return new BaseAdapterHelper(context, parent, layoutId, position);
    }

    // Retrieve the existing helper and update its position
    BaseAdapterHelper existingHelper = (BaseAdapterHelper) convertView.getTag();
    existingHelper.position = position;
    return existingHelper;
}

就如刚刚所说的“判断convertView是否已经存在,不存在则新建一个BaseAdapterHelper对象,存在则直接从convertView的Tag中直接获取一个BaseAdapterHelper对象”。

我们先看看第一个条件convertView == null

返回了一个新建的BaseAdapterHelper,那么我看看它的构造方法:

private BaseAdapterHelper(Context context, ViewGroup parent, int layoutId, int position) {
    this.context = context;
    this.position = position;
    this.views = new SparseArray<View>();
    convertView = LayoutInflater.from(context) //
            .inflate(layoutId, parent, false);
    convertView.setTag(this);
}

首先新建了一个view数组,SparseArray是稀疏数组,性能略高哈哈。这个数组是用于存放一个item中需要被绑定数据的view的(就是那些需要通过findviewByid获得的view)。

然后从item的布局文件中获得convertView,同时把this对象放到convertView的tag里,下次我们通过get方法获取BaseAdapterHelper对象的时候,就可以直接使用convertView.getTag()获取。

这里的convertView是一个成员变量,保存起来,然后在BaseQuickAdapter的getView中通过helper.getView()返回保存起来的convertView。


这里很绕是吧,其实说简单点那就是BaseAdapterHelper和convertView是相互持有的。

BaseAdapterHelper 构造方法中生成convertView 然后把持有它的BaseAdapterHelper放在自己的tag里,当convertView回收的时候,使用convertView.getTag()获得helper,然后再通过helper.getView()返回convertView给adapter的getView方法。

当然,在convertView能被回收的时候(convertView != null),其实可以不通过helper.getView()返回convertView,直接返回参数里的convertView也是可以的(实际上它们是同一个convertView)。

数据的绑定

数据的绑定是在convert方法中完成的。它本身是一个抽象方法,需要你在子类中写具体的实现,这样设计的好处就是它可以任意扩展,适应任何布局的adapter。一般来说一个抽象方法要想扩展,必须带一些非常实用的参数,

convert方法 中就有helper和item两个参数,我们来仔细看看这个方法的使用:

QuickAdapter<Blog> adapter = new QuickAdapter<Blog>(this, R.layout.item) {

    @Override
    protected void convert(BaseAdapterHelper helper, Blog blog) {
        helper.setText(R.id.title, blog.getTitle());
        helper.setText(R.id.author, blog.getAuthor());
        helper.description(R.id.description, blog.getDescription());
        helper.setImageUrl(R.id.litPic, blog.getLitPic());
    }
};
adapter.addAll(bolgList);

item是数据,它来自于传入的blogList,helper是在BaseQuickAdapter的getView中实例化的,这里基本就是调用了helper的各种set方法,就拿setText方法为例:

public BaseAdapterHelper setText(int viewId, String value) {
    TextView view = retrieveView(viewId);
    view.setText(value);
    return this;
}

看不出来啥,,倒是这个retrieveView有点意思

private <T extends View> T retrieveView(int viewId) {
    View view = views.get(viewId);
    if (view == null) {
        view = convertView.findViewById(viewId);
        views.put(viewId, view);
    }
    return (T) view;
}

首先,从views数组中寻找该id的view,没有找到,则用findviewById来找, 由于convertView是一个成员变量,因此在retrieveView中可以通过convertView找到相应id的view,一旦找到,我们就把它存在views中,这样能保证每个convertView只需调用一次findviewById。这点和普通ViewHolder的策略不太相同,普通ViewHolder,view是已知的,不是动态的,而我们的BaseAdapterHelper维护的view是动态数组,每find一次就保存起来。

另外retrieveView还有个很重要的特点,那就是他的返回值是用的泛型,这样,我们的的set方法就可以任意指定view的类型,比如上面的setText方法中,最后转换成的是TextView类型。retrieveView的实现也是我觉得这个库设计巧妙的一大原因。

实际上,我以前也尝试过要实现一个通用的ViewHolder,我的思路也是想办法能动态的往ViewHolder中增加变量,注意我想到的仅仅是动态的增加变量,而且显然是不能实现的,而base-adapter-helper

不增加变量,转而维护一个可以任意扩展的views数组,虽然views中都是普通的view,但是这些view随时都可以转换。想到这里,突然感觉这里即便没有使用泛型貌似也不会影响灵活性。

base-adapter-helper的缺点

实际上,上面的代码缺乏一定的灵活性,那就是绑定数据我们都是通过helper的set方法实现的,在上面的代码中我们使用到了两个set方法setText和setImageUrl

让我们看看它是如何定义的:

setText

public BaseAdapterHelper setText(int viewId, String value) {
    TextView view = retrieveView(viewId);
    view.setText(value);
    return this;
}

setImageUrl

public BaseAdapterHelper setImageUrl(int viewId, String imageUrl) {    
    ImageView view = retrieveView(viewId);   
    Picasso.with(context).load(imageUrl).into(view);    
    return this;    
}

要是我们需要设置一个View的透明度呢?幸好BaseAdapterHelper也定义了相关的方法:

public BaseAdapterHelper setAlpha(int viewId, float value) {
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) {
        retrieveView(viewId).setAlpha(value);
    } else {
        // Pre-honeycomb hack to set Alpha value
        AlphaAnimation alpha = new AlphaAnimation(value, value);
        alpha.setDuration(0);
        alpha.setFillAfter(true);
        retrieveView(viewId).startAnimation(alpha);
    }
    return this;
}

但是我们知道,理论上你永远无法在BaseAdapterHelper中实现完所有我们对view的设定需求。而且从setImageUrl方法中你可以看到,它是通过Picasso来加载图片的,要是我们想用Glide来加载呢?似乎得修改BaseAdapterHelper的源码了。

我可以在BaseAdapterHelper中增加一个叫setImageUrlGlide的方法,然后用Glide来实现图片的加载,但是如果我们又想用Fresco来加载呢,再增加一个吗?显然这是无穷无尽的。

其实从一开始我就觉得采用定义set方法来设置数据的方式是不靠谱的。

于是我这样做:

QuickAdapter<Blog> adapter = new QuickAdapter<Blog>(this, R.layout.item) {

    @Override
    protected void convert(BaseAdapterHelper helper, Blog blog) {
        TextView titleView = helper.retrieveView(R.id.title);
        titleView.setText(blog.getTitle());
        TextView authorView = helper.retrieveView(R.id.author);
        authorView.setText(blog.getAuthor());
        TextView descriptionView = helper.retrieveView(R.id.description);
        descriptionView.setText(blog.getDescription());
        ImageView image= helper.retrieveView(R.id.litPic);
        //如何显示图片就取决于你自己了
    }
};

我们直接跳过了set方法,直接通过retrieveView获得view的实例,但是retrieveView是私有方法,我们需要把它改成public的才能这样做。

这样,我们虽然多了一些代码,但是整个adapter的实现我们仍然全部是在convert中完成的,并没有增加任何其他关联的代码。


更正:其实这个库也提供了一个getView方法:

public <T extends View> T getView(int viewId) {
    return retrieveView(viewId);
}

所以我们不需要把retrieveView改成public,直接使用getView方法:

QuickAdapter<Blog> adapter = new QuickAdapter<Blog>(this, R.layout.item) {

    @Override
    protected void convert(BaseAdapterHelper helper, Blog blog) {
        TextView titleView = helper.getView(R.id.title);
        titleView.setText(blog.getTitle());
        TextView authorView = helper.getView(R.id.author);
        authorView.setText(blog.getAuthor());
        TextView descriptionView = helper.getView(R.id.description);
        descriptionView.setText(blog.getDescription());
        ImageView image= helper.getView(R.id.litPic);
        //如何显示图片就取决于你自己了
    }
};

总结

base-adapter-helper的分析就此结束,其实理解之后,感觉核心的东西很少,但是为什么我就没有实现呢?拦住我的其实也就是那么一点点技巧而已,哈哈。

总的说来,核心的东西只有三点:

  1. 列表数据要使用泛型;

  2. 原本ViewHolder中的View成员变量转而通过view数组来实现(比如SparseArray);

  3. 把数据绑定通过实现抽象方法来实现。


我比较喜欢这个库的调用方式,所以决定尝试看看是否可以用同样的api实现对RecyclerView 适配器的简化。成功了我会告诉大家。


已经写好了:

base-adapter-helper的RecyclerView版 


收藏 赞 (5) 踩 (0)
上一篇:自定义圆形头像CircleImageView的使用和源码分析
原文出处: http://blog.csdn.net/zhoubin1992/article/details/47258639 本文分为三大部分: CircleImageView的使用 CircleImageView源码分析 Android自定义View总结 CircleImageView项目源码下载: https://github.com/hdodenhof/CircleImageView 打开源码
下一篇:Cool Android Apis 整理(一)
Foreword 本文主要整理 Cool Android Apis 。 整理来源 Dan Lew 的 Android Tips Round-Up 系列文章。 尤其感谢 Gracker 对上面系列文章的 翻译和部分解释 。 知乎问题: Android开发中,有哪些让你觉得相见恨晚的方法、类或接口? 所以说严格来讲这篇文章基