Интерфейс подвисает при отображении логов в режиме реального времени

Проблема в том, что добавление текста в строку переписыванием ее содержимого полностью влечет за собой перерисовку содержимого всей строки.

Для того, чтобы объехать эту проблему, нам понадобится TextBox, пусть даже в режиме IsReadOnly = true. У текстбокса есть метод TextBox.AppendText(), который быстро и безболезненно добавляет какой-то текст в конец текстбокса. Даже если текста в нем очень много, добавление происходит очень быстро.

Но есть нюанс, связанный с тем, что бесконечно все-таки добавлять в него строки не стоит, потому что если у вас длина текста превысит (в байтах) 2 ГБ, то приложение упадет, к тому же я не думаю, что на больших объемах текста оно не будет тормозить. Поэтому я бы ввел ограничение на максимальное количество строк. И здесь нам помогут еще метод TextBox.Select() и свойство TextBox.SelectedText.

Обратите внимание, я вообще не работаю с свойством TextBox.Text. Обращение к данному свойству вызывает рендер всего содержимого текстбокса в string, что может при больших объемах текста и частых вызовах повлечь те же самые тормоза.

Так как прямая работа с контролами в MVVM - дело не чистое, я создал наследника текстбокса.

public class LogTextBox : TextBox
{
    public static readonly DependencyProperty TotalMaxLinesProperty =
        DependencyProperty.Register(nameof(TotalMaxLines), typeof(int), typeof(LogTextBox), new PropertyMetadata(-1));

    public static readonly DependencyProperty LineSourceProperty =
        DependencyProperty.Register(nameof(LineSource), typeof(string), typeof(LogTextBox), new FrameworkPropertyMetadata(string.Empty, new PropertyChangedCallback(LineAdded)));

    public int TotalMaxLines
    {
        get { return (int)GetValue(TotalMaxLinesProperty); }
        set { SetValue(TotalMaxLinesProperty, value); }
    }

    public string LineSource
    {
        get => (string)GetValue(LineSourceProperty);
        set => SetValue(LineSourceProperty, value);
    }

    private static void LineAdded(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        LogTextBox box = (LogTextBox)d;
        string newText = (string)e.NewValue;
        if (newText.Length == 0)
        {
            box.Text = string.Empty;
            return;
        }

        if (box.LineCount > 1 || box.Text.Length > 0) 
            box.AppendText(Environment.NewLine);
        box.AppendText(newText);
        int maxLines = box.TotalMaxLines;
        if (maxLines > 0)
        {
            int linesCountToRemove = box.LineCount - maxLines;
            if (linesCountToRemove > 0)
            {
                int index = 0;
                for (int i = 0; i < linesCountToRemove; i++)
                    index += box.GetLineLength(i);
                box.Select(0, index);
                box.SelectedText = string.Empty;
            }
        }
        box.ScrollToEnd();
    }
}

• Свойство TotalMaxLines отвечает за удаление лишних старых строк. Если оно 0 или меньше, то ограничения нет.
• LineSource отвечает за запись новой строки в текстбокс, при этом разделение строк переносом на новую строку происходит автоматически. То есть вам не следует вручную добавлять Environment.NewLine в коде к своим строчкам.

Далее вкручиваю этот контрол в окно

<local:LogTextBox Margin="5" ScrollViewer.VerticalScrollBarVisibility="Auto" IsReadOnly="True" LineSource="{Binding LogSystem}" TotalMaxLines="10"/>

И с помощью вот такого кода я это все тестировал

public class MainViewModel : NotifyPropertyChanged
{
    private string logSystem;

    public string LogSystem
    {
        get => logSystem;
        set
        {
            logSystem = value;
            OnPropertyChanged();
        }
    }

    private void Log(string msg = "")
    {
        LogSystem = msg.Length > 0 ? string.Format("[ {0} ] {1}", DateTime.Now.ToString("HH:mm"), msg) : string.Empty;
    }

    private async void LogLoop()
    {
        int i = 0;
        while (true)
        {
            Log($"Hello world {i++}");
            await Task.Delay(10);
        }
    }

    public MainViewModel()
    {
        LogLoop();
    }
}

public class NotifyPropertyChanged : INotifyPropertyChanged
{
    public event PropertyChangedEventHandler PropertyChanged;
    protected virtual void OnPropertyChanged([CallerMemberName] string propertyName = null)
        => PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
}

Внимание на LogSystem = string.Format, здесь поменялся код.

В выше показанном примере есть недостаток. Если вы запишите в свойство LogSystem несколько раз так быстро, что интерфейс не успеет обновиться между перезаписями, то перезаписанные строчки могут потеряться. К сожалению, это ограничение поведения DependencyProperty, и обойти его без особого изврата можно только создав механизм буферизации на стороне вьюмодели, то есть ловить факт, когда контрол забрал значение и сбрасывать буфер. Вероятность такого критически мала, но все равно для надежности пишите логи лучше параллельно в файл.

Следующая ваша проблема - это вызов метода Log из стороннего потока. Чтобы перенаправить вывод в UI поток, можно использвать Dispatcher, или например Progress<T>.

Вот так может измениться код, чтобы вывод в интерфейс стал потокобезопасным.

public class MainViewModel : NotifyPropertyChanged
{
    private IProgress<string> _logToUI;

    private string logSystem;
    public string LogSystem
    {
        get => logSystem;
        set
        {
            logSystem = value;
            OnPropertyChanged();
        }
    }

    private void Log(string msg = "")
    {
        _logToUI.Report(msg.Length > 0 ? string.Format("[ {0} ] {1}", DateTime.Now.ToString("HH:mm"), msg) : string.Empty);
    }

    private async void LogLoop()
    {
        int i = 0;
        while (true)
        {
            Log($"Hello world {i++}");
            await Task.Delay(10);
        }
    }

    public MainViewModel()
    {
        _logToUI = new Progress<string>(s => LogSystem = s);
        LogLoop();
    }
}

Progress автоматически перенаправляет вывод в тот контекст синхронизации, в котором он был создан (new Progress).