springBoot中自定义参数类型转换

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/liushangzaibeijing/article/details/82493910

一、缘起

       由于工作中的项目需要与第三方进行联调,在对方调用我方的接口中请求接受Content-Type 为application/x-www-form-urlencoded,但是针对该请求方式的springBoot中无法封装复杂类型的参数 例如一个VO对象中含有1、Date类型或者2、List对象

本片博文针对其中的两个问题进行解决。

二、解决方式

  1、构造VO对象

  Order对象

/**
 * author  xieqx
 * date   2018/9/7
 * 订单信息
 */
public class Order {

    /**
     * 订单id
     */
    private Long orderId;

    /**
     * 订单编号
     */
    private String orderNo;

    /**
     * 预定时间 默认情况下的日期类型也无法进行封装 需要添加自定义的预定时间
     */
    private Date bookingTime;

    /**
     * 订单详情列表,controller封装的order对象中如果没有自定义的类型转换,默认情况下无法正确的封装
     */
    private List<OrderDetail> orderDetailList;


...省略seter getter方法

OrderDetail对象

/**
 * @author  xieqx
 * date   2018/9/7
 * 订单详情 
 * 使用了lombok框架 简化了bean的创建
 */
@AllArgsConstructor
@Getter
@Setter
public class OrderDetail {

    private Long productId;

    private String productName;

    /**
     * 日期类型
     */
    private Date  buyTime;
}

     2、编写自定义的类型转换器

         2.1 String类型转换为Date类型

          继承Spring提供的org.springframework.core.convert.converter.Converter对象,重写其中的convert()方法 其中是自己的转换逻辑。

/**
 * author  xieqx
 * date   2018/9/4
 * 将String 转换为Date集合
 */
public class StringToDateConverter implements Converter<String, Date> {
    @Nullable
    @Override
    public Date convert(String json) {
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd");
        try {
            return simpleDateFormat.parse(json);
        } catch (ParseException e) {
            e.printStackTrace();
        }
        return null;

    }
}

2.2 String类型转换为List集合类型

   与2.1转换Date类型相似 这里使用了jackson框架进行转换

/**
 * author  xieqx
 * date   2018/9/4
 * 将String 转换为list集合
 */
public class StringToListConverter  implements Converter<String, List<OrderDetail>> {

    @Override
    public List<OrderDetail> convert(String json) {
        List<OrderDetail> priceDetails = JsonUtil.str2List(json,OrderDetail.class);
        return  priceDetails;
    }

}

2.3 转换类完成后,还需要将其交由Spring的容器进行处理,这里提供了两种方式 

   1、继承WebMvcConfigurationSupport类并将该对象创建进行添加

@Configuration
public class ApplicationConfig extends WebMvcConfigurationSupport {
    /**
     * 添加静态资源文件
     * @param registry
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/img").addResourceLocations("/img/");
        registry.addResourceHandler("/static/css").addResourceLocations("/css/");
        registry.addResourceHandler("/static/js").addResourceLocations("/js/");
        registry.addResourceHandler("/static/swf").addResourceLocations("/swf/");
        registry.addResourceHandler("/static/media").addResourceLocations("/media/");
    }

    /**
     * 添加自定义的Converters和Formatters.
     */
    @Override
    protected void addFormatters(FormatterRegistry registry) {
        //添加字符串转换list的自定义转换器
        registry.addConverter(new StringToListConverter());
        //添加字符串转换Date的自定义转换器
        registry.addConverter(new StringToDateConverter());
    }

}

  使用该方式会破坏SpringBoot默认加载静态文件的默认配置,需要重新进行添加. 切记

  2、第二种方式 

@Configuration
public class SpringDataConvert {

    @Autowired
    private RequestMappingHandlerAdapter requestMappingHandlerAdapter;

    /**
     * 增加字符串转换为List集合
     */
    @PostConstruct
    public void addConversionConfig() {
        ConfigurableWebBindingInitializer initializer = (ConfigurableWebBindingInitializer) requestMappingHandlerAdapter.getWebBindingInitializer();
        if (initializer.getConversionService() != null) {
            GenericConversionService genericConversionService = (GenericConversionService)initializer.getConversionService();
            //添加字符串转换为list集合的转换机器
            genericConversionService.addConverter(new StringToListConverter());
            //添加字符串转换为日期类型的字符串
            genericConversionService.addConverter(new StringToDateConverter());

        }
    }
}

