java - Pack200/Network Transfer Format Spec SourceDebugExtension 属性的格式规范

Question

如果您尝试使用 pack200 打包 spring-context 5.0.1.RELEASE JAR，打包程序会提示它不知道从 Kotlin 类编译的几个类中使用的类属性 SourceDebugExtension。

<小时/>

JSR-045将此属性定义为

The SourceDebugExtension attribute is an optional attribute in the attributes table of the ClassFile structure. There can be no more than one SourceDebugExtension attribute in the attributes table of a given ClassFile structure.

The SourceDebugExtension attribute has the following format:


    SourceDebugExtension_attribute {
       u2 attribute_name_index;
       u4 attribute_length;
       u1 debug_extension[attribute_length];
    }

The items of the SourceDebugExtension_attribute structure are as follows:

attribute_name_index
    The value of the attribute_name_index item must be a valid index into the constant_pool table. The constant_pool entry at that index must be a CONSTANT_Utf8_info structure representing the string "SourceDebugExtension".

attribute_length
    The value of the attribute_length item indicates the length of the attribute, excluding the initial six bytes. The value of the attribute_length item is thus the number of bytes in the debug_extension[] item.

debug_extension[]
    The debug_extension array holds a string, which must be in UTF-8 format. There is no terminating zero byte.

    The string in the debug_extension item will be interpreted as extended debugging information. The content of this string has no semantic effect on the Java Virtual Machine.

<小时/>

Network Transfer Format Spec定义了如何定义这些属性的格式，以便pack200可以处理它们。

<小时/>

Pack200 允许跳过具有这些属性的文件或丢弃这些属性或根据网络传输格式规范定义其格式。不幸的是，我没有获得正确的格式说明符，无法正确解析属性。需要通过格式说明符匹配的实际数据的 Hexdump 示例 - 即 debug_extension[] 的值是

00000b90:                   53 4d  41 50 0a 42 65 61 6e 44 ;      SMAP.BeanD
00000ba0: 65 66 69 6e 69 74 69 6f  6e 44 73 6c 2e 6b 74 0a ;efinitionDsl.kt.
00000bb0: 4b 6f 74 6c 69 6e 0a 2a  53 20 4b 6f 74 6c 69 6e ;Kotlin.*S Kotlin
00000bc0: 0a 2a 46 0a 2b 20 31 20  42 65 61 6e 44 65 66 69 ;.*F.+ 1 BeanDefi
00000bd0: 6e 69 74 69 6f 6e 44 73  6c 2e 6b 74 0a 6f 72 67 ;nitionDsl.kt.org
00000be0: 2f 73 70 72 69 6e 67 66  72 61 6d 65 77 6f 72 6b ;/springframework
00000bf0: 2f 63 6f 6e 74 65 78 74  2f 73 75 70 70 6f 72 74 ;/context/support
00000c00: 2f 42 65 61 6e 44 65 66  69 6e 69 74 69 6f 6e 44 ;/BeanDefinitionD
00000c10: 73 6c 24 62 65 61 6e 24  31 24 63 75 73 74 6f 6d ;sl$bean$1$custom
00000c20: 69 7a 65 72 24 31 0a 2a  4c 0a 31 23 31 2c 32 37 ;izer$1.*L.1#1,27
00000c30: 33 3a 31 0a 2a 45 0a                             ;3:1.*E.

<小时/>

不幸的是我还没有找到正确的格式。我希望这里有人已经这样做了，或者在找到正确的格式方面运气更好。

Answer 1

最后我自己找到了一个可行的解决方案。

格式有点棘手，如 SourceDebugExtension属性被定义为直接 UTF-8 字符串，没有任何终止字符，如 \0并且在格式字符串中，您不能定义诸如“获取所有剩余字节”或“直到到达字节数组末尾”之类的内容。

但是在阅读了一些格式字符串的可能性以及 SourceDebugExtension 内容的格式之后属性，我想出了一种在大多数情况下都适用的格式。

SourceDebugExtension属性携带解析的SMAP。在这种情况下，已解决很重要，因为在 Unresolved SMAP 中，可能会嵌入已经包含结束部分的 SMAP，这会使其变得更加复杂，但并非不可能。在已解决的 SMAP 中，您最终总是有 <line terminator>*E<line terminator>哪里<line terminator>可能是常见的嫌疑人\r , \n或\r\n如果解决了，这个序列不可能出现在 SMAP 的前面。

现在我们可以使用带有递归自调用的联合布局元素来构建以下格式字符串，该字符串在大多数情况下都可以正确匹配 SMAP。该格式字符串唯一假设的是，如果在 *E 之前行终止符\r\n找到后，它也是预期的，如果只是 \r或\n之前查到的，只有\r或\n预计之后。哪一个不重要，只是不重要\r\n 。如果发生这种情况，打包就会失败，并提示没有处理一个字节。但如果我们检查这两个字符，结果只剩下一个，我们会得到 ArrayIndexOutOfBoundsException ，我认为这种情况不太可能发生，即不同的行终止符混合在一起。

这是我目前的方法:

[TB(10)[TB(42)[TB(69)[TB(13,10)[]()[(0)]]()[(0)]]()[(0)]](13)[TB(10)[TB(42)[TB(69)[TB(13)[TB(10)[]()[(0)]]()[(0)]]()[(0)]]()[(0)]](42)[TB(69)[TB(13,10)[]()[(0)]]()[(0)]]()[(0)]]()[(0)]]

为了更好地理解这里相同的格式，但有一些间距和语义内容。这样就不能直接使用了。必须通过com.sun.java.util.jar.pack.Attribute#normalizeLayoutString这是 public static包私有(private)类中的方法，因此通常无法访问。如果您使用反射或 Groovy 为您完成此操作或将方法主体复制到您自己的方法中，您当然可以在代码中使用此版本。

[
   # covered likely cases:
   # \\n*E\\n
   # \\r\\n*E\\r\\n
   # \\r*E\\r
   #
   # covered unlikely cases:
   # \\n*E\\r
   # \\r*E\\n
   #
   # uncovered unlikely cases:
   # \\n*E\\r\\n
   # \\r*E\\r\\n
   # \\r\\n*E\\r
   # \\r\\n*E\\n
   TB
      (\\\n) [
         # covered cases:
         # \\n*E\\r
         # \\n*E\\n
         TB
            (\\*) [
               TB
                  (\\E) [
                     TB
                        (\\\r, \\\n) []
                        () [(0)]
                  ]
                  () [(0)]
            ]
            () [(0)]
      ]
      (\\\r) [
         # covered cases:
         # \\r\\n*E\\r\\n
         # \\r*E\\r
         # \\r*E\\n
         TB
            (\\\n) [
               # covered cases:
               # \\r\\n*E\\r\\n
               TB
                  (\\*) [
                     TB
                        (\\E) [
                           TB
                              (\\\r) [
                                 TB
                                    (\\\n) []
                                    () [(0)]
                              ]
                              () [(0)]
                        ]
                        () [(0)]
                  ]
                  () [(0)]
            ]
            (\\*) [
               # covered cases:
               # \\r*E\\r
               # \\r*E\\n
               TB
                  (\\E) [
                     TB
                        (\\\r, \\\n) []
                        () [(0)]
                  ]
                  () [(0)]
            ]
            () [(0)]
      ]
      () [(0)]
]