如何自定义Spring Data GET接口并添加额外外部系统数据？

方法一：Spring Data REST Projection（推荐，最简洁） #

Projection是Spring Data REST原生支持的扩展机制，无需修改原实体和Repository，就能自定义返回字段结构，同时完全保留原有分页、过滤、排序能力。

1. 定义Projection接口
   创建包含目标字段的Projection接口，通过自定义方法从外部系统获取用户名：

import org.springframework.data.rest.core.config.Projection;

@Projection(name = "orderWithUsername", types = Order.class)
public interface OrderWithUsernameProjection {
    // 映射原实体的name字段
    String getName();

    // 自定义方法获取用户名，替换为你的外部系统查询逻辑
    default String getUsername(Order order) {
        // 示例：调用用户服务根据uuid查询用户名
        return UserService.getUsernameByUuid(order.getUuid());
    }
}

注：若Spring版本不支持在Projection中直接注入服务，可将查询逻辑封装到独立Service类，通过静态方法或Spring上下文调用。

2. 配置默认使用Projection
   在OrderRepository上添加注解，让端点默认返回带用户名的结果：

import org.springframework.data.repository.PagingAndSortingRepository;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;

@RepositoryRestResource(excerptProjection = OrderWithUsernameProjection.class)
public interface OrderRepository extends PagingAndSortingRepository<Order, Long> {
}

也可通过请求参数临时指定Projection：GET /api/orders?projection=orderWithUsername

方法二：自定义RepositoryRestController（完全可控） #

如果需要更灵活的逻辑控制，可自定义Controller复用Spring Data的查询能力，手动转换为DTO：

1. 创建自定义Controller

import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.rest.webmvc.RepositoryRestController;
import org.springframework.data.web.PageableDefault;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;

@RepositoryRestController
public class OrderCustomController {

    private final OrderRepository orderRepository;
    private final UserService userService;

    public OrderCustomController(OrderRepository orderRepository, UserService userService) {
        this.orderRepository = orderRepository;
        this.userService = userService;
    }

    // 映射到原Spring Data REST的订单列表端点
    @GetMapping("/orders")
    public ResponseEntity<Page<OrderDTO>> getOrders(
            // 复用Spring Data的查询参数，比如?name=order42
            @RequestParam(required = false) String name,
            @PageableDefault Pageable pageable) {
        
        // 调用Repository方法，保留分页、过滤能力
        Page<Order> orderPage = name != null 
                ? orderRepository.findByName(name, pageable) 
                : orderRepository.findAll(pageable);

        // 转换为OrderDTO并填充用户名
        Page<OrderDTO> dtoPage = orderPage.map(order -> {
            OrderDTO dto = new OrderDTO();
            dto.setName(order.getName());
            dto.setUsername(userService.getUsernameByUuid(order.getUuid()));
            return dto;
        });

        return ResponseEntity.ok(dtoPage);
    }
}

注：需确保OrderRepository包含对应查询方法，比如findByName(String name, Pageable pageable)，Spring Data会自动实现该方法。

方法三：Jackson自定义序列化器（修改实体序列化逻辑） #

若不想修改端点结构，可通过Jackson自定义序列化器，在实体序列化时动态添加用户名：

1. 创建自定义序列化器

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.std.StdSerializer;

import java.io.IOException;

public class OrderSerializer extends StdSerializer<Order> {

    private final UserService userService;

    public OrderSerializer(UserService userService) {
        super(Order.class);
        this.userService = userService;
    }

    @Override
    public void serialize(Order order, JsonGenerator gen, SerializerProvider provider) throws IOException {
        gen.writeStartObject();
        gen.writeStringField("name", order.getName());
        // 添加用户名字段
        gen.writeStringField("username", userService.getUsernameByUuid(order.getUuid()));
        gen.writeEndObject();
    }
}

2. 注册序列化器
   在Order实体上添加注解指定序列化器：

import com.fasterxml.jackson.databind.annotation.JsonSerialize;

@JsonSerialize(using = OrderSerializer.class)
public class Order {
    public String name;
    public Long uuid;
}

注：此方式会让所有返回Order实体的端点都使用该序列化逻辑，若有其他端点不需要返回用户名，可能产生冲突。

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