栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

springmvc类型转换的几种方式

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

springmvc类型转换的几种方式

文章目录
  • 先说结论
  • 一、实现Formatter
    • 1.使用方式
  • 二、实现Converter
    • 1.使用方式
  • 三、使用`@InitBinder`
    • 1.使用方式
  • 四、原理解析
    • 1.转换器注入原理
    • 2.关联RequestMappingHandlerAdapter
    • 3.流程概述,关注WebDataBinder的生成
    • 4.类型转换核心方法


先说结论

目前所知一共有三种方式:

  1. 实现org.springframework.format.Formatter
  2. 实现org.springframework.core.convert.converter.Converter
  3. 使用@InitBinder来实现自定义转换

一、实现Formatter 1.使用方式

1.1 实现Formatter接口:

import org.springframework.format.Formatter;

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;

public class MyFormatter implements Formatter {
    @Override
    public Date parse(String text, Locale locale) throws ParseException {
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyyMMdd");
        Date date = simpleDateFormat.parse(text);
        System.out.println("转换了:"+date);
        return date;
    }

    @Override
    public String print(Date object, Locale locale) {
        return null;
    }
}

1.2 配置bean
这里使用的springMVC配置文件配置的方式

 

    
        
            
                
            
        
    

1.3 准备一个controller测试:

@RequestMapping(value = "/getDate", method = RequestMethod.GET)
    @ResponseBody
    public String testFormatData(Date date) {
        DateFormat df = new SimpleDateFormat("yyyy-MM-dd");
        return df.format(date);
    }

请求http://localhost:8080/getDate?date=20220129
最后控制台输出了想要的结果:

转换了:Sat Jan 29 00:00:00 CST 2022
二、实现Converter 1.使用方式

1.1 实现Converter接口:

package com.abz.converter;

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

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;

public class MyConverter implements Converter {
    @Override
    public Date convert(String text) {
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyyMMdd");
        Date date = null;
        try {
            date = simpleDateFormat.parse(text);
        } catch (ParseException e) {
            throw new RuntimeException(e);
        }
        System.out.println("转换了:"+date);
        return date;
    }
}

1.2 配置bean
这里使用的springMVC配置文件配置的方式



    
        
            
                
            
        
    

1.3 准备一个controller测试:

@RequestMapping(value = "/getDate", method = RequestMethod.GET)
    @ResponseBody
    public String testFormatData(Date date) {
        DateFormat df = new SimpleDateFormat("yyyy-MM-dd");
        return df.format(date);
    }

请求http://localhost:8080/getDate?date=20220129
最后控制台输出了想要的结果:

转换了:Sat Jan 29 00:00:00 CST 2022

1.4 这里简单对比一下formatter和converter方式的异同:

  • 首先formatter只可以String转换其他类型,而converter可以任意两个类型转换
三、使用@InitBinder 1.使用方式

1.1 使用@InitBinder:

package com.abz.controller;

import org.springframework.beans.propertyeditors.CustomDateEditor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;

@Controller
public class StudentController {
    

    @InitBinder
    public void initBinderXXX(WebDataBinder binder) {
        DateFormat df = new SimpleDateFormat("yyyy-MM-dd");
        CustomDateEditor dateEditor = new CustomDateEditor(df, true);
        binder.registerCustomEditor(Date.class, dateEditor);
        System.out.println("InitBinder");
    }


    @RequestMapping(value = "/getDate", method = RequestMethod.GET)
    @ResponseBody
    public String testFormatData(Date date) {
        DateFormat df = new SimpleDateFormat("yyyy-MM-dd");
        return df.format(date);
    }

}

请求http://localhost:8080/getDate?date=2022-01-29
最后控制台输出了想要的结果:

InitBinder
四、原理解析 1.转换器注入原理

通过之前的springMvc的配置文件,可以看出formatter和conventer都是存到FormattingConversionServiceFactoryBean这个factoryBean里,这个类实现了InitializingBean接口,最后是通过afterPropertiesSet去生成DefaultFormattingConversionService实例,并且把formatter和conventer都注册了,看代码:

@Override
	public void afterPropertiesSet() {
		this.conversionService = new DefaultFormattingConversionService(this.embeddedValueResolver, this.registerDefaultFormatters);
		ConversionServiceFactory.registerConverters(this.converters, this.conversionService);
		registerFormatters(this.conversionService);
	}

到这里,我们知道formatter和conventer存在DefaultFormattingConversionService里。

2.关联RequestMappingHandlerAdapter

这里我们看HandlerAdapter和FormattingConversionServiceFactoryBean关系。
首先,配置文件中的,spring通过
AnnotationDrivenBeanDefinitionParser#parse去解析这个标签,从代码中我们可以分析出他们的关联关系:

