在Spring Boot应用中，@ControllerAdvice是一个强大的工具，它允许我们在单个位置处理多个控制器的跨切面关注点，如全局数据绑定和预处理。这种方式可以大大减少重复代码，提高开发效率。本文将探讨如何在Spring Boot 3.3中使用@ControllerAdvice来实现全局数据绑定与预处理。
@ControllerAdvice简介
@ControllerAdvice是Spring框架提供的一个注解，用于定义一个类，该类可以包含多个处理请求的Advice（如@InitBinder、@ModelAttribute、@ExceptionHandler等）。被@ControllerAdvice注解的类可以应用到所有控制器上，或者通过指定注解的basePackages属性来限定特定的控制器。
全局数据绑定
全局数据绑定是指在请求处理之前，将请求中的参数绑定到控制器方法的参数上。这通常用于处理日期格式、货币格式等。
使用@InitBinder实现全局数据绑定
@ControllerAdvice
public class GlobalBindingInitializer {
@InitBinder
public void initBinder(WebDataBinder binder) {
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
dateFormat.setLenient(false);
binder.registerCustomEditor(Date.class, new CustomDateEditor(dateFormat, false));
}
}
在上面的代码中，我们定义了一个全局的日期编辑器，这样在所有的控制器中都不需要再单独设置日期格式。
数据预处理
数据预处理是指在控制器方法执行之前，对传入的数据进行一些处理，比如数据验证、格式化等。
使用@ModelAttribute实现全局数据预处理
@ControllerAdvice
public class GlobalDataPreprocessor {
@ModelAttribute
public void preprocess(@ModelAttribute("user") User user) {
// 在这里进行用户数据的预处理，比如密码加密
user.encryptPassword();
}
}
在这个例子中，我们在全局范围内对User对象进行了预处理，比如加密密码。这样在所有的控制器中都不需要再单独处理密码加密。
异常处理
@ControllerAdvice还可以用来全局处理异常。
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(DataAccessException.class)
public ResponseEntity<String> handleDataAccessException(DataAccessException ex) {
// 处理数据库异常
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Database error: " + ex.getMessage());
}
}
在这个例子中，我们全局处理了DataAccessException异常，并返回了一个错误响应。
结论
通过使用@ControllerAdvice，我们可以在Spring Boot应用中实现全局数据绑定与预处理，这不仅减少了重复代码，还提高了代码的可维护性。这种方式使得我们的控制器更加简洁，关注于业务逻辑的实现，而将数据绑定、预处理和异常处理等跨切面关注点集中管理。这是Spring Boot中实现优雅代码的一种最佳实践。
