[Exclusive for lazy people] Universal RecylerAdapter, built-in XRecyclerView, compatible with pull-up and pull-down and animation, high reuse, universal for all pages, support empty pages

Hello everyone, Guo Laoshi is here again. I used to read articles, but now I finally understand how hard it is to write. As a taciturn programmer, I deeply admire the predecessors who have written countless articles ((/- -)/).

I believe everyone has heard of RecylerView (are you sure you haven't heard of it = =), in the era when ListView was rampant, RecyclerView came into our sight with mixed reviews. At that time, I just started a new project and took it to practice. The following is an introduction to the usage process. It is recommended to play with the demo. ( ･᷄-･᷅ )

Normally, for each different list, we often need to implement different Adapters to handle the corresponding logic, which leads to a lot of duplicate code. Driven by the motivation of optimizing code (laziness), I implemented a universal Adapter. The Holder mentioned later can be understood as an Item in the list, belonging to its logic processing class, and each type of Item has a Holder.

With only one Adapter, you can implement various types of lists, which are compatible with different types of Items in one list. All you need to do is maintain your Holder (similar to an Item in a List) and Model, without having to worry about anything else. This allows for high reuse and multi-style logic, as well as support for custom animations and multiple pull-up and pull-down implementations. You don't need to write any Adapter code (^o^)/.

1. CommonRecyclerManager: bind layoutId and your Holder class name.

This management class is used to bind Holder and R.layout.xxx, so that CommonRecyclerAdapter can use it to find the corresponding Holder and create it through the layoutId of the data Model.

 //Associate the layout ID and holder type commonRecyclerManager.addType(TextHolder.ID, TextHolder.class.getName());

2. RecyclerBaseHolder: Inherit this Holder to meet your needs.

RecyclerBaseHolder is the base class of all Holders. It inherits RecyclerView.ViewHolder and defines two methods, so you just inherit it. Find the control when createView, and read the data to fill the screen in onBind. This is where your dream comes true!

 //The implemented hodler inherits RecyclerBaseHolder and overloads the following method to meet your needs
 public class TextHolder extends RecyclerBaseHolder {
 //Layout id, I usually write the ids that this Holder needs to handle here for easy management
 public final static   int ID = R.layout.text_item;
 @BindView(R.id.item_text)
 TextView itemText; 
 
 public TextHolder(Context context, View v) {
 super(context, v);
 } 
 
 /iew created
 @Override
 public void createView( View v) {
        ButterKnife.bind(this, v);
 } 
 
 /iew has been created, with more data processing logic
 @Override
 public void onBind(RecyclerBaseModel model, int position) {
 //Convert to your model
        TextModel textModel = (TextModel) (model);
        itemText.setText(textModel.getText());
 } 
 
 //No need to write
 @Override
 public AnimatorSet getAnimator( View   view ) {
 // Implement your animation
 return   null ;
 }
 }

3. CommonRecyclerAdapter: Common adapter

You only need to pass in the data List and CommonRecyclerManager, and it will automatically generate the corresponding Holder in the RecyclerView according to the order of the Model and the layoutId of the data. Other functions only require simple configuration.

 //Create with data and manager 
 
 adapteradapter = new CommonRecyclerAdapter(getActivity(), commonRecyclerManager, datas); 
 
 
 //Support needs to load more 
 
 adapter.setNeedLoadMore( true ); 
 
 
 //Support empty data display empty page 
 
 adapter.setShowNoData( true ); 
 
 
 //Set item display animation support to open 
 
 adapter.setNeedAnimation( true );

4. RecyclerBaseModel: The accumulation of data models must inherit it and never abandon it.

The purpose of inheriting it is that, because the entire Adapter is based on it as the base class, you need to inherit it. Ultimately, you need the layout ID corresponding to this Model so that it can find its own Holder.

 //Inherit RecyclerBaseModel to implement the data type you need public class TextModel extends RecyclerBaseModel {
 private String text = "" ; 
 
 public String getText() { return text;
 } 
 
 public void setText(String text) { this.text = text;
 }
 }

To sum up,

1. Implement your Holder and inherit RecyclerBaseHolder. This is where you implement your needs, which is equivalent to the logic of Item.

2. Let your data model inherit RecyclerBaseModel and set the Model's LayoutId (very important), so that the model will find the Holder corresponding to the LayoutId through CommonRecyclerManager and generate it.

3. You need a CommonRecyclerManager to bind your LayoutId and the Holder class name that handles this layout.

4. Generate CommonRecyclerAdapter through CommonRecyclerManager and Model's data list.

5. Give the Adapter to the Recycler.

Does the logic look a bit complicated? In fact, it is the LayoutId of the model. CommonRecyclerManager associates the Holder that handles it. In this way, we only need to set different LayoutId models according to the data in the data List, and the Adapter will automatically match the corresponding Holder.

In this way, you only need to implement the Holder and assemble the Model, and any list can be used without writing the Adapter logic. According to the order of the model, the Adapter automatically generates the corresponding Holder, and the same Holder can be bound to different LayoutIds. In the future, you only need to maintain and be compatible with your Holder, and use your holder logic in all lists. Isn't the code much cleaner in an instant?

Pull down to refresh and pull up to load more

