Implementação de solução para leak de memória em aplicações usando beans

ViewScoped.

Implementação de solução para leak de memória em aplicações usando beans
ViewScoped.
Danilo Costa Viana
1 parent fa5140b5
Showing 19 changed files with 162 additions and 60 deletions Show diff stats
archetype/jsf-jpa/src/main/resources/archetype-resources/src/main/webapp/WEB-INF/web.xml
impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/internal/context/FacesViewBeanStore.java
impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/internal/context/FacesViewContextImpl.java
impl/extension/jsf/src/main/java/br/gov/frameworkdemoiselle/internal/context/SessionBeanStore.java
impl/extension/jsf/src/test/resources/exception-handler-authentication/web.xml
impl/extension/jsf/src/test/resources/exception-handler-authorization/web.xml
impl/extension/jsf/src/test/resources/exception-handler-config-compatibility/web.xml
impl/extension/jsf/src/test/resources/exception-handler-config/web.xml
impl/extension/jsf/src/test/resources/exception-handler-redirect-config-compatibility/web.xml
impl/extension/jsf/src/test/resources/exception-handler-redirect-config/web.xml
impl/extension/jsf/src/test/resources/exception-handler-redirect/web.xml
impl/extension/jsf/src/test/resources/message/web.xml
impl/extension/jsf/src/test/resources/proxy/web.xml
impl/extension/servlet/src/main/java/br/gov/frameworkdemoiselle/util/SessionListener.java
impl/extension/servlet/src/test/java/test/Tests.java
impl/extension/servlet/src/test/resources/producer/request/web.xml
impl/extension/servlet/src/test/resources/producer/response/web.xml
impl/extension/servlet/src/test/resources/security/authentication/basic/web.xml
impl/extension/servlet/src/test/resources/security/authentication/form/web.xml
@@ -10,11 +10,17 @@
 	</listener>
  	-->
- 	<!-- If you are using servlet 2.5 then uncomment this listener -->
+ 	<!--
+ 	If you are using servlet 2.5 then uncomment those listeners and filters.
+ 	They're added automatically on servlet 3.0 or greater.
+ 	-->
  	<!--
 	<listener>
 		<listener-class>br.gov.frameworkdemoiselle.util.ServletListener</listener-class>
 	</listener>
+	<listener>
+		<listener-class>br.gov.frameworkdemoiselle.util.SessionListener</listener-class>
+	</listener>
 	<filter>
 		<filter-name>Demoiselle Servlet Filter</filter-name>
 		<filter-class>br.gov.frameworkdemoiselle.util.ServletFilter</filter-class>
@@ -0,0 +1,51 @@
+package br.gov.frameworkdemoiselle.internal.context;
+
+import java.io.Serializable;
+
+import javax.enterprise.context.spi.Contextual;
+import javax.enterprise.context.spi.CreationalContext;
+import javax.enterprise.inject.Alternative;
+
+/**
+ * Store that keeps view scoped beans. It associates all view scoped beans with a view ID.
+ * When the ID changes (meaning the view changed) all old view scoped beans are destroyed
+ * before new beans for the new view are created and stored.
+ * 
+ * @author SERPRO
+ *
+ */
+@Alternative
+public class FacesViewBeanStore implements Serializable {
+
+	private static final long serialVersionUID = -8265458933971929432L;
+
+	private Long lastViewId = null;
+
+	private BeanStore store;
+
+	synchronized BeanStore getStore(Long viewId, AbstractCustomContext context) {
+		if (lastViewId == null || !lastViewId.equals(viewId)) {
+			clear(context);
+			lastViewId = viewId;
+			store = AbstractCustomContext.createStore();
+		}
+
+		return store;
+	}
+
+	@SuppressWarnings({ "rawtypes", "unchecked" })
+	public void clear(AbstractCustomContext context) {
+		if (store != null) {
+			for (String id : store) {
+				Contextual contextual = context.getContextualStore().getContextual(id);
+				Object instance = store.getInstance(id);
+				CreationalContext creationalContext = store.getCreationalContext(id);
+
+				if (contextual != null && instance != null) {
+					contextual.destroy(instance, creationalContext);
+				}
+			}
+			store.clear();
+		}
+	}
+}
@@ -39,17 +39,20 @@ package br.gov.frameworkdemoiselle.internal.context;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.atomic.AtomicLong;
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.context.ContextNotActiveException;
+import javax.enterprise.context.spi.Context;
 import javax.enterprise.event.Observes;
 import javax.enterprise.inject.Alternative;
 import javax.faces.component.UIViewRoot;
 import javax.faces.context.FacesContext;
