在 Spring REST API 中从 DTO 到 Entity 的转换

2016-01-06 959 words 2 minutes

Contents

1.概述

在本教程中，我们将处理**在 Spring 应用程序的内部实体和DTO（数据传输对象） **之间发生的转换。

2. 模型映射器

让我们首先介绍我们将用于执行此实体-DTO 转换的主库*ModelMapper 。我们将在pom.xml*中需要这个依赖：

<dependency>
    <groupId>org.modelmapper</groupId>
    <artifactId>modelmapper</artifactId>
    <version>2.4.5</version>
</dependency>

要检查此库是否有更新版本，请转到此处。然后我们将在 Spring 配置中定义ModelMapper bean：

@Bean
public ModelMapper modelMapper() {
    return new ModelMapper();
}

3. DTO

接下来我们介绍一下这个双面问题的DTO端，Post DTO：

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);
    }
    // standard getters and setters
}

请注意，两个自定义日期相关方法处理客户端和服务器之间来回的日期转换：

getSubmissionDateConverted()方法将日期String转换为服务器时区中的Date，以在持久的Post实体中使用它
setSubmissionDate()方法是在当前用户时区将 DTO 的日期设置为Post的Date

4.服务层

现在让我们看一下服务级别操作，它显然适用于实体（而不是 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();
}

接下来我们将看一下服务之上的层，即控制器层。这是实际发生转换的地方。

5.控制器层

接下来让我们检查一个标准控制器实现，为Post资源公开简单的 REST API。我们将在这里展示一些简单的 CRUD 操作：create，update，get one，和get all。鉴于操作非常简单，我们对 Entity-DTO 转换方面特别感兴趣：

@Controller
class PostRestController {
    @Autowired
    private IPostService postService;
    @Autowired
    private IUserService userService;
    @Autowired
    private ModelMapper modelMapper;
    @GetMapping
    @ResponseBody
    public List<PostDto> getPosts(...) {
        //...
        List<Post> posts = postService.getPostsList(page, size, sortDir, sort);
        return posts.stream()
          .map(this::convertToDto)
          .collect(Collectors.toList());
    }
    @PostMapping
    @ResponseStatus(HttpStatus.CREATED)
    @ResponseBody
    public PostDto createPost(@RequestBody PostDto postDto) {
        Post post = convertToEntity(postDto);
        Post postCreated = postService.createPost(post));
        return convertToDto(postCreated);
    }
    @GetMapping(value = "/{id}")
    @ResponseBody
    public PostDto getPost(@PathVariable("id") Long id) {
        return convertToDto(postService.getPostById(id));
    }
    @PutMapping(value = "/{id}")
    @ResponseStatus(HttpStatus.OK)
    public void updatePost(@PathVariable("id") Long id, @RequestBody PostDto postDto) {
        if(!Objects.equals(id, postDto.getId())){
            throw new IllegalArgumentException("IDs don't match");
        }
        Post post = convertToEntity(postDto);
        postService.updatePost(post);
    }
}

这是我们从Post实体到PostDto的转换：

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

这是从 DTO 到实体的转换：

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;
}

如我们所见，在模型映射器的帮助下，转换逻辑快速而简单。我们正在使用映射器的mapAPI，并且无需编写任何转换逻辑即可转换数据。

6. 单元测试

最后，让我们做一个非常简单的测试，以确保实体和 DTO 之间的转换工作正常：

public class PostDtoUnitTest {
    private ModelMapper modelMapper = new ModelMapper();
    @Test
    public void whenConvertPostEntityToPostDto_thenCorrect() {
        Post post = new Post();
        post.setId(1L);
        post.setTitle(randomAlphabetic(6));
        post.setUrl("www.itcodingman.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(1L);
        postDto.setTitle(randomAlphabetic(6));
        postDto.setUrl("www.itcodingman.com");
        Post post = modelMapper.map(postDto, Post.class);
        assertEquals(postDto.getId(), post.getId());
        assertEquals(postDto.getTitle(), post.getTitle());
        assertEquals(postDto.getUrl(), post.getUrl());
    }
}