一、前言

????????在我們寫后臺接口時，難免對參數進行非空校驗，如果一兩個還好，但如果需要寫大量的接口，及必填參數太多的時候，會給我們開發帶來大量的重復工作，及很多相似代碼。而sping自帶的@RequestParam注解并不能完全滿足我們的需求，因為這個注解只會校驗請求中是否存在該參數，而不會校驗這個參數的值是nulll還是空字符串("")，如果參數不存在則會拋出org.springframework.web.bind.MissingServletRequestParameterException異常。雖然目前已經有許多成熟的校驗框架，功能豐富，但是我們只需要做一個非空校驗即可。

????????因此我們可以自定義 一個注解用于校驗參數是否為空。

使用的的框架

• spring boot：1.5.9.RELEASE
• JDK：1.8

二、準備工作

????????首先需要創建一個spring boot項目，并引入相關maven依賴(主要是spring-boot-starter-web與aspectjweaver),pom文件如下:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.beauxie</groupId>
    <artifactId>param-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>param-demo</name>
    <description>param-demo for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.9.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!-- 添加支持web -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--引入AOP相應的注解-->
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.8.5</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

說明:

• spring-boot-starter-web用于spring boot WEB支持
• aspectjweaver 用于引入aop的相關的注解，如@Aspect、@Pointcut等

三、自定義注解實現統一校驗

總體思路：自定義一個注解，對必填的參數加上該注解，然后定義一個切面，校驗該參數是否為空，如果為空則拋出自定義的異常，該異常被自定義的異常處理器捕獲，然后返回相應的錯誤信息。

1. 自定義注解

創建一個名為'ParamCheck'的注解，代碼如下：

package com.beauxie.param.demo.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * "參數不能為空"注解，作用于方法參數上。
 * 
 * @author Beauxie
 * @date Created on 2017/1/6
 */
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface ParamCheck {
    /**
     * 是否非空,默認不能為空
     */
    boolean notNull() default true;
}

說明:

• @Target(ElementType.PARAMETER)表示該注解作用于方法參數上
• 該類可以拓展，比如增加length校驗

2. 自定義異常類

這個異常類與自定義注解配合一起使用，當加上'@ParamCheck'的參數為空時，拋出該異常，代碼如下:

package com.beauxie.param.demo.exception;

/**
 * @author Beauxie
 * @date Created on 2017/1/6
 */
public class ParamIsNullException extends RuntimeException {
    private final String parameterName;
    private final String parameterType;

    public ParamIsNullException(String parameterName, String parameterType) {
        super("");
        this.parameterName = parameterName;
        this.parameterType = parameterType;
    }

    @Override
    public String getMessage() {
        return "Required " + this.parameterType + " parameter \'" + this.parameterName + "\' must be not null !";
    }

    public final String getParameterName() {
        return this.parameterName;
    }

    public final String getParameterType() {
        return this.parameterType;
    }
}

說明:

• 該異常繼承RuntimeException，并定義了兩個成員屬性、重寫了getMessage()方法
• 之所以自定義該異常，而不用現有的org.springframework.web.bind.MissingServletRequestParameterException類，是因為MissingServletRequestParameterException為Checked異常,在動態代理過程中，很容易引發java.lang.reflect.UndeclaredThrowableException異常。

3. 自定義AOP

代碼如下:

package com.beauxie.param.demo.aop;

import com.beauxie.param.demo.annotation.ParamCheck;
import com.beauxie.param.demo.exception.ParamIsNullException;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

/**
 * @author Beauxie
 * @date Created on 2017/1/6
 */
@Component
@Aspect
public class ParamCheckAop {
    private Logger logger = LoggerFactory.getLogger(this.getClass());


    /**
     * 定義有一個切入點，范圍為web包下的類
     */
    @Pointcut("execution(public * com.beauxie.param.demo.web..*.*(..))")
    public void checkParam() {
    }

