@ApiImplicitParam對@RequestParam的required屬性侵入怎么解決

本篇內容主要講解“@ApiImplicitParam對@RequestParam的required屬性侵入怎么解決”，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強。下面就讓小編來帶大家學習“@ApiImplicitParam對@RequestParam的required屬性侵入怎么解決”吧!

問題起源

使用SpringCloud構建項目時，使用Swagger生成相應的接口文檔是推薦的選項，Swagger能夠提供頁面訪問，直接在網頁上調試后端系統的接口， 非常方便。最近卻遇到了一個有點困惑的問題，演示接口示例如下（原有功能接口帶有業務實現邏輯，這里簡化了接口）：

/**
 * 
@description: 演示類
 * 
@author: Huang Ying
 **/
@Api(tags = 
"演示類")
@RestController
@Slf4j
public class DemoController {

@ApiOperation(value = 
"測試接口")
@ApiImplicitParams({
			@ApiImplicitParam(name = 
"uid", value = 
"用戶ID", paramType = 
"query", dataType = 
"Long")
	})
@RequestMapping(value = 
"/api/json/demo", method = RequestMethod.GET)
public String auth(@RequestParam(value = 
"uid") Long uid) {
		System.out.println(uid);
return "the uid: " + uid;
	}
}

問題出在接口參數uid的必填性上，@RequestParam注解里require默認為true，要求必填，但@ApiImplicitParam注解里require默認為false，要求非必填，該業務接口在進行功能聯調時，uid居然能得到一個null值，按照一般認知習慣@ApiImplicitParam注解的主要作用是生成接口文檔，不應該對@RequestParam的屬性有侵入性才對，目前反饋的bug，讓我懷疑@ApiImplicitParam是不是會侵入@RequestParam的require屬性？

框架選型、版本及主要功能

項目搭建

SpringBoot版本：2.1.6.RELEASESpringCloud版本：Greenwich.SR3

業務模塊

SpringCloud業務模塊使用的swagger:

swagger bootstrap ui 1.9.6 增強swagger ui樣式spring4all-swagger 1.9.0.RELEASE 配置化swagger參數，免去代碼開發

業務網關

SpringCloud業務網關使用的swagger:

knife4j 2.0.1 增強swagger ui樣式（網關用gateway搭建，swagger使用knife4j-spring-boot-starter依賴，可以聚合業務模塊的swagger文檔）

此次的范圍只針對SpringCloud業務模塊，暫時不涉及業務網關的Swagger文檔。

測試工具

測試工具目前有兩個：swagger doc：使用瀏覽器進行訪問，如下圖：

postman：手動配置接口參數，示例：

案例實戰

接口測試1

接口示例如開篇所示，我們先使用如下接口，全部使用默認值，即@ApiImplicitParam的required為false，@RequestParam的required為true：

@ApiOperation(value = 
"測試接口")
@ApiImplicitParams({
		@ApiImplicitParam(name = 
"uid", value = 
"用戶ID", paramType = 
"query", dataType = 
"Long")
})
@RequestMapping(value = 
"/api/json/demo", method = RequestMethod.GET)
public String auth(@RequestParam(value = 
"uid") Long uid) {
	System.out.println(uid);
return "the uid: " + uid;
}

看swagger的結果：

看postman的結果：

接口測試2

我們修改@ApiImplicitParam的required值為true，@RequestParam不變，重啟模塊@ApiImplicitParam(name = "uid", value = "用戶ID", paramType = "query", required = true, dataType = "Long")

看swagger的結果：

通過調試瀏覽器可以發現，為空校驗是js完成的，js判斷為空后，并未發起請求到后端，這樣我們可以認為swagger內@ApiImplicitParam的required參數生效了。

接口測試3

在前面我們使用postman測試接口時，發現參數項是空的，我們加上參數，但不寫值測試后，結果讓人詫異：

并且無論@ApiImplicitParam的required值如何修改，結果都是一樣的，肯定有一個地方是搞錯了，導致我們誤判。

后來仔細查閱資料，發現是我們對@RequestParam的required參數理解錯了，這個required為true的含義是：接口參數名一定要存在，但參數后面有沒有值它管不著。拿剛剛的例子來說：

這兩個請求是通過的：
localhost:8080/api/json//demo?uid
localhost:8080/api/json//demo?uid=

只有這種請求是不通過的：
localhost:8080/api/json//demo?

小結論

經過上述三個接口的測試場景，我們至少可以明確3點：

