使用MapStruct忽略不映射的属性

我不是女神ヾ 2023-01-15 02:12 287阅读 0赞

# 1.概述 #

在Java应用程序中，希望将值从一种Java bean复制到另一种Java bean。使用诸如MapStruct之类的bean映射器。

虽然使用相同的字段名称映射相同的字段非常简单，但是经常会遇到不匹配的bean

# 2.映射 #

MapStruct是Java注释处理器。 要做的就是定义映射器接口并声明映射方法。 MapStruct将在编译期间生成此接口的实现。

# 3.未映射的属性 #

由于MapStruct在编译时运行，因此它比动态映射框架要快。 如果映射不完整（即，并非所有目标属性都被映射），它也可以生成错误报告：

Warning:(X,X) java: Unmapped target property: "xxxx".

1.3.1版本只映射相同字段，新版本应该不存在上述问题

# 4.忽略特定字段 #

要跳过特定映射方法中的多个属性，可以在@Mapping注解中使用ignore属性：

@Mapper(componentModel = "spring")
    public interface DocumentMapper { 
    
        @Mapping(target = "comments", ignore = true)
        @Mapping(target = "author", ignore = true)
        DocumentDTO documentToDocumentDTO(Document entity);
    
        @Mapping(target = "modificationTime", ignore = true)
        Document documentDTOToDocument(DocumentDTO dto);
    }

在配置了，目标字段名称，并将ignore设置为true以表明它不进行映射。

但是，这种技术在某些情况下并不方便。 例如，当使用具有大量字段的大型模型时，可能会发现难以使用。

# 5.不映射的目标策略 #

为了使事情更清楚并使代码更易读，可以指定不映射的目标策略。

为此，当没有映射的源字段时，使用MapStruct unmappedTargetPolicy提供所需的行为：

ERROR：任何未映射的目标属性都将使构建失败–这可以避免意外的未映射字段  
WARN：（默认）构建期间的警告消息  
IGNORE：无输出或错误  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25pdWdhbmcwOTIw_size_16_color_FFFFFF_t_70]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25pdWdhbmcwOTIw_size_16_color_FFFFFF_t_70]: /images/20221022/89403a0ad77f4e679594cd3b90ef1a23.png