-import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpSession;
 import br.gov.frameworkdemoiselle.annotation.Priority;
 import br.gov.frameworkdemoiselle.annotation.ViewScoped;
 import br.gov.frameworkdemoiselle.context.ViewContext;
 import br.gov.frameworkdemoiselle.lifecycle.BeforeSessionDestroyed;
+import br.gov.frameworkdemoiselle.util.Beans;
 import br.gov.frameworkdemoiselle.util.Faces;
 /**
@@ -67,7 +70,7 @@ public class FacesViewContextImpl extends AbstractCustomContext implements ViewC
 	private final AtomicLong atomicLong = new AtomicLong();
-	private ConcurrentHashMap<String, SessionBeanStore> sessionBeanStore = new ConcurrentHashMap<String, SessionBeanStore>();
+	private ConcurrentHashMap<String, FacesViewBeanStore> sessionBeanStore = new ConcurrentHashMap<String, FacesViewBeanStore>();
 	private static final String FACES_KEY = FacesViewContextImpl.class.getCanonicalName();
@@ -82,15 +85,22 @@ public class FacesViewContextImpl extends AbstractCustomContext implements ViewC
 	@Override
 	protected BeanStore getStore() {
-		final String sessionId = getSessionId();
-		
-		if (sessionId==null){
+		String sessionId = getSessionId();
+		if (sessionId == null){
 			return null;
 		}
+		/*
+		 * Tenta obter o viewID de forma não thread-safe por questões de performance.
+		 * Se o viewID não existe entra em um trecho thread-safe para incrementa-lo, evitando
+		 * conflito entre duas requests tentando incrementar esse número. 
+		 */
 		Long viewId = (Long)Faces.getViewMap().get(FACES_KEY);
 		if (viewId==null){
 			synchronized (this) {
+				
+				//Tenta obte-lo novamente, caso entre a primeira tentativa e o bloqueio
+				//da thread outra thread já tenha criado o número. 
 				viewId = (Long)Faces.getViewMap().get(FACES_KEY);
 				if (viewId==null){
 					viewId = atomicLong.incrementAndGet();
@@ -99,24 +109,29 @@ public class FacesViewContextImpl extends AbstractCustomContext implements ViewC
 			}
 		}
-		SessionBeanStore currentStore = sessionBeanStore.get(sessionId);
+		//A mesma técnica de bloqueio de thread acima é usada aqui para
+		//criar um SessionBeanStore caso o mesmo ainda não exista.
+		FacesViewBeanStore currentStore = sessionBeanStore.get(sessionId);
 		if (currentStore==null){
 			synchronized (this) {
-				currentStore = (SessionBeanStore) sessionBeanStore.get(sessionId);
+				currentStore = (FacesViewBeanStore) sessionBeanStore.get(sessionId);
 				if (currentStore==null){
-					currentStore = new SessionBeanStore();
+					currentStore = new FacesViewBeanStore();
 					sessionBeanStore.put(sessionId, currentStore);
 				}
 			}
 		}
-		
+
 		return currentStore.getStore(viewId, this);
 	}
