Spring MVC @Controller拦截自己的请求

Question

想象我们有一个像这样的控制器：

@RestController
@RequestMapping("/{parameter}")
public class MyController {

    @ExceptionHandler(SomeException.class)
    public Object handleSomeException() { /* handle */ }

    @RequestMapping("/something")
    public Object handleSomething(@PathVariable("parameter") String parameter) {
        /* handle */
    }

    @RequestMapping("/somethingElse")
    public Object handleSomethingElse(@PathVariable("parameter") String parameter) {
        /* handle */
    }
}

问题是，如何以类似于@ExceptionHandler工作的方式为此特定控制器实现一些常见的pre \\\\ post-handling处理？ 例如，我想在控制器中有一个方法，该方法先接收处理程序方法的请求，但仅接收对此特定控制器的请求。

我知道RequestBodyAdvice和ResponseBodyAdvice接口，但是想要控制器本地的东西。

作为使用示例-我想在每个处理程序之前对公用parameter变量进行一些验证。

Answer 1

上面所有遗漏的内容回答了如何为特定控制器注册拦截器，可以通过以下方式完成：

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LocaleChangeInterceptor());
        registry.addInterceptor(new ThemeChangeInterceptor()).addPathPatterns("/**").excludePathPatterns("/admin/**");
        registry.addInterceptor(new SecurityInterceptor()).addPathPatterns("/secure/*");
    }
}

在XML中，相同：

<mvc:interceptors>
    <bean class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor"/>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <mvc:exclude-mapping path="/admin/**"/>
        <bean class="org.springframework.web.servlet.theme.ThemeChangeInterceptor"/>
    </mvc:interceptor>
    <mvc:interceptor>
        <mvc:mapping path="/secure/*"/>
        <bean class="org.example.SecurityInterceptor"/>
    </mvc:interceptor>
</mvc:interceptors>

春季文件

Answer 2

您将需要编写自己的HandlerInterceptor 。 您可以通过扩展HandlerInterceptorAdapter轻松地做到这一点。 然后，您可以覆盖preHandle()和/或postHandle() 。

在HandlerMapping确定适当的处理程序对象之后，但在HandlerAdapter调用处理程序之前，将调用preHandle() 。

在HandlerAdapter实际调用处理程序之后，但在DispatcherServlet呈现视图之前，将调用postHandle() 。

您可以使用HttpServletRequest的getRequestURI()方法为preHandle()不同处理程序添加逻辑。

例：

public class ValidationInterceptor extends HandlerInterceptorAdapter {

    public static final String FOO_URL = "foo";
    public static final String BAR_URL = "bar";

    @Override
    public boolean preHandle(HttpServletRequest request,
                             HttpServletResponse response,
                             Object handler) throws Exception {

        String uri = request.getRequestURI();

        if (FOO_URL.equals(uri)) {        
            // for example - validation failed
            response.sendRedirect("/to/some/url");
            return false;
        } else if (BAR_URL.equals(uri)) {
            // for example - validation successful
        }
        return true;
    }
}

然后在您的dispatcher-servlet.xml注册这个HandlerInterceptor 。

<mvc:interceptors>
    <bean class="your.package.ValidationInterceptor"/>
</mvc:interceptors>

您可以将其配置为更多特定于URL。 参见Spring Reference的22.16.5拦截器部分。

Answer 3

尽管HandlerInterceptorAdapter似乎是“正确”的解决方案，但它似乎并不是您想要的解决方案。

下面的代码可能是您想要的解决方案（或者至少是您在问题中要求的解决方案）。

摘要：编写您自己的preBlam和postBlam方法。

一些代码：

@RestController
@RequestMapping("/{parameter}")
public class MyController
{

    @ExceptionHandler(SomeException.class)
    public Object handleSomeException()
    {
    /* handle */
    }

    @RequestMapping("/something")
    public Object handleSomething(@PathVariable("parameter") String parameter)
    {
        preBlam(desired params here);

        /* handle */

        postBlam(desired params here);
    }

    @RequestMapping("/somethingElse")
    public Object handleSomethingElse(@PathVariable("parameter") String parameter)
    {
        preBlam(desired params here);

        /* handle */

        postBlam(desired params here);
    }

    private blam preBlam(parameters)
    {
    // do initial blamish work
    }

    private blam postBlam(parameters)
    {
    // do post blamish work here
    }
}

另一个选择：使用AOP为受影响的方法设置前置和后置处理程序。 我不是AOP的大用户，所以我不能只是举个例子。

Answer 4

使用HandlerInterceptorAdapter

截获控制器执行之前和之后，记录执行时间的开始和结束，并将其保存到现有截获的控制器的modelAndView中，以供以后显示。

public class ExecuteTimeInterceptor extends HandlerInterceptorAdapter{

private static final Logger logger = Logger.getLogger(ExecuteTimeInterceptor.class);

//before the actual handler will be executed
public boolean preHandle(HttpServletRequest request,
    HttpServletResponse response, Object handler)
    throws Exception {

    long startTime = System.currentTimeMillis();
    request.setAttribute("startTime", startTime);

    return true;
}

//after the handler is executed
public void postHandle(
    HttpServletRequest request, HttpServletResponse response,
    Object handler, ModelAndView modelAndView)
    throws Exception {

    long startTime = (Long)request.getAttribute("startTime");

    long endTime = System.currentTimeMillis();

    long executeTime = endTime - startTime;

    //modified the exisitng modelAndView
    modelAndView.addObject("executeTime",executeTime);

    //log it
    if(logger.isDebugEnabled()){
       logger.debug("[" + handler + "] executeTime : " + executeTime + "ms");
    }
}

其他一些示例-http: //www.mkyong.com/spring-mvc/spring-mvc-handler-interceptors-example/

Answer 5

当您想以通用方式处理path变量时，请考虑引入模型对象。 有了它，您可以验证属性（java bean验证），还可以混合路径变量和查询参数（这里是一个非常简单的示例，您甚至可以创建自定义验证）：

@Data
class SomeModel {
  @NotEmpty
  private String parameter;
}

在控制器中，您只需要将模型添加为参数：

@RequestMapping("/something")
public Object handleSomething(@Valid SomeModel model) {
  /* handle using model.getParameter() */
}