LDIF 解析

LDAP 目录交换格式 (LDIF) 文件是描述平面文件格式目录数据的标准媒介。这种格式最常见的用途包括信息传输和存档。然而,该标准也定义了一种在平面文件格式中描述对存储数据进行修改的方式。后一种类型的 LDIF 通常被称为 changetypemodify LDIF。

org.springframework.ldap.ldif 包提供了解析 LDIF 文件并将其反序列化为具体对象所需的类。LdifParserorg.springframework.ldap.ldif 包的主要类,能够解析符合 RFC 2849 的文件。此类从资源中读取行并将其组装成一个 LdapAttributes 对象。

LdifParser 目前忽略 changetype LDIF 条目,因为它们在应用程序上下文中的实用性尚未确定。

对象表示

org.springframework.ldap.core 包中的两个类提供了在代码中表示 LDIF 的方法

  • LdapAttribute:扩展 javax.naming.directory.BasicAttribute,增加了对 RFC2849 中定义的 LDIF 选项的支持。

  • LdapAttributes:扩展 javax.naming.directory.BasicAttributes,增加了对 DN 的专门支持。

LdapAttribute 对象将选项表示为 Set<String>。添加到 LdapAttributes 对象的 DN 支持采用了 javax.naming.ldap.LdapName 类。

解析器

Parser 接口为操作提供了基础,并采用了三个支持策略定义

  • SeparatorPolicy:建立将行组装成属性的机制。

  • AttributeValidationPolicy:确保属性在解析前结构正确。

  • Specification:提供了一种在组装后验证对象结构的机制。

这些接口的默认实现如下

  • org.springframework.ldap.ldif.parser.LdifParser

  • org.springframework.ldap.ldif.support.SeparatorPolicy

  • org.springframework.ldap.ldif.support.DefaultAttributeValidationPolicy

  • org.springframework.ldap.schema.DefaultSchemaSpecification

这四个类共同逐行解析资源并将数据转换为 LdapAttributes 对象。

SeparatorPolicy 确定从源文件读取的单行应如何解释,因为 LDIF 规范允许属性跨多行。默认策略在读取它们的顺序上下文中评估行,以确定所考虑行的性质。control 属性和 changetype 记录将被忽略。

DefaultAttributeValidationPolicy 使用正则表达式表达式来确保每个属性在解析后符合有效的属性格式(根据 RFC 2849)。如果属性验证失败,则会记录 InvalidAttributeFormatException,并跳过该记录(解析器返回 null)。

模式验证

通过 org.springframework.ldap.schema 包中的 Specification 接口,可以提供针对模式验证解析对象的方法。DefaultSchemaSpecification 不执行任何验证,适用于已知记录有效且无需检查的情况。此选项节省了验证带来的性能开销。BasicSchemaSpecification 应用基本检查,例如确保已提供 DN 和对象类声明。目前,针对实际模式的验证需要实现 Specification 接口。

Spring Batch 集成

虽然 LdifParser 可以用于任何需要解析 LDIF 文件的应用程序,但 Spring 提供了一个批处理框架,该框架提供了许多文件处理实用程序,用于解析 CSV 等分隔文件。org.springframework.ldap.ldif.batch 包提供了将 LdifParser 用作 Spring Batch 框架中有效配置选项所需的类。此包中有五个类。它们共同提供了三个基本用例

  • 从文件中读取 LDIF 记录并返回 LdapAttributes 对象。

  • 从文件中读取 LDIF 记录并将记录映射到 Java 对象 (POJO)。

  • 将 LDIF 记录写入文件。

第一个用例通过 LdifReader 实现。此类扩展了 Spring Batch 的 AbstractItemCountingItemStreamItemReader 并实现了其 ResourceAwareItemReaderItemStream。它自然地融入了框架,您可以将其用于从文件中读取 LdapAttributes 对象。

您可以使用 MappingLdifReader 将 LDIF 对象直接映射到任何 POJO。此类要求您提供 RecordMapper 接口的实现。此实现应实现将对象映射到 POJO 的逻辑。

您可以实现 RecordCallbackHandler 并将实现提供给任一读取器。您可以使用此处理程序对跳过的记录进行操作。有关更多信息,请参阅 Spring Batch API 文档

此包的最后一个成员,LdifAggregator,可用于将 LDIF 记录写入文件。此类调用 LdapAttributes 对象的 toString() 方法。

© . This site is unofficial and not affiliated with VMware.