@Override
	@Nullable
	public BeanDefinition parse(Element element, ParserContext context) {
		...
		...

		RuntimeBeanReference conversionService = getConversionService(element, source, context); //此处注册FormattingConversionServiceFactoryBean
		RuntimeBeanReference validator = getValidator(element, source, context);
		RuntimeBeanReference messageCodesResolver = getMessageCodesResolver(element);

		RootBeanDefinition bindingDef = new RootBeanDefinition(ConfigurableWebBindingInitializer.class);
		bindingDef.setSource(source);
		bindingDef.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
		bindingDef.getPropertyValues().add("conversionService", conversionService);
		bindingDef.getPropertyValues().add("validator", validator);
		bindingDef.getPropertyValues().add("messageCodesResolver", messageCodesResolver);
		...
		...
		RootBeanDefinition handlerAdapterDef = new RootBeanDefinition(RequestMappingHandlerAdapter.class);
		handlerAdapterDef.setSource(source);
		handlerAdapterDef.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
		handlerAdapterDef.getPropertyValues().add("contentNegotiationManager", contentNegotiationManager);
		handlerAdapterDef.getPropertyValues().add("webBindingInitializer", bindingDef);
		handlerAdapterDef.getPropertyValues().add("messageConverters", messageConverters);
		...
		...

至此,RequestMappingHandlerAdapter -->ConfigurableWebBindingInitializer --> FormattingConversionServiceFactoryBean

3.流程概述,关注WebDataBinder的生成

这边简单列一下主要的类和方法(这里代码追踪基于上述StudentController的方法触发):

DispatcherServlet#doDispatch -->
RequestMappingHandlerAdapter#handleInternal -->
RequestMappingHandlerAdapter#invokeHandlerMethod -->
打断一下,这个方法里重点关注一段代码(getDataBinderFactory):

@Nullable
	protected ModelAndView invokeHandlerMethod(HttpServletRequest request,
			HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {

		ServletWebRequest webRequest = new ServletWebRequest(request, response);
		try {
			//主要是这个方法,类型转换主要看binderFactory
			WebDataBinderFactory binderFactory = getDataBinderFactory(handlerMethod); 
			...
			...

ServletInvocableHandlerMethod#invokeAndHandle -->
AbstractNamedValueMethodArgumentResolver#resolveArgument
至此就可以看到类型转换的地方(binder.convertIfNecessary):

@Override
	@Nullable
	public final Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
			NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
		...
		...
		if (binderFactory != null) {
			WebDataBinder binder = binderFactory.createBinder(webRequest, null, namedValueInfo.name);
			try {
				arg = binder.convertIfNecessary(arg, parameter.getParameterType(), parameter);
			}
		...
		..

先关注WebDataBinder实例生成,:

@Override
	@SuppressWarnings("deprecation")
	public final WebDataBinder createBinder(
			NativeWebRequest webRequest, @Nullable Object target, String objectName) throws Exception {

		WebDataBinder dataBinder = createBinderInstance(target, objectName, webRequest);
		if (this.initializer != null) {
			this.initializer.initBinder(dataBinder, webRequest);
		}
		initBinder(dataBinder, webRequest);
		return dataBinder;
	}

这里面的initializer就是ConfigurableWebBindingInitializer ,看一下它的initBinder方法:

@Override
	public void initBinder(WebDataBinder binder) {
		...
		...
		if (this.validator != null && binder.getTarget() != null &&
				this.validator.supports(binder.getTarget().getClass())) {
			binder.setValidator(this.validator);
		}
		if (this.conversionService != null) {
			binder.setConversionService(this.conversionService);
		}
		if (this.propertyEditorRegistrars != null) {
			for (PropertyEditorRegistrar propertyEditorRegistrar : this.propertyEditorRegistrars) {
				propertyEditorRegistrar.registerCustomEditors(binder);
			}
		}
	}

可以发现,conversionService和自定义注册器都绑定到WebDataBinder。

4.类型转换核心方法

从上文可知,类型转换核心方法在binder.convertIfNecessary()里,这里面其实主要根据入参去匹配对应的转换器,找到转换器之后再进行转换,自定义转换器优先级最高,略过一些调用过程,直接看核心代码(TypeConverterDelegate#convertIfNecessary):

@Nullable
    public  T convertIfNecessary(@Nullable String propertyName, @Nullable Object oldValue, @Nullable Object newValue, @Nullable Class requiredType, @Nullable TypeDescriptor typeDescriptor) throws IllegalArgumentException {
        PropertyEditor editor = this.propertyEditorRegistry.findCustomEditor(requiredType, propertyName);
        ConversionFailedException conversionAttemptEx = null;
        ConversionService conversionService = this.propertyEditorRegistry.getConversionService();
        if (editor == null && conversionService != null && newValue != null && typeDescriptor != null) {
            TypeDescriptor sourceTypeDesc = TypeDescriptor.forObject(newValue);
            if (conversionService.canConvert(sourceTypeDesc, typeDescriptor)) {
                try {
                	//formatter和converter转换器执行
                    return conversionService.convert(newValue, sourceTypeDesc, typeDescriptor);
                } catch (ConversionFailedException var14) {
                    conversionAttemptEx = var14;
                }
            }
        }

        Object convertedValue = newValue;
        if (editor != null || requiredType != null && !ClassUtils.isAssignableValue(requiredType, newValue)) {
            if (typeDescriptor != null && requiredType != null && Collection.class.isAssignableFrom(requiredType) && newValue instanceof String) {
                TypeDescriptor elementTypeDesc = typeDescriptor.getElementTypeDescriptor();
                if (elementTypeDesc != null) {
                    Class elementType = elementTypeDesc.getType();
                    if (Class.class == elementType || Enum.class.isAssignableFrom(elementType)) {
                        convertedValue = StringUtils.commaDelimitedListToStringArray((String)newValue);
                    }
                }
            }

            if (editor == null) {
                editor = this.findDefaultEditor(requiredType);
            }
			//自定义转换器执行
            convertedValue = this.doConvertValue(oldValue, convertedValue, requiredType, editor);
        }

这里可以看出,自定义转换器优先级最高。

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/939781.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号