-	protected void clearInvalidatedSession(@Observes BeforeSessionDestroyed event){
-		String sessionId = event.getSessionId();
+	/*
+	 * Called before the session is invalidated for that user.
+	 * Destroys all view scoped beans stored on that session.
+	 */
+	private void clearInvalidatedSession(String sessionId){
 		if (sessionId != null){
-			final SessionBeanStore store = sessionBeanStore.get(sessionId);
+			final FacesViewBeanStore store = sessionBeanStore.get(sessionId);
 			if (store!=null){
 				store.clear(this);
 				sessionBeanStore.remove(sessionId);
@@ -124,8 +139,40 @@ public class FacesViewContextImpl extends AbstractCustomContext implements ViewC
 		}
 	}
+	/*
+	 * Returns the current session ID. Creates a session if one doesn't exist. Returns NULL if the session can't be created.
+	 */
 	private String getSessionId(){
 		final HttpSession session = (HttpSession) FacesContext.getCurrentInstance().getExternalContext().getSession(true);
 		return session!=null ? session.getId() : null;
 	}
+	
+	/**
+	 * Observes HTTP session lifecycle and notifies the ViewContext of session events (creation or destruction)
+	 * so view scoped beans can be created or destroyed based on their underlying session scopes.
+	 * 
+	 * @author SERPRO
+	 *
+	 */
+	@ApplicationScoped
+	protected static class FacesViewSessionListener {
+		
+		/**
+		 * Called before the session is invalidated for that user.
+		 * Destroys all view scoped beans stored on that session.
+		 */
+		protected void clearInvalidatedSession(@Observes BeforeSessionDestroyed event){
+			String sessionId = event.getSessionId();
+			try{
+				Context context = Beans.getBeanManager().getContext(ViewScoped.class);
+				if ( FacesViewContextImpl.class.isInstance(context) ){
+					((FacesViewContextImpl)context).clearInvalidatedSession(sessionId);
+				}
+			}
+			catch(ContextNotActiveException ce){
+				//Nada a fazer, contexto não está ativo. 
+			}
+		}
+	}
 }
+
@@ -1,43 +0,0 @@
-package br.gov.frameworkdemoiselle.internal.context;
-
-import java.io.Serializable;
-
-import javax.enterprise.context.SessionScoped;
-import javax.enterprise.context.spi.Contextual;
-import javax.enterprise.context.spi.CreationalContext;
-
-@SessionScoped
-public class SessionBeanStore implements Serializable {
-
-	private static final long serialVersionUID = -8265458933971929432L;
-
-	private Long lastViewId = null;
-
-	private BeanStore store;
-
-	synchronized BeanStore getStore(Long viewId, AbstractCustomContext context) {
-		if (lastViewId == null || !lastViewId.equals(viewId)) {
-			clear(context);
-			lastViewId = viewId;
-			store = AbstractCustomContext.createStore();
-		}
-
-		return store;
-	}
-
-	@SuppressWarnings({ "rawtypes", "unchecked" })
-	public void clear(AbstractCustomContext context) {
-		if (store != null) {
-			for (String id : store) {
-				Contextual contextual = context.getContextualStore().getContextual(id);
-				Object instance = store.getInstance(id);
-				CreationalContext creationalContext = store.getCreationalContext(id);
-
-				if (contextual != null && instance != null) {
-					contextual.destroy(instance, creationalContext);
-				}
-			}
-			store.clear();
-		}
-	}
-}
@@ -40,6 +40,9 @@
 	<listener>
 		<listener-class>br.gov.frameworkdemoiselle.util.ServletListener</listener-class>
 	</listener>
+	<listener>
+		<listener-class>br.gov.frameworkdemoiselle.util.SessionListener</listener-class>
+	</listener>
 	<filter>
 		<filter-name>Demoiselle Servlet Filter</filter-name>
 		<filter-class>br.gov.frameworkdemoiselle.util.ServletFilter</filter-class>
@@ -40,6 +40,9 @@
 	<listener>
 		<listener-class>br.gov.frameworkdemoiselle.util.ServletListener</listener-class>
 	</listener>
+	<listener>
+		<listener-class>br.gov.frameworkdemoiselle.util.SessionListener</listener-class>
+	</listener>
 	<filter>
 		<filter-name>Demoiselle Servlet Filter</filter-name>
 		<filter-class>br.gov.frameworkdemoiselle.util.ServletFilter</filter-class>
@@ -40,6 +40,9 @@
 	<listener>
 		<listener-class>br.gov.frameworkdemoiselle.util.ServletListener</listener-class>
 	</listener>
+	<listener>
+		<listener-class>br.gov.frameworkdemoiselle.util.SessionListener</listener-class>
+	</listener>
 	<filter>
 		<filter-name>Demoiselle Servlet Filter</filter-name>
 		<filter-class>br.gov.frameworkdemoiselle.util.ServletFilter</filter-class>
@@ -40,6 +40,9 @@
 	<listener>
 		<listener-class>br.gov.frameworkdemoiselle.util.ServletListener</listener-class>
 	</listener>
+	<listener>
+		<listener-class>br.gov.frameworkdemoiselle.util.SessionListener</listener-class>
+	</listener>
 	<filter>
 		<filter-name>Demoiselle Servlet Filter</filter-name>
 		<filter-class>br.gov.frameworkdemoiselle.util.ServletFilter</filter-class>
@@ -40,6 +40,9 @@
 	<listener>
 		<listener-class>br.gov.frameworkdemoiselle.util.ServletListener</listener-class>
 	</listener>
+	<listener>
+		<listener-class>br.gov.frameworkdemoiselle.util.SessionListener</listener-class>
+	</listener>
 	<filter>
 		<filter-name>Demoiselle Servlet Filter</filter-name>
 		<filter-class>br.gov.frameworkdemoiselle.util.ServletFilter</filter-class>
@@ -40,6 +40,9 @@
 	<listener>
 		<listener-class>br.gov.frameworkdemoiselle.util.ServletListener</listener-class>
 	</listener>
+	<listener>
+		<listener-class>br.gov.frameworkdemoiselle.util.SessionListener</listener-class>
+	</listener>
 	<filter>
 		<filter-name>Demoiselle Servlet Filter</filter-name>
 		<filter-class>br.gov.frameworkdemoiselle.util.ServletFilter</filter-class>
@@ -40,6 +40,9 @@
 	<listener>
 		<listener-class>br.gov.frameworkdemoiselle.util.ServletListener</listener-class>
 	</listener>
+	<listener>
+		<listener-class>br.gov.frameworkdemoiselle.util.SessionListener</listener-class>
+	</listener>
 	<filter>
 		<filter-name>Demoiselle Servlet Filter</filter-name>
 		<filter-class>br.gov.frameworkdemoiselle.util.ServletFilter</filter-class>
@@ -40,6 +40,9 @@
 	<listener>
 		<listener-class>br.gov.frameworkdemoiselle.util.ServletListener</listener-class>
 	</listener>
+	<listener>
+		<listener-class>br.gov.frameworkdemoiselle.util.SessionListener</listener-class>
+	</listener>
 	<filter>
 		<filter-name>Demoiselle Servlet Filter</filter-name>
 		<filter-class>br.gov.frameworkdemoiselle.util.ServletFilter</filter-class>
@@ -40,6 +40,9 @@
 	<listener>
 		<listener-class>br.gov.frameworkdemoiselle.util.ServletListener</listener-class>
 	</listener>
+	<listener>
+		<listener-class>br.gov.frameworkdemoiselle.util.SessionListener</listener-class>
+	</listener>
 	<filter>
 		<filter-name>Demoiselle Servlet Filter</filter-name>
 		<filter-class>br.gov.frameworkdemoiselle.util.ServletFilter</filter-class>
@@ -4,8 +4,8 @@ import javax.servlet.http.HttpSession;
 import javax.servlet.http.HttpSessionEvent;
 import javax.servlet.http.HttpSessionListener;
-import br.gov.frameworkdemoiselle.lifecycle.BeforeSessionDestroyed;
 import br.gov.frameworkdemoiselle.lifecycle.AfterSessionCreated;
+import br.gov.frameworkdemoiselle.lifecycle.BeforeSessionDestroyed;
 /**
  * <p>Implements the {@link HttpSessionListener} interface and fires two events.</p>
@@ -19,14 +19,14 @@ import br.gov.frameworkdemoiselle.lifecycle.AfterSessionCreated;
  *
  */
 public class SessionListener implements HttpSessionListener {
-
+	
 	@Override
 	public void sessionCreated(final HttpSessionEvent sessionEvent) {
 		Beans.getBeanManager().fireEvent(new AfterSessionCreated() {
 			@Override
 			public String getSessionId() {
 				HttpSession session = sessionEvent.getSession();
-				return session != null ? session.getId() : null;
+				return session!=null ? session.getId() : null;
 			}
 		});
 	}
@@ -37,7 +37,7 @@ public class SessionListener implements HttpSessionListener {
 			@Override
 			public String getSessionId() {
 				HttpSession session = sessionEvent.getSession();
-				return session != null ? session.getId() : null;
+				return session!=null ? session.getId() : null;
 			}
 		});
 	}