For ordinary lists, you can just use the system's SwipeRefreshLayout, which is simple and easy to use. To pull down to load more, just add the following method and easily pull up and down to refresh <(￣︶￣), which is simple and crude. Just remember to add a lock to avoid repeated entry.

 // Turn on support for loading more adapter.setNeedLoadMore( true ); 
 
 recycler.addOnScrollListener(new LoadMoreScrollListener() { @Override
 public void onLoadMore() { //Note locking
 if (!isLoadMore) {
           isLoadMore = true ;
           recycler.postDelayed(new Runnable() { @Override
 public void run() {
                   isLoadMore = false ;
                   loadMore();
 } 
 
 }, 2000);
 }
 } //Which item is currently visible?
 @Override
 public void onScrolled( int firstPosition) {
 }
 });

Other Configuration

You can also configure whether to display animation effects, configure the color of the pull-up loading, single click and long press, etc., see below.

 //Support empty data display empty page 
 
 adapter.setShowNoData( true ); 
 
 
 //Display empty data model, do not set the default empty page 
 
 adapter.setNoDataModel(noDataModel); 
 
 
 //Display the layout of the empty data page, do not set the display default, the layout id needs to be associated with the hodler through CommonRecyclerManager 
 
 adapter.setNoDataLayoutId(noDataLayoutId); 
 
 
 //Set animation support to open 
 
 adapter.setNeedAnimation( true ); 
 
 
 //Add click 
 
 adapter.setOnItemClickListener(); 
 
 XRecyclerView compatible support 

XRecyclerView is added and modified here. XRecyclerView has a built-in internal Adapter, which supports adding headers, built-in pull-down controls, and fully supports CommonRecyclerAdapter after some adjustments.

No need to listen to sliding, no need for SwipeRefreshLayout, easy to add refresh and load more. It also supports dynamic configuration, various styles of pull-up and pull-down support, specifically under ProgressStyle, there are multiple types of support configuration, which solves the problem that Adapter is not compatible with waterfall flow pull-up.

The usage here is the same as that of ordinary RecyclerView. It supports cooperation with CommonRecyclerAdapter, and it also supports displaying empty pages and adding various headers. The only thing you need to pay attention to is that when adding the dividing line class addItemDecoration and clicking, you need to convert the added header and the absolute position of the refresh into a relative position. I once made myself cry here ╥﹏╥... Let's look at the code below.

 //Whether to block the pull-down 
 
 //xRecycler.setPullRefreshEnabled( false ); 
 
 //Pull up to load more styles, you can also set pull down 
 
 xRecycler.setLoadingMoreProgressStyle(ProgressStyle.SysProgress); 
 
 //Set the manager to associate the layout with the holder class name. Different ids can manage one holder. 
 
 CommonRecyclerManager commonRecyclerManager = new CommonRecyclerManager(); 
 
 commonRecyclerManager.addType(ImageHolder.ID, ImageHolder.class.getName()); 
 
 commonRecyclerManager.addType(TextHolder.ID, TextHolder.class.getName()); 
 
 commonRecyclerManager.addType(ClickHolder.ID, ClickHolder.class.getName()); 
 
 // Initialize the general manager 
 
 commonRecyclerAdapter = new CommonRecyclerAdapter(getActivity(), commonRecyclerManager, dataList); 
 
 xRecycler.setAdapter(commonRecyclerAdapter); 
 
 
 ImageView imageView = new ImageView(getActivity()); 
 
 imageView.setImageResource(R.drawable.xxx1); 
 
 imageView.setScaleType(ImageView.ScaleType.CENTER_CROP); 
 
 imageView.setMinimumHeight(dip2px(getActivity(), 100)); 
 
 //Add header 
 
 xRecycler.addHeaderView(imageView); 
 
 //It also supports setting empty local 
 
 //xRecycler.setEmptyView(); 
 
 xRecycler.setLoadingListener(new XRecyclerView.LoadingListener() { 
 
 @Override 
 
 public void onRefresh() { 
 
        xRecycler.postDelayed(new Runnable() { 
 
 @Override 
 
 public void run() { 
 
                xRecycler.refreshComplete(); 
 
 } 
 
 }, 2000); 
 
 } 
 
 
 @Override 
 
 public void onLoadMore() { 
 
        xRecycler.postDelayed(new Runnable() { 
 
 @Override 
 
 public void run() { 
 
 loadMore(); 
 
 } 
 
 }, 2000); 
 
 } 
 
 }); 
 
 
 commonRecyclerAdapter.setOnItemClickListener(new OnItemClickListener() { 
 
 @Override 
 
 public void onItemClick(Context context, int position) { 
 
 //You need to subtract the number of your header and refreshed views 
 
 Toast.makeText(getActivity(), "Clicked!! " + (position - 2), Toast.LENGTH_SHORT).show(); 
 
 } 
 
 });

***

You should have known the general usage by now. The detailed internal implementation can be viewed through DEMO. The general logic is that CommonRecyclerManager associates layoutId and Holder class name, CommonRecyclerAdapter finds the Holder through the layoutId of the Model, and then creates the view with the layoutId, and passes the View, position, and model into the Holder to fill in the data. The layoutId is also *type id**, note:

When using it, remember to set setResLayoutId() for your model, which is the most easily forgotten.