stickyheaders library 사용 하면서 겪은 이슈
RecyclerView 의 리스트 표현시 Header / Section 을 표현하기 위한 라이브러리를 사용하면서 겪은 이슈를 정리하였습니다.
이슈
Support Library를 27.1.0 으로 업데이트 하고 난 뒤 정상적으로 동작되던 화면이 아래와 같은 Crash 로그가 발생되었습니다.
E/AndroidRuntime: FATAL EXCEPTION: main
Process: com.wanted.android.wanted, PID: 16842
java.lang.IllegalStateException: ViewHolder views must not be attached when created. Ensure that you are not passing 'true' to the attachToRoot parameter of LayoutInflater.inflate(..., boolean attachToRoot)
at android.support.v7.widget.RecyclerView$Adapter.createViewHolder(RecyclerView.java:6687)
at android.support.v7.widget.RecyclerView$Recycler.tryGetViewHolderForPositionByDeadline(RecyclerView.java:5869)
at android.support.v7.widget.RecyclerView$Recycler.getViewForPosition(RecyclerView.java:5752)
at android.support.v7.widget.RecyclerView$Recycler.getViewForPosition(RecyclerView.java:5748)
at com.wanted.android.wanted.ui.view.stickyheader.StickyHeaderLayoutManager.onLayoutChildren(StickyHeaderLayoutManager.java:216)
at android.support.v7.widget.RecyclerView.dispatchLayoutStep2(RecyclerView.java:3812)
at android.support.v7.widget.RecyclerView.dispatchLayout(RecyclerView.java:3529)
at android.support.v7.widget.RecyclerView.onLayout(RecyclerView.java:4082)
at android.view.View.layout(View.java:16694)
at android.view.ViewGroup.layout(ViewGroup.java:5481)
at android.widget.RelativeLayout.onLayout(RelativeLayout.java:1079)
at android.view.View.layout(View.java:16694)
at android.view.ViewGroup.layout(ViewGroup.java:5481)
at android.widget.FrameLayout.layoutChildren(FrameLayout.java:336)
at android.widget.FrameLayout.onLayout(FrameLayout.java:273)
at android.view.View.layout(View.java:16694)
at android.view.ViewGroup.layout(ViewGroup.java:5481)
at android.widget.LinearLayout.setChildFrame(LinearLayout.java:1743)
at android.widget.LinearLayout.layoutVertical(LinearLayout.java:1586)
at android.widget.LinearLayout.onLayout(LinearLayout.java:1495)
at android.view.View.layout(View.java:16694)
at android.view.ViewGroup.layout(ViewGroup.java:5481)
at android.widget.FrameLayout.layoutChildren(FrameLayout.java:336)
at android.widget.FrameLayout.onLayout(FrameLayout.java:273)
at android.view.View.layout(View.java:16694)
at android.view.ViewGroup.layout(ViewGroup.java:5481)
at android.widget.LinearLayout.setChildFrame(LinearLayout.java:1743)
at android.widget.LinearLayout.layoutVertical(LinearLayout.java:1586)
at android.widget.LinearLayout.onLayout(LinearLayout.java:1495)
at android.view.View.layout(View.java:16694)
at android.view.ViewGroup.layout(ViewGroup.java:5481)
at android.widget.FrameLayout.layoutChildren(FrameLayout.java:336)
at android.widget.FrameLayout.onLayout(FrameLayout.java:273)
at com.android.internal.policy.PhoneWindow$DecorView.onLayout(PhoneWindow.java:2697)
at android.view.View.layout(View.java:16694)
at android.view.ViewGroup.layout(ViewGroup.java:5481)
at android.view.ViewRootImpl.performLayout(ViewRootImpl.java:2227)
at android.view.ViewRootImpl.performTraversals(ViewRootImpl.java:1980)
at android.view.ViewRootImpl.doTraversal(ViewRootImpl.java:1140)
at android.view.ViewRootImpl$TraversalRunnable.run(ViewRootImpl.java:6231)
at android.view.Choreographer$CallbackRecord.run(Choreographer.java:858)
at android.view.Choreographer.doCallbacks(Choreographer.java:670)
at android.view.Choreographer.doFrame(Choreographer.java:606)
at android.view.Choreographer$FrameDisplayEventReceiver.run(Choreographer.java:844)
at android.os.Handler.handleCallback(Handler.java:739)
at android.os.Handler.dispatchMessage(Handler.java:95)
at android.os.Looper.loop(Looper.java:148)
at android.app.ActivityThread.main(ActivityThread.java:5527)
이슈 원인 분석
support library 27.1.0 의 createViewHolder 루틴은 다음과 같습니다.
/**
* This method calls {@link #onCreateViewHolder(ViewGroup, int)} to create a new
* {@link ViewHolder} and initializes some private fields to be used by RecyclerView.
*
* @see #onCreateViewHolder(ViewGroup, int)
*/
public final VH createViewHolder(@NonNull ViewGroup parent, int viewType) {
try {
TraceCompat.beginSection(TRACE_CREATE_VIEW_TAG);
final VH holder = onCreateViewHolder(parent, viewType);
if (holder.itemView.getParent() != null) {
throw new IllegalStateException("ViewHolder views must not be attached when"
+ " created. Ensure that you are not passing 'true' to the attachToRoot"
+ " parameter of LayoutInflater.inflate(..., boolean attachToRoot)");
}
holder.mItemViewType = viewType;
return holder;
} finally {
TraceCompat.endSection();
}
}
이전 버전까지는 itemView의 getParent() 를 체크하는 로직이 없었는데 Support Library v27.1.0 부터는 해당 로직이 추가되면서 HeaderLayoutManager의 header 영역을 그릴 때 Exception 이 발생 되었습니다.
해결 방법
RecyclerView의 각 itemView 중 getParent를 세팅하는 로직이 없는데 하면서 코드를 보니 SectioningAdapter 의 onCreateGhostHeaderViewHolder 함수가 다음과 같이 되어 있었습니다.
/**
* Called when a ViewHolder is needed for a section ghost header view
*
* @param parent The ViewGroup into which the new View will be added after it is bound to an adapter position.
* @return A new GhostHeaderViewHolder holding a ghost header view
*/
public GhostHeaderViewHolder onCreateGhostHeaderViewHolder(ViewGroup parent) {
View ghostView = new View(parent.getContext());
ViewGroup.LayoutParams layoutParams = new ViewGroup.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.WRAP_CONTENT);
parent.addView(ghostView, layoutParams);
return new GhostHeaderViewHolder(ghostView);
}
header 에 anchor 되는 뷰를 생성하는 시점에 parent.addView를 기본적으로 동작하고 있었으며, 해당 코드를 제거하여 정상 동작이 되는 것을 확인 하였습니다. Support Library 최신 버전 혹은 이전 버전 모두 정상 동작됩니다.
