本篇文章已授权微信公众号 guolin_blog （郭霖）独家发布
转载请标明出处：
本文出自:()
代码传送门：喜欢的话，随手点个star。多谢
在上篇文章（）里，我们用ItemDecoration为RecyclerView打造了带悬停头部的分组列表。其实Android版微信的通讯录界面，它的分组title也不是悬停的，我们已经领先了微信一小步（认真脸）~
再看看市面上常见的分组列表（例如饿了么点餐商品列表），不仅有悬停头部，悬停头部在切换时，还会伴有切换动画。
关于ItemDecoration还有一个问题，简单布局还好，我们可以draw出来，如果是复杂的头部呢？能否写个xml，inflate进来，这样使用起来才简单，即另一种简单使用onDraw和onDrawOver的姿势。
so，本文开头我们就先用两节完善一下我们的ItemDecoration。然后进入正题：自定义View实现右侧索引导航栏IndexBar，对数据源的排序字段按照拼音排序，最后将RecyclerView和IndexBar联动起来，触摸IndexBar上相应字母，RecyclerView滚动到相应位置。(在屏幕中间显示的其实就是一个TextView，我们set个体IndexBar即可)
由于大部分使用右侧索引导航栏的场景，都需要这几个固定步骤，对数据源排序，set给IndexBar，和RecyclerView联动等，所以最后再将其封装一把，成一个高度封装，因此扩展性不太高的控件，更方便使用，如果需要扩展的话，反正看完本文再其基础上修改应该很简单~。
最终版预览：
1. 用ItemDecoration实现悬停头部切换动画
2. 另一种简单使用onDraw()和onDrawOver()的姿势
3. 自定义View实现右侧**索引导航栏**IndexBar
4. 使用TinyPinyin对数据源排序
5. 联动IndexBar和RecyclerView。
6. 封装重复步骤，方便二次使用，并可定制导航数据源。
二 悬停头部的“切换动画”
实现了两种，
第一种就是仿饿了么点餐时,商品列表的悬停头部切换“动画效果”，如下：
第二种是一种头部折叠起来的视效，个人觉得也还不错~如下：(估计没人喜欢)
果然比上部残篇里的效果好看多了，那么代码多不多呢，看我的git show 记录：
就绿色部分的不到十行代码就搞定~先上这个图是为了让大家安心，代码不多，分分钟看完。
下面放上文字版代码，江湖人称 注释张 的我，已经写满了注释，
再简单说下吧，
滑动时，在判断头部即将切换（当前pos的tag和pos+1的tag不等）的时候，
1.计算出当前悬停头部应该上移的位移，
利用Canvas的画布移动方法Canvas.translate()，即可实现“饿了么”悬停头部切换效果。
2.计算出当前悬停头部应该在屏幕上还剩余的空间高度，作为头部绘制的高度
利用Canvas的Canvas.clipRect()方法，剪切画布，即可实现“折叠”的视效。
public void onDrawOver(Canvas c, RecyclerView parent, RecyclerView.State state) {//最后调用 绘制在最上层
int pos = ((LinearLayoutManager) (parent.getLayoutManager())).findFirstVisibleItemPosition()
String tag = mDatas.get(pos).getTag()
//View child = parent.getChildAt(pos)
View child = parent.findViewHolderForLayoutPosition(pos).itemView
boolean flag = false
if ((pos + 1) & mDatas.size()) {//防止数组越界（一般情况不会出现）
if (null != tag && !tag.equals(mDatas.get(pos + 1).getTag())) {//当前第一个可见的Item的tag，不等于其后一个item的tag，说明悬浮的View要切换了
Log.d("zxt", "onDrawOver() called with: c = [" + child.getTop())
if (child.getHeight() + child.getTop() & mTitleHeight) {//当第一个可见的item在屏幕中还剩的高度小于title区域的高度时，我们也该开始做悬浮Title的“交换动画”
flag = true
//一种头部折叠起来的视效，个人觉得也还不错~
//可与123行 c.drawRect 比较，只有bottom参数不一样，由于 child.getHeight() + child.getTop() & mTitleHeight，所以绘制区域是在不断的减小，有种折叠起来的感觉
//c.clipRect(parent.getPaddingLeft(), parent.getPaddingTop(), parent.getRight() - parent.getPaddingRight(), parent.getPaddingTop() + child.getHeight() + child.getTop())
//类似饿了么点餐时,商品列表的悬停头部切换“动画效果”
//上滑时，将canvas上移 （y为负数） ,所以后面canvas 画出来的Rect和Text都上移了，有种切换的“动画”感觉
c.translate(0, child.getHeight() + child.getTop() - mTitleHeight)
mPaint.setColor(COLOR_TITLE_BG)
c.drawRect(parent.getPaddingLeft(), parent.getPaddingTop(), parent.getRight() - parent.getPaddingRight(), parent.getPaddingTop() + mTitleHeight, mPaint)
mPaint.setColor(COLOR_TITLE_FONT)
mPaint.getTextBounds(tag, 0, tag.length(), mBounds)
c.drawText(tag, child.getPaddingLeft(),
parent.getPaddingTop() + mTitleHeight - (mTitleHeight / 2 - mBounds.height() / 2),
c.restore()
这份代码核心处c.translate(0, child.getHeight() + child.getTop() - mTitleHeight);实现的是饿了么效果，被注释掉的
//c.clipRect(parent.getPaddingLeft(), parent.getPaddingTop(), parent.getRight() - parent.getPaddingRight(), parent.getPaddingTop() + child.getHeight() + child.getTop())
实现的是效果二。
三 另一种使用onDraw()和onDrawOver()的姿势
之前我们使用onDraw(),onDrawOver()，都是用canvas的方法活生生的绘制一个出View，这对于很多人（包括我）来说都不容易，xy坐标的确认，尺寸都较难把握，基本上调UI效果时间都很长。尤其是canvas.drawText()方法的y坐标，其实是baseLine的位置，不了解的童鞋肯定要踩很多坑。
当我们想要绘制的分类title、悬停头部复杂一点时，我都不敢想象要调试多久了，这个时候我们还敢用ItemDecoration吗。
有没有一种方法，就像我们平时使用的那样，在Layout布局xml里画好View，然后inflate出来就可以了呢。
这个问题开始确实也把我难住了，难道又要从入门到放弃了吗？
于是我又搜寻资料，功夫不负有心人。
解决问题的办法就是，View类的：public void draw(Canvas canvas) {方法
下面我们就看一个用法Demo吧：
布局layout：header_complex.xml（注意有个ProgressBar哦）
&?xml version="1.0" encoding="utf-8"?&
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:background="@color/colorPrimaryDark"
android:orientation="vertical"&
android:layout_width="match_parent"
android:layout_height="match_parent"
android:background="@color/colorAccent"
android:text="复杂头部" /&
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="复杂头部"
android:textColor="@color/colorAccent" /&
android:layout_width="wrap_content"
android:layout_height="wrap_content" /&
onDrawOver代码如下：简单讲解下，先inflate这个复杂的Layout，然后拿到它的LayoutParams，利用这个lp拿到宽和高的MeasureSpec，然后依次调用 measure,layout,draw方法，将复杂头部显示在屏幕上。
（小安利一下，MeasureSpec不太了解的可以看看我的这篇）
View toDrawView = mInflater.inflate(R.layout.header_complex, parent, false)
int toDrawWidthSpec
int toDrawHeightSpec
//拿到复杂布局的LayoutParams，如果为空，就new一个。
// 后面需要根据这个lp 构建toDrawWidthSpec，toDrawHeightSpec
ViewGroup.LayoutParams lp = toDrawView.getLayoutParams()
if (lp == null) {
lp = new ViewGroup.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.WRAP_CONTENT)
toDrawView.setLayoutParams(lp)
if (lp.width == ViewGroup.LayoutParams.MATCH_PARENT) {
//如果是MATCH_PARENT，则用父控件能分配的最大宽度和EXACTLY构建MeasureSpec。
toDrawWidthSpec = View.MeasureSpec.makeMeasureSpec(parent.getWidth() - parent.getPaddingLeft() - parent.getPaddingRight(), View.MeasureSpec.EXACTLY)
} else if (lp.width == ViewGroup.LayoutParams.WRAP_CONTENT) {
//如果是WRAP_CONTENT，则用父控件能分配的最大宽度和AT_MOST构建MeasureSpec。
toDrawWidthSpec = View.MeasureSpec.makeMeasureSpec(parent.getWidth() - parent.getPaddingLeft() - parent.getPaddingRight(), View.MeasureSpec.AT_MOST)
//否则则是具体的宽度数值，则用这个宽度和EXACTLY构建MeasureSpec。
toDrawWidthSpec = View.MeasureSpec.makeMeasureSpec(lp.width, View.MeasureSpec.EXACTLY)
//高度同理
if (lp.height == ViewGroup.LayoutParams.MATCH_PARENT) {
toDrawHeightSpec = View.MeasureSpec.makeMeasureSpec(parent.getHeight() - parent.getPaddingTop() - parent.getPaddingBottom(), View.MeasureSpec.EXACTLY)
} else if (lp.height == ViewGroup.LayoutParams.WRAP_CONTENT) {
toDrawHeightSpec = View.MeasureSpec.makeMeasureSpec(parent.getHeight() - parent.getPaddingTop() - parent.getPaddingBottom(), View.MeasureSpec.AT_MOST)
toDrawHeightSpec = View.MeasureSpec.makeMeasureSpec(lp.width, View.MeasureSpec.EXACTLY)
//依次调用 measure,layout,draw方法，将复杂头部显示在屏幕上。
toDrawView.measure(toDrawWidthSpec, toDrawHeightSpec)
toDrawView.layout(parent.getPaddingLeft(), parent.getPaddingTop(),
parent.getPaddingLeft() + toDrawView.getMeasuredWidth(), parent.getPaddingTop() + toDrawView.getMeasuredHeight())
toDrawView.draw(c)
这里还有个有趣的地方，某些需要不断调用onDraw()更新绘制自己最新状态的View，例如ProgressBar,由于在屏幕上显示的并不是真正的View，只是我们手动的调用了一次draw方法，进而调用View的onDraw()显示的一次“残影”，所以ProgressBar只会显示onDraw()当时的样子，并不会主动刷新了。
看图说话，还是很容易理解的：
滑动时，由于会回调onDrawOver() 方法，所以ProgressBar又被手动调用了draw()，开始变化，滑动的快的话，progressBar会有动画效果。
停止不动时，ProgressBar也是静止的，保持draw()时绘制的状态。
四 自定义View实现右侧索引导航栏IndexBar
不管是自定义ItemDecoration还是实现右侧索引导航栏，都有大量的自定义View知识在里面 ，这里简单复习一下。
（步骤1-4是自定义View的必须套路，步骤5+是IndexBar特殊定制）
1 自定义View首先要确定这个View需要在xml里接受哪些属性？
在IndexBar里，我们先需要两个属性，每个索引的文字大小和手指按下时整个View的背景，
即在attrs.xml如下定义：
name="textSize" format="dimension" /&
name="IndexBar"&
name="textSize" /&
name="pressBackground" format="color" /&
2 在View的构造方法中获得我们自定义的属性
套路代码如下，都是套路，记得使用完最后要将typeArray对象 recycle()。
int textSize = (int) TypedValue.applyDimension(
TypedValue.COMPLEX_UNIT_SP, 16, getResources().getDisplayMetrics())
mPressedBackground = Color.BLACK
TypedArray typedArray = context.getTheme().obtainStyledAttributes(attrs, R.styleable.IndexBar, defStyleAttr, 0)
int n = typedArray.getIndexCount()
for (int i = 0
int attr = typedArray.getIndex(i)
switch (attr) {
case R.styleable.IndexBar_textSize:
textSize = typedArray.getDimensionPixelSize(attr, textSize)
case R.styleable.IndexBar_pressBackground:
mPressedBackground = typedArray.getColor(attr, mPressedBackground)
typedArray.recycle()
3 重写onMesure()方法（可选）
onMeasure()方法里，主要就是遍历一遍indexDatas，得到index最大宽度和高度。然后根据三种测量模式，分配不同的值给View，
EXACLTY就分配具体的测量值（match_parent,确定数值），
AT_MOST就分配父控件能给的最大值和自己需要的值之间的最小值。（保证不超过父控件限定的值）
UNSPECIFIED则分配自己需要的值。（随心所欲）
protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
int wMode = MeasureSpec.getMode(widthMeasureSpec);
int wSize = MeasureSpec.getSize(widthMeasureSpec);
int hMode = MeasureSpec.getMode(heightMeasureSpec);
int hSize = MeasureSpec.getSize(heightMeasureSpec);
int measureWidth = 0, measureHeight = 0;
Rect indexBounds = new Rect();
String index;
for (int i = 0; i & mIndexDatas.size(); i++) {
index = mIndexDatas.get(i);
mPaint.getTextBounds(index, 0, index.length(), indexBounds);
measureWidth = Math.max(indexBounds.width(), measureWidth);
measureHeight = Math.max(indexBounds.width(), measureHeight);
measureHeight *= mIndexDatas.size();
switch (wMode) {
case MeasureSpec.EXACTLY:
measureWidth = wS
case MeasureSpec.AT_MOST:
measureWidth = Math.min(measureWidth, wSize);
case MeasureSpec.UNSPECIFIED:
switch (hMode) {
case MeasureSpec.EXACTLY:
measureHeight = hS
case MeasureSpec.AT_MOST:
measureHeight = Math.min(measureHeight, hSize);
case MeasureSpec.UNSPECIFIED:
setMeasuredDimension(measureWidth, measureHeight);
4 重写onDraw()方法
整理一下需求和思路：
利用index数据源的size，和控件可绘制的高度(高度-paddingTop-paddingBottom)，求出每个index区域的高度mGapHeight。
每个index在绘制时，都是处于水平居中，竖直方向上在mGapHeight区域高度内居中。
思路整理清楚，代码很简单如下：
public static String[] INDEX_STRING = {"A", "B", "C", "D", "E", "F", "G", "H", "I","J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V","W", "X", "Y", "Z", "#"};
private List&String& mIndexD
private int mGapH
mIndexDatas = Arrays.asList(INDEX_STRING);
在onSizeChanged方法里，获取控件的宽高，并计算出mGapHeight:
protected void onSizeChanged(int w, int h, int oldw, int oldh) {
super.onSizeChanged(w, h, oldw, oldh);
mGapHeight = (mHeight - getPaddingTop() - getPaddingBottom()) / mIndexDatas.size();
最后在onDraw()方法里绘制,
如果对于竖直居中baseLine的计算不太理解可以先放置，这块的确挺绕人，后面应该会写一篇 canvas.drawText()x y坐标计算的小短文.
可记住重点就是 Paint默认的TextAlign是Left，即x方向，左对齐，所以x坐标决定绘制文字的左边界。
y坐标是绘制文字的baseLine位置。
protected void onDraw(Canvas canvas) {
int t = getPaddingTop();
Rect indexBounds = new Rect();
String index;
for (int i = 0; i & mIndexDatas.size(); i++) {
index = mIndexDatas.get(i);
mPaint.getTextBounds(index, 0, index.length(), indexBounds);
Paint.FontMetrics fontMetrics = mPaint.getFontMetrics();
int baseline = (int) ((mGapHeight - fontMetrics.bottom - fontMetrics.top) / 2);
canvas.drawText(index, mWidth / 2 - indexBounds.width() / 2, t + mGapHeight * i + baseline, mPaint);
以上四步基本完成了IndexBar的绘制工作，下面我们为它添加一些行为的响应。
5 重写onTouchEvent()方法
我们需要重写onTouchEvent()方法，
以便处理手指按下时的View背景变色，抬起时恢复原来颜色
并根据手指触摸的落点坐标，判断当前处于哪个index区域，回调给相应的监听器处理（显示当前index的值，滑动RecyclerView至相应区域等。。）
代码如下：
public boolean onTouchEvent(MotionEvent event) {
switch (event.getAction()) {
case MotionEvent.ACTION_DOWN:
setBackgroundColor(mPressedBackground);
case MotionEvent.ACTION_MOVE:
float y = event.getY();
int pressI = (int) ((y - getPaddingTop()) / mGapHeight);
if (pressI & 0) {
pressI = 0;
} else if (pressI &= mIndexDatas.size()) {
pressI = mIndexDatas.size() - 1;
if (null != mOnIndexPressedListener) {
mOnIndexPressedListener.onIndexPressed(pressI, mIndexDatas.get(pressI));
case MotionEvent.ACTION_UP:
case MotionEvent.ACTION_CANCEL:
setBackgroundResource(android.R.color.transparent);
if (null != mOnIndexPressedListener) {
mOnIndexPressedListener.onMotionEventEnd();
return true;
6 联动IndexBar和RecyclerView
具体的操作交由监听器处理，定义和实现如下：
值得一提的就是，滑动RecyclerView到指定postion，我们使用的是LinearLayoutManager的scrollToPositionWithOffset(int position, int offset)方法，offset传入0，postion即目标postion即可。如果使用RecyclerView.scrollToPosition();等方法，滑动会很飘~定位不准。
mPressedShowTextView 就是在屏幕中间显示的当前处于哪个index的TextView。
* 当前被按下的index的监听器
public interface onIndexPressedListener {
void onIndexPressed(int index, String text);
void onMotionEventEnd();
private onIndexPressedListener mOnIndexPressedL
public void setmOnIndexPressedListener(onIndexPressedListener mOnIndexPressedListener) {
this.mOnIndexPressedListener = mOnIndexPressedL
setmOnIndexPressedListener(new onIndexPressedListener() {
public void onIndexPressed(int index, String text) {
if (mPressedShowTextView != null) {
mPressedShowTextView.setVisibility(View.VISIBLE);
mPressedShowTextView.setText(text);
if (mLayoutManager != null) {
int position = getPosByTag(text);
if (position != -1) {
mLayoutManager.scrollToPositionWithOffset(position, 0);
public void onMotionEventEnd() {
if (mPressedShowTextView != null) {
mPressedShowTextView.setVisibility(View.GONE);
五 封装重复步骤，方便二次使用。
在我个人的理解里，程序过多的封装是会导致扩展性的降低（也是因为我水平有限），然而我们今天要封装的这个IndexBar，由于使用场景和套路还是挺固定的（城市分组列表，商品分类列表）所以值得将相关的操作都聚合起来，二次使用更方便。毕竟，一个项目里同样的代码写第二遍的程序员都不是好的圣斗士。（其实是我的leader不想写第二遍，让我封装一下给他秒用）
梳理一下固定的操作：
1 都是先对原始数据sourceDatas源按照排序字段拼音排序。
2 然后将屏幕中hint的TextView ，以及索引数据源indexDatas(通过sourceDatas获得)，通过set方法传给IndexBar。
3 联动IndexBar和RecyclerView，使得触摸IndexBar相应区域RecyclerView会滚动(借助sourceDatas获得对应postion)。
根据上述，我的设想在使用时，只需要给IndexBar设置 原始数据sourceDatas，HintTextView，和RecyclerView的LinearLayoutManager，在IndexBar内部对sourceDatas排序，并获得索引数据源indexDatas，然后设置一个默认的index触摸监听器，在手指按下滑动时，由于IndexBar持有HintTextView和LayoutManager，则HintTextView的show hide，以及LayoutManager的滚动 都在IndexBar内部完成。
最终使用预览：
mTvSideBarHint = (TextView) findViewById(R.id.tvSideBarHint);
mIndexBar = (IndexBar) findViewById(R.id.indexBar);
mIndexBar.setmPressedShowTextView(mTvSideBarHint)
.setNeedRealIndex(true)
.setmLayoutManager(mManager)
.setmSourceDatas(mDatas);
&?xml version="1.0" encoding="utf-8"?&
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"&
android:id="@+id/rv"
android:layout_width="match_parent"
android:layout_height="match_parent"&
android:id="@+id/indexBar"
android:layout_width="24dp"
android:layout_height="match_parent"
android:layout_gravity="right"
app:pressBackground="@color/partTranslucent"
app:textSize="16sp" /&
android:id="@+id/tvSideBarHint"
android:layout_width="80dp"
android:layout_height="80dp"
android:layout_gravity="center"
android:background="@drawable/shape_side_bar_bg"
android:gravity="center"
android:textColor="@android:color/white"
android:textSize="48sp"
android:visibility="gone"
tools:text="A"
tools:visibility="visible" /&
其中，setNeedRealIndex(true)//设置需要真实的索引，是指索引栏的数据不是固定的A-Z，#。而是根据真实的sourceDatas生成。
因为链式调用用起来很爽，所以在这些set方法里都return 了 this。
1 抽象两个实体类和一个接口。
先把tag抽象出来，放在顶层，这里存放的就是IndexBar显示的每个index值（A-Z,#）（本例是城市的汉语拼音首字母)，而且在联动滑动时，根据tag获取postion时，也需要用到tag。它是导航分组列表的基础。
public class BaseIndexTagBean {
public String getTag() {
public void setTag(String tag) {
this.tag =
然后抽象一个接口和一个实体类，
接口定义一个方法getTarget()，它返回 需要被转化成拼音，并取出首字母 索引排序的 字段。（本例就是城市的名字）
实体类继承BaseIndexTagBean，并实现以上接口，且额外存放 需要排序的字段的拼音值，（本例是城市的拼音）。它根据getTarget()返回的值利用TinyPinyin库得到拼音。
public interface IIndexTargetInterface {
String getTarget();
public abstract class BaseIndexPinyinBean extends BaseIndexTagBean implements IIndexTargetInterface {
private String pyC
public String getPyCity() {
return pyC
public void setPyCity(String pyCity) {
this.pyCity = pyC
有了以上两个类一个接口，我们就可以将 对原始数据源sourceDatas按照拼音排序，并取出索引数据源indexDatas的操作封装起来。
2 封装原始数据源初始化（利用TinyPinyin获取全拼音），取出索引数据源indexDatas的操作。
使用时，我们先让具体的实体bean，继承自BaseIndexPinyinBean ，在getTarget()方法返回排序目标字段。本例如下：
public class CityBean extends BaseIndexPinyinBean {
public CityBean() {
public CityBean(String city) {
this.city =
public String getCity() {
public void setCity(String city) {
this.city =
public String getTarget() {
IndexBar类内代码：
使用时会调用IndexBar.setmSourceDatas()方法传入原始数据源，在方法内对数据源初始化，并取出索引数据源。
private List&? extends BaseIndexPinyinBean& mSourceD
public IndexBar setmSourceDatas(List&? extends BaseIndexPinyinBean& mSourceDatas) {
this.mSourceDatas = mSourceD
initSourceDatas();
return this;
* 初始化原始数据源，并取出索引数据源
private void initSourceDatas() {
int size = mSourceDatas.size();
for (int i = 0; i & i++) {
BaseIndexPinyinBean indexPinyinBean = mSourceDatas.get(i);
StringBuilder pySb = new StringBuilder();
String target = indexPinyinBean.getTarget();
for (int i1 = 0; i1 & target.length(); i1++) {
pySb.append(Pinyin.toPinyin(target.charAt(i1)));
indexPinyinBean.setPyCity(pySb.toString());
String tagString = pySb.toString().substring(0, 1);
if (tagString.matches("[A-Z]")) {
indexPinyinBean.setTag(tagString);
if (isNeedRealIndex) {
if (!mIndexDatas.contains(tagString)) {
mIndexDatas.add(tagString);
indexPinyinBean.setTag("#");
if (isNeedRealIndex) {
if (!mIndexDatas.contains("#")) {
mIndexDatas.add("#");
sortData();
3 封装对原始数据源sourceDatas，索引数据源indexDatas的排序操作。
* 对数据源排序
private void sortData() {
Collections.sort(mIndexDatas, new Comparator&String&() {
public int compare(String lhs, String rhs) {
if (lhs.equals("#")) {
} else if (rhs.equals("#")) {
return -1;
return lhs.compareTo(rhs);
Collections.sort(mSourceDatas, new Comparator&BaseIndexPinyinBean&() {
public int compare(BaseIndexPinyinBean lhs, BaseIndexPinyinBean rhs) {
if (lhs.getTag().equals("#")) {
} else if (rhs.getTag().equals("#")) {
return -1;
return lhs.getPyCity().compareTo(rhs.getPyCity());
4 是否需要真实的索引数据源。
相关变量定义：
public static String[] INDEX_STRING = {"A", "B", "C", "D", "E", "F", "G", "H", "I","J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "#"};
private List&String& mIndexD
private boolean isNeedRealI
初始化init时，判断不需要真实的索引数据源，就用默认值（A-Z,#）
if (!isNeedRealIndex) {
mIndexDatas = Arrays.asList(INDEX_STRING);
使用时，如果如果真实索引数据源，调用这个方法，传入true，一定要在设置数据源setmSourceDatas(List)之前调用。
* 一定要在设置数据源{@link #setmSourceDatas(List)}之前调用
* needRealIndex
public IndexBar setNeedRealIndex(boolean needRealIndex) {
isNeedRealIndex = needRealI
if (isNeedRealIndex){
if (mIndexDatas != null) {
mIndexDatas = new ArrayList&&();
return this;
在initSourceDatas() 里，会根据这个变量往mIndexDatas里增加index。
5 IndexBar和外部联动的相关（HintTextView，和RecyclerView的LinearLayoutManager）
set方法很简单：
public IndexBar setmPressedShowTextView(TextView mPressedShowTextView) {
this.mPressedShowTextView = mPressedShowTextV
return this;
public IndexBar setmLayoutManager(LinearLayoutManager mLayoutManager) {
this.mLayoutManager = mLayoutM
return this;
它们两最终都是在index触摸监听器里用到，代码上文已提及，只不过这次挪到IndexBar内部init里。
init函数如下：
private void init(Context context, AttributeSet attrs, int defStyleAttr) {
if (!isNeedRealIndex) {
mIndexDatas = Arrays.asList(INDEX_STRING);
setmOnIndexPressedListener(new onIndexPressedListener() {
public void onIndexPressed(int index, String text) {
if (mPressedShowTextView != null) {
mPressedShowTextView.setVisibility(View.VISIBLE);
mPressedShowTextView.setText(text);
if (mLayoutManager != null) {
int position = getPosByTag(text);
if (position != -1) {
mLayoutManager.scrollToPositionWithOffset(position, 0);
public void onMotionEventEnd() {
if (mPressedShowTextView != null) {
mPressedShowTextView.setVisibility(View.GONE);
* 根据传入的pos返回tag
private int getPosByTag(String tag) {
if (TextUtils.isEmpty(tag)) {
return -1;
for (int i = 0; i & mSourceDatas.size(); i++) {
if (tag.equals(mSourceDatas.get(i).getTag())) {
return -1;
六 完整代码
思前想后还是放出来吧，三百多行有点长
* 介绍：索引右侧边栏
* 作者：zhangxutong
* CSDN：http://blog.csdn.net/zxt0601
* 时间： 16/09/04.
public class IndexBar extends View {
private static final String TAG = "zxt/IndexBar";
public static String[] INDEX_STRING = {"A", "B", "C", "D", "E", "F", "G", "H", "I",
"J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V",
"W", "X", "Y", "Z", "#"};
private List&String& mIndexD
private boolean isNeedRealI
private int mWidth, mH
private int mGapH
private Paint mP
private int mPressedB
private TextView mPressedShowTextV
private List&? extends BaseIndexPinyinBean& mSourceD
private LinearLayoutManager mLayoutM
public IndexBar(Context context) {
this(context, null);
public IndexBar(Context context, AttributeSet attrs) {
this(context, attrs, 0);
public IndexBar(Context context, AttributeSet attrs, int defStyleAttr) {
super(context, attrs, defStyleAttr);
init(context, attrs, defStyleAttr);
private void init(Context context, AttributeSet attrs, int defStyleAttr) {
int textSize = (int) TypedValue.applyDimension(
TypedValue.COMPLEX_UNIT_SP, 16, getResources().getDisplayMetrics());
mPressedBackground = Color.BLACK;
TypedArray typedArray = context.getTheme().obtainStyledAttributes(attrs, R.styleable.IndexBar, defStyleAttr, 0);
int n = typedArray.getIndexCount();
for (int i = 0; i & i++) {
int attr = typedArray.getIndex(i);
switch (attr) {
case R.styleable.IndexBar_textSize:
textSize = typedArray.getDimensionPixelSize(attr, textSize);
case R.styleable.IndexBar_pressBackground:
mPressedBackground = typedArray.getColor(attr, mPressedBackground);
typedArray.recycle();
if (!isNeedRealIndex) {
mIndexDatas = Arrays.asList(INDEX_STRING);
mPaint = new Paint();
mPaint.setAntiAlias(true);
mPaint.setTextSize(textSize);
mPaint.setColor(Color.BLACK);
setmOnIndexPressedListener(new onIndexPressedListener() {
public void onIndexPressed(int index, String text) {
if (mPressedShowTextView != null) {
mPressedShowTextView.setVisibility(View.VISIBLE);
mPressedShowTextView.setText(text);
if (mLayoutManager != null) {
int position = getPosByTag(text);
if (position != -1) {
mLayoutManager.scrollToPositionWithOffset(position, 0);
public void onMotionEventEnd() {
if (mPressedShowTextView != null) {
mPressedShowTextView.setVisibility(View.GONE);
protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
super.onMeasure(widthMeasureSpec, heightMeasureSpec);
protected void onDraw(Canvas canvas) {
int t = getPaddingTop();
Rect indexBounds = new Rect();
for (int i = 0; i & mIndexDatas.size(); i++) {
index = mIndexDatas.get(i);
mPaint.getTextBounds(index, 0, index.length(), indexBounds);
Paint.FontMetrics fontMetrics = mPaint.getFontMetrics();
int baseline = (int) ((mGapHeight - fontMetrics.bottom - fontMetrics.top) / 2);
canvas.drawText(index, mWidth / 2 - indexBounds.width() / 2, t + mGapHeight * i + baseline, mPaint);
public boolean onTouchEvent(MotionEvent event) {
switch (event.getAction()) {
case MotionEvent.ACTION_DOWN:
setBackgroundColor(mPressedBackground);
case MotionEvent.ACTION_MOVE:
float y = event.getY();
int pressI = (int) ((y - getPaddingTop()) / mGapHeight);
if (pressI & 0) {
pressI = 0;
} else if (pressI &= mIndexDatas.size()) {
pressI = mIndexDatas.size() - 1;
if (null != mOnIndexPressedListener) {
mOnIndexPressedListener.onIndexPressed(pressI, mIndexDatas.get(pressI));
case MotionEvent.ACTION_UP:
case MotionEvent.ACTION_CANCEL:
setBackgroundResource(android.R.color.transparent);
if (null != mOnIndexPressedListener) {
mOnIndexPressedListener.onMotionEventEnd();
return true;
protected void onSizeChanged(int w, int h, int oldw, int oldh) {
super.onSizeChanged(w, h, oldw, oldh);
mGapHeight = (mHeight - getPaddingTop() - getPaddingBottom()) / mIndexDatas.size();
* 当前被按下的index的监听器
public interface onIndexPressedListener {
void onIndexPressed(int index, String text);
void onMotionEventEnd();
private onIndexPressedListener mOnIndexPressedL
public onIndexPressedListener getmOnIndexPressedListener() {
return mOnIndexPressedL
public void setmOnIndexPressedListener(onIndexPressedListener mOnIndexPressedListener) {
this.mOnIndexPressedListener = mOnIndexPressedL
* 显示当前被按下的index的TextView
public IndexBar setmPressedShowTextView(TextView mPressedShowTextView) {
this.mPressedShowTextView = mPressedShowTextV
return this;
public IndexBar setmLayoutManager(LinearLayoutManager mLayoutManager) {
this.mLayoutManager = mLayoutM
return this;
* 一定要在设置数据源{@link #setmSourceDatas(List)}之前调用
* needRealIndex
public IndexBar setNeedRealIndex(boolean needRealIndex) {
isNeedRealIndex = needRealI
if (mIndexDatas != null) {
mIndexDatas = new ArrayList&&();
return this;
public IndexBar setmSourceDatas(List&? extends BaseIndexPinyinBean& mSourceDatas) {
this.mSourceDatas = mSourceD
initSourceDatas();
return this;
* 初始化原始数据源，并取出索引数据源
private void initSourceDatas() {
int size = mSourceDatas.size();
for (int i = 0; i & i++) {
BaseIndexPinyinBean indexPinyinBean = mSourceDatas.get(i);
StringBuilder pySb = new StringBuilder();
String target = indexPinyinBean.getTarget();
for (int i1 = 0; i1 & target.length(); i1++) {
pySb.append(Pinyin.toPinyin(target.charAt(i1)));
indexPinyinBean.setPyCity(pySb.toString());
String tagString = pySb.toString().substring(0, 1);
if (tagString.matches("[A-Z]")) {
indexPinyinBean.setTag(tagString);
if (isNeedRealIndex) {
if (!mIndexDatas.contains(tagString)) {
mIndexDatas.add(tagString);
indexPinyinBean.setTag("#");
if (isNeedRealIndex) {
if (!mIndexDatas.contains("#")) {
mIndexDatas.add("#");
sortData();
* 对数据源排序
private void sortData() {
Collections.sort(mIndexDatas, new Comparator&String&() {
public int compare(String lhs, String rhs) {
if (lhs.equals("#")) {
} else if (rhs.equals("#")) {
return -1;
return lhs.compareTo(rhs);
Collections.sort(mSourceDatas, new Comparator&BaseIndexPinyinBean&() {
public int compare(BaseIndexPinyinBean lhs, BaseIndexPinyinBean rhs) {
if (lhs.getTag().equals("#")) {
} else if (rhs.getTag().equals("#")) {
return -1;
return lhs.getPyCity().compareTo(rhs.getPyCity());
* 根据传入的pos返回tag
private int getPosByTag(String tag) {
if (TextUtils.isEmpty(tag)) {
return -1;
for (int i = 0; i & mSourceDatas.size(); i++) {
if (tag.equals(mSourceDatas.get(i).getTag())) {
return -1;
不管是自定义ItemDecoration还是实现右侧索引导航栏，其实大量的自定义View知识在里面 ，
so 要想自定义ItemDecoration玩得好，自定义View少不了。
对数据源的排序字段按照拼音排序,我们使用TinyPinyin（）帮助我们排序。
它的特性很适合Android平台。
1. 生成的拼音不包含声调，也不处理多音字，默认一个汉字对应一个拼音；
2. 拼音均为大写；
3. 无需初始化，执行效率很高(Pinyin4J的4倍)；
4. 很低的内存占用（小于30KB）。
（介绍来源于其项目github）
其实不仅仅是IndexBar以及它和RecyclerView，HintTextView的联动可以封装在一起。
悬停头部ItemDecoration也可以利用 BaseIndexTagBean 类来抽象一下，不与具体的实体类耦合，
private List&CityBean& mD
private List&?extends BaseIndexPinyinBean& mD
本文起笔于9.5晚八点，项目上线打包期间，每逢打包是非多~你们懂得，结果打包期间出现各种问题，各种bug紧急修复通宵到凌晨，9.6日，两点起床，又续写后面三节。本文篇幅也略长，写到后面自己也有点懵逼（也可能是通宵还没醒导致），总耗时6小时+，希望大家看后觉得有用可以给我刷波66666.
八 代码地址
我不想吐槽CSDN了，上传代码真心慢，
稍后补上CSDN地址。
csdn传送门：
github地址：欢迎star
使用RecyclerView自定义目录快速索引
快速索引在众多APP中是很常见的一个功能，尤其是在即时通讯和搜索的功能中，最近使用到就写了一个，希望对大家有用！
先看一下效果：首先我们要写的就是自定义QuickIndexBar快速索引类
为RecyclerView打造右侧索引导航栏IndexBar
为RecyclerView打造右侧索引导航栏IndexBar
今日科技快讯
针对于11月1日开始实施的网约车新规，滴滴出行今日发...
【Android】快速实现仿美团选择城市界面，微信通讯录界面
概述本文是这个系列的第三篇，不出意外也是终结篇。因为使用经过重构后的控件已经可以快速实现市面上带 索引导航、悬停分组的列表界面了。
在前两篇里，我们从0开始，一步一步实现了仿微信通讯录、饿了么选餐界...
自定义控件之A-Z快速检索QuickIndexBar
QuickIndexBar：
@Copyright (c) tianchenglin
@Author TCL
package c...
安卓 简单的 联系人快速检索控件QuickIndexBar实现
一切看效果，效果满足不了需求，可以不必看了
实现这样布局，需要自定义右侧QuickIndexBar，具体实现很简单，看代码
public class QuickIndexBar extends V...
https://github.com/mcxtzhang/Suspension&em&IndexBar&/em&/ 可运行的项目 城市列表仿美团 城市列表展示
一、效果图：
二、主要功能：
点击英文字母，自动将该字母条目置顶;
[2 ] 点击字母，显示该字母（相当于一个Toast）;
三、主要知识点：
Android快速索引条控件效果展示代码实现自定义view，画出静态的图形在canvas上指定好位置，用各种画笔Paint，重要的是分析的过程。
公司项目引用了张旭童大神的SuspensionIndexBar，效果是仿微信通讯录，字母标题分组悬停且有右侧菜单条相关连接 ：http://blog.csdn.net/zxt0601/article/...
Android 仿联系人菜单，带字母索引，顶部挤压动画，recyclerview实现联系人页面
效果图：（由于时间原因，未做recyclerview滚动关联索引栏，只实现索引栏控制recyclerview）用法：依赖：compile 'com.android.support:recyclervi...
没有更多推荐了，
QQ搞基交流群：