Как предотвратить утечку памяти в JTextPane.setCaretPosition(int)?

Я работаю над приложением Java с основанным на Swing GUI. Приложение использует JTextPane выводить сообщения журнала следующим образом: 1) обрезать существующий текст, чтобы сохранить общий размер текста ниже предела; 2) добавить новый текст; 3) прокрутить до конца (реальная логика немного отличается, но здесь это не имеет значения).

Я использовал Eclipse с JVM Monitor для определения разумного предела размера текста и обнаружил значительную утечку памяти. Я пытался удалить UndoableEditListeners из базового документа и отключите автоматическое обновление позиции каретки (путем явного изменения позиции с помощью DefaultCaret.NEVER_UPDATE а также JTextPane.setCaretPosition(int)), но безуспешно. Наконец, я решил полностью отключить изменение положения каретки, и это устранило утечку.

У меня есть два вопроса:

  1. Есть ли проблема с моим кодом? Если да, как я могу изменить его для выполнения задачи?

  2. Это ошибка Swing/JVM? Если да, как я могу сообщить об этом?

Подробности:

Вот SSCCE: GUI с textPane и двумя кнопками для небольших и стресс-тестов. FIX а также FIXXX флаги соответствуют моим попыткам исправить утечку памяти.

package memleak;

import java.awt.*;
import java.awt.event.*;
import javax.swing.*;
import javax.swing.event.UndoableEditListener;
import javax.swing.text.*;

class TestMain
{
  private JTextPane textPane;
  // try to fix memory leak
  private static final boolean FIX = false;
  // disable caret updates completely
  private static final boolean FIXXX = false;
  // number of strings to append
  private static final int ITER_SMALL = 20;
  private static final int ITER_HUGE = 1000000;
  // limit textPane content
  private static final int TEXT_SIZE_MAX = 100;

  TestMain()
  {
    JFrame frame = new JFrame();
    JPanel panel = new JPanel();
    textPane = new JTextPane();
    textPane.setEditable(false);
    if (FIX)
    {
      tryToFixMemory();
    } // end if FIX
    JScrollPane scrollPane = new JScrollPane(textPane);
    scrollPane.setPreferredSize(new Dimension(100, 100) );
    panel.add(scrollPane);
    JButton buttonSmall = new JButton("small test");
    buttonSmall.addActionListener(new ButtonHandler(ITER_SMALL) );
    panel.add(buttonSmall);
    JButton buttonStress = new JButton("stress test");
    buttonStress.addActionListener(new ButtonHandler(ITER_HUGE) );
    panel.add(buttonStress);
    frame.add(panel);
    frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
    frame.pack();
    frame.setVisible(true);
  } // end constructor

  public static void main(String[] args)
  {
    @SuppressWarnings("unused")
    TestMain testMain = new TestMain();
  } // end main

  private void append(String s)
  {
    Document doc = textPane.getDocument();
    try
    {
      int extraLength = doc.getLength() + s.length() - TEXT_SIZE_MAX;
      if (extraLength > 0)
      {
        doc.remove(0, extraLength);
      } // end if extraLength
      doc.insertString(doc.getLength(), s, null);
      if (FIX && !FIXXX)
      {  // MEMORY LEAK HERE
        textPane.setCaretPosition(doc.getLength() );
      } // end if FIX
    }
    catch (Exception e)
    {
      e.printStackTrace();
      System.exit(1);
    } // end try
  } // end method append

  private void tryToFixMemory()
  {    
    // disable caret updates
    Caret caret = textPane.getCaret();
    if (caret instanceof DefaultCaret)
    {
      ( (DefaultCaret) caret).setUpdatePolicy(
          DefaultCaret.NEVER_UPDATE);
    } // end if DefaultCaret

    // remove registered UndoableEditListeners if any
    Document doc = textPane.getDocument();
    if (doc instanceof AbstractDocument)
    {
      UndoableEditListener[] undoListeners = 
          ( (AbstractDocument) doc).getUndoableEditListeners();
      if (undoListeners.length > 0)
      {
        for (UndoableEditListener undoListener : undoListeners)
        {
          doc.removeUndoableEditListener(undoListener);
        } // end for undoListener
      } // end if undoListeners
    } // end if AbstractDocument
  } // end method tryToFixMemory

