springboot中的DTO

目录

定义

作用

使用场景

示例代码

1. 创建 DTO 类

2. 创建实体类

3. 创建服务层

4. 创建控制器层

---

 

在 Spring Boot 开发中，DTO（Data Transfer Object）即数据传输对象，它是一种设计模式，用于在不同层（如表示层、服务层、数据访问层）之间传输数据。下面从定义、作用、使用场景、示例代码几个方面详细介绍。

定义

DTO 是一个简单的 Java 对象（POJO），它包含了一组属性以及对应的 getter 和 setter 方法，主要用于封装数据，在不同的应用程序组件之间进行数据传递。DTO 通常不包含业务逻辑，只负责存储和传递数据。

作用

• 减少数据传输量：在客户端与服务器之间进行数据交互时，只传输必要的数据，避免传输过多的冗余信息，从而减少网络流量，提高系统性能。
• 解耦不同层之间的数据交互：不同层可能有不同的数据表示方式，通过 DTO 可以将数据进行转换和封装，使得各层之间的耦合度降低，提高代码的可维护性和可扩展性。
• 保护数据安全：可以对敏感数据进行过滤和处理，只将需要的数据传递给外部，避免敏感信息的泄露。

使用场景

• Web 服务：在 RESTful API 中，DTO 常用于封装请求和响应数据，将数据以 JSON 或 XML 的形式在客户端和服务器之间进行传输。
• 分层架构：在多层架构中，DTO 用于在不同层之间传递数据，例如从表示层传递到服务层，或者从服务层传递到数据访问层。

示例代码

以下是一个简单的 Spring Boot 项目中使用 DTO 的示例：

1. 创建 DTO 类

// UserDTO.java
public class UserDTO {
    private String username;
    private String email;

    // 构造函数
    public UserDTO() {}

    public UserDTO(String username, String email) {
        this.username = username;
        this.email = email;
    }

    // Getter和Setter方法
    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

2. 创建实体类

// User.java
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String username;
    private String email;
    private String password; // 敏感信息

    // 构造函数
    public User() {}

    public User(String username, String email, String password) {
        this.username = username;
        this.email = email;
        this.password = password;
    }

    // Getter和Setter方法
    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

3. 创建服务层

// UserService.java
import org.springframework.stereotype.Service;

import java.util.ArrayList;
import java.util.List;

@Service
public class UserService {
    public List<UserDTO> getAllUsers() {
        // 模拟从数据库获取用户数据
        List<User> users = new ArrayList<>();
        users.add(new User("user1", "user1@example.com", "password1"));
        users.add(new User("user2", "user2@example.com", "password2"));

        // 将实体对象转换为DTO对象
        List<UserDTO> userDTOs = new ArrayList<>();
        for (User user : users) {
            UserDTO userDTO = new UserDTO(user.getUsername(), user.getEmail());
            userDTOs.add(userDTO);
        }
        return userDTOs;
    }
}

4. 创建控制器层

// UserController.java
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping("/users")
    public List<UserDTO> getAllUsers() {
        return userService.getAllUsers();
    }
}

在上述示例中，UserDTO 用于封装用户的部分信息（用户名和邮箱），在服务层将 User 实体对象转换为 UserDTO 对象，然后在控制器层将 UserDTO 对象返回给客户端，避免了敏感信息（如密码）的泄露。