1. @ApiImplicitParam的required參數不會對@RequestParam的required值造成侵入，它們倆不相關。

2. @ApiImplicitParam的required參數會影響swagger doc的js邏輯判斷，為空校驗是在js層面上完成的。

3. @RequestParam的required參數默認情況下只會校驗是否有該參數名，不校驗它是否有值。

源碼剖析

swagger部分

上一節當中提及swagger讀取@ApiImplicitParam注解的required參數，最終會體現在js上，通過瀏覽器F12的追蹤，定位到swaggerbootstrapui.js文件上，這里摘抄部分源碼：

# 點擊發送按鈕時，逐行讀取參數信息，并提取required參數
 paramBody.find("tr").each(function () {
    var paramtr=$(this);
    var cked=paramtr.find("td:first").find(":checked").prop("checked");
    var _urlAppendflag=true;
    //that.log(cked)
    if (cked){
        //如果選中，留意此行的required:paramtr.data("required")信息提取
        var trdata={name:paramtr.find("td:eq(2)").find("input").val(),in:paramtr.data("in"),required:paramtr.data("required"),type:paramtr.data("type"),emflag:paramtr.data("emflag"),schemavalue:paramtr.data("schemavalue")};
        //that.log("trdata....")
        //that.log(trdata);
        //獲取key
        //var key=paramtr.find("td:eq(1)").find("input").val();
        var key=trdata["name"];
        //獲取value
        var value="";
        var reqflag=false;
        // 后面代碼省略
    }
})
 

js上判斷該屬性required是否為true的處理，js源碼如下：

//判斷是否required
if (trdata.hasOwnProperty("required")){
    var required=trdata["required"];
    if (required){
        if(!reqflag){
            //必須,驗證value是否為空
            if(value==null||value==""){
                validateflag=true;
                var des=trdata["name"]
                //validateobj={message:des+"不能為空"};
                validateobj={message:des+i18n.message.debug.fieldNotEmpty};
                return false;
            }
        }
    }

}

SpringCloud業務模塊部分

swagger前端js驗證通過可以向后臺發送請求，或者使用postman向后臺系統發送請求時，開始進入后臺的一系列過濾器、Servlet處理，東西還不少：

// 實際的業務方法部分
auth:28, DemoController (com.hy.demo.controller)
invoke0:-1, NativeMethodAccessorImpl (sun.reflect)
invoke:62, NativeMethodAccessorImpl (sun.reflect)
invoke:43, DelegatingMethodAccessorImpl (sun.reflect)
invoke:498, Method (java.lang.reflect)

// 請求參數的提取、控制部分
doInvoke:190, InvocableHandlerMethod (org.springframework.web.method.support)
invokeForRequest:138, InvocableHandlerMethod (org.springframework.web.method.support)
invokeAndHandle:104, ServletInvocableHandlerMethod (org.springframework.web.servlet.mvc.method.annotation)
invokeHandlerMethod:892, RequestMappingHandlerAdapter (org.springframework.web.servlet.mvc.method.annotation)
handleInternal:797, RequestMappingHandlerAdapter (org.springframework.web.servlet.mvc.method.annotation)
handle:87, AbstractHandlerMethodAdapter (org.springframework.web.servlet.mvc.method)