  private class ButtonHandler implements ActionListener
  {
    private final int iter;

    ButtonHandler(int iter)
    {
      this.iter = iter;
    } // end constructor

    @Override
    public void actionPerformed(ActionEvent e)
    {
      for (int i = 0; i < iter; i++)
      {
        append(String.format("%10d\n", i) );
      } // end for i
    } // end method actionPerformed

  } // end class ButtonHandler

} // end class TestMain

JVM была из официального комплекта Oracle Java SE Development Kit 8u45 для Linux x64. Все тесты были сделаны с -Xmx100m предел.

Оба флага false:

Небольшой тест

Работает как положено:

FF маленький тест

Стресс тест

GUI зависает в промежуточной точке:

FF стресс-тест

Утечка памяти:

FF стресс-тест памяти

В какой-то момент памяти не осталось, и я получил следующую ошибку:

Exception in thread "AWT-EventQueue-0" java.lang.OutOfMemoryError: GC overhead limit exceeded
  at java.util.Formatter.parse(Formatter.java:2560)
  at java.util.Formatter.format(Formatter.java:2501)
  at java.util.Formatter.format(Formatter.java:2455)
  at java.lang.String.format(String.java:2928)
  at memleak.TestMain$ButtonHandler.actionPerformed(TestMain.java:117)
  at javax.swing.AbstractButton.fireActionPerformed(AbstractButton.java:2022)
  at javax.swing.AbstractButton$Handler.actionPerformed(AbstractButton.java:2346)
  at javax.swing.DefaultButtonModel.fireActionPerformed(DefaultButtonModel.java:402)
  at javax.swing.DefaultButtonModel.setPressed(DefaultButtonModel.java:259)
  at javax.swing.plaf.basic.BasicButtonListener.mouseReleased(BasicButtonListener.java:252)
  at java.awt.Component.processMouseEvent(Component.java:6525)
  at javax.swing.JComponent.processMouseEvent(JComponent.java:3324)
  at java.awt.Component.processEvent(Component.java:6290)
  at java.awt.Container.processEvent(Container.java:2234)
  at java.awt.Component.dispatchEventImpl(Component.java:4881)
  at java.awt.Container.dispatchEventImpl(Container.java:2292)
  at java.awt.Component.dispatchEvent(Component.java:4703)
  at java.awt.LightweightDispatcher.retargetMouseEvent(Container.java:4898)
  at java.awt.LightweightDispatcher.processMouseEvent(Container.java:4533)
  at java.awt.LightweightDispatcher.dispatchEvent(Container.java:4462)
  at java.awt.Container.dispatchEventImpl(Container.java:2278)
  at java.awt.Window.dispatchEventImpl(Window.java:2750)
  at java.awt.Component.dispatchEvent(Component.java:4703)
  at java.awt.EventQueue.dispatchEventImpl(EventQueue.java:758)
  at java.awt.EventQueue.access$500(EventQueue.java:97)
  at java.awt.EventQueue$3.run(EventQueue.java:709)
  at java.awt.EventQueue$3.run(EventQueue.java:703)
  at java.security.AccessController.doPrivileged(Native Method)
  at java.security.ProtectionDomain$1.doIntersectionPrivilege(ProtectionDomain.java:75)
  at java.security.ProtectionDomain$1.doIntersectionPrivilege(ProtectionDomain.java:86)
  at java.awt.EventQueue$4.run(EventQueue.java:731)
  at java.awt.EventQueue$4.run(EventQueue.java:729)
