Spring REST API 從實體到 DTO 的轉換

時間 2019-11-29

標籤 spring rest api 實體 dto 轉換欄目 Spring 简体版

原文原文鏈接

介紹

在本文中，咱們將處理 Spring 應用的內部實體與客戶端外的 DTO（數據傳輸對象）之間須要進行的轉換。java

模型映射

讓咱們從介紹用於執行的實體到 DTO 轉換的主庫開始 —— ModelMapper。咱們須要將在 pom.xml 中添加以下依賴：服務器

<dependency>
    <groupId>org.modelmapper</groupId>
    <artifactId>modelmapper</artifactId>
    <version>2.3.2</version>
</dependency>
複製代碼

而後，咱們在 Spring 配置中定義 ModelMapper bean：app

@Bean
public ModelMapper modelMapper() {
    return new ModelMapper();
}
複製代碼

DTO

接下來，讓咱們來介紹這個雙面問題的 DTO 方面 —— Post DTO：dom

public class PostDto {
    private static final SimpleDateFormat dateFormat
      = new SimpleDateFormat("yyyy-MM-dd HH:mm");
 
    private Long id;
 
    private String title;
 
    private String url;
 
    private String date;
 
    private UserDto user;
 
    public Date getSubmissionDateConverted(String timezone) throws ParseException {
        dateFormat.setTimeZone(TimeZone.getTimeZone(timezone));
        return dateFormat.parse(this.date);
    }
 
    public void setSubmissionDate(Date date, String timezone) {
        dateFormat.setTimeZone(TimeZone.getTimeZone(timezone));
        this.date = dateFormat.format(date);
    }
 
    // getters and setters
}
複製代碼

注意，兩個自定義日期相關方法，處理客戶端和服務器之間的日期來回轉換：post

getSubmissionDateConverted() 方法將Date字符串轉換爲服務器時區中的日期，以在持久化 Post 實體中使用它
setSubmissionDate() 方法用於將 DTO 的日期設置爲當前用戶時區中的 Post 的 Date

Service

如今讓咱們看看一個 Service 層的操做 —— 顯然它將與實體（而不是DTO）一塊兒工做：單元測試

public List<Post> getPostsList( int page, int size, String sortDir, String sort) {
  
    PageRequest pageReq
     = PageRequest.of(page, size, Sort.Direction.fromString(sortDir), sort);
  
    Page<Post> posts = postRepository
      .findByUser(userService.getCurrentUser(), pageReq);
    return posts.getContent();
}
複製代碼

咱們接下來將看到服務的上層 —— Controller 層，這也是轉換實際發生的地方。學習

Controller

如今讓咱們看看一個標準的 Controller 實現，爲 Post 公開簡單的 REST API。
咱們將在這裏展現幾個簡單的 CRUD 操做：建立、更新、獲取一個和獲取所有。測試

@Controller
class PostRestController {
 
    @Autowired
    private IPostService postService;
 
    @Autowired
    private IUserService userService;
 
    @Autowired
    private ModelMapper modelMapper;
 
    @RequestMapping(method = RequestMethod.GET)
    @ResponseBody
    public List<PostDto> getPosts(...) {
        //...
        List<Post> posts = postService.getPostsList(page, size, sortDir, sort);
        return posts.stream()
          .map(post -> convertToDto(post))
          .collect(Collectors.toList());
    }
 
    @RequestMapping(method = RequestMethod.POST)
    @ResponseStatus(HttpStatus.CREATED)
    @ResponseBody
    public PostDto createPost(@RequestBody PostDto postDto) {
        Post post = convertToEntity(postDto);
        Post postCreated = postService.createPost(post));
        return convertToDto(postCreated);
    }
 
    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    @ResponseBody
    public PostDto getPost(@PathVariable("id") Long id) {
        return convertToDto(postService.getPostById(id));
    }
 
    @RequestMapping(value = "/{id}", method = RequestMethod.PUT)
    @ResponseStatus(HttpStatus.OK)
    public void updatePost(@RequestBody PostDto postDto) {
        Post post = convertToEntity(postDto);
        postService.updatePost(post);
    }
}
複製代碼

這是咱們從 Post 實體到 PostDto 的轉換：this

private PostDto convertToDto(Post post) {
    PostDto postDto = modelMapper.map(post, PostDto.class);
    postDto.setSubmissionDate(post.getSubmissionDate(), 
        userService.getCurrentUser().getPreference().getTimezone());
    return postDto;
}
複製代碼

這是從DTO到實體的轉換：url

private Post convertToEntity(PostDto postDto) throws ParseException {
    Post post = modelMapper.map(postDto, Post.class);
    post.setSubmissionDate(postDto.getSubmissionDateConverted(
      userService.getCurrentUser().getPreference().getTimezone()));
  
    if (postDto.getId() != null) {
        Post oldPost = postService.getPostById(postDto.getId());
        post.setRedditID(oldPost.getRedditID());
        post.setSent(oldPost.isSent());
    }
    return post;
}
複製代碼

所以，正如您所看到的，在模型映射的幫助下， 轉換邏輯快速而簡單 —— 咱們使用映射的 map API，無需編寫任何轉換邏輯就能夠得到轉換後的數據。

單元測試

最後，讓咱們作一個很是簡單的測試，以確保實體和 DTO 之間的轉換工做正常：

public class PostDtoUnitTest {
 
    private ModelMapper modelMapper = new ModelMapper();
 
    @Test
    public void whenConvertPostEntityToPostDto_thenCorrect() {
        Post post = new Post();
        post.setId(Long.valueOf(1));
        post.setTitle(randomAlphabetic(6));
        post.setUrl("www.test.com");
 
        PostDto postDto = modelMapper.map(post, PostDto.class);
        assertEquals(post.getId(), postDto.getId());
        assertEquals(post.getTitle(), postDto.getTitle());
        assertEquals(post.getUrl(), postDto.getUrl());
    }
 
    @Test
    public void whenConvertPostDtoToPostEntity_thenCorrect() {
        PostDto postDto = new PostDto();
        postDto.setId(Long.valueOf(1));
        postDto.setTitle(randomAlphabetic(6));
        postDto.setUrl("www.test.com");
 
        Post post = modelMapper.map(postDto, Post.class);
        assertEquals(postDto.getId(), post.getId());
        assertEquals(postDto.getTitle(), post.getTitle());
        assertEquals(postDto.getUrl(), post.getUrl());
    }
}
複製代碼