// 下面是各種基礎Web服務組件的過濾器等，暫時不關心
doDispatch:1039, DispatcherServlet (org.springframework.web.servlet)
doService:942, DispatcherServlet (org.springframework.web.servlet)
processRequest:1005, FrameworkServlet (org.springframework.web.servlet)
doGet:897, FrameworkServlet (org.springframework.web.servlet)
service:634, HttpServlet (javax.servlet.http)
service:882, FrameworkServlet (org.springframework.web.servlet)
service:741, HttpServlet (javax.servlet.http)
internalDoFilter:231, ApplicationFilterChain (org.apache.catalina.core)
doFilter:166, ApplicationFilterChain (org.apache.catalina.core)
doFilter:53, WsFilter (org.apache.tomcat.websocket.server)
internalDoFilter:193, ApplicationFilterChain (org.apache.catalina.core)
doFilter:166, ApplicationFilterChain (org.apache.catalina.core)
doFilter:84, SecurityBasicAuthFilter (com.github.xiaoymin.swaggerbootstrapui.filter)
internalDoFilter:193, ApplicationFilterChain (org.apache.catalina.core)
doFilter:166, ApplicationFilterChain (org.apache.catalina.core)
doFilter:53, ProductionSecurityFilter (com.github.xiaoymin.swaggerbootstrapui.filter)
internalDoFilter:193, ApplicationFilterChain (org.apache.catalina.core)
doFilter:166, ApplicationFilterChain (org.apache.catalina.core)
doFilter:124, WebStatFilter (com.alibaba.druid.support.http)
internalDoFilter:193, ApplicationFilterChain (org.apache.catalina.core)
doFilter:166, ApplicationFilterChain (org.apache.catalina.core)
doFilterInternal:88, HttpTraceFilter (org.springframework.boot.actuate.web.trace.servlet)
doFilter:109, OncePerRequestFilter (org.springframework.web.filter)
internalDoFilter:193, ApplicationFilterChain (org.apache.catalina.core)
doFilter:166, ApplicationFilterChain (org.apache.catalina.core)
doFilterInternal:99, RequestContextFilter (org.springframework.web.filter)
doFilter:109, OncePerRequestFilter (org.springframework.web.filter)
internalDoFilter:193, ApplicationFilterChain (org.apache.catalina.core)
doFilter:166, ApplicationFilterChain (org.apache.catalina.core)
doFilterInternal:92, FormContentFilter (org.springframework.web.filter)
doFilter:109, OncePerRequestFilter (org.springframework.web.filter)
internalDoFilter:193, ApplicationFilterChain (org.apache.catalina.core)
doFilter:166, ApplicationFilterChain (org.apache.catalina.core)
doFilterInternal:93, HiddenHttpMethodFilter (org.springframework.web.filter)
doFilter:109, OncePerRequestFilter (org.springframework.web.filter)
internalDoFilter:193, ApplicationFilterChain (org.apache.catalina.core)
doFilter:166, ApplicationFilterChain (org.apache.catalina.core)
filterAndRecordMetrics:114, WebMvcMetricsFilter (org.springframework.boot.actuate.metrics.web.servlet)
doFilterInternal:104, WebMvcMetricsFilter (org.springframework.boot.actuate.metrics.web.servlet)
doFilter:109, OncePerRequestFilter (org.springframework.web.filter)
internalDoFilter:193, ApplicationFilterChain (org.apache.catalina.core)
doFilter:166, ApplicationFilterChain (org.apache.catalina.core)
doFilterInternal:200, CharacterEncodingFilter (org.springframework.web.filter)
doFilter:109, OncePerRequestFilter (org.springframework.web.filter)
internalDoFilter:193, ApplicationFilterChain (org.apache.catalina.core)
doFilter:166, ApplicationFilterChain (org.apache.catalina.core)
invoke:202, StandardWrapperValve (org.apache.catalina.core)
invoke:96, StandardContextValve (org.apache.catalina.core)
invoke:490, AuthenticatorBase (org.apache.catalina.authenticator)
invoke:139, StandardHostValve (org.apache.catalina.core)
invoke:92, ErrorReportValve (org.apache.catalina.valves)
invoke:74, StandardEngineValve (org.apache.catalina.core)
service:343, CoyoteAdapter (org.apache.catalina.connector)
service:408, Http11Processor (org.apache.coyote.http11)
process:66, AbstractProcessorLight (org.apache.coyote)
process:853, AbstractProtocol$ConnectionHandler (org.apache.coyote)
doRun:1587, NioEndpoint$SocketProcessor (org.apache.tomcat.util.net)
run:49, SocketProcessorBase (org.apache.tomcat.util.net)
runWorker:1149, ThreadPoolExecutor (java.util.concurrent)
run:624, ThreadPoolExecutor$Worker (java.util.concurrent)
run:61, TaskThread$WrappingRunnable (org.apache.tomcat.util.threads)
run:748, Thread (java.lang)

聚集重點在請求參數的讀取校驗方面，首先看org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver類的resolveArgument方法：

@Override
@Nullable
public final Object resolveArgument(MethodParameter parameter, 
@Nullable ModelAndViewContainer mavContainer,
		NativeWebRequest webRequest, 
@Nullable WebDataBinderFactory binderFactory) throws Exception {

    // 留意此方法調用
	NamedValueInfo namedValueInfo = getNamedValueInfo(parameter);
	MethodParameter nestedParameter = parameter.nestedIfOptional();

	Object resolvedName = resolveStringValue(namedValueInfo.name);
	if (resolvedName == null) {
		throw new IllegalArgumentException(
				"Specified name must not resolve to null: [" + namedValueInfo.name + "]");
	}
	// 后面暫時省略
}

