Java 中的局部响应模式：优化数据交付以实现高效的 Web 服务

约 4 分钟

也称为

增量响应
局部结果

局部响应设计模式的意图

使应用程序能够向客户端返回局部响应，从而提高感知性能，并使客户端能够在整个响应可用之前开始处理部分数据。

局部响应模式的详细说明，以及现实世界中的示例

现实世界中的例子

想象一家餐厅，顾客点了一份多道菜的菜肴。餐厅不会等到所有菜肴都准备好才上菜，而是会在每道菜准备好后立即端出来。这样可以让顾客尽快开始享受美食，改善用餐体验，并通过让厨房逐步准备和上菜来优化厨房工作流程。同样，在软件中，局部响应设计模式会根据数据的可用性交付部分数据，使客户端能够立即开始处理，从而提高整体性能和响应能力。

用简单的话来说

局部响应设计模式允许系统将部分数据发送给客户端，这些数据在可用时就会发送，使客户端能够在收到完整响应之前开始处理数据。

Java 中局部响应模式的编程示例

局部响应设计模式允许客户端指定他们需要资源的哪些字段。这种模式对于减少网络传输的数据量和允许客户端更早地开始处理数据很有用。

该编程示例展示了一个简单的视频流应用程序。

Video 类表示一个具有多个字段的视频对象。

public class Video {
    private String id;
    private String title;
    private String description;
    private String url;

    // Getters and setters...
}

FieldJsonMapper 实用程序类将视频对象转换为 JSON，只包含请求的字段。mapFields 方法接受一个 Video 对象和一组字段名称。它创建一个 JSON 对象，其中只包含指定的字段。来自 Jackson 库的 ObjectMapper 用于构建 JSON 对象。

public class FieldJsonMapper {
    private static final ObjectMapper mapper = new ObjectMapper();

    public static ObjectNode mapFields(Video video, Set<String> fields) {
        ObjectNode node = mapper.createObjectNode();

        if (fields.contains("id")) {
            node.put("id", video.getId());
        }
        if (fields.contains("title")) {
            node.put("title", video.getTitle());
        }
        if (fields.contains("description")) {
            node.put("description", video.getDescription());
        }
        if (fields.contains("url")) {
            node.put("url", video.getUrl());
        }

        return node;
    }
}

VideoResource 类处理 HTTP 请求，并只返回视频数据的请求字段。

VideoResource 类是一个 RESTful 资源，用于处理 HTTP GET 请求。
getVideo 方法通过 ID 获取 Video，并处理 fields 查询参数。
它将 fields 参数拆分为一组字段名称，使用 FieldJsonMapper 将响应中只包含这些字段，并返回部分 JSON 响应。

@Path("/videos")
public class VideoResource {
    @GET
    @Path("/{id}")
    @Produces(MediaType.APPLICATION_JSON)
    public Response getVideo(@PathParam("id") String id, @QueryParam("fields") String fieldsParam) {
        Video video = findVideoById(id); // Assume this method fetches the video by ID

        Set<String> fields = new HashSet<>(Arrays.asList(fieldsParam.split(",")));
        ObjectNode responseNode = FieldJsonMapper.mapFields(video, fields);

        return Response.ok(responseNode.toString()).build();
    }

    private Video findVideoById(String id) {
        // Dummy data for demonstration purposes
        Video video = new Video();
        video.setId(id);
        video.setTitle("Sample Video");
        video.setDescription("This is a sample video.");
        video.setUrl("http://example.com/sample-video");

        return video;
    }
}

App 类初始化 Web 服务器，并注册 VideoResource。

App 类使用 Jersey 设置服务器。
它注册 VideoResource 类，该类将处理传入的 HTTP 请求。
服务器监听 http://localhost:8080/。

public class App {
    public static void main(String[] args) {
        ResourceConfig config = new ResourceConfig();
        config.register(VideoResource.class);
        SimpleContainerFactory.create("http://localhost:8080/", config);
    }
}