SpringBoot 自定义 HandlerMethodArgumentResolver 搞定xml泛型参数解析

最新推荐文章于 2024-05-16 09:49:07 发布
最新推荐文章于 2024-05-16 09:49:07 发布
阅读量1.2k 收藏 17
点赞数 16
分类专栏： # SpringBoot 文章标签： SpringBoot xml xml解析 SpringMVC
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_40979518/article/details/138329198
版权

文章目录

介绍

在 SpringBoot 应用中，自带的 json 序列化框架是 fastxml-jackson。引入 jackson 的jackson-dataformat-xml包后，配合Bean上的jackson XML注解就可以自动的将 XML 请求参数进行反序列化，将返回对象进行序列化。

但是对于包含泛型的对象参数，由于泛型的擦除机制程序运行时无法得知泛型内容自然也就无法正确的将 XML 请求参数反序列化成指定的 Java 对象了。这时候想要正确解析，就得手动告诉 jackson 我想反序列化的对象是什么类型。本篇博客通过手写一个自定义的HandlerMethodArgument 来实现泛型对象的请求参数解析。

程序源代码下载 demoxml.rar


一、解析简单 xml 数据案例

目标，使用 Controller 将传入的 Message XML 格式数据解析成 Java 对象。
请求的 XML 格式

<Request>
  <MessageHeader>
    <Sender>EMSS</Sender>
    <Receiver>ESB</Receiver>
    <SendTime>20240401145010</SendTime>
    <EventType>EMSS_SDZX</EventType>
    <MsgId>8952f937-2f36-41b4-af71-2742fde43f09</MsgId>
  </MessageHeader>
</Request>

引入 Jackson 的 xml 支持

<dependency>
  <groupId>com.fasterxml.jackson.dataformat</groupId>
  <artifactId>jackson-dataformat-xml</artifactId>
</dependency>

定义 Message 对象&MessageHeader 对象

使用 JacksonXMLxxxx 的注解对对象进行标记。

@Data
@AllArgsConstructor
@NoArgsConstructor
@JacksonXmlRootElement(localName="Request")
public class Message {

    @JacksonXmlProperty(localName = "MessageHeader")
    private MessageHeader messageHeader;

}

@Data
public class MessageHeader {

    /**
     *必填 发送应用程序 例如HIS
     */
    @JacksonXmlProperty(localName = "Sender")
    private String sender;

    /**
     *必填 接收应用程序
     */
    @JacksonXmlProperty(localName = "Receiver")
    private String receiver;

    /**
     *必填 消息创建时间 格式：YYYY-MM-DD HH:MM:SS
     */
    @JacksonXmlProperty(localName = "SendTime")
    private String sendTime;

    /**
     * 必填 事件类型 例如 ACK_PCA_SEARCH_ARCH
     */
    @JacksonXmlProperty(localName = "EventType")
    private String eventType;

    /**
     *必填 消息ID 建议用UUID生成
     */
    @JacksonXmlProperty(localName = "MsgId")
    private String msgId;

}

定义 Controller 方法

@Data
@AllArgsConstructor
@NoArgsConstructor
@JacksonXmlRootElement(localName="Request")
public class Message<T extends MessageBody> {

    @JacksonXmlProperty(localName = "MessageHeader")
    private MessageHeader messageHeader;


    @JacksonXmlProperty(localName = "MessageBody")
    private T messageBody;

}

调用结果

可以看到 XML 参数可以被正确序列化和反序列化
image.png



二、解析带泛型的 XML 数据案例

2.1 直接给 Message 加上泛型 T

@Data
@AllArgsConstructor
@NoArgsConstructor
@JacksonXmlRootElement(localName="Request")
public class Message<T extends MessageBody> {

    @JacksonXmlProperty(localName = "MessageHeader")
    private MessageHeader messageHeader;


    @JacksonXmlProperty(localName = "MessageBody")
    private T messageBody;

}


@Data
public class MessageBody implements Serializable {
    
}

定义 MessageBody 的一个实现类 AnkeUpdatePatientLocaBody

/**
 * @author Jean
 * @date 2024/04/16
 */
@Data
public class AnkeUpdatePatientLocaBody extends MessageBody {
    /**
     *ankeid
     */
    @JacksonXmlProperty(localName = "AnkeId")
    private String ankeId;

    /**
     *经度，不能为空
     */
    @JacksonXmlProperty(localName = "Longitude")
    private String longitude;

    /**
     *纬度，不能为空
     */
    @JacksonXmlProperty(localName = "Latitude")
    private String latitude;

}

2.2 无法直接解析泛型参数了

