SpringBoot中數據傳輸對象(DTO)的實現
探索在Spring Boot中使用數據傳輸對象（DTO）的好處，本文包括了手動創(chuàng)建DTO、使用ModelMapper和Lombok創(chuàng)建DTO的示例。
1. 什么是數據傳輸對象（DTO）？
數據傳輸對象（DTO）是一種設計模式，用于封裝和傳輸應用程序不同層之間的數據。
DTO是輕量級對象，通常只包含必要的字段，不包含任何業(yè)務邏輯。DTO作用于應用程序中不同的業(yè)務之間的數據傳輸，例如在前端和后端之間或在分布式系統(tǒng)中不同的微服務值之間。
在Spring Boot應用程序中，DTO特別有用，因為需要在控制器層、服務層和持久層之間傳輸數據。通過使用DTO就可以將內部數據模型與外部表示解耦（這點巨好，老鳥都知道），從而更好地控制數據傳輸。
2. 在Spring Boot中使用DTO的好處
在Spring Boot應用程序中使用DTO有幾個優(yōu)點：
- 數據隔離：DTO允許將暴露給外部的數據與內部的模型隔離。這可以防止暴露敏感和不必要的數據，并為數據交換提供清晰的字段。
- 減少開銷：DTO可以僅包含特定所需的字段，減少網絡傳輸。這最小化了傳輸大型對象的開銷。
- 版本控制和兼容性：DTO可以使接口支持向后兼容。一個API可以對外提供多個DTO結構。
- 提高安全性：通過對DTO暴露數據的控制，就避免了數據泄漏以及保護了敏感信息的安全性。
- 增強測試：DTO簡化了單元測試，因為您可以在測試場景中輕松創(chuàng)建和操作它們，而不依賴于復雜的域對象。
3. 在Spring Boot中以不同方式使用DTO
3.1. 手動創(chuàng)建DTO
在這種方法中，手動創(chuàng)建對實體結構映射的DTO類。然后編寫代碼在實體對象和DTO之間映射數據。
public class UserDTO {
private Long id;
private String username;
private String email;
// 構造函數、getter和setter
}
創(chuàng)建一個控制器方法演示手動映射：
@RestController
@RequestMapping("/api/users")
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/{id}")
public ResponseEntity getUserById(@PathVariable Long id) {
User user = userService.getUserById(id);
UserDTO userDTO = new UserDTO();
userDTO.setId(user.getId());
userDTO.setUsername(user.getUsername());
userDTO.setEmail(user.getEmail());
return ResponseEntity.ok(userDTO);
}
}
輸出：
調用/api/users/1請求時，將收到UserDTO結構的用戶數據。
{
"id": 1,
"username": "張三",
"email": "zhangsan@qq.com"
}
3.2. 使用ModelMapper
ModelMapper用于自動將實體對象映射到DTO，反之亦然。以下是pom.xml依賴：
<dependency> <groupId>org.modelmapper</groupId> <artifactId>modelmapper</artifactId> <version>2.4.3</version> </dependency>
實例化ModelMapper為一個BEAN，這樣就可以在整個程序中使用ModelMapper
以下是創(chuàng)建Spring Boot應用程序中ModelMapper Bean的方法：
import org.modelmapper.ModelMapper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MyApplicationConfig {
@Bean
public ModelMapper modelMapper() {
return new ModelMapper();
}
}
以下是如何使用ModelMapper將實體對象映射到DTO：
@RestController
@RequestMapping("/api/users")
public class UserController {
@Autowired
private UserService userService;
@Autowired
private ModelMapper modelMapper; // 自動裝配ModelMapper Bean
@GetMapping("/{id}")
public ResponseEntity getUserById(@PathVariable Long id) {
User user = userService.getUserById(id);
UserDTO userDTO = modelMapper.map(user, UserDTO.class); // 使用ModelMapper進行映射
return ResponseEntity.ok(userDTO);
}
}
輸出：
輸出將與手動創(chuàng)建DTO的示例相同。
3.3 使用Lombok
在pom.xml文件中添加Lombok依賴項。
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.22</version> <scope>provided</scope> </dependency>
以下是演示如何使用Lombok為User實體創(chuàng)建DTO。
import lombok.Data;
@Data //關鍵注解
public class UserDTO {
private Long id;
private String username;
private String email;
}
以下是如何使用Lombok將實體對象映射到DTO：
@RestController
@RequestMapping("/api/users")
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/{id}")
public ResponseEntity getUserById(@PathVariable Long id) {
User user = userService.getUserById(id);
UserDTO userDTO = UserDTO.builder()
.id(user.getId())
.username(user.getUsername())
.email(user.getEmail())
.build();
return ResponseEntity.ok(userDTO);
}
}
輸出：
輸出與手動創(chuàng)建DTO的示例相同。
4.在DTO中格式化不同類型的值
在DTO中格式化不同類型的值是確保數據在序列化或顯示時以特定格式呈現的常見要求。根據業(yè)務要求格式化的值類型，可以使用各種方法，包括注解、自定義方法或外部庫。下面是在DTO中格式化不同類型的值實例：
4.1. 格式化日期和時間
4.1.1. 使用@JsonFormat注解（Jackson）
要在DTO中格式化日期和時間值，可以使用Jackson庫提供的@JsonFormat注解。
import com.fasterxml.jackson.annotation.JsonFormat;
public class UserDTO {
private Long id;
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "UTC")
private Date registrationDate;
// 其他字段、getter和setter
}
在此示例中，registrationDateField使用@JsonFormat注解指定所需的日期和時間格式。
4.1.2. 使用SimpleDateFormat（自定義方法）
還可以通過在DTO類中提供自定義getter方法來格式化日期和時間，該方法返回格式化后的日期字符串。
import java.text.SimpleDateFormat;
public class UserDTO {
private Long id;
private Date registrationDate;
public String getFormattedRegistrationDate() {
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
return sdf.format(registrationDate);
}
// 其他字段、getter和setter
}
4.2. 格式化數字
4.2.1. 使用@NumberFormat注解（Spring）
要格式化數字值，如數字或貨幣，您可以使用Spring提供的@NumberFormat注解。此注解允許您指定數字格式模式。
import org.springframework.format.annotation.NumberFormat;
public class ProductDTO {
private Long id;
@NumberFormat(pattern = "#,###.00")
private BigDecimal price;
// 其他字段、getter和setter
}
在此示例中，price字段使用@NumberFormat注解指定數字格式模式。
4.2.2. 使用DecimalFormat（自定義方法）
還可以通過在DTO類中提供自定義getter方法來格式化數字，該方法使用DecimalFormat返回格式化后的數字字符串。
import java.text.DecimalFormat;
public class ProductDTO {
private Long id;
private BigDecimal price;
public String getFormattedPrice() {
DecimalFormat df = new DecimalFormat("#,###.00");
return df.format(price);
}
// 其他字段、getter和setter
}
4.3. 格式化字符串
4.3.1. 使用自定義方法
對于格式化字符串值，可以在DTO類中創(chuàng)建自定義getter方法以根據需要操作字符串。例如，您可以優(yōu)化空格、大寫單詞或應用任何其他字符串操作邏輯。
public class ArticleDTO {
private Long id;
private String title;
public String getFormattedTitle() {
// 自定義格式化邏輯在這里
return title.trim(); // 示例：修剪空格
}
// 其他字段、getter和setter
}
4.4. 格式化枚舉
4.4.1. 使用自定義方法
在處理DTO中的枚舉時，可以創(chuàng)建自定義getter方法以返回枚舉值的格式化表示形式。例如，您可以將枚舉值轉換為大寫或使用不同的表示形式。
public class OrderDTO {
private Long id;
private OrderStatus status;
public String getFormattedStatus() {
return status.toString().toUpperCase(); // 示例：轉換為大寫
}
// 其他字段、getter和setter
}
4.5. 格式化布爾值
4.5.1. 使用自定義方法
對于布爾值，可以創(chuàng)建自定義getter方法以返回格式化表示形式，例如“是”或“否”，而不是“true”或“false”。
public class UserDTO {
private Long id;
private boolean isActive;
public String getFormattedIsActive() {
return isActive ? "Yes" : "No"; // 示例：轉換為"Yes"或"No"
}
// 其他字段、getter和setter
}
通過使用這些方法，可以根據具體要求格式化DTO中的不同類型的值，確保在序列化或顯示DTO時數據以期望的格式呈現。
5.其他注意事項和最佳實踐
5.1. DTO中的驗證
在處理DTO時，考慮數據驗證至關重要。應該驗證DTO中的傳入數據，以確保它滿足所需的約束和業(yè)務規(guī)則。可以使用Spring的驗證注解（如@NotNull、@Size）或自定義驗證注解來驗證DTO字段。
以下是使用Spring的@NotBlank注解進行DTO驗證的示例：
public class UserDTO {
@NotNull
private Long id;
@NotBlank
@Size(min = 5, max = 50)
private String username;
@Email
private String email;
// 構造函數、getter和setter
}
5.2. 用于復雜嵌套對象的DTO
在實際業(yè)務中，處理嵌套對象的DTO會很復雜。需要創(chuàng)建嵌套的DTO來準確映射這些結構。
例如，如果一個User與一組Address對象關聯，可以創(chuàng)建一個嵌套AddressDTO的UserDTO：
public class UserDTO {
private Long id;
private String username;
private String email;
private List<AddressDTO> addresses;
// 構造函數、getter和setter
}
5.3. DTO版本控制
隨著業(yè)務的發(fā)展，可能需要對DTO進行更改。為了保持向后兼容性則需要考慮對DTO進行版本控制。例如可以通過向DTO添加版本標識符或在必要時創(chuàng)建新的DTO版本來實現。
5.4. RESTful API中的DTO
DTO在RESTful API中常用于表示客戶端和服務器之間的數據交換。在設計RESTful端時，應仔細選擇或創(chuàng)建DTO，以滿足不同業(yè)務需求。
6.將DTO與Spring驗證一起使用
Spring提供了一個強大的機制，使用@Valid注解在控制器方法中去驗證DTO。當你將DTO參數與@Valid注解一起使用時，Spring將自動基于DTO類中定義的驗證規(guī)則觸發(fā)驗證。
以下是使用DTO驗證的控制器方法示例：
@RestController
@RequestMapping("/api/users")
public class UserController {
@Autowired
private UserService userService;
@PostMapping("/create")
public ResponseEntity createUser(@Valid @RequestBody UserDTO userDTO) {
// 驗證邏輯會自動觸發(fā)
// 將UserDTO映射到User實體并保存它
User user = modelMapper.map(userDTO, User.class);
User savedUser = userService.saveUser(user);
// 返回保存的UserDTO
UserDTO savedUserDTO = modelMapper.map(savedUser, UserDTO.class);
return ResponseEntity.status(HttpStatus.CREATED).body(savedUserDTO);
}
}
在此示例中，@Valid注解基于UserDTO類中定義的規(guī)則觸發(fā)驗證。如果驗證失敗，Spring將自動處理驗證錯誤并返回帶有適當錯誤消息的響應數據。
7.微服務架構中的DTO
在微服務架構中，DTO在定義微服務之間的邊界方面起著關鍵作用。每個微服務都可以擁有一套針對其特定需求而量身定制的DTO。這種分離模式確保了微服務之間的松耦合。
DTO還有助于減少微服務之間傳輸的數據量，這對于維護基于微服務的系統(tǒng)的性能和可擴展性至關重要。
8.結論
數據傳輸對象（DTO）在Spring Boot應用程序中不可或缺，它充當應用程序不同層和外部系統(tǒng)之間的橋梁。通過仔細設計和使用DTO，可以改善數據隔離、減少開銷、增強安全性并簡化測試。無論是選擇手動創(chuàng)建DTO或使用像ModelMapper這樣的庫，還是利用Lombok減少代碼，關鍵是選擇最適合項目要求和可維護性的方法。將DTO作為架構一部分，你將會更好地打造自己健壯高效的Spring Boot應用程序。
到此這篇關于SpringBoot中數據傳輸對象(DTO)的實現的文章就介紹到這了,更多相關SpringBoot 數據傳輸對象內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要介紹了JVM運行時數據區(qū)劃分原理詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-05-05
這篇文章主要介紹了Java多線程之簡單模擬售票功能,文中有非常詳細的代碼示例,對正在學習java的小伙伴們有很好地幫助,需要的朋友可以參考下2021-04-04
但在多線程的異步開發(fā)模式下，數據的傳遞和返回和同步開發(fā)模式有很大的區(qū)別。由于線程的運行和結束是不可預料的，因此，在傳遞和返回數據時就無法象函數一樣通過函數參數和return語句來返回數據2012-11-11
Spring Boot + thymeleaf 實現文件上傳下載功能
最近同事問我有沒有有關于技術的電子書，我打開電腦上的小書庫，但是郵件發(fā)給他太大了，公司又禁止用文件夾共享，于是花半天時間寫了個小的文件上傳程序，部署在自己的Linux機器上,需要的朋友可以參考下2018-01-01
這篇文章主要介紹了超詳細的IntelliJ IDEA的安裝及配置,文中有非常詳細的圖文示例,對想要安裝IDEA的小伙伴們有非常好的幫助,需要的朋友可以參考下2021-04-04
spring boot 添加admin監(jiān)控的方法
這篇文章主要介紹了spring boot 添加admin監(jiān)控的相關知識，非常不錯，具有參考借鑒價值,需要的朋友可以參考下2018-02-02
這篇文章主要介紹了Zuul 如何屏蔽服務和指定路徑的實現方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-07-07
在Java開發(fā)中,我們經常需要對字符串進行分割操作,本文主要介紹了java split結果去除空字符串的方法實現,具有一定的參考價值,感興趣的可以了解一下2023-10-10
這篇文章主要為大家介紹了java操作時間方式demo基礎教程示例,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-10-10
這篇文章主要介紹了@CacheEvict + redis實現批量刪除緩存方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-10-10