Spring Boot REST API客户端指定加载返回字段的最优实现方案

你当前的实现核心问题是字段判断逻辑硬编码在转换器中，新增可选返回字段就要修改转换层代码，扩展性较差，可参考以下更成熟的实现方案：

方案1：持久层动态投影（推荐，从根源避免加载不必要字段） #

直接使用Spring Data JPA原生的动态投影能力，无需依赖第三方EntityGraph工具包，查询时直接只获取需要的字段，从根源上避免多余数据加载：

// 定义投影接口，无需手动实现，Spring会自动生成代理类
// 基础字段投影
public interface CategorySimpleProjection {
    String getId();
    String getName();
}
// 带子分类的投影
public interface CategoryWithSubProjection extends CategorySimpleProjection {
    Set<SubCategoryProjection> getSubCategories();
    interface SubCategoryProjection {
        String getId();
        String getName();
    }
}

Repository层调整：

@Repository
interface CategoryRepository extends JpaRepository<Category, String>{
    // 泛型方法，根据传入的投影类动态返回对应字段
    <T> Optional<T> findById(String id, Class<T> projectionType);
}

Controller层调用：

@GetMapping(value = "/{id}")
public ResponseEntity<?> get(@PathVariable("id") String id, @RequestParam(value="fields",required=false) String fields ) throws Exception {
    Class<?> projectionType = StringUtils.contains(fields, "subCategories") ? CategoryWithSubProjection.class : CategorySimpleProjection.class;
    Optional<?> result = repository.findById(id, projectionType);
    if(result.isEmpty()) {
        throw new NotFoundException();
    }
    return ResponseEntity.ok(result.get());
}

这个方案完全省去了手动写DTO、转换器的代码，查询时直接只捞需要的字段，性能最优。

方案2：表现层动态序列化（适合已有DTO不想调整持久层的场景） #

用Jackson自带的@JsonView注解实现动态字段过滤，只需要给DTO字段加标注，不需要调整查询逻辑：

// 定义视图标识类
public class View {
    public interface Base {}
    public interface WithSub extends Base {}
}

// DTO加注解标记对应视图
public class CategoryDTO {
    @JsonView(View.Base.class)
    private String id;
    @JsonView(View.Base.class)
    private String name;
    @JsonView(View.WithSub.class)
    private Set<SubCategoryDTO> subCategories;
    // 省略getter setter
}

Controller层动态指定序列化视图：

@GetMapping(value = "/{id}")
public ResponseEntity<MappingJacksonValue> get(@PathVariable("id") String id, @RequestParam(value="fields",required=false) String fields ) throws Exception {
    Optional<Category> categOpt=repository.findById(id);
    if(categOpt.isEmpty()) {
        throw new NotFoundException();
    }
    CategoryDTO dto = categoryDTOConverter.convert(categOpt.get());
    MappingJacksonValue wrapper = new MappingJacksonValue(dto);
    // 根据入参选择序列化视图，自动过滤不需要的字段
    wrapper.setSerializationView(StringUtils.contains(fields, "subCategories") ? View.WithSub.class : View.Base.class);
    return ResponseEntity.ok(wrapper);
}

这个方案只需要写一次转换逻辑，新增可选字段只需要给DTO加对应JsonView注解即可，扩展性很强。

方案3：MapStruct自动生成转换器（适合转换逻辑复杂的场景） #

如果你的DTO和实体之间有复杂的映射规则，用MapStruct替代手写转换器，避免重复劳动，生成的转换代码是直接调用set/get方法，性能远高于反射类映射工具：

@Mapper(componentModel = "spring")
public interface CategoryConverter {
    CategoryDTO toSimpleDto(Category category);
    @Mapping(source = "subCategories", target = "subCategories")
    CategoryDTO toFullDto(Category category);
}

Controller层直接调用对应转换方法即可，不需要自己手写循环添加子分类的逻辑。

内容的提问来源于stack exchange，提问作者ScorprocS