【WPF】UI虚拟化之------自定义VirtualizingWrapPanel
前言
前几天QA报了一个关于OOM的bug，在排查的过程中发现，ListBox控件中被塞入了过多的Item，而ListBox又定义了两种样式的ItemsPanelTemplate。一种用的是虚拟化的VirtualizingStackPanel，另一种没有考虑虚拟化用的是WrapPanel。所以当ListBox切换到第二种Template，而且有很多Item的时候，内存就爆掉然后直接挂了。
然后就想着有没有现成的VirtualizingWrapPanel可以直接拿来用用，可惜微软并没有直接给我们提供这种panel，但是提供了VirtualizingPanel这个抽象类。没办法只能自己动手做了，借助于VirtualizingPanel和IScrollInfo。IScrollInfo主要是用来滚动效果，而VirtualizingPanel则提供了虚拟化过程中，child的移除和添加操作。其实虚拟化的本质不就是把需要显示到UI上的item画上去，把已经画上去但不需要再显示的撤下来嘛！
因为改bug的时候又来了个新的需求，就是要把WrapPanel中每一行的item之间的距离设置为等间距的，所以这次的UI虚拟化之旅确切来说应该是自定义一个VirtualizingUniformGridWrapPanel。
实现
1. 新建类VirtualizingWrapPanel，继承VirtualizingPanel并实现IScrollInfo
public class VirtualizingWrapPanel : VirtualizingPanel, IScrollInfo
{
}然后添加一个TranslateTransform字段，这主要是滚动时需要用到。
private TranslateTransform trans = new TranslateTransform();接下来添加几个依赖属性，设置内部Child的宽、高和鼠标滚动一次的偏移量。
public static readonly DependencyProperty ChildWidthProperty = DependencyProperty.RegisterAttached("ChildWidth", typeof(double), typeof(VirtualizingWrapPanel), new FrameworkPropertyMetadata(200.0, FrameworkPropertyMetadataOptions.AffectsMeasure | FrameworkPropertyMetadataOptions.AffectsArrange));
public static readonly DependencyProperty ChildHeightProperty = DependencyProperty.RegisterAttached("ChildHeight", typeof(double), typeof(VirtualizingWrapPanel), new FrameworkPropertyMetadata(200.0, FrameworkPropertyMetadataOptions.AffectsMeasure | FrameworkPropertyMetadataOptions.AffectsArrange));
//鼠标每一次滚动 UI上的偏移
public static readonly DependencyProperty ScrollOffsetProperty = DependencyProperty.RegisterAttached("ScrollOffset", typeof(int), typeof(VirtualizingWrapPanel), new PropertyMetadata(10));
public int ScrollOffset
{
get { return Convert.ToInt32(GetValue(ScrollOffsetProperty)); }
set { SetValue(ScrollOffsetProperty, value); }
}
public double ChildWidth
{
get => Convert.ToDouble(GetValue(ChildWidthProperty));
set => SetValue(ChildWidthProperty, value);
}
public double ChildHeight
{
get => Convert.ToDouble(GetValue(ChildHeightProperty));
set => SetValue(ChildHeightProperty, value);
}2. 理解WPF中的布局定位流程
WPF中布局定位的计算是通过Measure和Arrange方法构成的。以VirtualizingWrapPanel为例（以下简称VWP），VWP的父layout调用自身的Measure(Size availableSize) 方法，告诉VWP你有availableSize的大小可以使用，然后MeasureCore会根据一定的测量逻辑，告诉VWP的protected override Size MeasureOverride(Size availableSize) 方法，你有availableSize的大小可以用，在这里VWP调用其子元素的Measure方法，告诉子元素有多大的Size可以用（此例，因为我们子child的大小都是通过依赖属性设置好的，所以直接传入即可，子child的DesiredSize也不考虑）。子child都Measure完之后，返回一个Size，这个Size是VMP自身需要的Size，父layout会通过VWP.DesiredSize属性拿到这个值。然后ArrangeCore又会根据一定的逻辑，分配一个finalSize给VWP。VWP通过protected override Size ArrangeOverride(Size finalSize)方法就收到了这个值，然后在给定的finalSize里划分不同的区域，调用子child的Arrange方法，告诉每个child应该在哪个区域。
/// 3. 什么时候应该刷新UI
MSDN文档 告诉我们，当ScrollViewer的offset, extent, or viewport 这三个属性发生变化时，应该当调用ScrollViewer的InvalidateScrollInfo方法，然后ScrollView就会自动更新滚动条长短和位置。此时也应该调用InvalidateMeasure方法，然后会重新Measure布局。
offset，extent和viewport的表示区域如下图：
黑色的表示实际显示到界面上的内容。如果不虚拟化则24个item都会在wrappanel中，虚拟化后只有需要显示的那部分（9-16）会在wrappanel中，其他的都删除了。
更新UI操作：
public void SetVerticalOffset(double offset)
{
if (offset < 0 || this.viewPort.Height >= this.extent.Height)
offset = 0;
else
if (offset + this.viewPort.Height >= this.extent.Height)
offset = this.extent.Height - this.viewPort.Height;
this.offset.Y = offset;
this.ScrollOwner?.InvalidateScrollInfo();//Scroll信息已过期
this.trans.Y = -offset;
this.InvalidateMeasure();//Measure信息已过期
//接下来会触发MeasureOverride()
}4. 虚拟化操作
操作的第一步是获取当前VWP中已加载的所有的child和ListBox的数据源中所有的child。
VWP中children的获取可通过this.InternalChildren拿到。
数据源中children包含在this.ItemContainerGenerator 里面。
这里sdk有个bug，如果你不先调用this.InternalChildren，直接用ItemContainerGenerator后续生成child操作会返回null。
第二步，获取到应该显示到viewport区域内的第一个child和最后一个child的索引，此时viewport的大小可能已经是变化后的。（因为你可能滚动了鼠标，或者更改了VWP的宽高）
/// 第三、通过Generator生成从firstIndex到lastIndex的项，并添加到ListBox（等ItemsControl中）。
在开始之前先看几个定义和工作流程：
- 定义：在这里我们把你绑定到ItemsControl上的数据称作DataItems，其子项称为DataItem。
- 定义：把在UI上的Itemscontrol空间内的item称为UIItem，UIItem放到不同的control里有不同的名字，如
ListViewItem、TreeViewItem等。 - 获取generatorPostition流程：对应的是
generator.GeneratorPositionFromIndex(dataItemIndex)方法，根据dataItemIndex从DataItems里找到对应的DataItem，然后再根据DataItem获取到它在generator里的索引。 - GeneratorPosition类：有两个属性index和offset。当offset==0时，表示此DataItem被
Realized过，即存在对应的UIItem，index就是UIItem在generator中的位置索引。当offset！=0时，表示此DataItem是Virtualized的，没有被Realized过，此时index是-1。（不知道理解是否有误） - 生成流程：
generator负责把DataItem加工成UIItem并显示（添加）到ItemsControl上。对应的是generator.GenerateNext()方法，返回值是一个UIElement（也就是UIItem），并把它添加/插入到Children中，并为它准备好容器PrepareItemContainer。 - 其他：listBox.ItemContainerGenerator几个方法的对比：
ListBox.ItemContainerGenerator.ContainerFromIndex():通过DataItem在DataItems里的index，查到在ItemContainerGenerator中对应的UIItem。ListBox.ItemContainerGenerator.ContainerFromItem(): 通过DataItem，查找在ItemContainerGenerator中对应的Item。generator.GeneratorPositionFromIndex():通过DataItem在DataItems里的index，获取它在generator里的位置。
GeneratorPosition startPosi = generator.GeneratorPositionFromIndex(firstVisiableIndex);
int childIndex = (startPosi.Offset == 0) ? startPosi.Index : startPosi.Index + 1;
using (generator.StartAt(startPosi, GeneratorDirection.Forward, true))
{
int itemIndex = firstVisiableIndex;
while (itemIndex <= lastVisiableIndex)
{
bool newlyRealized = false;
//不断的从DataItems中获取DataItem并生成UIItem
var child = generator.GenerateNext(out newlyRealized) as UIElement;
if (newlyRealized)
{
if (childIndex >= children.Count)
{
base.AddInternalChild(child);
}
else
{
base.InsertInternalChild(childIndex, child);
}
generator.PrepareItemContainer(child);
}
else
{//generator里已经有了
if (!child.Equals(children[childIndex]))
{
//不相等表示children[childIndex]对应的DataItem已经不在DataItems里了，所以在Children里也要删除。
base.RemoveInternalChildRange(childIndex, 1);
}
}
child.Measure(new Size(this.ChildWidth, this.ChildHeight));
itemIndex++;
childIndex++;
}
}第四、将VWP中已不需在viewport内显示的child从children和generator的container中移除。（generator里的子项个数就是children里的子项个数。）
/// 这里虽然调用了generator.Remove方法，将不需要显示的进行移除，但是我发现移除后generator中元素的个数与ListBox绑定的数据源中元素的个数始终是一致的。所以我觉得可能是将次child从generator的container中移除了。因为你从上面的MeasureOverride方法中也看到了，新加时是调用generator的PrepareItemContainer方法。
5. UniformGrid效果的WrapPanel该怎么给child Arrange
其实就在上面的ArrangeOverride方法里，很简单：
xCorrdForItem = column * availableItemWidth + (availableItemWidth - this.ChildWidth) / 2;6. 存在的Bug或者问题
第一个bug你已经在上面的第4步看过了。
还有个bug是VMP的ScrollOwner报null reference的异常，本质是找不到包裹它的ScrollViewer，其原因可能有两个：
1. 为你的ListBox设置ItemsPanlTempalte是通过Bind的方式，会引发这个异常。如果你尝试着给它Bind一个scrollviewer，那么接下来你可能还会面临着滚动页面出现空白，但是明明新的child已经生成了，就是不会显示的UI上的问题。正确的解决方式是CodeBind，用C#代码为这个ListBox设置ItemsPanlTemplate。
2. 自定义了Control的Tempalte，就像下面这个代码一样：
<ControlTemplate TargetType="{x:Type ListView}">
<ScrollViewer HorizontalScrollBarVisibility="Disabled" VerticalScrollBarVisibility="Visible">
<Border Margin="10">
<ItemsPresenter />
Border>
ScrollViewer>
ControlTemplate>相当于你定义ControlTempate的时候重新设置了ScrollViewer，然后VMP就找不到了。所以看能不能找到不定义Tempalte的方法吧。
7. 使用方法
<ListBox Margin="0,50,0,0" Name="listB">
<ListBox.ItemTemplate>
<DataTemplate>
<TextBlock Text="{Binding}" Width="70" Height="70"/>
DataTemplate>
ListBox.ItemTemplate>
<ListBox.ItemsPanel>
<ItemsPanelTemplate>
<local:VirtualizingWrapPanel ScrollOffset="50" ChildHeight="70" ChildWidth="70"/>
ItemsPanelTemplate>
ListBox.ItemsPanel>
ListBox>8. 完整代码：
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Controls.Primitives;
using System.Windows.Media;
namespace VirtualizingPPanel
{
public class VirtualizingWrapPanel : VirtualizingPanel, IScrollInfo
{
private TranslateTransform trans = new TranslateTransform();
public VirtualizingWrapPanel()
{
this.RenderTransform = trans;
}
#region DependencyProperties
public static readonly DependencyProperty ChildWidthProperty = DependencyProperty.RegisterAttached("ChildWidth", typeof(double), typeof(VirtualizingWrapPanel), new FrameworkPropertyMetadata(200.0, FrameworkPropertyMetadataOptions.AffectsMeasure | FrameworkPropertyMetadataOptions.AffectsArrange));
public static readonly DependencyProperty ChildHeightProperty = DependencyProperty.RegisterAttached("ChildHeight", typeof(double), typeof(VirtualizingWrapPanel), new FrameworkPropertyMetadata(200.0, FrameworkPropertyMetadataOptions.AffectsMeasure | FrameworkPropertyMetadataOptions.AffectsArrange));
//鼠标每一次滚动 UI上的偏移
public static readonly DependencyProperty ScrollOffsetProperty = DependencyProperty.RegisterAttached("ScrollOffset", typeof(int), typeof(VirtualizingWrapPanel), new PropertyMetadata(10));
public int ScrollOffset
{
get { return Convert.ToInt32(GetValue(ScrollOffsetProperty)); }
set { SetValue(ScrollOffsetProperty, value); }
}
public double ChildWidth
{
get => Convert.ToDouble(GetValue(ChildWidthProperty));
set => SetValue(ChildWidthProperty, value);
}
public double ChildHeight
{
get => Convert.ToDouble(GetValue(ChildHeightProperty));
set => SetValue(ChildHeightProperty, value);
}
#endregion
int GetItemCount(DependencyObject element)
{
var itemsControl = ItemsControl.GetItemsOwner(element);
return itemsControl.HasItems ? itemsControl.Items.Count : 0;
}
int CalculateChildrenPerRow(Size availableSize)
{
int childPerRow = 0;
if (availableSize.Width == double.PositiveInfinity)
childPerRow = this.Children.Count;
else
childPerRow = Math.Max(1, Convert.ToInt32(Math.Floor(availableSize.Width / this.ChildWidth)));
return childPerRow;
}
/// 9. Demo下载
最终效果：
下载：
链接: https://pan.baidu.com/s/1jHMBFM2 密码: 4csp
参考
1. Magentaize!——正确实现 WPF 中的 UI 虚拟化
2. GitHub - digimezzo/WPFControls: WPF Controls
3.WPF布局
4.Implementing a VirtualizingPanel part 3: MeasureCore