一文搞懂SpringMVC中@InitBinder註解的使用

Posted on by

環境：Springboot2.4.12

簡介

​@Controller或@ControllerAdvice類可以有@InitBinder方法來初始化WebDataBinder的實例，這些方法可以:

  • 將請求參數(即表單或查詢數據)綁定到模型對象。
  • 將基於字符串的請求值(如請求參數、路徑變量、頭、cookie等)轉換為控制器方法參數的目標類型。
  • 渲染HTML表單時，將模型對象的值格式化為字符串值。

@InitBinder方法可以註冊控制器特定的java.bean.PropertyEditor或Spring Converter和 Formatter組件。另外，你可以使用MVC配置在全局共享的FormattingConversionService中註冊Converter和Formatter類型。

@InitBinder方法支持許多與@RequestMapping方法相同的參數，除瞭@ModelAttribute(命令對象)參數。通常，它們是用WebDataBinder參數(用於註冊)和一個void返回值聲明的。

應用示例

@RestController
@RequestMapping("/demos")
public class DemoController {
  @InitBinder // 1
  public void bind(WebDataBinder binder) { // 2
    binder.registerCustomEditor(Long.class, new PropertyEditorSupport() { // 3
      @Override
      public void setAsText(String text) throws IllegalArgumentException {
        setValue(Long.valueOf(text) + 666L) ;
      }
    }) ;
  }
  @GetMapping("/index")
  public Object index(Long id) {
    return "index - " + id ;
  }
}

註意以下幾點：

  • 使用 @InitBinder 註解。
  • 接收 WebDataBinder 參數。
  • 註冊自定義的轉換器。
  • 方法返回值必須是 void。

在上面的示例中註冊瞭一個類型轉換器從字符串轉換為Long類型 並且在原來值基礎上增加瞭666L。

原理解讀

HandlerAdapter 執行。

public class RequestMappingHandlerAdapter extends AbstractHandlerMethodAdapter implements BeanFactoryAware, InitializingBean {
  protected ModelAndView invokeHandlerMethod(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
    // ...
    // 這裡會查找當前執行的Controller中定義的所有@InitBinder註解的方法
    WebDataBinderFactory binderFactory = getDataBinderFactory(handlerMethod);
    ServletInvocableHandlerMethod invocableMethod = createInvocableHandlerMethod(handlerMethod);
    invocableMethod.invokeAndHandle(webRequest, mavContainer);
    // ...
  }
}

ServletInvocableHandlerMethod 執行。

