深入理解 toDto 与 toEntity

2024-06-19 21:22:31 浏览数 (1)

在现代软件开发中，尤其是后端开发中，数据传输对象（DTO）和实体对象的转换是一个常见且重要的操作。理解和正确实现这种转换不仅能提高代码的可维护性，还能提升应用的性能和安全性。本文将深入探讨 toDto 和 toEntity 方法，并结合 Eladmin 框架，帮助开发者更好地掌握这一关键技术。

什么是 Eladmin？

Eladmin 是一个基于 Spring Boot 的开源管理后台框架，集成了 Spring Security、JWT、Spring Data JPA、MapStruct 等流行技术。它提供了一整套完整的后台管理解决方案，极大地方便了开发者快速构建后台系统。

什么是 DTO 和 实体对象？

数据传输对象（DTO） 是一种设计模式，用于在不同层（如客户端和服务器端）之间传输数据。DTO 通常是一个简单的 POJO（Plain Old Java Object），仅包含数据，不包含业务逻辑。它的主要目的是携带数据并减少网络流量。

实体对象（Entity） 通常是与数据库表直接映射的对象，包含了数据和业务逻辑。在大多数情况下，实体对象用于持久化数据和执行复杂的业务操作。

为什么需要转换？

在一个典型的应用程序中，实体对象和 DTO 之间的转换是不可避免的。主要原因包括：

  1. 安全性：直接暴露实体对象可能会泄露敏感信息。
  2. 分离关注点：DTO 关注数据传输，而实体对象关注业务逻辑。
  3. 简化客户端代码：客户端不需要知道实体对象的内部结构，只需要关心需要的数据。
  4. 性能优化：DTO 可以减少不必要的数据传输，提升性能。

实现 toDto 和 toEntity 方法

在 Eladmin 中，使用 MapStruct 进行对象转换非常方便。MapStruct 是一个代码生成器，它简化了 Java bean 类型之间的映射。

示例：User 实体和 UserDTO

首先，我们定义一个 User 实体类：

代码语言：java复制
@Entity
@Table(name = "user")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String username;

    private String email;

    private String password;

    // Getters and setters
}

然后，定义一个 UserDTO 类：

代码语言：java复制
public class UserDTO {
    private Long id;
    private String username;
    private String email;

    // Getters and setters
}

在 Eladmin 中，通常会有一个 Mapper 接口来定义实体和 DTO 之间的转换：

代码语言：java复制
import org.mapstruct.Mapper;
import org.mapstruct.ReportingPolicy;
import org.mapstruct.factory.Mappers;

@Mapper(componentModel = "spring", unmappedTargetPolicy = ReportingPolicy.IGNORE)
public interface UserMapper {
    UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);

    UserDTO toDto(User user);

    User toEntity(UserDTO userDTO);
}

配置和使用 MapStruct 在 Eladmin 中自动生成转换代码

在 Maven 中添加 MapStruct 依赖：

代码语言：xml复制
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct</artifactId>
    <version>1.4.2.Final</version>
</dependency>
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-processor</artifactId>
    <version>1.4.2.Final</version>
    <scope>provided</scope>
</dependency>

在 application.yml 中配置 MapStruct：

代码语言：yaml复制
mapstruct:
  default-component-model: spring

这样，MapStruct 将自动生成实现类，并将其注册为 Spring Bean。你可以直接在服务类中注入使用：

代码语言：java复制
@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public UserDTO getUserDto(Long userId) {
        User user = userRepository.findById(userId).orElseThrow(() -> new EntityNotFoundException("User not found"));
        return userMapper.toDto(user);
    }

    public User createUser(UserDTO userDTO) {
        User user = userMapper.toEntity(userDTO);
        return userRepository.save(user);
    }
}

结合实际项目：完整的 CRUD 示例

以下是一个完整的 CRUD 示例，展示了如何在 Eladmin 中使用 toDto 和 toEntity 方法进行对象转换。

Controller
代码语言：java复制
@RestController
@RequestMapping("/api/users")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public ResponseEntity<UserDTO> getUser(@PathVariable Long id) {
        UserDTO userDTO = userService.getUserDto(id);
        return ResponseEntity.ok(userDTO);
    }

    @PostMapping
    public ResponseEntity<UserDTO> createUser(@RequestBody UserDTO userDTO) {
        User user = userService.createUser(userDTO);
        UserDTO createdUserDTO = userMapper.toDto(user);
        return ResponseEntity.status(HttpStatus.CREATED).body(createdUserDTO);
    }

    @PutMapping("/{id}")
    public ResponseEntity<UserDTO> updateUser(@PathVariable Long id, @RequestBody UserDTO userDTO) {
        User updatedUser = userService.updateUser(id, userDTO);
        UserDTO updatedUserDTO = userMapper.toDto(updatedUser);
        return ResponseEntity.ok(updatedUserDTO);
    }

    @DeleteMapping("/{id}")
    public ResponseEntity<Void> deleteUser(@PathVariable Long id) {
        userService.deleteUser(id);
        return ResponseEntity.noContent().build();
    }
}
Service
代码语言：java复制
@Service
public class UserService {

    @Autowired
    private UserRepository userRepository;

    @Autowired
    private UserMapper userMapper;

    public UserDTO getUserDto(Long userId) {
        User user = userRepository.findById(userId).orElseThrow(() -> new EntityNotFoundException("User not found"));
        return userMapper.toDto(user);
    }

    public User createUser(UserDTO userDTO) {
        User user = userMapper.toEntity(userDTO);
        return userRepository.save(user);
    }

    public User updateUser(Long id, UserDTO userDTO) {
        User user = userRepository.findById(id).orElseThrow(() -> new EntityNotFoundException("User not found"));
        user.setUsername(userDTO.getUsername());
        user.setEmail(userDTO.getEmail());
        return userRepository.save(user);
    }

    public void deleteUser(Long id) {
        userRepository.deleteById(id);
    }
}

结论

DTO 和实体对象之间的转换在现代应用开发中至关重要。通过实现 toDto 和 toEntity 方法，或者使用自动化工具如 MapStruct，我们可以简化这一过程，提高代码的可维护性和性能。在 Eladmin 框架中，结合 Spring Boot 和 MapStruct，转换操作变得更加简洁和高效。

希望本文能帮助你更好地理解和掌握 DTO 和实体对象之间的转换技术，并在实际项目中灵活应用。

我正在参与2024腾讯技术创作特训营最新征文，快来和我瓜分大奖！

腾讯技术创作特训营S7

0 人点赞