Hướng dẫn Java Design Pattern – Transfer Object

1. Transfer Object Pattern là gì?

Transfer Object/ Data Transfer Object Pattern là một dạng Architectural Design Pattern, được sử dụng khi chúng ta muốn truyền dữ liệu qua lại giữa các tầng trong ứng dụng, giữa Client – Server. Data Transfer Object (DTO) còn được gọi là Value Object (VO).

Transfer Object đơn giản là một POJO (Plain Old Java Object), chỉ chứa các getter/ setter method và có thể có implement serialize để truyền tải dữ liệu thông qua network.

DTO hoàn toàn không chứa behavior/ logic, chỉ được sử dụng để truyền dữ liệu và map dữ liệu từ các Domain Model trước khi truyền tới Client. Trong các ứng dụng đơn giản, các Domain Model thường có thể được sử dụng lại trực tiếp dưới dạng DTO và được truyền trực tiếp đến lớp hiển thị, do đó chỉ có một Data Model thống nhất. Đối với các ứng dụng phức tạp hơn, chúng ta không muốn hiển thị toàn bộ Domain Model cho Client, do đó, việc ánh xạ từ các Domain Model sang DTO là cần thiết.

2. Cài đặt Transfer Object Pattern như thế nào?

Các thành phần tham gia Transfer Object Pattern:

• Business Object : là một Business Service, tạo Transfer Object và trả nó về Client khi cần thiết. Nó cũng có thể nhận dữ liệu từ Client trong một Transfer Object và gửi đến Server để cập nhật vào database.
• Transfer Object : là một POJO, chỉ chứa các getter/ setter method.
• Client : người sử dụng ứng dụng.

2.1. Ví dụ sử dụng Transfer Object Pattern

Lớp xử lý nghiệp vụ ở phía Server thường truy vấn dữ liệu từ database và gán các giá trị vào Transfer Object để gửi lại Client. Phía Client có thể tạo một Transfer Object và gán giá trị vào để gửi lại Server thực hiện update vào database.

Trong ví dụ bên dưới, chúng ta sẽ cùng tìm hiểu cách áp dụng DTO với DAO ở bài viết trước.

UserModel.java

package com.maixuanviet.patterns.other.dto;
 
import lombok.Data;
 
/**
 * Domain Model / Entity
 */
@Data
public class UserModel {
 
    private Integer id;
    private String userName;
    private String fullName;
    private String password;
    private String email;
    private String bankAccount;
}

Dao.java

package com.maixuanviet.patterns.other.dto;
 
import java.util.List;
import java.util.Optional;
 
/**
 * Data Access Object
 */
public interface Dao<T> {
 
    List<T> getAll();
 
    Optional<T> get(Integer id);
 
    void save(T t);
 
    void update(T t);
 
    void delete(T t);
}

UserDao.java

package com.maixuanviet.patterns.other.dto;
 
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
 
public class UserDao implements Dao<UserModel> {
 
    // Temporary database
    private List<UserModel> users = new ArrayList<>();
 
    public UserDao() {
        UserModel user = new UserModel();
        user.setId(1);
        user.setUserName("maixuanviet");
        user.setEmail("maixuanvietvn@gmail.com");
        user.setFullName("GP Coder");
        user.setPassword("1234567");
        user.setBankAccount("9999-9999-9999");
        users.add(user);
    }
 
    @Override
    public List<UserModel> getAll() {
        return users;
    }
 
    @Override
    public Optional<UserModel> get(Integer id) {
        return users.stream().filter(u -> u.getId() == id).findFirst();
    }
 
    @Override
    public void save(UserModel user) {
        users.add(user);
    }
 
    @Override
    public void update(UserModel user) {
        int index = -1;
        for (UserModel u : users) {
            index++;
            if (user.getId().equals(u.getId())) {
                users.set(index, user);
                break;
            }
        }
    }
 
    @Override
    public void delete(UserModel user) {
        get(user.getId()).ifPresent(existUser -> users.remove(existUser));
    }
}