public class ServletInvocableHandlerMethod extends InvocableHandlerMethod {
  public void invokeAndHandle(ServletWebRequest webRequest, ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {
    // 調用父類方法
    Object returnValue = invokeForRequest(webRequest, mavContainer, providedArgs);
    // ...
  }
}
// 執行父類方法調用
public class InvocableHandlerMethod extends HandlerMethod {
  public Object invokeForRequest(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {
    Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs);
    return doInvoke(args);
  }
  protected Object[] getMethodArgumentValues(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {
    Object[] args = new Object[parameters.length];
    for (int i = 0; i < parameters.length; i++) {
      // 解析參數
      args[i] = this.resolvers.resolveArgument(parameter, mavContainer, request, this.dataBinderFactory);
    }
  }
}

參數解析

在上面的Controller示例中，參數的解析器是RequestParamMethodArgumentResolver。

調用父類的resolveArgument方法。

public abstract class AbstractNamedValueMethodArgumentResolver {
  public final Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
    // 封裝方法參數的名稱這裡為：id
    NamedValueInfo namedValueInfo = getNamedValueInfo(parameter);
    // resolvedName = id
    Object resolvedName = resolveEmbeddedValuesAndExpressions(namedValueInfo.name);
    // ...
    // 獲取參數名對應的請求參數值：/demos/index?id=100 , 這就返回100
    Object arg = resolveName(resolvedName.toString(), nestedParameter, webRequest);
    // ...
    if (binderFactory != null) {
      // 根據當前的Request對象及請求參數名創建WebDataBinder對象
      // 內部創建的ExtendedServletRequestDataBinder對象
      WebDataBinder binder = binderFactory.createBinder(webRequest, null, namedValueInfo.name);
      try {
        // 執行類型轉換
        arg = binder.convertIfNecessary(arg, parameter.getParameterType(), parameter);
      }
    }
  }
}
// 創建WebDataBinder對象
public class DefaultDataBinderFactory implements WebDataBinderFactory {
  public final WebDataBinder createBinder(NativeWebRequest webRequest, @Nullable Object target, String objectName) throws Exception {
    WebDataBinder dataBinder = createBinderInstance(target, objectName, webRequest);
    if (this.initializer != null) {
      // 初始化WebDataBinder對象，這裡最主要的就是為其設置類型轉換器
      this.initializer.initBinder(dataBinder, webRequest);
    }
    // 初始化執行@InitBinder註解的方法
    initBinder(dataBinder, webRequest);
    return dataBinder;
  }
}
public class InitBinderDataBinderFactory extends DefaultDataBinderFactory {
  public void initBinder(WebDataBinder dataBinder, NativeWebRequest request) throws Exception {
    // 遍歷所有@InitBinder註解的方法
    for (InvocableHandlerMethod binderMethod : this.binderMethods) {
      if (isBinderMethodApplicable(binderMethod, dataBinder)) {
        // 這裡就是執行@InitBinder註解的方法
       Object returnValue = binderMethod.invokeForRequest(request, null, dataBinder);
        // 如果@InitBinder註解的方法有返回值則拋出異常
        if (returnValue != null) {
          throw new IllegalStateException("@InitBinder methods must not return a value (should be void): " + binderMethod);
        }
      }
    }
  }
}
// 解析@InitBinder註解方法的參數及方法執行
public class InvocableHandlerMethod extends HandlerMethod {
  public Object invokeForRequest(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {
    // 解析獲取@InitBinder註解方法的參數
    Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs);
    // 執行調用
    return doInvoke(args);
  }
}

執行類型轉換

在上面執行流程中，我們知道獲取瞭一個WebDataBinder對象和由@InitBinder 註解的方法的調用執行。接下來就是進行類型的轉換。

public abstract class AbstractNamedValueMethodArgumentResolver {
  public final Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
    if (binderFactory != null) {
      // 根據當前的Request對象及請求參數名創建WebDataBinder對象
      // 內部創建的ExtendedServletRequestDataBinder對象
      WebDataBinder binder = binderFactory.createBinder(webRequest, null, namedValueInfo.name);
      try {
        // 執行類型轉換
        arg = binder.convertIfNecessary(arg, parameter.getParameterType(), parameter);
      }
    }
  }
}
// 最終通過該類調用類型轉換
class TypeConverterDelegate {
  public <T> T convertIfNecessary(@Nullable String propertyName, @Nullable Object oldValue, @Nullable Object newValue, @Nullable Class<T> requiredType, @Nullable TypeDescriptor typeDescriptor) throws IllegalArgumentException {
    // Custom editor for this type?
    // 獲取自定義的類型轉換器（首先獲取的就是我們上面自定義的）
    PropertyEditor editor = this.propertyEditorRegistry.findCustomEditor(requiredType, propertyName);
    // ...
    Object convertedValue = newValue;
    // ...
    convertedValue = doConvertValue(oldValue, convertedValue, requiredType, editor);
  }
  private Object doConvertValue(@Nullable Object oldValue, @Nullable Object newValue, @Nullable Class<?> requiredType, @Nullable PropertyEditor editor) { 
    // ...
    if (convertedValue instanceof String) {
      if (editor != null) {
        String newTextValue = (String) convertedValue;
        // 最終的調用
        return doConvertTextValue(oldValue, newTextValue, editor);
      } else if (String.class == requiredType) {
        returnValue = convertedValue;
      }
    }
    return returnValue;
  }
  // 最終得到瞭我們想要的值
  private Object doConvertTextValue(@Nullable Object oldValue, String newTextValue, PropertyEditor editor) {
    try {
      editor.setValue(oldValue);
    }
    // ...
    editor.setAsText(newTextValue);
    return editor.getValue();
  }
}

以上就是參數綁定及類型轉換的過程。

到此這篇關於一文搞懂SpringMVC中@InitBinder註解的使用的文章就介紹到這瞭,更多相關SpringMVC @InitBinder註解內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：