Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

SPR-6909 Improve extension hooks in DefaultDataBinderFactory and subclasses.

Browse Source
This commit is contained in:
Rossen Stoyanchev
2011-06-24 12:04:16 +00:00
parent 2122cbcb1b
commit 8e240d814b
4 changed files with 113 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
org.springframework.web/src/main/java/org/springframework/web/bind/support/DefaultDataBinderFactory.java
View File

@@ -20,45 +20,58 @@ import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.context.request.NativeWebRequest;
/**
* A {@link WebDataBinderFactory} that creates {@link WebDataBinder} and initializes them
* with a {@link WebBindingInitializer}.
* Creates a {@link WebRequestDataBinder} and initializes it through a {@link WebBindingInitializer}.
*
* @author Rossen Stoyanchev
* @since 3.1
*/
public class DefaultDataBinderFactory implements WebDataBinderFactory {
private final WebBindingInitializer bindingInitializer;
private final WebBindingInitializer initializer;
/**
* Create {@link DefaultDataBinderFactory} instance.
* @param bindingInitializer a {@link WebBindingInitializer} to initialize new data binder instances with
* @param initializer a global initializer to initialize new data binder instances with
*/
public DefaultDataBinderFactory(WebBindingInitializer bindingInitializer) {
this.bindingInitializer = bindingInitializer;
public DefaultDataBinderFactory(WebBindingInitializer initializer) {
this.initializer = initializer;
}
/**
* Create a new {@link WebDataBinder} for the given target object and initialize it through
* a {@link WebBindingInitializer}.
*/
public WebDataBinder createBinder(NativeWebRequest webRequest, Object target, String objectName) throws Exception {
WebDataBinder dataBinder = createBinderInstance(target, objectName);
public final WebDataBinder createBinder(NativeWebRequest webRequest, Object target, String objectName) throws Exception {
WebDataBinder dataBinder = createBinderInstance(target, objectName, webRequest);
if (bindingInitializer != null) {
this.bindingInitializer.initBinder(dataBinder, webRequest);
if (initializer != null) {
this.initializer.initBinder(dataBinder, webRequest);
}
initBinder(dataBinder, webRequest);
return dataBinder;
}
/**
* Create a {@link WebDataBinder} instance.
* @param target the object to create a data binder for, or {@code null} if creating a binder for a simple type
* Extension hook that subclasses can use to create a data binder of a specific type.
* The default implementation creates a {@link WebRequestDataBinder}.
* @param target the data binding target object; or {@code null} for type conversion on simple objects.
* @param objectName the name of the target object
* @param webRequest the current request
*/
protected WebDataBinder createBinderInstance(Object target, String objectName) {
protected WebDataBinder createBinderInstance(Object target, String objectName, NativeWebRequest webRequest) {
return new WebRequestDataBinder(target, objectName);
}
/**
* Extension hook that subclasses can override to initialize further the data binder.
* Will be invoked after the data binder is initialized through the {@link WebBindingInitializer}.
* @param dataBinder the data binder instance to customize
* @param webRequest the current request
* @throws Exception if initialization fails
*/
protected void initBinder(WebDataBinder dataBinder, NativeWebRequest webRequest) throws Exception {
}
}

66
org.springframework.web/src/main/java/org/springframework/web/method/annotation/InitBinderDataBinderFactory.java
View File

@@ -18,63 +18,67 @@ package org.springframework.web.method.annotation;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Collection;
import java.util.List;
import java.util.Set;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.support.DefaultDataBinderFactory;
import org.springframework.web.bind.support.WebBindingInitializer;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.method.support.InvocableHandlerMethod;
/**
* A specialization of {@link DefaultDataBinderFactory} that further initializes {@link WebDataBinder} instances
* by invoking {@link InitBinder} methods.
* Adds data binder initialization through the invocation of @{@link InitBinder} methods.
*
* @author Rossen Stoyanchev
* @since 3.1
*/
public class InitBinderDataBinderFactory extends DefaultDataBinderFactory {
private final List<InvocableHandlerMethod> initBinderMethods;
private final List<InvocableHandlerMethod> binderMethods;
/**
* Create an {@code InitBinderDataBinderFactory} instance with the given {@link InitBinder} methods.
* @param binderMethods {@link InitBinder} methods to use to invoke to initialize new data binder instances
* @param bindingInitializer a {@link WebBindingInitializer} to initialize new data binder instances with
* Create a new instance.
* @param binderMethods {@link InitBinder} methods to initialize new data binder instances with
* @param initializer a global initializer to initialize new data binder instances with
*/
public InitBinderDataBinderFactory(List<InvocableHandlerMethod> binderMethods,
WebBindingInitializer bindingInitializer) {
super(bindingInitializer);
this.initBinderMethods = (binderMethods != null) ? binderMethods : new ArrayList<InvocableHandlerMethod>();
public InitBinderDataBinderFactory(List<InvocableHandlerMethod> binderMethods, WebBindingInitializer initializer) {
super(initializer);
this.binderMethods = (binderMethods != null) ? binderMethods : new ArrayList<InvocableHandlerMethod>();
}
/**
* Create a {@link WebDataBinder} for the given object and initialize it by calling {@link InitBinder} methods.
* Only methods with an {@link InitBinder} annotation value that doesn't list attributes names or methods with
* an {@link InitBinder} annotation value that matches the target object name are invoked.
* Initializes the given data binder through the invocation of @{@link InitBinder} methods.
* An @{@link InitBinder} method that defines names via {@link InitBinder#value()} will
* not be invoked unless one of the names matches the target object name.
* @see InitBinder#value()
* @throws Exception if one of the invoked @{@link InitBinder} methods fail.
*/
@Override
public WebDataBinder createBinder(NativeWebRequest request, Object target, String objectName) throws Exception {
WebDataBinder dataBinder = super.createBinder(request, target, objectName);
for (InvocableHandlerMethod binderMethod : this.initBinderMethods) {
InitBinder annot = binderMethod.getMethodAnnotation(InitBinder.class);
Set<String> attributeNames = new HashSet<String>(Arrays.asList(annot.value()));
if (attributeNames.size() == 0 || attributeNames.contains(objectName)) {
Object returnValue = binderMethod.invokeForRequest(request, null, dataBinder);
if (returnValue != null) {
throw new IllegalStateException("InitBinder methods must not have a return value: " + binderMethod);
}
public void initBinder(WebDataBinder binder, NativeWebRequest request) throws Exception {
for (InvocableHandlerMethod binderMethod : this.binderMethods) {
if (!isBinderMethodApplicable(binderMethod, binder)) {
continue;
}
Object returnValue = binderMethod.invokeForRequest(request, null, binder);
if (returnValue != null) {
throw new IllegalStateException("This @InitBinder method does not return void: " + binderMethod);
}
}
return dataBinder;
}
/**
* Returns {@code true} if the given @{@link InitBinder} method should be invoked to initialize
* the given {@link WebDataBinder} instance. This implementations returns {@code true} if
* the @{@link InitBinder} annotation on the method does not define any names or if one of the
* names it defines names matches the target object name.
*/
protected boolean isBinderMethodApplicable(HandlerMethod binderMethod, WebDataBinder binder) {
InitBinder annot = binderMethod.getMethodAnnotation(InitBinder.class);
Collection<String> names = Arrays.asList(annot.value());
return (names.size() == 0 || names.contains(binder.getObjectName()));
}
}
}