    @Before("checkParam()")
    public void doBefore(JoinPoint joinPoint) {
    }

    /**
     * 檢查參數是否為空
     */
    @Around("checkParam()")
    public Object doAround(ProceedingJoinPoint pjp) throws Throwable {

        MethodSignature signature = ((MethodSignature) pjp.getSignature());
        //得到攔截的方法
        Method method = signature.getMethod();
        //獲取方法參數注解，返回二維數組是因為某些參數可能存在多個注解
        Annotation[][] parameterAnnotations = method.getParameterAnnotations();
        if (parameterAnnotations == null || parameterAnnotations.length == 0) {
            return pjp.proceed();
        }
        //獲取方法參數名
        String[] paramNames = signature.getParameterNames();
        //獲取參數值
        Object[] paranValues = pjp.getArgs();
        //獲取方法參數類型
        Class<?>[] parameterTypes = method.getParameterTypes();
        for (int i = 0; i < parameterAnnotations.length; i++) {
            for (int j = 0; j < parameterAnnotations[i].length; j++) {
                //如果該參數前面的注解是ParamCheck的實例，并且notNull()=true,則進行非空校驗
                if (parameterAnnotations[i][j] != null && parameterAnnotations[i][j] instanceof ParamCheck && ((ParamCheck) parameterAnnotations[i][j]).notNull()) {
                    paramIsNull(paramNames[i], paranValues[i], parameterTypes[i] == null ? null : parameterTypes[i].getName());
                    break;
                }
            }
        }
        return pjp.proceed();
    }

    /**
     * 在切入點return內容之后切入內容（可以用來對處理返回值做一些加工處理）
     *
     * @param joinPoint
     */
    @AfterReturning("checkParam()")
    public void doAfterReturning(JoinPoint joinPoint) {
    }

    /**
     * 參數非空校驗，如果參數為空，則拋出ParamIsNullException異常
     * @param paramName
     * @param value
     * @param parameterType
     */
    private void paramIsNull(String paramName, Object value, String parameterType) {
        if (value == null || "".equals(value.toString().trim())) {
            throw new ParamIsNullException(paramName, parameterType);
        }
    }

}

4. 全局異常處理器

該異常處理器捕獲在ParamCheckAop類中拋出的ParamIsNullException異常，并進行處理,代碼如下:

package com.beauxie.param.demo.exception;

import com.beauxie.param.demo.common.Result;
import com.beauxie.param.demo.enums.EnumResultCode;
import com.beauxie.param.demo.utils.ResponseMsgUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.servlet.http.HttpServletRequest;

/**
 * 全局異常處理.
 * 一般情況下，方法都有異常處理機制，但不能排除有個別異常沒有處理，導致返回到前臺，因此在這里做一個異常攔截，統一處理那些未被處理過的異常
 *
 * @author Beauxie
 * @date Created on 2017/1/6
 */
@RestControllerAdvice
public class GlobalExceptionHandler {
    private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);


    /**
     * 參數為空異常處理
     *
     * @param ex
     * @return
     */
    @ExceptionHandler({MissingServletRequestParameterException.class, ParamIsNullException.class})
    public Result<String> requestMissingServletRequest(Exception ex) {
        LOGGER.error("request Exception:", ex);
        return ResponseMsgUtil.builderResponse(EnumResultCode.FAIL.getCode(), ex.getMessage(), null);
    }

    /**
     * 特別說明： 可以配置指定的異常處理,這里處理所有
     *
     * @param request
     * @param e
     * @return
     */
    @ExceptionHandler(value = Exception.class)
    public Result<String> errorHandler(HttpServletRequest request, Exception e) {
        LOGGER.error("request Exception:", e);
        return ResponseMsgUtil.exception();
    }
}

說明：

• 在requestMissingServletRequest()方法上加上@ExceptionHandler({MissingServletRequestParameterException.class, ParamIsNullException.class})注解，表明只處理處理MissingServletRequestParameterException與ParamIsNullException異常
• errorHandler()方法則處理其他的異常

