如何为Java REST接口添加可选XML请求体兼容旧客户端？

针对你遇到的XML空请求体触发400错误的问题，核心原因是JAXB无法将空内容解析为DueDatesDetails对象，而JSON解析器默认会将空请求体映射为null。以下是几种可行的兼容方案：

方案一：自定义JAXB异常映射器 #

通过捕获JAXB解析空内容的异常，将其转换为null参数传递给接口方法，避免返回400：

import javax.ws.rs.core.Response;
import javax.ws.rs.ext.ExceptionMapper;
import javax.ws.rs.ext.Provider;
import javax.xml.bind.UnmarshalException;

@Provider
public class JAXBEmptyBodyExceptionMapper implements ExceptionMapper<UnmarshalException> {
    @Override
    public Response toResponse(UnmarshalException exception) {
        // 判断是否为空请求体导致的解析失败
        if (exception.getCause() instanceof org.xml.sax.SAXParseException) {
            org.xml.sax.SAXParseException saxEx = (org.xml.sax.SAXParseException) exception.getCause();
            if (saxEx.getMessage().contains("premature end of file")) {
                // 返回正常响应，框架会将参数设为null
                return Response.ok().build();
            }
        }
        // 其他解析异常仍返回400
        return Response.status(Response.Status.BAD_REQUEST).entity(exception.getMessage()).build();
    }
}

同时修改接口方法，明确标记参数为可选：

@POST
@Path("/sites/{siteid}/filestatus")
@Consumes({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
public Response linkContent(
        @ApiParam(value = "site id", required = true) @PathParam("siteid") String siteId,
        @ApiParam(value = "status", required = true) @QueryParam("status") String status,
        @ApiParam(value = "Due dates details", required = false) DueDatesDetails dueDatesDetails) {
    // 空请求体时dueDatesDetails为null，执行原有逻辑
    if (dueDatesDetails == null) {
        // 原有业务代码
    } else {
        // 新增的请求体处理逻辑
    }
    // ...
}

方案二：自定义XML消息体读取器 #

直接拦截XML请求体的读取流程，为空请求体返回null：

import javax.ws.rs.Consumes;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.ext.MessageBodyReader;
import javax.ws.rs.ext.Provider;
import java.io.IOException;
import java.io.InputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;

@Provider
@Consumes(MediaType.APPLICATION_XML)
public class EmptyXmlBodyReader implements MessageBodyReader<DueDatesDetails> {

    @Override
    public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
        return type == DueDatesDetails.class;
    }

    @Override
    public DueDatesDetails readFrom(Class<DueDatesDetails> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String, String> httpHeaders, InputStream entityStream) throws IOException {
        // 检查请求体是否为空
        entityStream.mark(1);
        if (entityStream.read() == -1) {
            return null;
        }
        // 非空请求体交给默认JAXB解析
        entityStream.reset();
        try {
            return javax.xml.bind.JAXBContext.newInstance(type).createUnmarshaller().unmarshal(entityStream);
        } catch (Exception e) {
            throw new IOException(e);
        }
    }
}

关键注意事项 #

• 确保DueDatesDetails类有无参构造器（JAXB默认要求，若使用Lombok的@Getter/@Setter会自动生成）。
• 自定义的@Provider类需被JAX-RS框架扫描到（Spring Boot环境下只需放在可扫描包内即可）。
• 测试原有XML客户端发送空请求体的场景，确认参数能被正确设为null且返回正常响应。

内容的提问来源于stack exchange，提问作者Alex