getNamedValueInfo方法的實現如下：

/**
 * Obtain the named value for the given method parameter.
 */
private NamedValueInfo getNamedValueInfo(MethodParameter parameter) {
	NamedValueInfo namedValueInfo = 
this.namedValueInfoCache.get(parameter);
if (namedValueInfo == 
null) {
		namedValueInfo = createNamedValueInfo(parameter);
		namedValueInfo = updateNamedValueInfo(parameter, namedValueInfo);
this.namedValueInfoCache.put(parameter, namedValueInfo);
	}
return namedValueInfo;
}

進入createNamedValueInfo(parameter)方法時，這部分代碼如下：

@Override
protected NamedValueInfo 
createNamedValueInfo(MethodParameter parameter) {
	RequestParam ann = parameter.getParameterAnnotation(RequestParam.class);
return (ann != 
null ? 
new RequestParamNamedValueInfo(ann) : 
new RequestParamNamedValueInfo());
}

/**
 * NamedValueInfo的定義
 * Represents the information about a named value, including name, whether it's required and a default value.
 */
protected static class NamedValueInfo {

private final String name;

private final boolean required;

@Nullable
private final String defaultValue;

public NamedValueInfo(String name, 
boolean required, @Nullable String defaultValue) {
this.name = name;
this.required = required;
this.defaultValue = defaultValue;
	}
}

這段代碼很關鍵，這里只讀取@RequestParam注解，不會讀@ApiImplicitParam注解，所以@ApiImplicitParam注解不會影響@RequestParam的屬性，并且無論是從swagger doc過來的請求，還是postman過來的請求，都執行這一段代碼，最終讀取注解的結果用CurrenctHashMap存儲，key的格式是method 'xxx' parameter y，xxx為方法名，y為參數的順序號，如method 'auth' parameter 0，基本上可以保證唯一性。

階段性總結

源碼閱讀到這里，基本上可以驗證前面提及的小結論的前2條，引用一下：

1. @ApiImplicitParam的required參數不會對@RequestParam的required值造成侵入，它們倆不相關。

2. @ApiImplicitParam的required參數會影響swagger doc的js邏輯判斷，為空校驗是在js層面上完成的。

3. @RequestParam的required參數默認情況下只會校驗是否有該參數名，不校驗它是否有值。

前面2個問題已經從源碼中找到解釋，來看第3個問題：如果參數設置required=true，但只是要求參數名存在，如果此字段是Long類型或Integer類型，寫成uid=或’uid’，也能通過校驗，最終進入方法后，還是得手動寫代碼進行為空校驗，這顯然不是我們想要的結果？該如何解決呢？

請求參數data bind的問題

接上一節，如果這樣通用的參數，得挨個判斷是否為空，這樣的做法就有點難受了，有沒有更好的解決辦法呢？預期的實現效果是字段加上require=true后，Long類型或其他數值類型可以把""，null過濾掉，要不然require還有什么意義呢？

解決方法有兩個思路：

1. POST請求方法中將多個參數封裝到一個POJO類里，用@RequestBody聲明，POJO類中可以使用@Validator框架的@NotNull等注解，并在參數前聲明@Valid。

2. 自定義參數綁定規則擴展。

方案2更通用一些，適用GET、POST請求，并且原有的單個參數聲明無需封裝到POJO類里。

官網本身提供自定義參數綁定的擴展，見https://docs.spring.io/spring/docs/5.1.8.RELEASE/spring-framework-reference/web.html#mvc-ann-initbinder

官網的例子是在指定的Controller類中使用@InitBinder注解，影響范圍僅限該Controller類，示例如下：

@InitBinder
public void initBinder(WebDataBinder binder) {
	/*
	 * 注冊對于String類型參數對象的屬性進行trim操作的編輯器,
	 * 構造參數代表空串是否轉為null，false，則將null轉為空串。
	 */
	binder.registerCustomEditor(String.class, new StringTrimmerEditor(false));
	// 這里我還添加了其他類型的屬性編輯器，true表示允許使用""，并且將""處理為空，false表示不允許使用""
	binder.registerCustomEditor(Short.class, new CustomNumberEditor(Short.class, 
false));
	binder.registerCustomEditor(Integer.class, new CustomNumberEditor(Integer.class, 
false));
	binder.registerCustomEditor(Long.class, new CustomNumberEditor(Long.class, 
false));
	binder.registerCustomEditor(Float.class, new CustomNumberEditor(Float.class, 
false));
	binder.registerCustomEditor(Double.class, new CustomNumberEditor(Double.class, 
false));
	binder.registerCustomEditor(BigDecimal.class, new CustomNumberEditor(BigDecimal.class, 
false));
	binder.registerCustomEditor(BigInteger.class, new CustomNumberEditor(BigInteger.class, 
false));
}

