Readplace

Data transfer object

Wikimedia Foundation, Inc. 2 min read
View original
  • best
Summary (TL;DR)
A data transfer object (DTO) carries data between processes, mainly used to reduce expensive remote calls by aggregating data into a single call. DTOs have no business logic, only data storage and serialization. They differ from value objects and are often misused outside remote interfaces. The term viewmodel is also used for DTOs in some patterns.

From Wikipedia, the free encyclopedia

In the field of programming a data transfer object (DTO[1][2]) is an object that carries data between processes. The motivation for its use is that communication between processes is usually done resorting to remote interfaces (e.g., web services), where each call is an expensive operation.[2] Because the majority of the cost of each call is related to the round-trip time between the client and the server, one way of reducing the number of calls is to use an object (the DTO) that aggregates the data that would have been transferred by the several calls, but that is served by one call only.[2]

The difference between data transfer objects and business objects or data access objects is that a DTO does not have any behavior except for storage, retrieval, serialization and deserialization of its own data (mutators, accessors, serializers and parsers). In other words, DTOs are simple objects that should not contain any business logic but may contain serialization and deserialization mechanisms for transferring data over the wire.[1]

This pattern is often incorrectly used outside of remote interfaces. This has triggered a response from its author[3] where he reiterates that the whole purpose of DTOs is to shift data in expensive remote calls.

In some languages, these can usually be represented as records (or structs).

Terminology

A value object is not a DTO. The two terms have been conflated by Sun/Java community in the past.[2]

For the model–view–viewmodel pattern, the data transfer object can be referred to as the viewmodel.[4][dubious – discuss]

Example

The following is an example of a DTO, using a Java record.

import java.io.FileInputStream;
import java.io.IOException;
import java.util.Properties;

import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.NotBlank;

record UserResponseDTO(
    Long id,
    @NotBlank(message = "Name cannot be empty") String name,
    @Email(message = "Invalid email format") String email
) {}

try (FileInputStream f = new FileInputStream("config.properties") {
    Properties prop = new Properties();
    prop.load(f);
    UserResponseDTO user = new UserResponseDTO(1L, prop.getProperty("user.name"), prop.getProperty("user.email"));
    System.out.println(user.name());
} catch (IOException e) {
    System.err.println("Error loading properties file: " + e.getMessage());
}

References

  1. 1 2 MSDN (2010). Data Transfer Object. Microsoft MSDN Library. Retrieved from https://msdn.microsoft.com/en-us/library/ms978717.aspx.
  2. 1 2 3 4 Fowler, Martin (2010). Data Transfer Object. Patterns of Enterprise Application Architecture. Retrieved from http://martinfowler.com/eaaCatalog/dataTransferObject.html.
  3. ↑ LocalDTO. Retrieved from http://martinfowler.com/bliki/LocalDTO.html.
  4. ↑ Microsoft Learn (3 January 2024). "Tutorial: Create a web API with ASP.NET Core".

External links