Spring Boot 中繪製的最佳實踐

在 Spring Boot 应用程序中决定将 DTO 映射到实体（反之亦然）的最佳实践时，需要考虑几个关键因素：简单性、可维护性、性能和可测试性。每种方法都有其优点，因此最佳实践取决于您的项目的要求。以下是不同方法以及何时使用它们的详细信息：

1. 使用像> （大型项目的首选）

MapStruct 是一个编译时代码生成器，可自动执行 DTO 和实体之间的映射过程。
最适合： 拥有许多 DTO 和实体并且希望避免重复的手动映射代码的大型项目。
为什么 MapStruct 是一个不错的选择：

• 性能：因为它在编译时生成映射代码，所以与运行时解决方案相比非常高效。 类型安全：如果映射不正确或丢失，则会出现编译时错误，从而减少运行时失败的机会。
• 可维护性：它为您生成所有样板代码，减少重复。
• 自定义映射支持：您可以轻松地为复杂字段定义自定义映射（例如，不同的字段名称、嵌套对象）。

何时使用 MapStruct：

• 当您有许多 DTO 和实体要映射时。
• 当性能是一个问题时（因为它是编译时生成的）。
• 当您想要减少样板代码但保持对映射的控制时。

public interface BaseMapper<D, E> {
    D toDto(E entity);
    E toEntity(D dto);
}

@Mapper(componentModel = "spring")
public interface ClientMapper extends BaseMapper<ClientDTO, User> {
    // MapStruct will automatically inherit the methods from BaseMapper
}

@Mapper(componentModel = "spring")
public interface SentimentMapper extends BaseMapper<SentimentDTO, Product> {
    // Inherits from BaseMapper
}

您应该按如下方式组织文件：

src
 └── main
     └── java
         └── com
             └── yourapp
                 ├── mapper                # Package for mappers
                 │    ├── BaseMapper.java  # Abstract base mapper
                 │    ├── ClientMapper.java # Client-specific mapper
                 │    └── SentimentMapper.java # Sentiment-specific mapper

示例：如何在服务中使用映射器

package com.yourapp.service;

import com.yourapp.dto.UserDTO;
import com.yourapp.entity.User;
import com.yourapp.mapper.UserMapper;
import org.springframework.stereotype.Service;

@Service
public class ClientService {

    private final ClientMapper clientMapper;

    // Constructor injection (preferred method)
    public UserService(ClientMapper clientMapper) {
        this.clientMapper = clientMapper;
    }

    // Method to convert Client entity to ClientDTO
    public ClientDTO getClientDto(Client client) {
        return clientMapper.toDto(client);
    }

    // Method to convert ClientDTO to Client entity
    public User createClientFromDto(ClientDTO clientDTO) {
        return clientMapper.toEntity(clientDTO);
    }
}

2. 使用像> （用于快速动态映射）

ModelMapper 在运行时动态映射 DTO 和实体之间的字段。
最适合：快速设置，尤其是在原型设计中或当您不想为许多字段手动编写映射逻辑时。
为什么选择 ModelMapper：

• 易于设置： 需要很少的设置，并且适用于简单的用例。
• 动态映射：非常适合实体和 DTO 具有相似结构且您不想编写单独的映射方法的情况。

示例：

        ModelMapper modelMapper = new ModelMapper();
        ClientDTO clientDTO = modelMapper.map(client, ClientDTO.class);
        Client client = modelMapper.map(clientDTO, Client.class);

何时使用 ModelMapper：

• 当项目规模较小或中等，并且您不想编写单独的映射器时。
• 当您的 DTO 和实体的结构非常相似并且不需要太多自定义时。

3. 手动映射（最适合小型项目或特定案例）

手动映射涉及您自己编写转换代码，通常使用简单的 getter/setter 调用。
最适合：小型项目、简单映射，或者当您需要完全控制映射过程的各个方面时。
为什么手动映射是一个不错的选择：

• 简单映射：如果您只有几个 DTO 和实体，手动映射可以直接且易于实现。
• 完全控制：您可以完全控制映射的完成方式，这在映射过程中进行复杂逻辑或数据转换时非常有用。

示例：

public class ClientMapper {
    public ClientDTO toDto(Client client) {
        ClientDTO clientDTO = new ClientDTO();
        clientDTO.setEmail(client.getEmail());
        return clientDTO;
    }

    public User toEntity(ClientDTO clientDTO) {
        Client client = new User();
        client.setEmail(clientDTO.getEmail());
        return client;
    }
}

何时使用手动映射：

• 在只有少數 DTO 和實體存在的小型或簡單專案中。
• 當您需要最大限度地控制映射邏輯時。
• 對於映射庫可能開銷太大的邊緣情況。

選擇映射方法的關鍵考慮因素

可維護性

• MapStruct 隨著專案的成長更容易維護，因為它會自動產生映射程式碼。
• 手動映射在大型專案中可能會變得更難維護，因為每個 DTO 實體對都需要單獨的方法。
• ModelMapper 如果您需要大量自訂邏輯，它很快就會變得難以維護，因為它是動態的並且不強制執行編譯時檢查。

表現

• MapStruct 具有高效能，因為映射是在編譯時產生的。這使其成為性能關鍵型應用的理想選擇。
• 手動映射也很有效，但它可能會引入人為錯誤並且更加冗長。
• ModelMapper 可能會更慢，因為它在運行時使用反射來映射欄位。

映射的複雜性

• 對於簡單映射：手動映射或ModelMapper可能就足夠了。
• 對於複雜映射（巢狀物件、自訂欄位名稱或轉換），首選 MapStruct 或 手動映射，因為它提供更多控制。

項目規模

• 在小型專案中，手動映射通常就足夠了且易於維護。
• 對於具有多個實體和 DTO 的大型項目，最好使用 MapStruct 來減少樣板檔案並提高可讀性。

一般最佳實務：

• 對於可維護性、效能和編譯時安全性至關重要的大型項目，請使用 MapStruct。
• 在小型專案或需要編寫非常特定的轉換邏輯時使用手動映射。
• 避免在大型或複雜專案中使用 ModelMapper，因為使用反射進行運行時映射可能會很慢且容易出錯。
• 始終努力保持 DTO 簡單，僅包含必要的數據，並避免在其中包含域邏輯。
• 映射時正確處理空安全和邊緣情況（例如選用欄位、集合）。
• 如果您的 DTO 經常更改，MapStruct 等工具將透過自動產生程式碼並提供編譯時回饋來幫助您更快地適應。

結論

• 對於存在許多 DTO 和實體且映射重複的大型應用程序，MapStruct 通常是最佳實踐。
• 對於具有最少映射的小型項目，手動映射就足夠了並且使事情變得簡單。
• ModelMapper 可用於快速原型或簡單用例，但由於效能和可維護性問題，它不是生產環境的最佳選擇。

作者

• @mohamedamine.mhenni

支援

如需支持，請發送電子郵件至 mhenni.medamine@gmail.com 。

執照

麻省理工學院

以上是Spring Boot 中繪製的最佳實踐的詳細內容。更多資訊請關注PHP中文網其他相關文章！