【问题标题】:Tools for Java template-based String construction基于 Java 模板的字符串构造工具
【发布时间】:2018-11-08 17:47:01
【问题描述】:

我正在尝试重构一些遗留代码。这里的任务是基于一些看起来像这样的预定义模板构造冗长的消息/字符串:

field1,8,String
filed2,5,Integer
field3,12,String
......

然后我得到一个包含所有这些字段的 java 对象。这里需要做的只是从对象字段中获取数据,并使用它们基于模板构造一个长消息/字符串。其中一些字段也可以根据一些简单的规则进行转换。例如:

abc => a
def => d
ghi => g

因此,我们需要不时检查这些字段的值。还有关于填充的规则(主要是在右侧添加空格)。因此构造的消息/字符串可能如下所示:

uater   4751 enterprise  ......

目前我们只是用蛮力来完成这项工作。首先,我们将模板输入到 ArrayList 中,每个元素都是一行,例如“field1,8,String”。在实际的消息构造过程中,我们循环遍历这个 ArrayList,然后将数据填充到一个 StringBuffer 中。这是一些示例 sn-p

StringBuffer message = new StringBuffer(1000);
for (String field : templateFields) {
    String[] fieldArray = field.split(Constants.SEPARATOR);
    if (fieldArray[0].equalsIgnoreCase(Constants.WORKFLOW)) {
        message.append(rightPad(object.getFieldOne(), Integer.parseInt(fieldArray[1])));
    } else if (fieldArray[0].equalsIgnoreCase(Constants.WORKVOLUME)) {
        message.append(rightPad(object.getFieldTwo(), Integer.parseInt(fieldArray[1]));
    } else if (fieldArray[0].equalsIgnoreCase(Constants.WORKTYPE)) {
        if (object.getFieldThree().equalsIgnoreCase("abc")) {
             message.append(rightPad("a", Integer.parseInt(fieldArray[1]));
        } else if (object.getFieldThree().equalsIgnoreCase("def")) {
             message.append(rightPad("d", Integer.parseInt(fieldArray[1]));
        } else {
            message.append(rightPad("g", Integer.parseInt(fieldArray[1]));
        }
    } else if ......
}

如您所见,尽管它很可怕,但它可以完成工作。但是这样的代码容易出错,并且难以维护。我想知道你们是否有任何工具或库或一些优雅的解决方案可以推荐。
非常感谢!华

【问题讨论】:

    标签: java string templates construction


    【解决方案1】:

    如果我正确理解您的问题,那么您有一种方法可以遍历可能的templateFields。没必要。

    由于每个fieldArray[0] 都与一些Constants 值进行比较,并且在进一步处理匹配的情况下,我们可以用Map 替换for 循环。它的键是可能的Constants 值,它的值是映射器。映射器是BiFunction,它接受objectfieldArray[1] 的值,并为这些返回String 类型的消息。

    让我们从映射器开始:

    public class FieldToMessageMapper {
    
        private static final Map<String, Function<String, String>> WORKINGTYPE_MESSAGE_MAPPER = new HashMap<>();
        static {
          WORKINGTYPE_MESSAGE_MAPPER.put("abc", fieldArray1 -> rightPad("a", Integer.parseInt(fieldArray1)));
          WORKINGTYPE_MESSAGE_MAPPER.put("def", fieldArray1 -> rightPad("d", Integer.parseInt(fieldArray1)));
          WORKINGTYPE_MESSAGE_MAPPER.put("DEFAULT", fieldArray1 -> rightPad("g", Integer.parseInt(fieldArray1)));
        }
    
        private static Map<String, BiFunction<MyObject, String, String>> MESSAGE_MAPPER = new HashMap<>();
        static {
          MESSAGE_MAPPER.put(Constants.WORKFLOW, (o, fieldArray1) -> rightPad(o.getFieldOne(), Integer.parseInt(fieldArray1)));
          MESSAGE_MAPPER.put(Constants.WORKVOLUME, (o, fieldArray1) -> rightPad(o.getFieldTwo(), Integer.parseInt(fieldArray1)));
          MESSAGE_MAPPER.put(Constants.WORKTYPE,
            (o, fieldArray1) -> WORKINGTYPE_MESSAGE_MAPPER.getOrDefault(o.getFieldThree().toLowerCase(), WORKINGTYPE_MESSAGE_MAPPER.get("DEFAULT")).apply(fieldArray1));
        }
    
        public static Optional<String> map(MyObject o, String fieldArray0, String fieldArray1) {
          return Optional.ofNullable(MESSAGE_MAPPER.get(fieldArray0.toLowerCase()))
            .map(mapper -> mapper.apply(o, fieldArray1));
        }
    
        private static String rightPad(String string, int pad) {
            // TODO right pad
            return string;
        }
      }
    

    我们不返回映射器本身。 FieldToMessageMapper 提供了进行映射的方法 map。它返回一个Optional&lt;String&gt;,表示如果输入没有映射,则结果可能为空。
    为了确保得到一个独立于字符大小写的映射器,所有键都是String..toLowerCase()

    让我们继续整体处理:

      protected StringBuffer process(Collection<String> templateFields, MyObject object) {
        StringBuffer message = new StringBuffer(1000);
        for (String field : templateFields) {
          String[] fieldArray = field.split(Constants.SEPARATOR);
          String msg = FieldToMessageMapper.map(object, fieldArray[0], fieldArray[1])
            .orElseThrow(() -> new IllegalArgumentException(String.format("Unsupported field %s", field)));
          message.append(msg);
        }
        return message;
      }
    

    我不知道您需要如何处理丢失的映射。我选择通过抛出异常快速失败。

    请注意:StringBuffer

    线程安全、可变的字符序列。字符串缓冲区就像 String,但可以修改。

    如果您的处理不是多线程的,您可以使用StringBuilder。如果结果没有进一步修改,您可以使用String

    让我展示另一个使用Stream 的替代方法,它返回String

      protected String process(Collection<String> templateFields, MyObject object) {
        return templateFields.stream()
          .map(field -> field.split(Constants.SEPARATOR))
          .map(fieldArray -> FieldToMessageMapper.map(object, fieldArray[0], fieldArray[1])
            .orElseThrow(() -> new IllegalArgumentException(String.format("Unsupported field %s", Arrays.toString(fieldArray)))))
          .collect(Collectors.joining());
      }
    

    如果我从问题中得到了正确的代码,应该有Constants的以下实现:

      public class Constants {
        public static final String SEPARATOR = ",";
        public static final String WORKFLOW = "field1";
        public static final String WORKVOLUME = "filed2";
        public static final String WORKTYPE = "field3";
      }
    

    编辑:

    如果你想有一种配置方法,你可以进一步详细说明这段代码以使用 Spring 配置:

    1. 定义一个接口MessageMapper,它有两个方法:String getKey()String map(MyObject o, String fieldArray1)getKey() 返回映射器为其提供映射的 Constants 值。
    2. 使用此接口实现上述每个MESSAGE_MAPPER
    3. 添加一个CommonMessageMapper,它有一个构造函数CommonMessageMapper(MessageMapper... messageMappers)messageMappers 必须放在 Map&lt;String, BiFunction&lt;MyObject, String, String&gt;&gt; mappers 中,例如:mappers.put(messageMapper.getKey(), messageMapper)。定义一个方法String map(MyObject o, String fieldArray0, String fieldArray1),它将使用fieldArray0MessageMapper mm = mappers.get(fieldArray0)查找适当的MessageMapper mm。然后调用mm.map(o, feldArray1)。 (您也可以在此处使用Optional 来处理没有合适映射器的情况。)
    4. 要使用 Spring 配置,所有 MessageMapperCommonMessageMapper 必须注释为 BeanComponentCommonMessageMapper的构造函数必须用@Autowired注解。
    5. 定义一个 Spring 配置(使用 XML 或 @Configuration),它将所需的 MessageMapper 注入到 CommonMessageMapper 中,并为此类 CommonMessageMapper 提供工厂方法。
    6. 使用CommonMessageMapper 而不是上面的FieldToMessageMapper

    【讨论】:

    • 非常感谢卢西奥!我希望主要通过配置来完成这项工作。但我也很喜欢你的解决方案!
    • @Hua 我已经更新了我的答案,展示了如何详细说明我的配置方法。
    • 谢谢卢西奥!我真的很感激!
    • 是的。刚刚做了!再次感谢!
    • 感谢您的upvote。很高兴我能提供帮助。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2015-06-28
    • 1970-01-01
    • 2021-04-23
    • 1970-01-01
    • 2016-10-30
    相关资源
    最近更新 更多