Spring Boot单DTO实现不同Controller返回不同字段的可行性

当然可以用单个DTO/POJO来满足这两个接口的不同返回字段需求，下面是几种在Spring Boot中常用的实现方式：

1. 使用Jackson的@JsonView注解（推荐） #

通过定义不同的视图接口，标记DTO中哪些字段属于哪个视图，然后在Controller的接口方法上指定要使用的视图，序列化时就只会输出对应视图包含的字段。

首先定义视图标记接口：

public class Views {
    // 对应ControllerA（列表接口）的返回字段集合
    public interface ListView {}
    // 对应ControllerB（详情接口）的返回字段集合，继承ListView可共用emailBody字段
    public interface DetailView extends ListView {}
}

然后编写DTO类，用@JsonView标记每个字段所属的视图：

public class EmailTemplateDto {
    @JsonView(Views.ListView.class)
    private Long id;

    @JsonView(Views.ListView.class)
    private String emailTitle;

    @JsonView({Views.ListView.class, Views.DetailView.class})
    private String emailBody;

    @JsonView(Views.DetailView.class)
    private String correspondingApi;

    // 省略getter、setter、构造方法
}

最后在Controller中指定接口对应的视图：

@RestController
@RequestMapping("/email")
public class MailController {

    @GetMapping("/template")
    @JsonView(Views.ListView.class)
    public List<EmailTemplateDto> getTemplateList() {
        // 模拟业务数据查询
        List<EmailTemplateDto> templates = new ArrayList<>();
        EmailTemplateDto dto = new EmailTemplateDto();
        dto.setId(1L);
        dto.setEmailTitle("用户注册通知");
        dto.setEmailBody("欢迎注册我们的平台...");
        dto.setCorrespondingApi("/api/user/register"); // 该字段不会在ListView视图下序列化输出
        templates.add(dto);
        return templates;
    }

    @GetMapping("/template/{id}")
    @JsonView(Views.DetailView.class)
    public EmailTemplateDto getTemplateDetail(@PathVariable Long id) {
        EmailTemplateDto dto = new EmailTemplateDto();
        dto.setEmailBody("欢迎注册，点击链接验证：{link}");
        dto.setCorrespondingApi("/api/user/verify");
        return dto;
    }
}

2. 使用@JsonInclude注解控制非空字段序列化 #

通过给DTO添加@JsonInclude(JsonInclude.Include.NON_NULL)注解，让Jackson序列化时只输出非null的字段。然后在构造DTO实例时，不为不需要返回的字段赋值（保持为null）即可。

DTO类定义：

@JsonInclude(JsonInclude.Include.NON_NULL)
public class EmailTemplateDto {
    private Long id;
    private String emailTitle;
    private String emailBody;
    private String correspondingApi;

    // 针对不同场景提供构造方法
    // 列表接口用的构造器：初始化id、emailTitle、emailBody
    public EmailTemplateDto(Long id, String emailTitle, String emailBody) {
        this.id = id;
        this.emailTitle = emailTitle;
        this.emailBody = emailBody;
    }

    // 详情接口用的构造器：初始化emailBody、correspondingApi
    public EmailTemplateDto(String emailBody, String correspondingApi) {
        this.emailBody = emailBody;
        this.correspondingApi = correspondingApi;
    }

    // 省略getter、setter
}

Controller中的用法：

@RestController
@RequestMapping("/email")
public class MailController {

    @GetMapping("/template")
    public List<EmailTemplateDto> getTemplateList() {
        List<EmailTemplateDto> templates = new ArrayList<>();
        templates.add(new EmailTemplateDto(1L, "用户注册通知", "欢迎注册我们的平台..."));
        return templates;
    }

    @GetMapping("/template/{id}")
    public EmailTemplateDto getTemplateDetail(@PathVariable Long id) {
        return new EmailTemplateDto("欢迎注册，点击链接验证：{link}", "/api/user/verify");
    }
}

3. 使用@JsonProperty的access属性（适合特定场景） #

对于只需要写入、不需要在某些接口读出的字段，可以设置@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)，这样该字段只会在反序列化（接收请求）时生效，序列化（返回响应）时不会被输出。不过这种方式灵活性不如前两种，适合字段使用场景单一的情况，不太适配当前需求，但可以作为补充方案了解。

内容的提问来源于stack exchange，提问作者黃奕翔