开发一款商业级Banner控件

2,087 阅读6分钟
原文链接: www.jianshu.com

本文已授权微信公众号:鸿洋(hongyangAndroid)原创首发。

商业级控件最重要的特性:高内聚、低耦合!

1、分析需求

我们想要实现什么功能、达到什么效果? 站在用户在这里就是我们的程序员的角度上来看,我们在使用的时候是希望以最少的代码实现更多的功能,且能有足够地自由去自定义该功能。功能需求如下:

用户需求用例图

我们想要实现的效果 :


2、理清技术点

在开发之前,大致评估一下技术可行性,结合技术点的特性才能更好的去划分层次和搭建框架,首先梳理几个功能点 以及它们相对应的技术点;

  1. ViewPeger作为view的载体(为什么不用recyclerView,懒,使用recyclerVIew会多出很多代码,比如自己写滑动监听,换页换页监听,换页动画等等比较麻烦的代码,以及各种计算)
  2. 如何无限循环,如图所示; 首尾各增加一项item; 且当滑动至 第0项 时无缝切换至 倒数第二项(真实数据最后一项下标),当滑动到最后一项时无缝切换至第二项(真实数据第一项);
  3. 翻页动画,有一个ViewPager有个接口PageTransformer;贼好用,在滑动过程中 会计算各个itemVIew的左坐标与滑动距离差 与 总宽度的比例;
    protected void onPageScrolled(int position, float offset, int offsetPixels) {
        ...    
           if (mPageTransformer != null) {
            final int scrollX = getScrollX();
            final int childCount = getChildCount();
            for (int i = 0; i < childCount; i++) {
                final View child = getChildAt(i);
               ....
                final float transformPos = (float) (child.getLeft() - scrollX) / getClientWidth();
                mPageTransformer.transformPage(child, transformPos);
            }
        ...
  1. 默认指示器,一个自定义View, 动态添加指示点。根据状态切换指示点图标。
  2. 如何一页显示多屏(如下效果),其中用到了 clipChildren属性
    ,在ViewGroup中该属性是这样注释的
    // When set, ViewGroup invalidates only the child's rectangle
    // Set by default
    static final int FLAG_CLIP_CHILDREN = 0x1;
    /**
     * By default, children are clipped to their bounds before drawing. This
     * allows view groups to override this behavior for animations, etc.
     *
     * @param clipChildren true to clip children to their bounds,
     *        false otherwise
     * @attr ref android.R.styleable#ViewGroup_clipChildren
     */
    public void setClipChildren(boolean clipChildren) {
    ...

通过设置根布局 android:clipChildren="false" 这样我们就能实现一屏显示多view的效果了。

多屏

3、面向对象设计

我们需要根据业务的细分对象,每个对象要实现什么功能;各个对象之间如何关联起来贯穿整个业务流程; 设计框架与高层抽象;

3.1、 细分对象

我们都知道面向对象设计思想呢 有一种原则叫 单一职责原则! 所以我们第一步就是划分这个对象。每个对象该做什么事情。 且遵循单一职责原则的优点在于:我的任一单一的对象都可以拿出来单独使用,这样就能极大程度保证我们的代码的可扩展性。

ok,那我们一个一个来分析:

  1. wenldBanner
    也是我们最外层一个对象,它包含了viewPager 对象与我们的指示器对象;负责协调我们VIewPager与指示器之间的关联关系与位置摆放,同时能够对各个对象的属性进行相对应的设置。
  2. AutoTurnViewPager :
    负责自动翻页相关功能;
  3. LoopViewPager
    负责自动翻页设置; 重写滑动监听事件(addOnPageChangeListener,removeOnPageChangeListener);重写真实选中事件(setCurrentItem,getCurrentItem)等等;
  4. WenldPagerAdapter :
    展示真实的View;提供适配器下标与真实数据下标相互转换算法; 并实现对View的复用;
  5. Holder:
    适配器View,Holder
  6. DefaultPageIndicator
    默认指示器
  7. PageIndicatorListener
    指示器监听接口。

3.2 简单UML

大概事件有这么多,如下图:


根据以上搭建类图:

4 拆分代码编程

根据uml流程用例图以及类图 搭建好框架后 定义出接口并写出伪代码;依次实现细节代码。
具体可以进入源码 WenldBanner查看。

5 总结

5.1 遇到的坑

5.1.1、 notifyDataSetChanged "不刷新问题"

这个坑还算是比较轻松就能填充的: 首先是数据源改变后 调用notifyDataSetChanged 界面不刷新
例如:数据从{"一","二","三" }变为{"四","五","六" } 时的效果展现失败,如下图所示

数据变换前
数据变换后
slove:

1、进入notifyDataSetChanged 源码查看 ,通过几步找到了ViewPager的 dataSetChanged() 方法

   void dataSetChanged() {
        ...
        for (int i = 0; i < mItems.size(); i++) {
            final ItemInfo ii = mItems.get(i);
          //调用adapter的 getItemPosition方法  ,然而 该方法返回值 一直为:POSITION_UNCHANGED
            final int newPos = mAdapter.getItemPosition(ii.object);

            if (newPos == PagerAdapter.POSITION_UNCHANGED) {
                continue;
            }
          //如果返回的是 PagerAdapter.POSITION_NONE 那么移除所有view 重新填充
            if (newPos == PagerAdapter.POSITION_NONE) {
            //移除
                mItems.remove(i);
                ...
          //移除
                mAdapter.destroyItem(this, ii.position, ii.object);
          ...
           //在该方法内  如果 mItems 为空 该方法内最终会调用 到 adapter.instantiateItem 方法 填充新的view
            setCurrentItemInternal(newCurrItem, false, true);
            requestLayout();
        }
    }

可以看到 如果 mAdapter.getItemPosition()方法 返回的是 PagerAdapter.POSITION_NONE,那么我们就会将旧items清除掉;经过方法判断items为空, 最终会重新填充新的view;

2、所以我们就可以在 adapter的 getItemPosition方法内下手:
在调用notifyDataSetChanged时保证 getItemPosition返回的是POSITION_NONE

WenldPagerAdapter.class 

    @Override
    public void notifyDataSetChanged() {
        myNotify=true;
        super.notifyDataSetChanged();
        myNotify=false;
    }

    @Override
    public int getItemPosition(Object object) {
        if (!myNotify) {
            return super.getItemPosition(object);
        } else {
            return POSITION_NONE;
        }
    }

5.1.2、 设置切换动画后 notifyDataSetChanged 错乱

1、这个坑算是比较大的:如果我们设置了切换动画,调用notifyDataSetChanged 以后效果会错乱, 如下图所示


2、还是进入源码来分析解决问题,不过分析比较多,请查看ViewPager源码解析PageAdapter刷新问题

5.2 收获

一款商业级Banner控件

既然敢说商业级,那么就支持足够的自定义与扩展性! 实现思路请看这 开发一款商业级Banner控件

效果图:


可以做到以下效果

  • 设置自定义指示器效果
  • 设置指示器位置
  • 设置是否循环
  • 是否可以跳转
  • 页面切换间隔
  • 页面切换持续时间
  • 是否支持手动滑动
  • 是否反向切换页面(切换方向)

use

1、引用:

版本号:[图片上传失败...(image-e7ddb3-1511330475991)]

// root build.gradle
repositories {
    jcenter()
    maven { url "https://www.jitpack.io" }
}
// yout project build.gradle
dependencies {
        compile 'com.github.LidongWen:WenldBanner:1.0.1'
}

2. 使用 WenldBanner:

2.1. xml

```
    <com.wenld.wenldbanner.WenldBanner
        xmlns:app="http://schemas.android.com/apk/res-auto"
        android:id="@+id/commonBanner"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        app:canLoop="true"    //设置是否循环
        app:canTurn="true"  //是否可以跳转
        app:autoTurnTime="5000"// 页面切换间隔
        app:scrollDuration="2000"//页面切换持续时间
        app:isTouchScroll="true" //是否支持手动滑动
        app:reverse="true" // 是否反向切换页面(切换方向)
   />
```

2.2. Java代码中设置属性

        wenldBanner = (WenldBanner) findViewById(R.id.commonBanner);
        //初始化指示器
        defaultPageIndicator = new DefaultPageIndicator(this);
       //设置指示器样式  选中图标与未选中图标
        defaultPageIndicator.setPageIndicator(new int[]{R.mipmap.ic_page_indicator, R.mipmap.ic_page_indicator_focused});

        //设置 view 与 数据
        wenldBanner.setPages(Common.holder, Common.datas);
        wenldBanner
                .setPageIndicatorListener(defaultPageIndicator)  //设置指示器监听
                .setIndicatorView(defaultPageIndicator)  //设置指示器VIew
                .setPageIndicatorAlign(RelativeLayout.ALIGN_PARENT_BOTTOM, RelativeLayout.CENTER_HORIZONTAL);    //设置指示器位置

还可以设置任意指示器样式,指示器监听事件,指示器位置等等...

指示器样式1
指示器样式2
指示器样式3

3. 自定义拆分使用:

比如实现这个效果:

注意
先将根目录设置 android:clipChildren="false",在设置AutiTurnViewPager的宽度 给 viewpPager留出一些空隙android:layout_width="250dp"
在代码中设置PageTransformer查看转换效果

xml文件

<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
   ...
   android:clipChildren="false">

   <com.wenld.wenldbanner.AutoTurnViewPager
       android:id="@+id/autoTurnViewPager"
       android:layout_width="250dp"
       android:clipToPadding="false"
       ... 

   <com.wenld.wenldbanner.DefaultPageIndicator
     ... 
</FrameLayout>

java 要设置PageTransformer否则看不出效果

protected void onCreate(Bundle savedInstanceState) {
    autoTurnViewPager.setPageTransformer(new ZoomOutPageTransformer());
}

具体查看代码:Github地址


希望我的文章不会误导在观看的你,如果有异议的地方欢迎讨论和指正。 如果能给观看的你带来收获,那就是最好不过了。

人生得意须尽欢, 桃花坞里桃花庵