1714402604488.png
可以看到 Controller 方法的 Message 泛型参数没有被正确的解析出来。为什么呢，因为泛型参数只存在于编译期，运行时程序并没有保存泛型数据。所有的泛型参数都会被擦除被替换为其上限类型（没有则替换为 Object）类型。不过虽然运行时没有泛型参数，但是类和方法上的泛型声明仍然可以通过反射获取到。



三、自定义 MVC 的参数解析器实现泛型参数解析

MVC 的消息解析器和方法参数解析器介绍

  1. 消息转换器(HttpMessageConverter):
    • 当请求到达并且需要读取请求体内容时，如使用@RequestBody注解的参数，Spring MVC会根据consumes指定的媒体类型，选择合适的HttpMessageConverter来将请求体中的数据（如JSON、XML）转换为Java对象。
    • 在响应阶段，如果Controller方法返回一个对象，并且需要转换为HTTP响应体（比如使用@ResponseBody注解），Spring会使用相应的HttpMessageConverter将Java对象转换为指定格式（如JSON、XML）的数据写入响应体。
  2. 消息解析器(HandlerMethodArgumentResolver):
  • 在调用Controller方法之前，Spring MVC会根据方法签名中的参数类型和注解，选择合适的HandlerMethodArgumentResolver来解析和填充参数。例如，对于@PathVariable、@RequestParam、@RequestHeader等注解的参数，Spring会使用对应的解析器来获取请求中的参数值。
  • 对于@RequestBody注解的参数，虽然实际的数据转换是由HttpMessageConverter完成，但触发这个转换的决策过程是在RequestBodyArgumentResolver（它是HandlerMethodArgumentResolver的一种）中进行的，它负责判断参数是否标记了@RequestBody，然后调用对应的HttpMessageConverter来处理请求体数据。

让 MVC 解析泛型参数的方案

  1. jackson 无法解析泛型 XML 参数的原因是因为泛型被擦除，jackson 也没有针对泛型做其他处理方案
  2. 我们写代码的时候是知道具体的类型的，我们通过某种防范将泛型类告诉 jackson 就行了
  3. jackson 负责实现 XMl 字符串解析成 Java 对象的过程，那我们自定义一个**HandlerMethodArgumentResolver **来实现泛型参数解析不就行了吗

具体方案

定义一个类似@RequestBody的注解，来关联我们自定义的HandlerMethodArgumentResolver
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface XmlGenerics {
    //用来保存泛型信息
    Class<? extends MessageBody> value();
}
自定义HandlerMethodArgumentResolver 来实现将我们自定义注解中的泛型类告诉 JackSon-xml

这里为了方便直接写了 Message.class，如果需要通用只需要改成根据 controller 方法来获取参数类型即可

/**
 *
 * 自定义一个请求参数消息解析器，解析Message类型的Xml请求数据不走@RequestBody的解析器
 * 1.请求方法参数中使用了泛型后 jackson-xml 无法正确的反序列化,因为泛型抹除后无法获知具体的泛型类型。
 * 2.此处使用自定义注解保存泛型信息来进行反序列化参数。
 * <p>
 * {@link RequestResponseBodyMethodProcessor}  @RequestBody方法解析器
 * {@link org.springframework.boot.autoconfigure.http.JacksonHttpMessageConvertersConfiguration} jackson-xml的消息转换器的自动配置
 *
 * @author
 * @date 2024/04/16 17:22
 */
public class XmlMessageResolver implements HandlerMethodArgumentResolver {
    //用来解析xml的Mapper
    private final XmlMapper xmlMapper = new XmlMapper();

    public XmlMessageResolver() {
        //配置xmlMapper遇到未知属性时忽略，而不是报错
        xmlMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
    }

    /**
     * supports参数
     *
     * @param parameter 参数
     * @return boolean
     */
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        boolean support = parameter.hasParameterAnnotation(XmlGenerics.class) && parameter.getParameterType().equals(Message.class);
        return support;
    }

    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
                                  NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        //读取请求体
        HttpServletRequest servletRequest = webRequest.getNativeRequest(HttpServletRequest.class);
        String requestBody = StreamUtils.copyToString(servletRequest.getInputStream(), StandardCharsets.UTF_8);

        //获取注解参数中标识的泛型类型
        XmlGenerics parameterAnnotation = parameter.getParameterAnnotation(XmlGenerics.class);
        Class<? extends MessageBody> genericClass = parameterAnnotation.value();

        //构造类型参考对象
        TypeReference<Message<?>> typeRef = new TypeReference<Message<?>>() {
            @Override
            public Type getType() {
                return new ParameterizedType() {
                    //指定泛型实际参数，来自注解中的class标识
                    @Override
                    public Type[] getActualTypeArguments() {
                        return new Type[]{genericClass};
                    }

                    //获取参数类型
                    @Override
                    public Type getRawType() {
                        return Message.class;
                    }

                    //标识泛型参数所属的内部类类型，这里不包含内部类直接返回NULL
                    @Override
                    public Type getOwnerType() {
                        return null;
                    }
                };
            }
        };
        //使用参考类型来反序列化XML请求数据
        Message<?> message = xmlMapper.readValue(requestBody, typeRef);
        return message;
    }

}
注入我们自己写的方法参数解析器
@Configuration
public class WebConfig implements WebMvcConfigurer {