四、測試

在com.beauxie.param.demo.web包下新建一個名為HelloController的類,用于測試,代碼如下:

package com.beauxie.param.demo.web;

import com.beauxie.param.demo.annotation.ParamCheck;
import com.beauxie.param.demo.common.Result;
import com.beauxie.param.demo.enums.EnumResultCode;
import com.beauxie.param.demo.utils.ResponseMsgUtil;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author Beauxie
 * @date Created on 2018/1/6
 */
@RestController
public class HelloController {
    /**
     *測試@RequestParam注解
     * @param name
     * @return
     */
    @GetMapping("/hello1")
    public Result<String> hello1(@RequestParam String name) {
        return ResponseMsgUtil.builderResponse(EnumResultCode.SUCCESS.getCode(), "請求成功", "Hello," + name);
    }

    /**
     * 測試@ParamCheck注解
     * @param name
     * @return
     */
    @GetMapping("/hello2")
    public Result<String> hello2(@ParamCheck String name) {
        return ResponseMsgUtil.builderResponse(EnumResultCode.SUCCESS.getCode(), "請求成功", "Hello," + name);
    }

    /**
     * 測試@ParamCheck與@RequestParam一起時
     * @param name
     * @return
     */
    @GetMapping("/hello3")
    public Result<String> hello3(@ParamCheck @RequestParam String name) {
        return ResponseMsgUtil.builderResponse(EnumResultCode.SUCCESS.getCode(), "請求成功", "Hello," + name);
    }

最后運行ParamDemoApplicatio的main方法,打開瀏覽器進行測試。

1. 測試@RequestParam注解

• 參數名為空測試
  
  在瀏覽器的地址欄輸入:http://localhost:8080/hello1，結果如下:
  

  RequestParam1
  
  后臺錯誤信息輸出：
  
  Error1
  
  此時后臺會報org.springframework.web.bind.MissingServletRequestParameterException: Required String parameter 'name' is not present錯誤信息，提示參數'name'不存在

• 參數名不為空，值為空測試
  
  在瀏覽器的地址欄輸入:http://localhost:8080/hello1?name=，結果如下:
  

  RequestParam2
  
  
  此時，name的值為空，但請求結果正常返回。

• 參數名與值都不為空測試
  
  在瀏覽器的地址欄輸入:http://localhost:8080/hello1?name=Beauxie，結果如下:
  

  RequestParam3

2. 測試@ParamCheck注解

• 參數名為空測試
  
  在瀏覽器的地址欄輸入:http://localhost:8080/hello2，結果如下:
  [圖片上傳失敗...(image-f11449-1515228018125)]
  后臺錯誤信息輸出：
  

  Error2

• 參數名不為空，值為空測試
  
  在瀏覽器的地址欄輸入:http://localhost:8080/hello2?name=，結果如下:
  [圖片上傳失敗...(image-8d0648-1515228018125)]
  此時，name的值為空，請求結果y提示參數name的值不能為空。
  后臺錯誤信息輸出：
  

  Error3

• 參數名與值都不為空測試
  
  在瀏覽器的地址欄輸入:http://localhost:8080/hello2?name=Beauxie，結果如下:
  

  ParamCheck3

3. 測試總結

• 當參數名為空時，分別添加兩個注解的接口都會提示參數不能為空
• 當參數名不為空，值為空時，@RequestParam注解不會報錯，但@ParamCheck注解提示參數'name'的值為空

五、總結

• 經過以上的測試也驗證了@RequestParam只會驗證對應的參數是否存在，而不會驗證值是否為空
• ParamCheck還可以進行拓展，比如參數值長度、是否含有非法字符等校驗

六、源碼下載地址

由于csdn下載需要積分，因此添加github源碼地址:

• github: https://github.com/Beauxie/projects-demo
• csdn: http://download.csdn.net/download/beauxie/10191744