SpringMVC實現自定義類型轉換器

我們在使用SpringMVC時，常常需要把表單中的參數映射到我們對象的屬性中，我們可以在默認的spring-servlet.xml加上如下的配置即可做到普通數據類型的轉換，如將String轉換成Integer和Double等：

<mvc:annotation-driven />

或

復制代碼 代碼如下:
<bean id="conversionService" class="org.springframework.format.support.FormattingConversionServiceFactoryBean" />

其實  <mvc:annotation-driven /> 標簽會默認創建並注冊一個 RequestMappingHandlerMapping（在Spring3.2之前是DefaultAnnotationHandlerMapping） 和 RequestMappingHandlerAdapter （Spring3.2之前是AnnotationMethodHandlerAdapter），當然，如果上下文有對應的顯示實現類，將該注解注冊的覆蓋掉。該注解還會創建一個ConversionService，即 FormattingConversionServiceFactoryBean。

如果想把一個字符串轉換成其它實體類型，spring沒有提供這樣默認的功能，我們需要自定義類型轉換器。

這裡有個實體類Employee。

package com.proc;

public class Employee {

  private String name;
  private Integer age;
  private String gender;
  public String getName() {
    return name;
  }
  public void setName(String name) {
    this.name = name;
  }
  public Integer getAge() {
    return age;
  }
  public void setAge(Integer age) {
    this.age = age;
  }
  public String getGender() {
    return gender;
  }
  public void setGender(String gender) {
    this.gender = gender;
  }
  @Override
  public String toString() {
    return "Employee [name=" + name + ", age=" + age + ", gender=" + gender
        + "]";
  }
  
}

規定將字符串轉換成實體類的規則為：  name-age-gender

那麼接下來就寫一個類型轉換器，需要實現一個接口org.springframework.core.convert.converter.Converter

package com.proc;

import org.springframework.core.convert.converter.Converter;
import org.springframework.stereotype.Component;

@Component
public class EmployeeConverter implements Converter<String, Employee> {

  @Override
  public Employee convert(String str) {
    Employee emp=null;
    //字符串格式 name-age-gender
    if(str!=null && str.split("-").length==3){
      emp=new Employee();
      String[] arr=str.split("-");
      emp.setName(arr[0]);
      emp.setAge(Integer.parseInt(arr[1]));
      emp.setGender(arr[2]);
    }
    return emp;
  }
}

這裡我們為轉換器加上@Component注解，是為了讓Spring自動掃描該轉換器到容器中。這樣就不用通過配置文件配置<bean>了

接下來編寫控制器

package com.proc;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

@Controller
public class EmployeeController {

  @RequestMapping("/add")
  public String add(@RequestParam("employee") Employee employee){
    System.out.println(employee);
    return "add";
  }
}

這裡可以看到，參數的名字為employee，所有要為請求定義一個employee參數，該參數傳入需要轉換的字符串

除此之外，我們還需要在spring配置文件中配置，如下類容。讓轉換器生效

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:context="http://www.springframework.org/schema/context"
  xmlns:mvc="http://www.springframework.org/schema/mvc"
  xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd
    http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
    http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd"> 
  
  <context:component-scan base-package="com.proc"></context:component-scan>
  
  <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <property name="prefix" value="/WEB-INF/"/>
    <property name="suffix" value=".jsp"></property>
  </bean>

    <mvc:annotation-driven conversion-service="conversionService"/>
    
    <bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
      <property name="converters">
        <set>
          <ref bean="employeeConverter"/>
        </set>
      </property>
    </bean>
</beans>

測試代碼：http://localhost:8080/springmvc-1/add?employee=caoyc-18-male

結果輸出：Employee [name=caoyc, age=18, gender=male]

上面配置文件中我們使用配置了一個ConversionServiceFactoryBean。雖然可以這樣，但不建議。我們通常用org.springframework.format.support.FormattingConversionServiceFactoryBean

 為什麼要這樣用呢？這樣用的好處是什麼呢？

使用FormattingConversionServiceFactoryBean可以讓SpringMVC支持@NumberFormat和@DateTimeFormat等Spring內部自定義的轉換器。

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持。