SpringBoot自定义注解校验接收参数不能为空

1.定义接口

package com.hndfsj.common.annotation.notnull;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * TODO：自定义注解校验接收参数不能为空
 *
 * ElementType.PARAMETER：参数级别
 * RetentionPolicy.RUNTIME：注解保留到运行阶段
 *
 * @author zhangjunchao
 * @email zhangjunchaoyx@163.com
 * @date 2020/11/5
 */
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface ParamsNotNull {}

2.校验处理器

package com.hndfsj.common.annotation.notnull;

import com.alibaba.fastjson.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.jetbrains.annotations.NotNull;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Parameter;
import java.util.ArrayList;
import java.util.List;
/**
 * TODO：校验处理器
 *
 * @author zhangjunchao
 * @date 2020/11/5
 */
@Slf4j
public class CheckParamsInterceptor extends HandlerInterceptorAdapter {

    @Override
    public boolean preHandle(@NotNull HttpServletRequest request, @NotNull HttpServletResponse response, @NotNull Object handler)
            throws Exception {
        if (!(handler instanceof HandlerMethod)) {
            log.warn("UnSupport handler");
            return true;
        }
        //获取方法上加了注解的参数名称
        List<String> list = getParamsName((HandlerMethod) handler);
        for (String s : list) {
            //判空
            String parameter = request.getParameter(s);
            if (StringUtils.isBlank(parameter) || "".equals(parameter.trim())){
                JSONObject jsonObject = new JSONObject();
                jsonObject.put("msg", "必传参数错误");
                response.setHeader("Content-type", "application/json;charset=UTF-8");
                response.getWriter().write(jsonObject.toJSONString());
                return false;
            }
        }
        //如果获取的对象为空,说明方法上没有此注解,直接放行
        return true;
    }

    /**拿到在参数上加了该注解的参数名称*/
    private List<String> getParamsName(HandlerMethod handlerMethod) {
        Parameter[] parameters = handlerMethod.getMethod().getParameters();
        List<String> list = new ArrayList<String>();
        for (Parameter parameter : parameters) {
            if(parameter.isAnnotationPresent(ParamsNotNull.class)){
                list.add(parameter.getName());
            }
        }
        return list;
    }

}

3.校验配置

package com.hndfsj.common.annotation.notnull;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * TODO：校验配置
 *
 * @author zhangjunchao
 * @date 2020/11/5
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    CheckParamsInterceptor checkSourceInterceptor = new CheckParamsInterceptor();
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //拦截路径
        registry.addInterceptor(checkSourceInterceptor).addPathPatterns("/**");
    }

}

4.使用方法(@ParamsNotNull)

//  直接在需要校验的参数前加上 @ParamsNotNull 注解即可
public void editProgram(@ParamsNotNull String editProgram) {

        System.out.println("我是使用方法，如果帮助到了你，请点个大大的赞！");
    }

如果加了此注解，访问此接口，传过来的参数为空，返回如下错误消息（可根据项目具体情况，修改返回的提示消息）