HintsController и EventQueue в NetBeans

Question

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

У нас есть следующий класс для выделения ошибок в синтаксисе:

class SyntaxErrorsHighlightingTask extends org.netbeans.modules.parsing.spi.ParserResultTask {

public SyntaxErrorsHighlightingTask () {
}

@Override
public void run (org.netbeans.modules.parsing.spi.Parser.Result result, org.netbeans.modules.parsing.spi.SchedulerEvent event) {
    try {
        final javax.swing.text.Document document = result.getSnapshot().getSource ().getDocument(false);
        final List<ErrorDescription> errors = new ArrayList<ErrorDescription> ();
        // finds errors on the document and add them to 'errors' list
        }

        /***
        OFFENDING CODE GOES HERE
        ***/

    } catch (javax.swing.text.BadLocationException ex1) {
        org.openide.util.Exceptions.printStackTrace (ex1);
    } catch (org.netbeans.modules.parsing.spi.ParseException ex1) {
        Exceptions.printStackTrace (ex1);
    }
}

@Override
public int getPriority () {
    return 100;
}

@Override
public Class<? extends Scheduler> getSchedulerClass () {
    return Scheduler.EDITOR_SENSITIVE_TASK_SCHEDULER;
}

@Override
public void cancel () {
}

}

Оскорбительный код, который выдает исключение, таков:

org.netbeans.spi.editor.hints.HintsController.setErrors (document, "testsequence", errors);

По результатам поиска оно было изменено на следующее:

SwingUtilities.invokeLater(new Runnable() {

                @Override
                public void run() {
                     System.err.println("is EDT? " + SwingUtilities.isEventDispatchThread());
                     HintsController.setErrors (document, "testsequence", errors);
                }
           });

Вот что происходит, когда в редакторе вводится синтаксическая ошибка:

is EDT? true
SEVERE [org.openide.util.RequestProcessor]: Error in RequestProcessor org.netbeans.spi.editor.hints.HintsController$1
java.lang.IllegalStateException: Must be run in EQ
    at org.netbeans.editor.Annotations.addAnnotation(Annotations.java:195)
    at org.netbeans.modules.editor.NbEditorDocument.addAnnotation(NbEditorDocument.java:251)
    at org.openide.text.NbDocument.addAnnotation(NbDocument.java:504)
    at org.netbeans.modules.editor.hints.AnnotationHolder$NbDocumentAttacher.attachAnnotation(AnnotationHolder.java:235)
    at org.netbeans.modules.editor.hints.AnnotationHolder.attachAnnotation(AnnotationHolder.java:208)
    at org.netbeans.modules.editor.hints.AnnotationHolder.updateAnnotationOnLine(AnnotationHolder.java:674)
    at org.netbeans.modules.editor.hints.AnnotationHolder.setErrorDescriptionsImpl(AnnotationHolder.java:899)
    at org.netbeans.modules.editor.hints.AnnotationHolder.access$1300(AnnotationHolder.java:113)
    at org.netbeans.modules.editor.hints.AnnotationHolder$4.run(AnnotationHolder.java:812)
    at org.netbeans.editor.BaseDocument.render(BaseDocument.java:1409)
    at org.netbeans.modules.editor.hints.AnnotationHolder.setErrorDescriptions(AnnotationHolder.java:809)
    at org.netbeans.modules.editor.hints.HintsControllerImpl.setErrorsImpl(HintsControllerImpl.java:111)
    at org.netbeans.modules.editor.hints.HintsControllerImpl.setErrors(HintsControllerImpl.java:93)
    at org.netbeans.spi.editor.hints.HintsController$1.run(HintsController.java:79)
    at org.openide.util.RequestProcessor$Task.run(RequestProcessor.java:1424)
    at org.openide.util.RequestProcessor$Processor.run(RequestProcessor.java:1968)
Caused: org.openide.util.RequestProcessor$SlowItem: task failed due to
    at org.openide.util.RequestProcessor.post(RequestProcessor.java:425)
    at org.netbeans.spi.editor.hints.HintsController.setErrors(HintsController.java:77)
    at com.#.#.#.editor.parser.SyntaxErrorsHighlightingTask$1.run(SyntaxErrorsHighlightingTask.java:74)
    at java.awt.event.InvocationEvent.dispatch(InvocationEvent.java:209)
    at java.awt.EventQueue.dispatchEventImpl(EventQueue.java:641)
    at java.awt.EventQueue.access$000(EventQueue.java:84)
    at java.awt.EventQueue$1.run(EventQueue.java:602)
    at java.awt.EventQueue$1.run(EventQueue.java:600)
    at java.security.AccessController.doPrivileged(Native Method)
    at java.security.AccessControlContext$1.doIntersectionPrivilege(AccessControlContext.java:87)
    at java.awt.EventQueue.dispatchEvent(EventQueue.java:611)
    at org.netbeans.core.TimableEventQueue.dispatchEvent(TimableEventQueue.java:148)
    at java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:269)
    at java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:184)
    at java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:174)
    at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:169)
    at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:161)
[catch] at java.awt.EventDispatchThread.run(EventDispatchThread.java:122)

Что происходит, то вызов HintsController выполняется в EDT (поток EventDispatch). Однако Annotations.addAnnotation() запускается в другом потоке - иногда в потоке "Синхронизатор системного буфера обмена", иногда в потоке "Неактивный запросщик". Поскольку он проверяет, выполняется ли его на EDT, он всегда выдает исключение IllegalStateException.

Я не эксперт в использовании платформы Netbeans, и я довольно новичок в этом конкретном приложении в компании - так что я могу упустить что-то действительно очевидное. Google не сильно помог. У кого-нибудь есть совет?

Answer 1

Оказывается, это не было проблемой с кодом в конце концов.

Как указано в списке разработчиков NetBeans:

HintsController.setErrors может быть вызван из любого потока - он использует свой собственный рабочий поток и при необходимости перепланирует его в поток AWT.

Требование вызвать Annotations.addAnnotation в потоке AWT было удалено довольно давно: http://hg.netbeans.org/main-silver/rev/db82e4e0fbcc

Тот же набор изменений также удалил автоматическое перепланирование в поток AWT в NbDocument.addAnnotation. Таким образом, кажется, что сборка, которую вы используете, имеет вторую часть набора изменений, но не первую часть (...)

После тщательного рассмотрения Maven's pom.xml файлы, я понял, что приложение загружает более новые версии библиотек, в то время как модуль загружает более старые версии, поэтому он будет запускать неправильный код. Связанный ТАК вопрос об этом здесь.

Answer 2

Может быть, вы должны попытаться обновить свои ошибки с помощью метода, подобного этому:

private void updateError(javax.swing.text.Document document, List<ErrorDescription> errors) {
    if(javax.swing.SwingUtilities.isEventDispatchThread()) {
        HintsController.setErrors (document, "testsequence", errors);
    }
    else {
        SwingUtilities.invokeLater(new Runnable() {
            @Override
            public void run() {
                 HintsController.setErrors (document, "testsequence", errors);
            }
       });
    }    
}