UserDTO.java

package com.maixuanviet.patterns.other.dto;
 
import lombok.Data;
 
/**
 * Data Transfer Object
 */
@Data
public class UserDTO {
 
    private Integer id;
    private String userName;
    private String fullName;
    private String email;
}

UserService.java

package com.maixuanviet.patterns.other.dto;
 
/**
 * Business Object / Logic
 */
public class UserService {
 
    private UserDao dao = new UserDao();
 
    public UserDTO getUser(Integer id) {
        UserModel model = dao.get(id).get();
        return convertToDTO(model);
    }
 
    public void saveUser(UserDTO dto) {
        UserModel model = convertToModel(dto);
        dao.save(model);
    }
 
    public void updateUser(UserDTO dto) {
        UserModel model = convertToModel(dto);
        dao.update(model);
    }
 
    private UserModel convertToModel(UserDTO dto) {
        UserModel model = new UserModel();
        model.setId(dto.getId());
        model.setFullName(dto.getFullName());
        model.setUserName(dto.getUserName());
        model.setEmail(dto.getEmail());
        return model;
    }
 
    private UserDTO convertToDTO(UserModel model) {
        UserDTO dto = new UserDTO();
        dto.setId(model.getId());
        dto.setFullName(model.getFullName());
        dto.setUserName(model.getUserName());
        dto.setEmail(model.getEmail());
        return dto;
    }
}

DataAccessObjectPatternExample.java

package com.maixuanviet.patterns.other.dto;
 
/**
 * Client - Data Access Object Pattern Example
 */
public class DataAccessObjectPatternExample {
 
    public static void main(String[] args) {
        UserService service = new UserService();
        UserDTO dto = service.getUser(1);
        System.out.println("User: " + dto);
 
        dto.setFullName("maixuanviet.com");
        service.updateUser(dto);
        System.out.println("User Updated: " + dto);
    }
}

Output của chương trình:

User: UserDTO(id=1, userName=maixuanviet, fullName=Mai Xuan Viet, email=maixuanviet.com@gmail.com)
User Updated: UserDTO(id=1, userName=maixuanviet, fullName=maixuanviet.com, email=maixuanviet.com@gmail.com)

3. Lợi ích của Transfer Object Pattern là gì?

• Tách biệt logic một cách rõ ràng : Transfer Object chỉ chứa data, còn logic được implement trong phần khác.
• Cãi thiện hiệu suất ứng dụng : chi phí của mỗi request/ response là lớn, chúng ta nên cố gắng gửi nhiều nhất có thể. Để làm điều này, chúng ta có thể tạo một Transfer Object để gửi data từ Client lên Server hay từ Server đến Client một lần duy nhất, thay vì phải gửi từng phần riêng lẻ.
• Giảm kết dính giữa các tầng trong ứng dụng: Client chỉ thao tác với Transfer Object, nên nó không bị ảnh hưởng khi Domain Model thay đổi.
• Bao đóng các đối số : một phương thức có nhiều đối số, chúng ta có thể bao đóng chúng trong một Transfer Object. Giúp chúng ta dễ dàng mở rộng, thêm/ bớt đối số.
• Nhận nhiều dữ liệu trả về : trong Java, một phương thức chỉ có thể trả về một giá trị, để có thể nhận được nhiều giá trị, chúng ta có thể bao đóng chúng trong một Transfer Object.
• Tăng bảo mật ứng dụng : tùy vào người dùng khác nhau có thể xem được một số dữ liệu nhất định. Chúng ta có thể tạo nhiều Transfer Object khác nhau cho từng loại người dùng thay vì trả về một Domain Object một cách trực tiếp. Trường hợp rõ ràng nhất là User Model, domain object này chứa thông tin cả email, password, số tài khoản ngân hàng. Chúng ta có thể tạo một Transfer Object đơn giản chỉ chứa thông tin họ tên, ngày sinh. Không cần thiết phải trả tất cả dữ liệu Domain Model về Client.
• Transfer Object thường được sử dụng với Data Access Object .