转载

飞哥讲代码6：消除重复，需要配置代码分离

案例

下面的代码来自我们某一平台产品前端源码(Java语言)中：

private static Map<String, Map<String, String>> constructConstrainMap() {
    Map<String, Map<String, String>> typeConstrainMap = new HashMap<String, Map<String, String>>();
    Map<String, String> imageConstrainPatternMap = new HashMap<String, String>();
    imageConstrainPatternMap.put("allowdPatten", "^[a-zA-Z0-9_~.=@-]$");
    imageConstrainPatternMap.put("allowdMin", "1");
    imageConstrainPatternMap.put("allowdMax", "256");
    imageConstrainPatternMap.put("allowdValue", null);
    imageConstrainPatternMap.put("noEcho", "false");
    imageConstrainPatternMap.put("description", "com.huawei.....");
    typeConstrainMap.put(TPropType.IAA_S_IMAGE_ID.value(), imageConstrainPatternMap)

    Map<String, String> netWorkConstrainPatternMap = new HashMap<String, String>();
    // 省略 put ...

    Map<String, String> containerConstrainPatternMap = new HashMap<String, String>();
    // 省略 put ...

    // 省略 其它的Constrain代码 ...
}

上面的代码在一个方法中构造了16个Constrain，它是提供给BME控件用于输入框的校验。显然代码出现了重复（相似），也较容易想到采用外部配置文件方式来简化样板代码，但采用什么配置方式呢？

对于较老的代码，可以选择XML，Properties。
对于基于SpringBoot框架开发的代码，有更多的选择，还可以是JSON与YAML。

无论哪种配置文件格式，解释库几乎都提供配置内容直接到Java对象的映射。比如XML，JDK1.6起提供JAXB(Java Architecture for XML Binding)来序列化与反序列化XML文件。不过由于XML技术过于古老，JDK11把JAXB从标准模块移除了，需要额外引入依赖或使用Jackson的JAXB能力。倘若使用DOM或SAX来解释XML，要写的代码有些多，也容易出错，直观感觉还不如上面一行一行代码写死配置内容来得快。而采用JAXB，定义映射结构类加上解释代码，也就20行左右代码可以搞定。那我们来尝试优化一下此案例代码：

第一步，定义XML的格式：

<Constrains>
    <Constrain id="image" allowdPatten="^[a-zA-Z0-9_~.=@-]$" allowdMin="1" allowdMax="256" noEcho="false" description="com...">
    <Constrain id="network" allowdPatten="^[a-zA-Z0-9_]$" allowdMin="1" allowdMax="256" noEcho="false" allowdValue="local/external" description="com...">
    <!--省略其它的-->
</Constrains>

第二步，定义Java类结构：

@XmlAccessorType(XmlAccessType.FIELD)
@Getter
@Setter
public class Constrain {
    @XmlAttribute(name="id")
    private String id;
    @XmlAttribute(name="allowdPatten")
    private String allowdPatten;
    @XmlAttribute(name="allowdMin")
    private int allowdMin;
    @XmlAttribute(name="iallowdMaxd")
    private int allowdMax;
    @XmlAttribute(name="noEcho")
    private boolean noEcho;
    @XmlAttribute(name="allowdValue")
    private String allowdValue;
    @XmlAttribute(name="description")
    private String description;
}

@XmlRootElement(name="Constrains")
@Getter
@Setter
public class Constrains {
    @XmlElement(name = "Constrain")
    protected List<Constrain> items;
}

第三步，解释配置文件

try (InputStream is = new FileInputStream("constrains.xml")) {
    JAXBContext jc = JAXBContext.newInstance(Constrains.class);
    Unmarshaller unmarshaller = jc.createUnmarshaller();
    Constrains constrains = (Constrains)unmarshaller.unmarshal(is)
}

不过上面的代码有两个坑：

JAXBContext不能每次都new，存在Class泄露(注：以前在JDK1.7版本遇到过，不知1.8以后是否还存在)，它是线程安全的，只要new一次即可在不同的线程中使用。
可能存在XML的外部实体注入攻击，虽然配置文件不直接暴露给外部，从公司可信代码要求来看，存在风险。

再优化一下:

// JAXBContext jc = JAXBContext.newInstance(Constrains.class); 在初始化或静态区中确保jc只new一次
XMLInputFactory xif = XMLInputFactory.newFactory();
xif.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, false); // 关闭外部实体解释支持
xif.setProperty(XMLInputFactory.SUPPORT_DTD, false); // 注：视情况true/false，当存在DTD，可以由DTD检查XML合法性，请参考要相关文档
try (XMLStreamReader xsr = xif.createXMLStreamReader(new FilterInputStream("constrains.xml"), "UTF-8")) {
    Unmarshaller unmarshaller = jc.createUnmarshaller();
    Constrains constrains = (Constrains)unmarshaller.unmarshal(xsr)
}