@@ -54,6 +54,7 @@ import br.gov.frameworkdemoiselle.security.ServletAuthorizer;
 import br.gov.frameworkdemoiselle.util.BasicAuthFilter;
 import br.gov.frameworkdemoiselle.util.ServletFilter;
 import br.gov.frameworkdemoiselle.util.ServletListener;
+import br.gov.frameworkdemoiselle.util.SessionListener;
 @Ignore
 public final class Tests {
@@ -76,6 +77,7 @@ public final class Tests {
 				.addClass(ServletAuthorizer.class)
 				.addClass(ServletFilter.class)
 				.addClass(ServletListener.class)
+				.addClass(SessionListener.class)
 				.addClass(HttpServletRequestProducer.class)
 				.addClass(HttpServletResponseProducer.class)
 				.addClass(HttpSessionProducer.class)
@@ -40,6 +40,9 @@
 	<listener>
 		<listener-class>br.gov.frameworkdemoiselle.util.ServletListener</listener-class>
 	</listener>
+	<listener>
+		<listener-class>br.gov.frameworkdemoiselle.util.SessionListener</listener-class>
+	</listener>
 	<filter>
 		<filter-name>Demoiselle Servlet Filter</filter-name>
@@ -40,6 +40,9 @@
 	<listener>
 		<listener-class>br.gov.frameworkdemoiselle.util.ServletListener</listener-class>
 	</listener>
+	<listener>
+		<listener-class>br.gov.frameworkdemoiselle.util.SessionListener</listener-class>
+	</listener>
 	<filter>
 		<filter-name>Demoiselle Servlet Filter</filter-name>
@@ -40,6 +40,9 @@
 	<listener>
 		<listener-class>br.gov.frameworkdemoiselle.util.ServletListener</listener-class>
 	</listener>
+	<listener>
+		<listener-class>br.gov.frameworkdemoiselle.util.SessionListener</listener-class>
+	</listener>
 	<filter>
 		<filter-name>Demoiselle Servlet Filter</filter-name>
@@ -40,6 +40,9 @@
 	<listener>
 		<listener-class>br.gov.frameworkdemoiselle.util.ServletListener</listener-class>
 	</listener>
+	<listener>
+		<listener-class>br.gov.frameworkdemoiselle.util.SessionListener</listener-class>
+	</listener>
 	<filter>
 		<filter-name>Demoiselle Servlet Filter</filter-name>
@@ -0,0 +1,51 @@		@@ -0,0 +1,51 @@
	1	+package br.gov.frameworkdemoiselle.internal.context;
	2	+
	3	+import java.io.Serializable;
	4	+
	5	+import javax.enterprise.context.spi.Contextual;
	6	+import javax.enterprise.context.spi.CreationalContext;
	7	+import javax.enterprise.inject.Alternative;
	8	+
	9	+/**
	10	+ * Store that keeps view scoped beans. It associates all view scoped beans with a view ID.
	11	+ * When the ID changes (meaning the view changed) all old view scoped beans are destroyed
	12	+ * before new beans for the new view are created and stored.
	13	+ *
	14	+ * @author SERPRO
	15	+ *
	16	+ */
	17	+@Alternative
	18	+public class FacesViewBeanStore implements Serializable {
	19	+
	20	+ private static final long serialVersionUID = -8265458933971929432L;
	21	+
	22	+ private Long lastViewId = null;
	23	+
	24	+ private BeanStore store;
	25	+
	26	+ synchronized BeanStore getStore(Long viewId, AbstractCustomContext context) {
	27	+ if (lastViewId == null \|\| !lastViewId.equals(viewId)) {
	28	+ clear(context);
	29	+ lastViewId = viewId;
	30	+ store = AbstractCustomContext.createStore();
	31	+ }
	32	+
	33	+ return store;
	34	+ }
	35	+
	36	+ @SuppressWarnings({ "rawtypes", "unchecked" })
	37	+ public void clear(AbstractCustomContext context) {
	38	+ if (store != null) {
	39	+ for (String id : store) {
	40	+ Contextual contextual = context.getContextualStore().getContextual(id);
	41	+ Object instance = store.getInstance(id);
	42	+ CreationalContext creationalContext = store.getCreationalContext(id);
	43	+
	44	+ if (contextual != null && instance != null) {
	45	+ contextual.destroy(instance, creationalContext);
	46	+ }
	47	+ }
	48	+ store.clear();
	49	+ }
	50	+ }
	51	+}
	@@ -1,43 +0,0 @@	@@ -1,43 +0,0 @@
1	-package br.gov.frameworkdemoiselle.internal.context;
2	-
3	-import java.io.Serializable;
4	-
5	-import javax.enterprise.context.SessionScoped;
6	-import javax.enterprise.context.spi.Contextual;
7	-import javax.enterprise.context.spi.CreationalContext;
8	-
9	-@SessionScoped
10	-public class SessionBeanStore implements Serializable {
11	-
12	- private static final long serialVersionUID = -8265458933971929432L;
13	-
14	- private Long lastViewId = null;
15	-
16	- private BeanStore store;
17	-
18	- synchronized BeanStore getStore(Long viewId, AbstractCustomContext context) {
19	- if (lastViewId == null \|\| !lastViewId.equals(viewId)) {
20	- clear(context);
21	- lastViewId = viewId;
22	- store = AbstractCustomContext.createStore();
23	- }
24	-
25	- return store;
26	- }
27	-
28	- @SuppressWarnings({ "rawtypes", "unchecked" })
29	- public void clear(AbstractCustomContext context) {
30	- if (store != null) {
31	- for (String id : store) {
32	- Contextual contextual = context.getContextualStore().getContextual(id);
33	- Object instance = store.getInstance(id);
34	- CreationalContext creationalContext = store.getCreationalContext(id);
35	-
36	- if (contextual != null && instance != null) {
37	- contextual.destroy(instance, creationalContext);
38	- }
39	- }
40	- store.clear();
41	- }
42	- }
43	-}