Question

我有一个REST端点，如下所示。

@Path("/api/observers")
public interface MyServiceEndpoint {

    @GET
    @Path("/history")
    HistoryPage<Action> getObserverHistory(@QueryParam("pageNum") @DefaultValue("1") int pageNum,
                                           @QueryParam("pageSize") @DefaultValue("25") int pageSize,
                                           @QueryParam("methodName") String methodName,
                                           @QueryParam("dateBefore") String dateBefore,
                                           @QueryParam("dateAfter") String dateAfter,
                                           @QueryParam("actionUUID") String actionUUID,
                                           @QueryParam("supersededByUUID") String supersededByUUID,
                                           @QueryParam("eventUUID") String eventUUID,
                                           @QueryParam("wasSuccessful") Boolean wasSuccessful);

}

如您所见，有许多参数，其中一些是可选的。有人告诉我，更好的设计模式是使用param对象而不是指定这几个参数。我是REST的新手，我不知道这意味着什么以及如何做到这一点我也想知道一旦完成，如何从AngularJS服务中消费它？现在我正在使用这个现有的端点，如：

myService.toggleEnabled = function (observer) {
            return $http({
                method: 'PUT',
                url: 'api/observers/history',
                headers: {
                    'Accept': mimeType,
                    'Content-Type': mimeType
                },
                params : {
                    pageNum: 1,
                    pageSize: 5
                }
            });
        };

有人可以给我一个例子，或者指出正确的方向/资源吗？

Answer 1

自JAX-RS 2.0以来，@BeanParam已作为参数聚合器引入。您只需要将所有查询参数定义为简单的POJO类作为字段：

public class ObserverHistoryParams {
    @QueryParam("pageNum") @DefaultValue("1") 
    private int pageNum;

    @QueryParam("pageSize") @DefaultValue("25") 
    private int pageSize;

    // other params & getters & setters
}

然后将getObserverHistory方法签名更改为：

HistoryPage<Action> getObserverHistory(@BeanParam ObserverHistoryParams params) {
  ...
}

使用此方法，您的Angular前端界面不需要任何更改。

当REST端点的可选参数太多时，如何使用param对象而不是多个参数

1 个答案: