Spring Boot中使用@ControllerAdvice获取请求参数的妙用

在Spring Boot应用开发中，@ControllerAdvice 是一个非常强大的注解，它可以让我们在全局范围内处理请求和响应。今天我们来探讨一下如何利用 @ControllerAdvice 来获取请求参数，并介绍其在实际应用中的一些妙用。

什么是@ControllerAdvice？

@ControllerAdvice 是Spring框架提供的一个注解，用于定义全局的异常处理、数据绑定、模型属性等。它可以与 @ExceptionHandler、@InitBinder、@ModelAttribute 等注解结合使用，实现对控制器的增强。

获取请求参数的基本方法

在Spring MVC中，获取请求参数通常是通过控制器方法的参数注入来实现的。然而，当我们需要在多个控制器中重复获取相同的参数时，使用 @ControllerAdvice 可以大大简化代码。

@ModelAttribute 注解：

@ControllerAdvice
public class GlobalControllerAdvice {
    @ModelAttribute
    public void addAttributes(Model model, HttpServletRequest request) {
        String param = request.getParameter("paramName");
        model.addAttribute("param", param);
    }
}

通过这种方式，我们可以在所有控制器方法执行之前，将请求参数添加到模型中。

@InitBinder 注解：

@ControllerAdvice
public class GlobalControllerAdvice {
    @InitBinder
    public void initBinder(WebDataBinder binder, HttpServletRequest request) {
        String param = request.getParameter("paramName");
        binder.setFieldDefaultPrefix("param");
    }
}

这个方法可以用于自定义数据绑定器，处理请求参数的绑定。

实际应用场景

全局参数验证：我们可以使用 @ControllerAdvice 来进行全局的参数验证。例如，检查所有请求中的某个参数是否符合特定规则：

@ControllerAdvice
public class ValidationAdvice {
    @InitBinder
    public void initBinder(WebDataBinder binder) {
        binder.addValidators(new CustomValidator());
    }
}

统一处理请求参数：在某些情况下，我们可能需要对所有请求参数进行统一处理，比如去除空格、转换大小写等：

@ControllerAdvice
public class ParamAdvice {
    @ModelAttribute
    public void processParams(Model model, HttpServletRequest request) {
        Enumeration<String> parameterNames = request.getParameterNames();
        while (parameterNames.hasMoreElements()) {
            String paramName = parameterNames.nextElement();
            String[] values = request.getParameterValues(paramName);
            for (int i = 0; i < values.length; i++) {
                values[i] = values[i].trim().toLowerCase();
            }
            request.setAttribute(paramName, values);
        }
    }
}

日志记录：通过 @ControllerAdvice，我们可以记录所有请求的参数，方便后续的日志分析和调试：

@ControllerAdvice
public class LoggingAdvice {
    @ModelAttribute
    public void logRequestParams(HttpServletRequest request) {
        Map<String, String[]> parameterMap = request.getParameterMap();
        // 记录参数到日志
        logger.info("Request Parameters: {}", parameterMap);
    }
}

注意事项

性能考虑：在使用 @ControllerAdvice 时，由于它会对所有请求生效，因此需要注意性能问题，避免不必要的处理。
安全性：确保在处理请求参数时，不泄露敏感信息。
兼容性：确保你的Spring Boot版本支持你所使用的注解和方法。

通过以上介绍，我们可以看到 @ControllerAdvice 在Spring Boot应用中获取请求参数的强大功能。它不仅简化了代码的重复性，还提供了全局的控制和处理能力，使得开发更加高效和规范。希望这篇文章能帮助大家更好地理解和应用 @ControllerAdvice，在实际项目中发挥其最大价值。