java 实体返回前端 null字段转为空注解

原创

mob64ca12d8821d 2024-02-29 05:45:37 ©著作权

文章标签 字段 User 实体类 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12d8821d的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java实体返回前端null字段转为空注解

在开发过程中，我们经常需要将Java实体类返回给前端，但有时候实体类中的某些字段值为null，这样会给前端展示带来一定的困扰。为了解决这个问题，我们可以使用注解的方式来将null字段转为空，从而提升前端展示的友好度。

注解的作用

通过在实体类的字段上添加注解，我们可以控制该字段在返回给前端时的值。当字段的值为null时，通过注解，我们可以将其转换为空字符串或其他默认值，从而在前端展示时避免出现null值的情况。

示例

假设我们有一个用户实体类User，其中包含姓名、年龄和性别三个字段，我们希望在返回给前端时，如果某个字段的值为null，就将其转为空字符串。

public class User {
    private Long id;
    
    @NullToEmpty
    private String name;
    
    @NullToEmpty
    private Integer age;
    
    @NullToEmpty
    private String gender;
    
    // 省略getter和setter方法
}

在上面的示例中，我们为User类的name、age和gender字段添加了@NullToEmpty注解，表示当这些字段的值为null时，将其转为空字符串。接下来，我们来实现@NullToEmpty注解。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface NullToEmpty {
}

上面的代码定义了一个@NullToEmpty注解，它可以应用在字段上，并在运行时生效。

接下来，我们通过AOP的方式来实现@NullToEmpty注解的功能。我们创建一个切面类NullToEmptyAspect，并在@Before通知中处理null字段转为空的逻辑。

@Aspect
@Component
public class NullToEmptyAspect {

    @Before("execution(* com.example.service.*.*(..))")
    public void before(JoinPoint joinPoint) throws Throwable {
        Object[] args = joinPoint.getArgs();
        for (Object arg : args) {
            Field[] fields = arg.getClass().getDeclaredFields();
            for (Field field : fields) {
                if (field.isAnnotationPresent(NullToEmpty.class)) {
                    field.setAccessible(true);
                    Object value = field.get(arg);
                    if (value == null) {
                        field.set(arg, "");
                    }
                }
            }
        }
    }
}

上面的代码中，我们定义了NullToEmptyAspect类，并在@Before通知中获取方法参数中的对象，遍历其字段，判断是否有@NullToEmpty注解，并将null转为空字符串。

最后，我们可以在UserController中调用UserService返回的User对象，查看转换后的效果。

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        return userService.getUserById(id);
    }
}

类图

下面是User类和NullToEmpty注解的类图:

classDiagram
    class User {
        - Long id
        + String name
        + Integer age
        + String gender
    }
    class NullToEmpty {
    }
    User -- NullToEmpty : @NullToEmpty