    // ... 上面的HttpMessageConverter配置...
    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        argumentResolvers.add(0, new XmlMessageResolver());
        System.out.println("注入完成");
    }
}

测试效果

将@RequestBody 改成我们自定义的注解@XmlGenerics
@RestController
public class AnkeDataReceiverController {

    /**
     * 接收xml消息
     *
     * @return {@link Message}
     */
    @PostMapping(value = "/test", consumes = MediaType.APPLICATION_XML_VALUE, produces = MediaType.APPLICATION_XML_VALUE)
    public Message pushPatientDataToJjld(@XmlGenerics(AnkeUpdatePatientLocaBody.class) Message<AnkeUpdatePatientLocaBody> message) {
        AnkeUpdatePatientLocaBody messageBody = message.getMessageBody();
        System.out.println(messageBody);
        return message;
    }
}
结果成功解析

image.png



四、你可能存在的一些疑问

为什么响应的时候不需要加泛型 Jackson 都可以正确的进行序列化

因为响应的时候，已经存在对象了，可以直接获取到对象及其参数的真实类型。所以反序列化不会存在这种问题

栗子叶
关注
  • 16
    点赞
  • 踩
  • 17
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
springboot工程自定义response注解、自定义规范化返回数据结构
09-02
springboot工程通过自定义response注解、java反射机制、自定义java拦截器、自定义功能类实现WebMvcConfigurer接口等功能，实现自定义规范化返回数据结构。
SpringBoot自定义参数解析器HandlerMethodArgumentResolver（解析ip）
baiqi123456的博客
11-16 574
RequestMappingHandlerAdapter 初始化时，会准备 HandlerMethod 调用时需要的各个组件，如： HandlerMethodArgumentResolver 解析控制器方法参数 HandlerMethodReturnValueHandler 处理控制器方法返回值
SpringBoot实现HandlerMethodArgumentResolver（自定义参数解析器）
moxiaomo0804的博客
11-15 1893
对Controller层请求参数进行处理 自定义注解 @Documented @Target({ElementType.PARAMETER}) @Retention(RetentionPolicy.RUNTIME) public @interface CommonParams { String[] params() default {}; } 自定义参数解析器 ...
springboot中解析自定义xml配置文件
weixin_42741254的博客
02-18 3389
项目中可以使用xml配置文件使开发简便，其他开发者可以填入自己的配置，需要有一个配置类和一个xml的实体类 xml文件如下： <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <xmlconfig> <policys policyId="MH6817"> <beanName></beanName> <consumerTopic>&
SpringBoot 返回自定义的xml
Fu_fly的博客
12-06 2240
一般方法 SpringBoot 默认返回格式是json，现在项目中需要后台返回xml格式的数据，通常做法是加入依赖 jackson-dataformat-xml &lt;dependency&gt; &lt;groupId&gt;com.fasterxml.jackson.dataformat&lt;/groupId&gt; &lt;artifactId&gt;jac...
springBoot 自定参数解析器（HandlerMethodArgumentResolver）
cmqwan的博客
11-05 8280
spring 自定参数解析器（HandlerMethodArgumentResolver） 由于之前用@RequestParam无法接收request payload 正文格式为json格式的字符串，只能使用@RequestBody整个接收，觉得麻烦，但是spring自带的参数解析器不具有这种功能，只能尝试着用自定义参数解析器去解决。 自定义解析器需要实现HandlerMethodArgument...
springboot 自定义注解（含源码）
热门推荐
杨先森的专栏
03-04 2万+
spring注解 一般在记录日志、定时器中使用非常方便，在springmvc框架广泛应用，可以注解的随处可见，近几年流行的springboot框架，更把注解用到了极致，这框架的基本消灭了大部分传统框架上xml配制后改为注解代替，既然注解这么使用这么多，那么如何自定义注解呢 以下例子以springboot中使用自定义注解来简单讲解（源码地址：https://gitee.com/xing_xin/my...
SpringBoot 自定义logback.xml打印日志
Simon's Blog
03-21 2232
SpringBoot 自定义logback.xml打印日志 pringBoot默认的日志组合为slf4j + logback，但是默认配置是日志只输出在控制台，在实际项目中我们需要输出到指定的log文件才便于日后的日志定位。 实践 在无任何配置的前提下，只要我们引入了SpringBoot的包，就可以直接使用日志的功能。 SpringBoot会默认去加载resources下名为logback.xml 或者 logback-spring.xml的配置文件 自定义logback.xml文件：
SpringBoot自定义注解接收json参数
qq_41289165的博客
11-23 1638
SpringBoot如果接受json参数的话需要定义实体类然后使用@RequestBody注解，但是如果每个接口都创建一个实体类的话太麻烦，因此可以使用自定义注解的方法接收。从网上发现了这篇博客，解决了一个大大的疑惑。。转载： 大佬的博客 RequestJson package com.school.service.config; import java.lang.annotation...
springboot使用自定义的xml和properties文件
weixin_43968372的博客
03-08 1118
springboot使用自定义的xml文件：https://blog.csdn.net/gwd1154978352/article/details/79122863?depth_1-utm_source=distribute.pc_relevant.none-task&utm_source=distribute.pc_relevant.none-task springboot使用自定义的p...
python自定义解析简单xml格式文件的方法
09-22
主要介绍了python自定义解析简单xml格式文件的方法,涉及Python解析XML文件的相关技巧,非常具有实用价值,需要的朋友可以参考下
xml解析文件的两种方式
08-23
使用SAX DOM两种解析方式解析文件
springboot mybatis mapper.xml 配置
06-22
springboot mybatis mapper.xml 配置，里面包含了新增，修改，删除，查询，分页查询例子以及通过 网页访问的例子
XML使用与解析
最新发布
weixin_44201223的博客
05-16 260
XML介绍 XML使用DOM4J解析
XMl发展前景及相关领域
wsl3465205046的博客
05-11 417
随着互联网和信息技术的不断发展，XML将继续发挥其重要的作用，为数据交换、系统集成和数据处理等领域提供解决方案。数据交换和存储：XML提供了一种通用的数据格式，可以用于在不同系统之间交换数据，同时也可以作为一种存储数据的格式。数据分析和处理：XML提供了一种结构化的数据表示方式，可以用于数据的分析和处理。通过使用XML，可以更方便地进行数据的查询、过滤和转换等操作，提升数据处理的效率和灵活性。数据标准化和集成：XML可以用于定义和描述数据的结构和格式，使得不同系统之间可以更易于集成和共享数据。
android xml 定义渐变色背景
dengfuma的专栏
05-11 344
android xml 定义渐变色背景
XML元素
wsl3465205046的博客
05-11 257
【代码】XML元素。
XML标记语言
wsl3465205046的博客
05-11 284
它是一种通用的框架，可以用来设计和实现各种不同的标记语言，如HTML、XML和SGML。通用标记语言的一个重要特点是它的可扩展性，可以通过添加新的元素和属性来扩展标记语言的功能和表达能力。XML使用自定义的标记来组织和嵌套数据，这些标记以尖括号（< >）包围，并且可以使用属性来提供关于数据的其他信息。它使用特定的标记标签来包围和标识文本中的元素，从而使计算机能够理解和解释这些元素的含义。它不是一种具体的数据格式，而是一种用于定义其他数据格式的元语言，也就是说，它可以用来定义各种各样的数据格式。
springboot自定义请求参数校验
05-17
在 Spring Boot 中，可以使用 Hibernate Validator 来进行请求参数校验。具体步骤如下： 1. 引入 Hibernate Validator 依赖： ```xml <dependency> <groupId>org.hibernate.validator</groupId> <artifactId>hibernate-validator</artifactId> <version>6.1.5.Final</version> </dependency> ``` 2. 在需要校验的请求参数实体类中添加校验注解，例如： ```java public class User { @NotBlank(message = "用户名不能为空") private String username; @NotBlank(message = "密码不能为空") private String password; @Email(message = "邮箱格式不正确") private String email; // 省略 getter 和 setter 方法 } ``` 3. 在请求处理方法中添加 @Validated 注解，并在参数上添加 @Valid 注解，例如： ```java @RestController @RequestMapping("/user") @Validated public class UserController { @PostMapping("/login") public Result login(@RequestBody @Valid User user) { // 处理登录逻辑 } } ``` 4. 当请求参数不符合校验规则时，会抛出 ConstraintViolationException 异常。可以在全局异常处理器中对该异常进行处理，例如： ```java @RestControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(ConstraintViolationException.class) public Result handleConstraintViolationException(ConstraintViolationException e) { List<String> errorMessages = e.getConstraintViolations().stream() .map(ConstraintViolation::getMessage) .collect(Collectors.toList()); return Result.error(String.join(",", errorMessages)); } } ``` 这样就可以自定义请求参数校验了。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值