轻松实现SpringBoot公共字段自动填充：自定义注解@AutoFill让数据操作更省心
2023-09-04 18:37:21
用自定义注解和切面实现SpringBoot公共字段自动填充
在SpringBoot项目中，经常需要对某些公共字段进行自动填充，例如创建时间、更新时间、创建人、更新人等。传统的方法需要逐个字段进行初始化，容易带来重复劳动和代码冗余。本文介绍一种使用自定义注解和切面的优雅方法，实现公共字段的自动填充。
自定义注解
我们首先定义一个自定义注解@AutoFill：
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface AutoFill {
FillType type() default FillType.INSERT;
String[] fields() default {"createTime", "updateTime"};
}
@AutoFill注解用于标记方法，表明该方法需要进行公共字段自动填充。type属性指定填充类型，可以是插入(INSERT)或更新(UPDATE)。fields属性指定需要填充的字段，默认为createTime和updateTime。
切面类
接下来，需要创建切面类，在方法执行前进行拦截和字段填充：
@Aspect
@Component
public class AutoFillAspect {
@Before("@annotation(com.example.demo.annotation.AutoFill)")
public void doBefore(JoinPoint joinPoint) {
AutoFill autoFill = joinPoint.getTarget().getClass().getAnnotation(AutoFill.class);
Object[] args = joinPoint.getArgs();
String[] fields = autoFill.fields();
for (Object arg : args) {
if (arg instanceof Entity) {
for (String field : fields) {
try {
Field fieldObj = arg.getClass().getDeclaredField(field);
fieldObj.setAccessible(true);
if (fieldObj.getType() == Date.class) {
fieldObj.set(arg, new Date());
} else if (fieldObj.getType() == String.class) {
fieldObj.set(arg, "admin");
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
}
}
AutoFillAspect切面类通过@Before注解，拦截所有被@AutoFill注解标记的方法。在拦截方法前，它获取方法参数、需要填充的字段，并使用反射为公共字段赋值。根据字段类型，它自动填充当前时间或指定值。
用法
现在，我们可以将@AutoFill注解应用于需要进行自动填充的方法，例如：
@PostMapping("/user")
@AutoFill
public User createUser(@RequestBody User user) {
return userService.save(user);
}
当createUser方法被调用时，AutoFillAspect切面会拦截该方法，并为user对象的createTime和updateTime字段自动填充当前时间。
优点
使用自定义注解和切面实现公共字段自动填充具有以下优点：
- 代码简洁： 避免了重复的字段赋值代码，简化了代码结构。
- 易于维护： 当需要修改字段填充逻辑时，只需要修改切面类，而不影响其他代码。
- 可扩展性强： 可以轻松扩展切面类，支持更多类型的自动填充，例如自动填充创建人、更新人等。
常见问题解答
-
是否可以指定自定义的填充值？
是的，可以通过重写切面类的
doBefore方法，并根据需要自定义字段填充逻辑。 -
是否可以支持其他类型的字段，例如数字或布尔值？
是的，可以通过修改切面类的反射赋值逻辑，支持不同类型的字段填充。
-
如何在多个实体类中使用自动填充？
可以创建一个通用的切面类，并使用通配符匹配需要进行自动填充的方法。
-
是否可以使用该方法进行数据验证？
是的，可以在切面类中添加数据验证逻辑，并在必要时抛出异常。
-
如何处理嵌套对象中的字段填充？
可以递归遍历嵌套对象，并针对每个嵌套对象应用自动填充。
结论
通过使用自定义注解和切面，我们实现了SpringBoot中公共字段的自动填充。这种方法简化了代码，提高了维护性和可扩展性。希望本文能为大家提供一种高效、灵活的公共字段自动填充解决方案。