   2.4 编写controller进行测试

@Controller
@RequestMapping("/api")
public class DateConvertController {
    private static final Logger logger = LoggerFactory.getLogger(DateConvertController.class);
    /**
     * 
     * @param order 订单信息
     * @return  请求方式为application/x-www-form-urlencoded
     */
    @ResponseBody
    @RequestMapping(value = "test",method = RequestMethod.POST,
consumes = "application/x-www-form-urlencoded",produces = "application/json")
    public Object checkInventoryForm(Order order){
        if(order==null){
            throw new RuntimeException("the hotelOrder is null");
        }
        return order;
    }
}

     

3、启动测试

         3.1、不添加日期类型转换器的post请求

      提示String无法转换为Date类型

  3.2  不添加List类型转换

  提示String无法转换为List

    3.3、自定义的类型转换器都注册上

三、升级

   3.1、 如果我的Order在添加一个Date类型 checkOutTime 格式为yyyy-MM-dd HH:mm:ss(区别于bookingTime yyyy-MM-dd)

如果使用上面的日期类型转换,需要则无法处理怎可以使用@DateFormat注解来针对每一个日期类型的进行定制化的配置

并取消自定义的日期类型的转换器

/**
 * author  xieqx
 * date   2018/9/7
 * 订单信息
 */
public class Order {

    /**
     * 订单id
     */
    private Long orderId;

    /**
     * 订单编号
     */
    private String orderNo;

    /**
     * 预定时间 默认情况下的日期类型也无法进行封装 需要添加自定义的预定时间
     */
    @DateTimeFormat(pattern = "yyyy-MM-dd")
    //@JsonFormat( timezone = "GMT+8",pattern = "yyyy-MM-dd")
    private Date bookingTime;

    /**
     * 离店时间
     */
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date checkOutTime;

    /**
     * 订单详情列表,controller封装的order对象中如果没有自定义的类型转换,默认情况下无法正确的封装
     */
    private List<OrderDetail> orderDetailList;

  postman的请求结果

3.2、对于若干个相同集合的处理

   添加一个用户列表List<User>需要重新构造一个类似于StringToListConverter   去转换User list集合挺麻烦的,我们可以对于StringToListConverter<T>构造成范型,如下代码

/**
 * @author  xieqx
 * date   2018/9/4
 * 将String 转换为list集合 范型的处理
 */
public class StringToListConverter<T>  implements Converter<String, List<T>> {

    @Override
    public List<T> convert(String json) {
        Type type  =  (Class < T > ) ((ParameterizedType) getClass().getGenericSuperclass()).getActualTypeArguments()[0];
        Class clazz = type.getClass();
        List<T> list = JsonUtil.str2List(json,clazz);
        return  list;
    }

}

需要解析Bean的集合形式只需继承即可

#解析OrderDetail 集合对象
public class StringToOrderDetailListConverter extends StringToListConverter<OrderDetail> {

}


#解析User 集合对象
public class StringToUserListConverter extends StringToListConverter<User> {

}

在spring中进行注册

@Configuration
public class SpringDataConvert {

    @Autowired
    private RequestMappingHandlerAdapter requestMappingHandlerAdapter;

    /**
     * 增加字符串转换为List集合
     */
    @PostConstruct
    public void addConversionConfig() {
        ConfigurableWebBindingInitializer initializer = (ConfigurableWebBindingInitializer) requestMappingHandlerAdapter.getWebBindingInitializer();
        if (initializer.getConversionService() != null) {
            GenericConversionService genericConversionService = (GenericConversionService)initializer.getConversionService();
   
   //添加转换OrderDetail 集合         
   genericConversionService.addConverter(new StringToOrderDetailListConverter());
   //添加转换User 集合
   genericConversionService.addConverter(new StringToUserListConverter());            

   //添加字符串转换为日期类型的字符串
   //genericConversionService.addConverter(new StringToDateConverter());

        }
    }
}

github  源码地址:https://github.com/liushangzaibeijing/TypeConvert.git

展开阅读全文

没有更多推荐了,返回首页