用string adapter来解决系统接口对接中发现的空值验证问题

技术博客

June 1, 2020

客户用的是很旧版本的ERP系统，在与客户系统做接口对接的时候发现了一个问题。假设接口请求需要的body是xml格式的，共有三个字段：name, mobile, email。由于客户ERP系统比较老，如果某个字段没有值，传的是空字符串，而不是将该字段在请求消息体中隐藏。客户发的请求类似下面的例子：

<xml>
    <name>John</name>
    <mobile>13800138000</mobile>
    <email></email>
</xml>

由于历史遗留问题，我方系统里在字段上面加了 javax.validation.constraints.Pattern 注解使用正则表达式来对传入的请求值做验证。当传入值为空字符串的时候，正则表达式验证就无法通过。

与客户做过沟通，对于空值的字段，他们也没有办法在请求中隐藏字段，只能传空字符串。那就只能在我方系统这边看看是否可以通过修改代码来解决。一种方案是修改正则表达式，来兼容空字符串，但是由于这些都是传统代码，不确定把空字符串设置在这个字段上面会对后面的处理会有什么影响。如果有更合适的、代价更小的方案，那么就最好不选择这种。

@XmlType
@XmlAccessorType(XmlAccessType.FIELD)
public class TestRequest implements Serializable {
    @XmlElement(required = true)
    private String name;

    @XmlElement(required = false)
    @Pattern(regexp = Constants.regexpMobile, message = "invalidMobile")
    private String mobile;

    @XmlElement(required = false)
    @Pattern(regexp = Constants.regexpEmail, message = "invalidEmail")
    private String email;

    // getter / setter
    ...
}

通过查阅相关资料，发现 javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter 注解可以达到目的。这个注解可以指定一个类，用于转换与处理xml请求中的字段值。这样，我们只需要自定义一个类，将传入空字符串值转换成null

首先，先定义一个XmlAdapter类

public class MyXmlStringAdapter extends XmlAdapter<String, String> {

    @Override
    public String marshal(String value) throws Exception {
        if ("".equals(value)) {
            return null;
        }

        return value;
    }

    @Override
    public String unmarshal(String value) throws Exception {
        if ("".equals(value)) {
            return null;
        }

        return value;
    }

}

然后，在相应的字段上面，使用前面定义好的XmlAdapter类。这样，xml解析器在转换请求的时候，会将空字符串转换成null，这样就认为该字段没有传值，不使用正则表达式做验证。

@XmlType
@XmlAccessorType(XmlAccessType.FIELD)
public class TestRequest implements Serializable {
    @XmlElement(required = true)
    private String name;

    @XmlElement(required = false)
    @Pattern(regexp = Constants.regexpMobile, message = "invalidMobile")
    @XmlJavaTypeAdapter(value = MyXmlStringAdapter.class, type = String.class)  // Use MyXmlStringAdapter
    private String mobile;

    @XmlElement(required = false)
    @Pattern(regexp = Constants.regexpEmail, message = "invalidEmail")
    @XmlJavaTypeAdapter(value = MyXmlStringAdapter.class, type = String.class)  // Use MyXmlStringAdapter
    private String email;

    // getter / setter
    ...
}

最后更新于 November 30, 2024