SpringBoot中數(shù)據(jù)傳輸對(duì)象(DTO)的實(shí)現(xiàn)
探索在Spring Boot中使用數(shù)據(jù)傳輸對(duì)象（DTO）的好處，本文包括了手動(dòng)創(chuàng)建DTO、使用ModelMapper和Lombok創(chuàng)建DTO的示例。
1. 什么是數(shù)據(jù)傳輸對(duì)象（DTO）？
數(shù)據(jù)傳輸對(duì)象（DTO）是一種設(shè)計(jì)模式，用于封裝和傳輸應(yīng)用程序不同層之間的數(shù)據(jù)。
DTO是輕量級(jí)對(duì)象，通常只包含必要的字段，不包含任何業(yè)務(wù)邏輯。DTO作用于應(yīng)用程序中不同的業(yè)務(wù)之間的數(shù)據(jù)傳輸，例如在前端和后端之間或在分布式系統(tǒng)中不同的微服務(wù)值之間。
在Spring Boot應(yīng)用程序中，DTO特別有用，因?yàn)樾枰诳刂破鲗?、服?wù)層和持久層之間傳輸數(shù)據(jù)。通過(guò)使用DTO就可以將內(nèi)部數(shù)據(jù)模型與外部表示解耦（這點(diǎn)巨好，老鳥都知道），從而更好地控制數(shù)據(jù)傳輸。
2. 在Spring Boot中使用DTO的好處
在Spring Boot應(yīng)用程序中使用DTO有幾個(gè)優(yōu)點(diǎn)：
- 數(shù)據(jù)隔離：DTO允許將暴露給外部的數(shù)據(jù)與內(nèi)部的模型隔離。這可以防止暴露敏感和不必要的數(shù)據(jù)，并為數(shù)據(jù)交換提供清晰的字段。
- 減少開銷：DTO可以僅包含特定所需的字段，減少網(wǎng)絡(luò)傳輸。這最小化了傳輸大型對(duì)象的開銷。
- 版本控制和兼容性：DTO可以使接口支持向后兼容。一個(gè)API可以對(duì)外提供多個(gè)DTO結(jié)構(gòu)。
- 提高安全性：通過(guò)對(duì)DTO暴露數(shù)據(jù)的控制，就避免了數(shù)據(jù)泄漏以及保護(hù)了敏感信息的安全性。
- 增強(qiáng)測(cè)試：DTO簡(jiǎn)化了單元測(cè)試，因?yàn)槟梢栽跍y(cè)試場(chǎng)景中輕松創(chuàng)建和操作它們，而不依賴于復(fù)雜的域?qū)ο蟆?/li>
3. 在Spring Boot中以不同方式使用DTO
3.1. 手動(dòng)創(chuàng)建DTO
在這種方法中，手動(dòng)創(chuàng)建對(duì)實(shí)體結(jié)構(gòu)映射的DTO類。然后編寫代碼在實(shí)體對(duì)象和DTO之間映射數(shù)據(jù)。
public class UserDTO {
private Long id;
private String username;
private String email;
// 構(gòu)造函數(shù)、getter和setter
}
創(chuàng)建一個(gè)控制器方法演示手動(dò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);
}
}
輸出：
調(diào)用/api/users/1請(qǐng)求時(shí)，將收到UserDTO結(jié)構(gòu)的用戶數(shù)據(jù)。
{
"id": 1,
"username": "張三",
"email": "zhangsan@qq.com"
}
3.2. 使用ModelMapper
ModelMapper用于自動(dòng)將實(shí)體對(duì)象映射到DTO，反之亦然。以下是pom.xml依賴：
<dependency> <groupId>org.modelmapper</groupId> <artifactId>modelmapper</artifactId> <version>2.4.3</version> </dependency>
實(shí)例化ModelMapper為一個(gè)BEAN，這樣就可以在整個(gè)程序中使用ModelMapper
以下是創(chuàng)建Spring Boot應(yīng)用程序中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將實(shí)體對(duì)象映射到DTO：
@RestController
@RequestMapping("/api/users")
public class UserController {
@Autowired
private UserService userService;
@Autowired
private ModelMapper modelMapper; // 自動(dòng)裝配ModelMapper Bean
@GetMapping("/{id}")
public ResponseEntity getUserById(@PathVariable Long id) {
User user = userService.getUserById(id);
UserDTO userDTO = modelMapper.map(user, UserDTO.class); // 使用ModelMapper進(jìn)行映射
return ResponseEntity.ok(userDTO);
}
}
輸出：
輸出將與手動(dòng)創(chuàng)建DTO的示例相同。
3.3 使用Lombok
在pom.xml文件中添加Lombok依賴項(xiàng)。
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.22</version> <scope>provided</scope> </dependency>
以下是演示如何使用Lombok為User實(shí)體創(chuàng)建DTO。
import lombok.Data;
@Data //關(guān)鍵注解
public class UserDTO {
private Long id;
private String username;
private String email;
}
以下是如何使用Lombok將實(shí)體對(duì)象映射到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);
}
}
輸出：
輸出與手動(dòng)創(chuàng)建DTO的示例相同。
4.在DTO中格式化不同類型的值
在DTO中格式化不同類型的值是確保數(shù)據(jù)在序列化或顯示時(shí)以特定格式呈現(xiàn)的常見要求。根據(jù)業(yè)務(wù)要求格式化的值類型，可以使用各種方法，包括注解、自定義方法或外部庫(kù)。下面是在DTO中格式化不同類型的值實(shí)例：
4.1. 格式化日期和時(shí)間
4.1.1. 使用@JsonFormat注解（Jackson）
要在DTO中格式化日期和時(shí)間值，可以使用Jackson庫(kù)提供的@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注解指定所需的日期和時(shí)間格式。
4.1.2. 使用SimpleDateFormat（自定義方法）
還可以通過(guò)在DTO類中提供自定義getter方法來(lái)格式化日期和時(shí)間，該方法返回格式化后的日期字符串。
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. 格式化數(shù)字
4.2.1. 使用@NumberFormat注解（Spring）
要格式化數(shù)字值，如數(shù)字或貨幣，您可以使用Spring提供的@NumberFormat注解。此注解允許您指定數(shù)字格式模式。
import org.springframework.format.annotation.NumberFormat;
public class ProductDTO {
private Long id;
@NumberFormat(pattern = "#,###.00")
private BigDecimal price;
// 其他字段、getter和setter
}
在此示例中，price字段使用@NumberFormat注解指定數(shù)字格式模式。
4.2.2. 使用DecimalFormat（自定義方法）
還可以通過(guò)在DTO類中提供自定義getter方法來(lái)格式化數(shù)字，該方法使用DecimalFormat返回格式化后的數(shù)字字符串。
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. 使用自定義方法
對(duì)于格式化字符串值，可以在DTO類中創(chuàng)建自定義getter方法以根據(jù)需要操作字符串。例如，您可以優(yōu)化空格、大寫單詞或應(yīng)用任何其他字符串操作邏輯。
public class ArticleDTO {
private Long id;
private String title;
public String getFormattedTitle() {
// 自定義格式化邏輯在這里
return title.trim(); // 示例：修剪空格
}
// 其他字段、getter和setter
}
4.4. 格式化枚舉
4.4.1. 使用自定義方法
在處理DTO中的枚舉時(shí)，可以創(chuàng)建自定義getter方法以返回枚舉值的格式化表示形式。例如，您可以將枚舉值轉(zhuǎn)換為大寫或使用不同的表示形式。
public class OrderDTO {
private Long id;
private OrderStatus status;
public String getFormattedStatus() {
return status.toString().toUpperCase(); // 示例：轉(zhuǎn)換為大寫
}
// 其他字段、getter和setter
}
4.5. 格式化布爾值
4.5.1. 使用自定義方法
對(duì)于布爾值，可以創(chuàng)建自定義getter方法以返回格式化表示形式，例如“是”或“否”，而不是“true”或“false”。
public class UserDTO {
private Long id;
private boolean isActive;
public String getFormattedIsActive() {
return isActive ? "Yes" : "No"; // 示例：轉(zhuǎn)換為"Yes"或"No"
}
// 其他字段、getter和setter
}
通過(guò)使用這些方法，可以根據(jù)具體要求格式化DTO中的不同類型的值，確保在序列化或顯示DTO時(shí)數(shù)據(jù)以期望的格式呈現(xiàn)。
5.其他注意事項(xiàng)和最佳實(shí)踐
5.1. DTO中的驗(yàn)證
在處理DTO時(shí)，考慮數(shù)據(jù)驗(yàn)證至關(guān)重要。應(yīng)該驗(yàn)證DTO中的傳入數(shù)據(jù)，以確保它滿足所需的約束和業(yè)務(wù)規(guī)則。可以使用Spring的驗(yàn)證注解（如@NotNull、@Size）或自定義驗(yàn)證注解來(lái)驗(yàn)證DTO字段。
以下是使用Spring的@NotBlank注解進(jìn)行DTO驗(yàn)證的示例：
public class UserDTO {
@NotNull
private Long id;
@NotBlank
@Size(min = 5, max = 50)
private String username;
@Email
private String email;
// 構(gòu)造函數(shù)、getter和setter
}
5.2. 用于復(fù)雜嵌套對(duì)象的DTO
在實(shí)際業(yè)務(wù)中，處理嵌套對(duì)象的DTO會(huì)很復(fù)雜。需要?jiǎng)?chuàng)建嵌套的DTO來(lái)準(zhǔn)確映射這些結(jié)構(gòu)。
例如，如果一個(gè)User與一組Address對(duì)象關(guān)聯(lián)，可以創(chuàng)建一個(gè)嵌套AddressDTO的UserDTO：
public class UserDTO {
private Long id;
private String username;
private String email;
private List<AddressDTO> addresses;
// 構(gòu)造函數(shù)、getter和setter
}
5.3. DTO版本控制
隨著業(yè)務(wù)的發(fā)展，可能需要對(duì)DTO進(jìn)行更改。為了保持向后兼容性則需要考慮對(duì)DTO進(jìn)行版本控制。例如可以通過(guò)向DTO添加版本標(biāo)識(shí)符或在必要時(shí)創(chuàng)建新的DTO版本來(lái)實(shí)現(xiàn)。
5.4. RESTful API中的DTO
DTO在RESTful API中常用于表示客戶端和服務(wù)器之間的數(shù)據(jù)交換。在設(shè)計(jì)RESTful端時(shí)，應(yīng)仔細(xì)選擇或創(chuàng)建DTO，以滿足不同業(yè)務(wù)需求。
6.將DTO與Spring驗(yàn)證一起使用
Spring提供了一個(gè)強(qiáng)大的機(jī)制，使用@Valid注解在控制器方法中去驗(yàn)證DTO。當(dāng)你將DTO參數(shù)與@Valid注解一起使用時(shí)，Spring將自動(dòng)基于DTO類中定義的驗(yàn)證規(guī)則觸發(fā)驗(yàn)證。
以下是使用DTO驗(yàn)證的控制器方法示例：
@RestController
@RequestMapping("/api/users")
public class UserController {
@Autowired
private UserService userService;
@PostMapping("/create")
public ResponseEntity createUser(@Valid @RequestBody UserDTO userDTO) {
// 驗(yàn)證邏輯會(huì)自動(dòng)觸發(fā)
// 將UserDTO映射到User實(shí)體并保存它
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ā)驗(yàn)證。如果驗(yàn)證失敗，Spring將自動(dòng)處理驗(yàn)證錯(cuò)誤并返回帶有適當(dāng)錯(cuò)誤消息的響應(yīng)數(shù)據(jù)。
7.微服務(wù)架構(gòu)中的DTO
在微服務(wù)架構(gòu)中，DTO在定義微服務(wù)之間的邊界方面起著關(guān)鍵作用。每個(gè)微服務(wù)都可以擁有一套針對(duì)其特定需求而量身定制的DTO。這種分離模式確保了微服務(wù)之間的松耦合。
DTO還有助于減少微服務(wù)之間傳輸?shù)臄?shù)據(jù)量，這對(duì)于維護(hù)基于微服務(wù)的系統(tǒng)的性能和可擴(kuò)展性至關(guān)重要。
8.結(jié)論
數(shù)據(jù)傳輸對(duì)象（DTO）在Spring Boot應(yīng)用程序中不可或缺，它充當(dāng)應(yīng)用程序不同層和外部系統(tǒng)之間的橋梁。通過(guò)仔細(xì)設(shè)計(jì)和使用DTO，可以改善數(shù)據(jù)隔離、減少開銷、增強(qiáng)安全性并簡(jiǎn)化測(cè)試。無(wú)論是選擇手動(dòng)創(chuàng)建DTO或使用像ModelMapper這樣的庫(kù)，還是利用Lombok減少代碼，關(guān)鍵是選擇最適合項(xiàng)目要求和可維護(hù)性的方法。將DTO作為架構(gòu)一部分，你將會(huì)更好地打造自己健壯高效的Spring Boot應(yīng)用程序。
到此這篇關(guān)于SpringBoot中數(shù)據(jù)傳輸對(duì)象(DTO)的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)SpringBoot 數(shù)據(jù)傳輸對(duì)象內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Java 中 getClass() 方法的使用與原理深入分析(對(duì)象類型信息)
在 Java 編程中,getClass() 是一個(gè)非常重要的方法,它用于獲取對(duì)象的運(yùn)行時(shí)類信息,無(wú)論是調(diào)試代碼、反射操作,還是類型檢查,getClass() 都扮演著關(guān)鍵角色,本文將深入探討 getClass() 的使用方法、底層原理以及實(shí)際應(yīng)用場(chǎng)景,感興趣的朋友一起看看吧2024-12-12
Spring MVC學(xué)習(xí)教程之視圖深入解析
這篇文章主要給大家介紹了關(guān)于Spring MVC學(xué)習(xí)教程之視圖解析的相關(guān)資料，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家學(xué)習(xí)或使用spring mvc具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面來(lái)一起看看吧2018-11-11
maven 中relativePath標(biāo)簽的作用
元素在 Maven 的 pom.xml 文件中用于指定父項(xiàng)目的相對(duì)路徑,這篇文章主要介紹了maven 中relativePath標(biāo)簽的作用,需要的朋友可以參考下2024-11-11
這篇文章主要幫助大家輕松掌握java裝飾者模式,具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2016-09-09
詳解tryAcquire()、addWaiter()、acquireQueued()
這篇文章主要tryAcquire()、addWaiter()、acquireQueued()的用法，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-03-03
這篇文章主要介紹了SpringBoot中的自定義Starter解讀,啟動(dòng)器模塊其實(shí)是一個(gè)空的jar文件,里面沒有什么類、接口,僅僅是提供輔助性依賴管理,這些依賴可能用于自動(dòng)裝配或者其他類庫(kù),需要的朋友可以參考下2023-12-12
這篇文章主要介紹了java 中modCount 詳解及源碼分析的相關(guān)資料,需要的朋友可以參考下2017-02-02
這篇文章主要介紹了SpringBoot集成Kafka的步驟，幫助大家更好的理解和使用SpringBoot，感興趣的朋友可以了解下2021-01-01
在互聯(lián)網(wǎng)應(yīng)用中,URL（Uniform?Resource?Locator,統(tǒng)一資源定位符）是定位和訪問(wèn)網(wǎng)絡(luò)資源的重要標(biāo)識(shí),然而,URL?中可能包含一些特殊字符,為了保證?URL?的有效性和兼容性,必須對(duì)?URL?進(jìn)行編碼處理,所以本文給大家介紹了如何使用Java對(duì)URL進(jìn)行編碼和解碼2025-03-03
idea中文件被Mark as Plain Text后恢復(fù)方式
在IntelliJ IDEA中,如果錯(cuò)誤地將文件標(biāo)記為純文本（Mark as Plain Text）,可以通過(guò)在項(xiàng)目目錄中右鍵點(diǎn)擊文件并選擇“Mark as”來(lái)恢復(fù)原文件類型2024-11-11