Как обнаружить и удалить (во время сеанса) неиспользуемые bean-компоненты @ViewScoped, которые не могут быть удалены сборщиком мусора

По сути, вы хотите, чтобы состояние представления JSF и все bean-компоненты с областью представления были уничтожены во время выгрузки окна. Решение было реализовано в аннотации OmniFaces @ViewScoped, которая подробно описана в его документации, как показано ниже:

Могут быть случаи, когда желательно немедленно уничтожить bean-компонент с областью видимости, а также при вызове события браузера unload. т.е. когда пользователь уходит с помощью GET или закрывает вкладку/окно браузера. Ни одна из аннотаций области представления JSF 2.2 не поддерживает это. Начиная с OmniFaces 2.2, эта аннотация области представления CDI гарантирует, что аннотированный метод @PreDestroy также вызывается при выгрузке браузера. Этот трюк выполняется с помощью синхронного запроса XHR через автоматически подключаемый вспомогательный скрипт omnifaces:unload.js. Однако есть небольшая оговорка: в медленной сети и/или слабом серверном оборудовании может быть заметная задержка между действием конечного пользователя по выгрузке страницы и желаемым результатом. Если это нежелательно, то лучше придерживаться собственных аннотаций области представления JSF 2.2 и принять отложенное уничтожение.

Начиная с OmniFaces 2.3, выгрузка была дополнительно улучшена, чтобы также физически удалить связанное состояние представления JSF из внутренней карты LRU реализации JSF в случае сохранения состояния на стороне сервера, тем самым еще больше снижая риск на ViewExpiredException для других представлений, которые были созданы/открыты ранее . В качестве побочного эффекта этого изменения аннотированный метод @PreDestroy любого стандартного компонента JSF с областью видимости, на который ссылается тот же вид, что и компонент OmniFaces CDI с областью видимости, также будет гарантированно вызываться при выгрузке браузера.

Вы можете найти соответствующий исходный код здесь:

• Инициализатор сценария выгрузки: ViewScopeManager#registerUnloadScript()
• Сам скрипт выгрузки: unload.unminified.js
• Обработчик представления выгрузки: OmniViewHandler#unloadView()
• Разрушитель состояния представления JSF: Hacks#removeViewState()

Скрипт выгрузки запустится во время события beforeunload окна, если только оно не вызвано отправкой формы на основе JSF (ajax). Что касается отправки командной ссылки и/или ajax, это зависит от реализации. В настоящее время распознаются Mojarra, MyFaces и PrimeFaces.

Сценарий выгрузки будет триггер navigator.sendBeacon в современных браузерах и вернуться к синхронному XHR (асинхронный вызов завершится ошибкой, поскольку страница может быть выгружена раньше, чем запрос действительно попадет на сервер).

var url = form.action;
var query = "omnifaces.event=unload&id=" + id + "&" + VIEW_STATE_PARAM + "=" + encodeURIComponent(form[VIEW_STATE_PARAM].value);
var contentType = "application/x-www-form-urlencoded";

if (navigator.sendBeacon) {
    // Synchronous XHR is deprecated during unload event, modern browsers offer Beacon API for this which will basically fire-and-forget the request.
    navigator.sendBeacon(url, new Blob([query], {type: contentType}));
}
else {
    var xhr = new XMLHttpRequest();
    xhr.open("POST", url, false);
    xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest");
    xhr.setRequestHeader("Content-Type", contentType);
    xhr.send(query);
}

Обработчик представления выгрузки будет явно уничтожить все компоненты @ViewScoped, включая стандартные JSF (обратите внимание, что сценарий выгрузки инициализируется только тогда, когда представление ссылается хотя бы на один компонент OmniFaces @ViewScoped).

context.getApplication().publishEvent(context, PreDestroyViewMapEvent.class, UIViewRoot.class, createdView);

Однако это не разрушает физическое состояние просмотра JSF в сеансе HTTP и, следовательно, приведенный ниже вариант использования потерпит неудачу:

1. Установите количество физических представлений равным 3 (в Mojarra используйте параметр контекста com.sun.faces.numberOfLogicalViews, а в MyFaces используйте параметр контекста org.apache.myfaces.NUMBER_OF_VIEWS_IN_SESSION).
2. Создайте страницу, которая ссылается на стандартный компонент JSF @ViewScoped.
3. Откройте эту страницу во вкладке и держите ее открытой все время.
4. Откройте ту же страницу в другой вкладке и сразу же закройте эту вкладку.
5. Откройте ту же страницу в другой вкладке и сразу же закройте эту вкладку.
6. Откройте ту же страницу в другой вкладке и сразу же закройте эту вкладку.
7. Отправьте форму на первой вкладке.

Это не удастся с ViewExpiredException, потому что состояния представления JSF ранее закрытых вкладок физически не уничтожаются во время PreDestroyViewMapEvent. Они все еще остаются на сеансе. OmniFaces @ViewScoped фактически уничтожит их. Однако разрушение состояния представления JSF зависит от реализации. Это объясняет, по крайней мере, довольно хакерский код в классе Hacks, который должен достичь этого.

Интеграционный тест для этого конкретного случая можно найти в ViewScopedIT#destroyViewState() на ViewScopedIT.xhtml, который равен в настоящее время работает с WildFly 10.0.0, TomEE 7.0.1 и Payara 4.1.1.163.

В двух словах: просто замените javax.faces.view.ViewScoped на org.omnifaces.cdi.ViewScoped. Остальное прозрачно.

import javax.inject.Named;
import org.omnifaces.cdi.ViewScoped;

@Named
@ViewScoped
public class Bean implements Serializable {}

По крайней мере, я попытался предложить общедоступный метод API для физического уничтожения состояния представления JSF. Возможно, это появится в JSF 2.3, и тогда я смогу устранить шаблон в классе Hacks OmniFaces. Как только все будет отполировано в OmniFaces, возможно, в конечном итоге оно войдет в JSF, но не раньше 2.4.