java 非空校验自定义返回

原创

mob649e81576de1 2024-07-11 03:58:20 ©著作权

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

Java非空校验自定义返回实现指南

一、整体流程

下表展示了实现“Java非空校验自定义返回”的整体流程：

步骤	操作
1	新建一个自定义的注解用于标记需要进行非空校验的字段
2	创建一个拦截器，拦截请求并对标记了注解的字段进行非空校验
3	在非空校验不通过时，返回自定义的错误信息

二、具体步骤及代码实现

1. 新建自定义注解

// 引用形式的描述信息
public @interface NotEmpty {
}

2. 创建拦截器

// 引用形式的描述信息
public class NotEmptyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 获取被注解标记的字段
        Field[] fields = handler.getClass().getDeclaredFields();
        for (Field field : fields) {
            if (field.isAnnotationPresent(NotEmpty.class)) {
                field.setAccessible(true);
                Object value = field.get(handler);
                if (value == null || "".equals(value.toString())) {
                    // 非空校验不通过，返回自定义错误信息
                    response.getWriter().write("Field " + field.getName() + " cannot be empty");
                    return false;
                }
            }
        }
        return true;
    }
    
}

3. 编写Controller

// 引用形式的描述信息
@RestController
public class TestController {

    @NotEmpty
    private String name;

    @RequestMapping("/test")
    public String test() {
        return "Hello, World!";
    }
    
}

4. 注册拦截器

在Spring Boot中，可以通过配置类的方式注册拦截器：

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new NotEmptyInterceptor());
    }
    
}

三、类图

使用Mermaid语法表示类图如下：

classDiagram
    class NotEmpty {
        <<annotation>>
    }
    class NotEmptyInterceptor {
        -preHandle(HttpServletRequest, HttpServletResponse, Object): boolean
    }
    class TestController {
        -name: String
        +test()
    }
    class WebMvcConfig {
        +addInterceptors(InterceptorRegistry)
    }