用Java漂亮打印地图

我正在寻找一种漂亮地打印的好方法Map。

map.toString() 给我： {key1=value1, key2=value2, key3=value3}

我希望地图输入值具有更大的自由度，并且正在寻找更多类似这样的东西： key1="value1", key2="value2", key3="value3"

我写了这段代码：

StringBuilder sb = new StringBuilder();
Iterator<Entry<String, String>> iter = map.entrySet().iterator();
while (iter.hasNext()) {
    Entry<String, String> entry = iter.next();
    sb.append(entry.getKey());
    sb.append('=').append('"');
    sb.append(entry.getValue());
    sb.append('"');
    if (iter.hasNext()) {
        sb.append(',').append(' ');
    }
}
return sb.toString();

但是我敢肯定，这样做的方式更加优雅简洁。

或将您的逻辑放在一个整洁的小班上。

public class PrettyPrintingMap<K, V> {
    private Map<K, V> map;

    public PrettyPrintingMap(Map<K, V> map) {
        this.map = map;
    }

    public String toString() {
        StringBuilder sb = new StringBuilder();
        Iterator<Entry<K, V>> iter = map.entrySet().iterator();
        while (iter.hasNext()) {
            Entry<K, V> entry = iter.next();
            sb.append(entry.getKey());
            sb.append('=').append('"');
            sb.append(entry.getValue());
            sb.append('"');
            if (iter.hasNext()) {
                sb.append(',').append(' ');
            }
        }
        return sb.toString();

    }
}

用法：

Map<String, String> myMap = new HashMap<String, String>();

System.out.println(new PrettyPrintingMap<String, String>(myMap));

注意：您也可以将该逻辑放入实用程序方法中。

Arrays.toString(map.entrySet().toArray())

看一下Guava库：

Joiner.MapJoiner mapJoiner = Joiner.on(",").withKeyValueSeparator("=");
System.out.println(mapJoiner.join(map));

抢救Apache库！

MapUtils.debugPrint(System.out, "myMap", map);

所有您需要的Apache commons-collections库（项目链接）

Maven用户可以使用以下依赖关系添加库：

<dependency>
    <groupId>commons-collections</groupId>
    <artifactId>commons-collections</artifactId>
    <version>3.2.1</version>
</dependency>

简单容易。欢迎来到JSON世界。使用Google的Gson：

new Gson().toJson(map)

具有3个按键的地图示例：

{"array":[null,"Some string"],"just string":"Yo","number":999}

当我org.json.JSONObject在类路径中时，我会做：

Map<String, Object> stats = ...;
System.out.println(new JSONObject(stats).toString(2));

（这个缩进的列表，集合和映射可以缩进精美）

使用Java 8流：

Map<Object, Object> map = new HashMap<>();

String content = map.entrySet()
                    .stream()
                    .map(e -> e.getKey() + "=\"" + e.getValue() + "\"")
                    .collect(Collectors.joining(", "));

System.out.println(content);

我更喜欢将地图转换为JSON字符串：

• 一个标准
• 可读
• 在Sublime，VS Code等编辑器中受支持，并具有语法突出显示，格式设置和部分隐藏/显示的功能
• 支持JPath，因此编辑者可以准确报告您导航到的对象的哪一部分

• 支持对象内的嵌套复杂类型

  import com.fasterxml.jackson.core.JsonProcessingException;
  import com.fasterxml.jackson.databind.ObjectMapper;
  
  public static String getAsFormattedJsonString(Object object)
  {
      ObjectMapper mapper = new ObjectMapper();
      try
      {
          return mapper.writerWithDefaultPrettyPrinter().writeValueAsString(object);
      }
      catch (JsonProcessingException e)
      {
          e.printStackTrace();
      }
      return "";
  }

查看OpenJDK源代码中的HashMap#toString()和代码AbstractMap#toString()：

class java.util.HashMap.Entry<K,V> implements Map.Entry<K,V> {
       public final String toString() {
           return getKey() + "=" + getValue();
       }
   }
 class java.util.AbstractMap<K,V> {
     public String toString() {
         Iterator<Entry<K,V>> i = entrySet().iterator();
         if (! i.hasNext())
            return "{}";

        StringBuilder sb = new StringBuilder();
        sb.append('{');
        for (;;) {
            Entry<K,V> e = i.next();
            K key = e.getKey();
            V value = e.getValue();
            sb.append(key   == this ? "(this Map)" : key);
            sb.append('=');
            sb.append(value == this ? "(this Map)" : value);
            if (! i.hasNext())
                return sb.append('}').toString();
            sb.append(", ");
        }
    }
}

因此，如果OpenJDK的家伙没有找到更优雅的方式来做到这一点，那就没有了:-)

您应该可以通过以下方式做自己想做的事情：

System.out.println(map) 例如

只要您在地图中的所有对象都覆盖了toString您将看到的方法：
{key1=value1, key2=value2}以一种有意义的方式

如果这是为了您的代码，则覆盖toString是一个好习惯，我建议您改为这样做。

对于您的对象为Strings的示例，您应该没有其他问题。
即System.out.println(map)无需任何额外的代码即可准确打印您所需的内容

public void printMapV2 (Map <?, ?> map) {
    StringBuilder sb = new StringBuilder(128);
    sb.append("{");
    for (Map.Entry<?,?> entry : map.entrySet()) {
        if (sb.length()>1) {
            sb.append(", ");
        }
        sb.append(entry.getKey()).append("=").append(entry.getValue());
    }
    sb.append("}");
    System.out.println(sb);
}

我想类似的东西会更干净，并为您提供更大的输出格式灵活性（只需更改模板）：

    String template = "%s=\"%s\",";
    StringBuilder sb = new StringBuilder();
    for (Entry e : map.entrySet()) {
        sb.append(String.format(template, e.getKey(), e.getValue()));
    }
    if (sb.length() > 0) {
        sb.deleteCharAt(sb.length() - 1); // Ugly way to remove the last comma
    }
    return sb.toString();

我知道必须删除最后一个逗号很丑陋，但我认为它比这种解决方案中的替代方法或手动使用迭代器的方法更干净。

作为利用现有基础架构的快速而肮脏的解决方案，您可以将其包装uglyPrintedMap成java.util.HashMap，然后使用toString()。

uglyPrintedMap.toString(); // ugly
System.out.println( uglyPrintedMap ); // prints in an ugly manner

new HashMap<Object, Object>(jobDataMap).toString(); // pretty
System.out.println( new HashMap<Object, Object>(uglyPrintedMap) ); // prints in a pretty manner

不能完全回答问题，但是值得一提的是Lombodok @ToString 批注。如果您有注释@ToString的key / value类，然后做System.out.println(map)将返回有意义的事。

它也适用于地图地图，例如： Map<MyKeyClass, Map<String, MyValueClass>>将打印为

{MyKeyClass(properties...)={string1=MyValuesClass(properties...), string2=MyValuesCalss(properties...),..}, ... }

String result = objectMapper.writeValueAsString(map) -就这么简单！

结果：

{"2019-07-04T03:00":1,"2019-07-04T04:00":1,"2019-07-04T01:00":1,"2019-07-04T02:00":1,"2019-07-04T13:00":1,"2019-07-04T06:00":1 ...}

PS将Jackson JSON添加到您的类路径中。

从Java 8开始，使用Lambda可以轻松实现：

yourMap.keySet().forEach(key -> {
    Object obj = yourMap.get(key);
    System.out.println( obj);
}