Rossen Stoyanchev
7 years ago
10 changed files with 608 additions and 69 deletions
@ -0,0 +1,136 @@
@@ -0,0 +1,136 @@
|
||||
/* |
||||
* Copyright 2002-2017 the original author or authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
*/ |
||||
package org.springframework.web.reactive.result.method.annotation; |
||||
|
||||
import java.util.Arrays; |
||||
import java.util.Collections; |
||||
import java.util.HashMap; |
||||
import java.util.HashSet; |
||||
import java.util.Map; |
||||
import java.util.Set; |
||||
import java.util.concurrent.ConcurrentHashMap; |
||||
|
||||
import org.springframework.core.annotation.AnnotatedElementUtils; |
||||
import org.springframework.util.Assert; |
||||
import org.springframework.web.bind.annotation.SessionAttributes; |
||||
import org.springframework.web.server.WebSession; |
||||
|
||||
/** |
||||
* Package-private class to assist {@link ModelInitializer} with managing model |
||||
* attributes in the {@link WebSession} based on model attribute names and types |
||||
* declared va {@link SessionAttributes @SessionAttributes}. |
||||
* |
||||
* @author Rossen Stoyanchev |
||||
* @since 5.0 |
||||
*/ |
||||
class SessionAttributesHandler { |
||||
|
||||
private final Set<String> attributeNames = new HashSet<>(); |
||||
|
||||
private final Set<Class<?>> attributeTypes = new HashSet<>(); |
||||
|
||||
private final Set<String> knownAttributeNames = Collections.newSetFromMap(new ConcurrentHashMap<>(4)); |
||||
|
||||
|
||||
/** |
||||
* Create a new instance for a controller type. Session attribute names and |
||||
* types are extracted from the {@code @SessionAttributes} annotation, if |
||||
* present, on the given type. |
||||
* @param handlerType the controller type |
||||
*/ |
||||
public SessionAttributesHandler(Class<?> handlerType) { |
||||
SessionAttributes annotation = |
||||
AnnotatedElementUtils.findMergedAnnotation(handlerType, SessionAttributes.class); |
||||
if (annotation != null) { |
||||
this.attributeNames.addAll(Arrays.asList(annotation.names())); |
||||
this.attributeTypes.addAll(Arrays.asList(annotation.types())); |
||||
} |
||||
this.knownAttributeNames.addAll(this.attributeNames); |
||||
} |
||||
|
||||
|
||||
/** |
||||
* Whether the controller represented by this instance has declared any |
||||
* session attributes through an {@link SessionAttributes} annotation. |
||||
*/ |
||||
public boolean hasSessionAttributes() { |
||||
return (!this.attributeNames.isEmpty() || !this.attributeTypes.isEmpty()); |
||||
} |
||||
|
||||
/** |
||||
* Whether the attribute name or type match the names and types specified |
||||
* via {@code @SessionAttributes} on the underlying controller. |
||||
* <p>Attributes successfully resolved through this method are "remembered" |
||||
* and subsequently used in {@link #retrieveAttributes(WebSession)} |
||||
* and also {@link #cleanupAttributes(WebSession)}. |
||||
* @param attributeName the attribute name to check |
||||
* @param attributeType the type for the attribute |
||||
*/ |
||||
public boolean isHandlerSessionAttribute(String attributeName, Class<?> attributeType) { |
||||
Assert.notNull(attributeName, "Attribute name must not be null"); |
||||
if (this.attributeNames.contains(attributeName) || this.attributeTypes.contains(attributeType)) { |
||||
this.knownAttributeNames.add(attributeName); |
||||
return true; |
||||
} |
||||
else { |
||||
return false; |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Retrieve "known" attributes from the session, i.e. attributes listed |
||||
* by name in {@code @SessionAttributes} or attributes previously stored |
||||
* in the model that matched by type. |
||||
* @param session the current session |
||||
* @return a map with handler session attributes, possibly empty |
||||
*/ |
||||
public Map<String, Object> retrieveAttributes(WebSession session) { |
||||
Map<String, Object> attributes = new HashMap<>(); |
||||
this.knownAttributeNames.forEach(name -> { |
||||
Object value = session.getAttribute(name); |
||||
if (value != null) { |
||||
attributes.put(name, value); |
||||
} |
||||
}); |
||||
return attributes; |
||||
} |
||||
|
||||
/** |
||||
* Store a subset of the given attributes in the session. Attributes not |
||||
* declared as session attributes via {@code @SessionAttributes} are ignored. |
||||
* @param session the current session |
||||
* @param attributes candidate attributes for session storage |
||||
*/ |
||||
public void storeAttributes(WebSession session, Map<String, ?> attributes) { |
||||
attributes.keySet().forEach(name -> { |
||||
Object value = attributes.get(name); |
||||
if (value != null && isHandlerSessionAttribute(name, value.getClass())) { |
||||
session.getAttributes().put(name, value); |
||||
} |
||||
}); |
||||
} |
||||
|
||||
/** |
||||
* Remove "known" attributes from the session, i.e. attributes listed |
||||
* by name in {@code @SessionAttributes} or attributes previously stored |
||||
* in the model that matched by type. |
||||
* @param session the current session |
||||
*/ |
||||
public void cleanupAttributes(WebSession session) { |
||||
this.knownAttributeNames.forEach(name -> session.getAttributes().remove(name)); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,50 @@
@@ -0,0 +1,50 @@
|
||||
/* |
||||
* Copyright 2002-2017 the original author or authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
*/ |
||||
package org.springframework.web.reactive.result.method.annotation; |
||||
|
||||
import org.springframework.core.MethodParameter; |
||||
import org.springframework.lang.Nullable; |
||||
import org.springframework.util.Assert; |
||||
import org.springframework.web.bind.support.SessionStatus; |
||||
import org.springframework.web.reactive.BindingContext; |
||||
import org.springframework.web.reactive.result.method.SyncHandlerMethodArgumentResolver; |
||||
import org.springframework.web.server.ServerWebExchange; |
||||
|
||||
/** |
||||
* Resolver for a {@link SessionStatus} argument obtaining it from the |
||||
* {@link BindingContext}. |
||||
* |
||||
* @author Rossen Stoyanchev |
||||
* @since 5.0 |
||||
*/ |
||||
public class SessionStatusMethodArgumentResolver implements SyncHandlerMethodArgumentResolver { |
||||
|
||||
|
||||
@Override |
||||
public boolean supportsParameter(MethodParameter parameter) { |
||||
return SessionStatus.class == parameter.getParameterType(); |
||||
} |
||||
|
||||
@Nullable |
||||
@Override |
||||
public Object resolveArgumentValue(MethodParameter parameter, BindingContext bindingContext, |
||||
ServerWebExchange exchange) { |
||||
|
||||
Assert.isInstanceOf(InitBinderBindingContext.class, bindingContext); |
||||
return ((InitBinderBindingContext) bindingContext).getSessionStatus(); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,122 @@
@@ -0,0 +1,122 @@
|
||||
/* |
||||
* Copyright 2002-2016 the original author or authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
*/ |
||||
|
||||
package org.springframework.web.reactive.result.method.annotation; |
||||
|
||||
|
||||
import java.time.Duration; |
||||
import java.util.HashSet; |
||||
|
||||
import org.junit.Test; |
||||
|
||||
import org.springframework.tests.sample.beans.TestBean; |
||||
import org.springframework.ui.ModelMap; |
||||
import org.springframework.web.bind.annotation.SessionAttributes; |
||||
import org.springframework.web.server.WebSession; |
||||
import org.springframework.web.server.session.InMemoryWebSessionStore; |
||||
|
||||
import static java.util.Arrays.asList; |
||||
import static org.junit.Assert.assertEquals; |
||||
import static org.junit.Assert.assertFalse; |
||||
import static org.junit.Assert.assertNotNull; |
||||
import static org.junit.Assert.assertNull; |
||||
import static org.junit.Assert.assertTrue; |
||||
|
||||
/** |
||||
* Test fixture with {@link SessionAttributesHandler}. |
||||
* @author Rossen Stoyanchev |
||||
*/ |
||||
public class SessionAttributesHandlerTests { |
||||
|
||||
private final SessionAttributesHandler sessionAttributesHandler = |
||||
new SessionAttributesHandler(TestController.class); |
||||
|
||||
|
||||
@Test |
||||
public void isSessionAttribute() throws Exception { |
||||
assertTrue(this.sessionAttributesHandler.isHandlerSessionAttribute("attr1", String.class)); |
||||
assertTrue(this.sessionAttributesHandler.isHandlerSessionAttribute("attr2", String.class)); |
||||
assertTrue(this.sessionAttributesHandler.isHandlerSessionAttribute("simple", TestBean.class)); |
||||
assertFalse(this.sessionAttributesHandler.isHandlerSessionAttribute("simple", String.class)); |
||||
} |
||||
|
||||
@Test |
||||
public void retrieveAttributes() throws Exception { |
||||
WebSession session = new InMemoryWebSessionStore().createWebSession().block(Duration.ZERO); |
||||
assertNotNull(session); |
||||
|
||||
session.getAttributes().put("attr1", "value1"); |
||||
session.getAttributes().put("attr2", "value2"); |
||||
session.getAttributes().put("attr3", new TestBean()); |
||||
session.getAttributes().put("attr4", new TestBean()); |
||||
|
||||
assertEquals("Named attributes (attr1, attr2) should be 'known' right away", |
||||
new HashSet<>(asList("attr1", "attr2")), |
||||
sessionAttributesHandler.retrieveAttributes(session).keySet()); |
||||
|
||||
// Resolve 'attr3' by type
|
||||
sessionAttributesHandler.isHandlerSessionAttribute("attr3", TestBean.class); |
||||
|
||||
assertEquals("Named attributes (attr1, attr2) and resolved attribute (att3) should be 'known'", |
||||
new HashSet<>(asList("attr1", "attr2", "attr3")), |
||||
sessionAttributesHandler.retrieveAttributes(session).keySet()); |
||||
} |
||||
|
||||
@Test |
||||
public void cleanupAttributes() throws Exception { |
||||
WebSession session = new InMemoryWebSessionStore().createWebSession().block(Duration.ZERO); |
||||
assertNotNull(session); |
||||
|
||||
session.getAttributes().put("attr1", "value1"); |
||||
session.getAttributes().put("attr2", "value2"); |
||||
session.getAttributes().put("attr3", new TestBean()); |
||||
|
||||
this.sessionAttributesHandler.cleanupAttributes(session); |
||||
|
||||
assertNull(session.getAttributes().get("attr1")); |
||||
assertNull(session.getAttributes().get("attr2")); |
||||
assertNotNull(session.getAttributes().get("attr3")); |
||||
|
||||
// Resolve 'attr3' by type
|
||||
this.sessionAttributesHandler.isHandlerSessionAttribute("attr3", TestBean.class); |
||||
this.sessionAttributesHandler.cleanupAttributes(session); |
||||
|
||||
assertNull(session.getAttributes().get("attr3")); |
||||
} |
||||
|
||||
@Test |
||||
public void storeAttributes() throws Exception { |
||||
WebSession session = new InMemoryWebSessionStore().createWebSession().block(Duration.ZERO); |
||||
assertNotNull(session); |
||||
|
||||
ModelMap model = new ModelMap(); |
||||
model.put("attr1", "value1"); |
||||
model.put("attr2", "value2"); |
||||
model.put("attr3", new TestBean()); |
||||
|
||||
sessionAttributesHandler.storeAttributes(session, model); |
||||
|
||||
assertEquals("value1", session.getAttributes().get("attr1")); |
||||
assertEquals("value2", session.getAttributes().get("attr2")); |
||||
assertTrue(session.getAttributes().get("attr3") instanceof TestBean); |
||||
} |
||||
|
||||
|
||||
@SessionAttributes(names = { "attr1", "attr2" }, types = { TestBean.class }) |
||||
private static class TestController { |
||||
} |
||||
|
||||
} |
||||
Loading…
Reference in new issue