由于此次面臨的問題是全模塊@RequestParam的值的問題，需要做一個全局的配置，此時需要新增一個類，并使用@ControllerAdvice注解，代碼如下：

@ControllerAdvice
public class CustomWebBindingInitializer implements WebBindingInitializer {

@InitBinder
@Override
	public void initBinder(WebDataBinder binder) {
/*
		 * 注冊對于String類型參數對象的屬性進行trim操作的編輯器,
		 * 構造參數代表空串是否轉為null，false，則將null轉為空串。
		 */
binder.registerCustomEditor(String.class, new StringTrimmerEditor(false));
// 這里我還添加了其他類型的屬性編輯器，true表示允許使用""，并且將""處理為空，false表示不允許使用""
		binder.registerCustomEditor(Short.class, new CustomNumberEditor(Short.class, false));
		binder.registerCustomEditor(Integer.class, new CustomNumberEditor(Integer.class, false));
		binder.registerCustomEditor(Long.class, new CustomNumberEditor(Long.class, false));
		binder.registerCustomEditor(Float.class, new CustomNumberEditor(Float.class, false));
		binder.registerCustomEditor(Double.class, new CustomNumberEditor(Double.class, false));
		binder.registerCustomEditor(BigDecimal.class, new CustomNumberEditor(BigDecimal.class, false));
		binder.registerCustomEditor(BigInteger.class, new CustomNumberEditor(BigInteger.class, false));
	}

}

注意一下CustomNumberEditor實例初始化的傳的false參數。

重啟應用，看一下效果：

擴展DataBinder后相關源碼閱讀

都已經到這兒了，再加把勁把相關的源碼看一下，還是在org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver類的resolveArgument方法的后半段：

@Override
@Nullable
public final Object resolveArgument(MethodParameter parameter, 
@Nullable ModelAndViewContainer mavContainer,
		NativeWebRequest webRequest, 
@Nullable WebDataBinderFactory binderFactory) throws Exception {
    // 前面省略
	if (binderFactory != null) {
		WebDataBinder binder = binderFactory.createBinder(webRequest, null, namedValueInfo.name);
		try {
		    // 在這里對參數進行轉換
			arg = binder.convertIfNecessary(arg, parameter.getParameterType(), parameter);
		}
		catch (ConversionNotSupportedException ex) {
			throw new MethodArgumentConversionNotSupportedException(arg, ex.getRequiredType(),
					namedValueInfo.name, parameter, ex.getCause());
		}
		catch (TypeMismatchException ex) {
			throw new MethodArgumentTypeMismatchException(arg, ex.getRequiredType(),
					namedValueInfo.name, parameter, ex.getCause());

		}
	}

	handleResolvedValue(arg, namedValueInfo.name, parameter, mavContainer, webRequest);

	return arg;
}

從binder.convertIfNecessary方法一路跟下去，中間省略一些調用，最終到達org.springframework.beans.propertyeditors.CustomNumberEditor類的setAsText方法：

/**
 * Parse the Number from the given text, using the specified NumberFormat.
 */
@Override
public void setAsText(String text) throws IllegalArgumentException {
if (this.allowEmpty && !StringUtils.hasText(text)) {
// Treat empty String as null value.
		setValue(null);
	}
	else if (this.numberFormat != null) {
		// Use given NumberFormat for parsing text.
		setValue(NumberUtils.parseNumber(text, this.numberClass, this.numberFormat));
	}
	else {
		// Use default valueOf methods for parsing text.
		setValue(NumberUtils.parseNumber(text, this.numberClass));
	}
}

仔細看allowEmpty變量，針對Long類型的參數，我們擴展數據綁定時，該變量設置的是false，表示不接受空值，試驗中我們傳的值是空串，那么這里的條件分支判斷就必須對空串轉換成數值，執行Long.valueOf("")結果報出運行時異常java.lang.NumberFormatException，告知客戶端參數不對，這是期望的結果。

到此，相信大家對“@ApiImplicitParam對@RequestParam的required屬性侵入怎么解決”有了更深的了解，不妨來實際操作一番吧！這里是億速云網站，更多相關內容可以進入相關頻道進行查詢，關注我們，繼續學習！