Exception in thread "AWT-EventQueue-0" java.lang.OutOfMemoryError: GC overhead limit exceeded
  at javax.swing.text.GlyphPainter1.modelToView(GlyphPainter1.java:147)
  at javax.swing.text.GlyphView.modelToView(GlyphView.java:653)
  at javax.swing.text.CompositeView.modelToView(CompositeView.java:265)
  at javax.swing.text.BoxView.modelToView(BoxView.java:484)
  at javax.swing.text.ParagraphView$Row.modelToView(ParagraphView.java:900)
  at javax.swing.text.CompositeView.modelToView(CompositeView.java:265)
  at javax.swing.text.BoxView.modelToView(BoxView.java:484)
  at javax.swing.text.CompositeView.modelToView(CompositeView.java:265)
  at javax.swing.text.BoxView.modelToView(BoxView.java:484)
  at javax.swing.plaf.basic.BasicTextUI$RootView.modelToView(BasicTextUI.java:1509)
  at javax.swing.plaf.basic.BasicTextUI.modelToView(BasicTextUI.java:1047)
  at javax.swing.text.DefaultCaret.repaintNewCaret(DefaultCaret.java:1308)
  at javax.swing.text.DefaultCaret$1.run(DefaultCaret.java:1287)
  at java.awt.event.InvocationEvent.dispatch(InvocationEvent.java:311)
  at java.awt.EventQueue.dispatchEventImpl(EventQueue.java:756)
  at java.awt.EventQueue.access$500(EventQueue.java:97)
  at java.awt.EventQueue$3.run(EventQueue.java:709)
  at java.awt.EventQueue$3.run(EventQueue.java:703)
  at java.security.AccessController.doPrivileged(Native Method)
  at java.security.ProtectionDomain$1.doIntersectionPrivilege(ProtectionDomain.java:75)
  at java.awt.EventQueue.dispatchEvent(EventQueue.java:726)
  at java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:201)
  at java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:116)
  at java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:105)
  at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:101)
  at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:93)
  at java.awt.EventDispatchThread.run(EventDispatchThread.java:82)
Exception in thread "RMI TCP Connection(idle)" java.lang.OutOfMemoryError: GC overhead limit exceeded
  at java.lang.Thread.getName(Thread.java:1135)
  at sun.rmi.transport.tcp.TCPTransport$ConnectionHandler.run(TCPTransport.java:677)
  at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)
  at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)
  at java.lang.Thread.run(Thread.java:745)

Подробная статистика памяти показывает очень высокие показатели java.awt.event.InvocationEvent, sun.awt.EventQueueItem, а также javax.swing.text.DefaultCaret$1 (отсутствует в фиксированной версии):

Статистика стресс-теста FF

настройка FIX = true не улучшил ситуацию.

Оба флага true:

Небольшой тест

Теперь показывает, что позиция каретки не обновляется:

TT маленький тест

Стресс тест

Работает и не имеет признаков утечки памяти:

ТТ стресс-тестТТ стресс-тест памяти

Источник

1 ответ

Решение

Причина этого заключается в том, что вы запускаете цикл for в потоке отправки событий (см. Поток отправки событий). Это поток, в котором происходят все взаимодействия с пользовательским интерфейсом.

Если вы выполняете длинную задачу, вы должны запустить ее в другом потоке, чтобы пользовательский интерфейс оставался отзывчивым. Если вам нужно внести изменения в пользовательский интерфейс, например, изменить текст в JTextPane и установить позицию каретки из потока, отличного от потока диспетчеризации событий, вам необходимо вызвать либо EventQueue.invokeLater() или же EventQueue.invokeAndWait() (см. EventQueue).

Я думаю, что инициированные события от установки позиции каретки ставятся в очередь в вашем случае и могут быть обработаны только после завершения цикла (потому что оба обрабатываются в потоке диспетчеризации событий). Поэтому вы должны попробовать что-то вроде этого:

@Override
public void actionPerformed(ActionEvent e)
{
  new Thread(new Runnable() {
    @Override
    public void run() {
      for (int i = 0; i < iter; i++)
      {
        final String display = String.format("%10d\n", i);
        try {
          EventQueue.invokeAndWait(new Runnable() {
            @Override
            public void run() {
              append(display);
            }
          });
        } catch (Exception e) {
          e.printStackTrace();
        }
      } // end for i
    }
  }).start();
}

Может быть, даже лучше, если вы позвоните EventQueue.invokeAndWait только после x итераций и кеширования предыдущих результатов, которые необходимо отобразить.

Источник
Другие вопросы по тегам