将 Spring ModelAttribute 应用于所有使用特定参数类型的控制器

ped*_*rro 5 java spring spring-mvc

在 SpringBoot REST 应用程序中,我有一个TableRequest类型,其中包含表格数据 GET 请求的列排序、过滤和分页详细信息。它是通用的,因为它不关心所请求的具体数据是什么,它只指定通用表参数。因此它适用于许多不同的控制器方法。此外,因为它适用于 GET 请求,所以字段作为请求参数传递(无@RequestBodyjson 参数)。我在控制器类中有一个@ModelAttribute方法,它将请求参数解析为一个TableRequest对象,然后实际的@RequestMapping方法接收该对象作为@ModelAttribute参数。

因为该类TableRequest是通用的,所以我希望能够跨多个控制器使用它,而不必将解析逻辑复制到每个控制器中。我想知道是否有一种基于 Spring-y 注释的方法可以@ModelAttribute在控制器有TableRequest输入参数时重用相同的方法。

提前致谢 :)


我的解决方案(基于下面选定的答案)

我创建了一个@TableRequestController注释和一个相应的@ControllerAdvice类,该类仅适用于具有该注释的控制器类。该 ControllerAdvice 类包含@ModelAttribute将 GET 请求参数解析为TableRequest对象的方法。

这里一个重要的警告是,新的@TableRequestController可能仅适用于整个控制器类,而不适用于单个控制器方法。因此,我创建了一个单独的内部控制器类,用该注释标记,其 @RequestMapping 方法都接受 TableRequest 对象。

@TableRequestController:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface TableRequestController {}
Run Code Online (Sandbox Code Playgroud)

控制器建议类:

@ControllerAdvice(annotations = TableRequestController.class)
public class TableRequestControllerAdvice {

    @ModelAttribute
    public TableRequest tableRequest(
            @RequestParam Map<String, String> params,
            @RequestParam int pageStart,
            @RequestParam int pageSize) {

        return new TableRequest(params, pageStart, pageSize);
    }
}
Run Code Online (Sandbox Code Playgroud)

TableRequest REST 控制器类:

@RestController
@TableRequestController
public static class MyTableRequestController {

    @RequestMapping("/the/table/request/url")
    public MyResponse makeTableRequest(
            TableRequest tableRequest) {

        return new MyResponse(tableRequest);
    }
}
Run Code Online (Sandbox Code Playgroud)

a b*_*ver 2

您可以使用@ControllerAdvice。此处定义的所有内容都适用于所有控制器或定义的子集(如果您愿意)。

文档

另一种选择(更好的恕我直言)是编写一个消息转换器。它只处理一种特定类型。您不再需要@ModelAttribute,而只需TableRequest在控制器方法中添加一个参数即可。