You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by GitBox <gi...@apache.org> on 2018/12/04 01:20:42 UTC
[GitHub] liubao68 closed pull request #1004: [SCB-925] Springmvc,
when have defaultValue, required should be false, when param not exist,
should check isRequired
liubao68 closed pull request #1004: [SCB-925] Springmvc, when have defaultValue, required should be false, when param not exist, should check isRequired
URL: https://github.com/apache/servicecomb-java-chassis/pull/1004
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/RestCodec.java b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/RestCodec.java
index 5642642d5..ac65d61a0 100644
--- a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/RestCodec.java
+++ b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/RestCodec.java
@@ -24,6 +24,7 @@
import org.apache.servicecomb.common.rest.definition.RestOperationMeta;
import org.apache.servicecomb.common.rest.definition.RestParam;
+import org.apache.servicecomb.foundation.common.utils.ExceptionUtils;
import org.apache.servicecomb.swagger.invocation.exception.InvocationException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -66,7 +67,7 @@ public static void argsToRest(Object[] args, RestOperationMeta restOperation,
} catch (Exception e) {
LOG.error("Parameter is not valid for operation {}. ",
restOperation.getOperationMeta().getMicroserviceQualifiedName(),
- e);
+ ExceptionUtils.getExceptionMessageWithoutTrace(e));
// give standard http error code for invalid parameter
throw new InvocationException(Status.BAD_REQUEST, "Parameter is not valid.");
}
diff --git a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/AbstractParamProcessor.java b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/AbstractParamProcessor.java
index 509e03e8c..147aa0ac3 100644
--- a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/AbstractParamProcessor.java
+++ b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/AbstractParamProcessor.java
@@ -26,17 +26,24 @@
protected Object defaultValue;
+ protected boolean required = false;
+
public Object getDefaultValue() {
return defaultValue;
}
- public AbstractParamProcessor(String paramPath, JavaType targetType, Object defaultValue) {
+ public AbstractParamProcessor(String paramPath, JavaType targetType, Object defaultValue, boolean required) {
this.paramPath = paramPath;
this.targetType = targetType;
this.defaultValue = defaultValue;
+ this.required = required;
}
public String getParameterPath() {
return paramPath;
}
+
+ public boolean isRequired() {
+ return required;
+ }
}
diff --git a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/CookieProcessorCreator.java b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/CookieProcessorCreator.java
index 659637e50..90f3946e7 100644
--- a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/CookieProcessorCreator.java
+++ b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/CookieProcessorCreator.java
@@ -21,9 +21,12 @@
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
+import javax.ws.rs.core.Response.Status;
import org.apache.servicecomb.common.rest.codec.RestClientRequest;
import org.apache.servicecomb.common.rest.codec.RestObjectMapperFactory;
+import org.apache.servicecomb.swagger.invocation.exception.InvocationException;
+import org.springframework.util.ObjectUtils;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.type.TypeFactory;
@@ -35,33 +38,38 @@
public static final String PARAMTYPE = "cookie";
public static class CookieProcessor extends AbstractParamProcessor {
- public CookieProcessor(String paramPath, JavaType targetType, Object defaultValue) {
- super(paramPath, targetType, defaultValue);
+ public CookieProcessor(String paramPath, JavaType targetType, Object defaultValue, boolean required) {
+ super(paramPath, targetType, defaultValue, required);
}
@Override
- public Object getValue(HttpServletRequest request) throws Exception {
+ public Object getValue(HttpServletRequest request) {
Cookie[] cookies = request.getCookies();
- if (cookies == null) {
- return null;
+ Object value = null;
+ if (cookies == null || cookies.length == 0) {
+ value = checkRequiredAndDefaultValue();
+ return convertValue(value, targetType);
}
- String value = null;
for (Cookie cookie : cookies) {
if (paramPath.equals(cookie.getName())) {
value = cookie.getValue();
- if (value == null) {
- Object defaultValue = getDefaultValue();
- if (defaultValue != null) {
- value = defaultValue.toString();
- }
- }
+ break;
}
}
-
+ if (value == null) {
+ value = checkRequiredAndDefaultValue();
+ }
return convertValue(value, targetType);
}
+ private Object checkRequiredAndDefaultValue() {
+ if (isRequired()) {
+ throw new InvocationException(Status.BAD_REQUEST, "Parameter is required.");
+ }
+ return getDefaultValue();
+ }
+
@Override
public void setValue(RestClientRequest clientRequest, Object arg) throws Exception {
clientRequest.addCookie(paramPath,
@@ -81,6 +89,7 @@ public CookieProcessorCreator() {
@Override
public ParamValueProcessor create(Parameter parameter, Type genericParamType) {
JavaType targetType = TypeFactory.defaultInstance().constructType(genericParamType);
- return new CookieProcessor(parameter.getName(), targetType, ((CookieParameter) parameter).getDefaultValue());
+ return new CookieProcessor(parameter.getName(), targetType, ((CookieParameter) parameter).getDefaultValue(),
+ parameter.getRequired());
}
}
diff --git a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/FormProcessorCreator.java b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/FormProcessorCreator.java
index 81cf9125c..04ea5bfd6 100644
--- a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/FormProcessorCreator.java
+++ b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/FormProcessorCreator.java
@@ -22,9 +22,11 @@
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.Part;
+import javax.ws.rs.core.Response.Status;
import org.apache.servicecomb.common.rest.RestConst;
import org.apache.servicecomb.common.rest.codec.RestClientRequest;
+import org.apache.servicecomb.swagger.invocation.exception.InvocationException;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.type.TypeFactory;
@@ -37,8 +39,8 @@
public static final String PARAMTYPE = "formData";
public static class FormProcessor extends AbstractParamProcessor {
- public FormProcessor(String paramPath, JavaType targetType, Object defaultValue) {
- super(paramPath, targetType, defaultValue);
+ public FormProcessor(String paramPath, JavaType targetType, Object defaultValue, boolean required) {
+ super(paramPath, targetType, defaultValue, required);
}
@Override
@@ -50,20 +52,25 @@ public Object getValue(HttpServletRequest request) {
}
if (targetType.isContainerType()) {
+ //Even if the paramPath does not exist, it won't be null at now
return convertValue(request.getParameterValues(paramPath), targetType);
}
Object value = request.getParameter(paramPath);
if (value == null) {
- Object defaultValue = getDefaultValue();
- if (defaultValue != null) {
- value = defaultValue;
- }
+ value = checkRequiredAndDefaultValue();
}
return convertValue(value, targetType);
}
+ private Object checkRequiredAndDefaultValue() {
+ if (isRequired()) {
+ throw new InvocationException(Status.BAD_REQUEST, "Parameter is required.");
+ }
+ return getDefaultValue();
+ }
+
@Override
public void setValue(RestClientRequest clientRequest, Object arg) {
clientRequest.addForm(paramPath, arg);
@@ -84,9 +91,11 @@ public ParamValueProcessor create(Parameter parameter, Type genericParamType) {
JavaType targetType = TypeFactory.defaultInstance().constructType(genericParamType);
if (isPart(parameter)) {
- return new PartProcessor(parameter.getName(), targetType, ((FormParameter) parameter).getDefaultValue());
+ return new PartProcessor(parameter.getName(), targetType, ((FormParameter) parameter).getDefaultValue(),
+ parameter.getRequired());
}
- return new FormProcessor(parameter.getName(), targetType, ((FormParameter) parameter).getDefaultValue());
+ return new FormProcessor(parameter.getName(), targetType, ((FormParameter) parameter).getDefaultValue(),
+ parameter.getRequired());
}
private boolean isPart(Parameter parameter) {
@@ -94,8 +103,8 @@ private boolean isPart(Parameter parameter) {
}
private static class PartProcessor extends AbstractParamProcessor {
- PartProcessor(String paramPath, JavaType targetType, Object defaultValue) {
- super(paramPath, targetType, defaultValue);
+ PartProcessor(String paramPath, JavaType targetType, Object defaultValue, boolean required) {
+ super(paramPath, targetType, defaultValue, required);
}
@Override
diff --git a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/HeaderProcessorCreator.java b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/HeaderProcessorCreator.java
index 810e01814..4d9126143 100644
--- a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/HeaderProcessorCreator.java
+++ b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/HeaderProcessorCreator.java
@@ -22,9 +22,11 @@
import java.util.Enumeration;
import javax.servlet.http.HttpServletRequest;
+import javax.ws.rs.core.Response.Status;
import org.apache.servicecomb.common.rest.codec.RestClientRequest;
import org.apache.servicecomb.common.rest.codec.RestObjectMapperFactory;
+import org.apache.servicecomb.swagger.invocation.exception.InvocationException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -40,33 +42,37 @@
public static final String PARAMTYPE = "header";
public static class HeaderProcessor extends AbstractParamProcessor {
- public HeaderProcessor(String paramPath, JavaType targetType, Object defaultValue) {
- super(paramPath, targetType, defaultValue);
+ public HeaderProcessor(String paramPath, JavaType targetType, Object defaultValue, boolean required) {
+ super(paramPath, targetType, defaultValue, required);
}
@Override
- public Object getValue(HttpServletRequest request) throws Exception {
+ public Object getValue(HttpServletRequest request) {
Object value = null;
if (targetType.isContainerType()) {
Enumeration<String> headerValues = request.getHeaders(paramPath);
if (headerValues == null) {
+ //Even if the paramPath does not exist, headerValues won't be null at now
return null;
}
-
value = Collections.list(headerValues);
} else {
value = request.getHeader(paramPath);
if (value == null) {
- Object defaultValue = getDefaultValue();
- if (defaultValue != null) {
- value = defaultValue;
- }
+ value = checkRequiredAndDefaultValue();
}
}
return convertValue(value, targetType);
}
+ private Object checkRequiredAndDefaultValue() {
+ if (isRequired()) {
+ throw new InvocationException(Status.BAD_REQUEST, "Parameter is required.");
+ }
+ return getDefaultValue();
+ }
+
@Override
public void setValue(RestClientRequest clientRequest, Object arg) throws Exception {
if (null == arg) {
@@ -91,6 +97,7 @@ public HeaderProcessorCreator() {
@Override
public ParamValueProcessor create(Parameter parameter, Type genericParamType) {
JavaType targetType = TypeFactory.defaultInstance().constructType(genericParamType);
- return new HeaderProcessor(parameter.getName(), targetType, ((HeaderParameter) parameter).getDefaultValue());
+ return new HeaderProcessor(parameter.getName(), targetType, ((HeaderParameter) parameter).getDefaultValue(),
+ parameter.getRequired());
}
}
diff --git a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/PathProcessorCreator.java b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/PathProcessorCreator.java
index dbf459c80..6f5f3fd60 100644
--- a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/PathProcessorCreator.java
+++ b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/PathProcessorCreator.java
@@ -36,8 +36,8 @@
public static final String PARAMTYPE = "path";
public static class PathProcessor extends AbstractParamProcessor {
- public PathProcessor(String paramPath, JavaType targetType, Object defaultValue) {
- super(paramPath, targetType, defaultValue);
+ public PathProcessor(String paramPath, JavaType targetType, Object defaultValue, boolean required) {
+ super(paramPath, targetType, defaultValue, required);
}
@Override
@@ -73,6 +73,6 @@ public PathProcessorCreator() {
@Override
public ParamValueProcessor create(Parameter parameter, Type genericParamType) {
JavaType targetType = TypeFactory.defaultInstance().constructType(genericParamType);
- return new PathProcessor(parameter.getName(), targetType, ((PathParameter) parameter).getDefaultValue());
+ return new PathProcessor(parameter.getName(), targetType, ((PathParameter) parameter).getDefaultValue(), true);
}
}
diff --git a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/QueryProcessorCreator.java b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/QueryProcessorCreator.java
index 952c6495a..e226730c3 100644
--- a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/QueryProcessorCreator.java
+++ b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/QueryProcessorCreator.java
@@ -20,10 +20,12 @@
import java.lang.reflect.Type;
import javax.servlet.http.HttpServletRequest;
+import javax.ws.rs.core.Response.Status;
import org.apache.commons.lang3.StringUtils;
import org.apache.servicecomb.common.rest.codec.RestClientRequest;
import org.apache.servicecomb.swagger.converter.property.SwaggerParamCollectionFormat;
+import org.apache.servicecomb.swagger.invocation.exception.InvocationException;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.type.TypeFactory;
@@ -46,19 +48,21 @@
private SwaggerParamCollectionFormat collectionFormat;
- public QueryProcessor(String paramPath, JavaType targetType, Object defaultValue, String collectionFormat) {
- super(paramPath, targetType, defaultValue);
+ public QueryProcessor(String paramPath, JavaType targetType, Object defaultValue, boolean required,
+ String collectionFormat) {
+ super(paramPath, targetType, defaultValue, required);
if (StringUtils.isNoneEmpty(collectionFormat)) {
this.collectionFormat = SwaggerParamCollectionFormat.valueOf(collectionFormat.toUpperCase());
}
}
@Override
- public Object getValue(HttpServletRequest request) throws Exception {
+ public Object getValue(HttpServletRequest request) {
Object value = null;
if (targetType.isContainerType()
&& SwaggerParamCollectionFormat.MULTI.equals(collectionFormat)) {
value = request.getParameterValues(paramPath);
+ //Even if the paramPath does not exist, value won't be null at now
} else {
value = request.getParameter(paramPath);
// make some old systems happy
@@ -68,10 +72,7 @@ public Object getValue(HttpServletRequest request) throws Exception {
}
}
if (value == null) {
- Object defaultValue = getDefaultValue();
- if (!ignoreDefaultValue && defaultValue != null) {
- value = defaultValue;
- }
+ value = checkRequiredAndDefaultValue();
}
if (null != collectionFormat) {
value = collectionFormat.splitParam((String) value);
@@ -81,6 +82,17 @@ public Object getValue(HttpServletRequest request) throws Exception {
return convertValue(value, targetType);
}
+ private Object checkRequiredAndDefaultValue() {
+ if (isRequired()) {
+ throw new InvocationException(Status.BAD_REQUEST, "Parameter is required.");
+ }
+ Object defaultValue = getDefaultValue();
+ if (!ignoreDefaultValue && defaultValue != null) {
+ return defaultValue;
+ }
+ return null;
+ }
+
@Override
public void setValue(RestClientRequest clientRequest, Object arg) throws Exception {
// query不需要set
@@ -105,6 +117,7 @@ public ParamValueProcessor create(Parameter parameter, Type genericParamType) {
QueryParameter queryParameter = (QueryParameter) parameter;
JavaType targetType = TypeFactory.defaultInstance().constructType(genericParamType);
return new QueryProcessor(parameter.getName(), targetType, queryParameter.getDefaultValue(),
+ parameter.getRequired(),
queryParameter.getCollectionFormat());
}
}
diff --git a/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestCookieProcessor.java b/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestCookieProcessor.java
index 370543494..63364c482 100644
--- a/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestCookieProcessor.java
+++ b/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestCookieProcessor.java
@@ -45,7 +45,11 @@
RestClientRequest clientRequest;
private CookieProcessor createProcessor(String name, Class<?> type) {
- return new CookieProcessor(name, TypeFactory.defaultInstance().constructType(type), null);
+ return new CookieProcessor(name, TypeFactory.defaultInstance().constructType(type), null, true);
+ }
+
+ private CookieProcessor createProcessor(String name, Class<?> type, String defaultValue, boolean required) {
+ return new CookieProcessor(name, TypeFactory.defaultInstance().constructType(type), defaultValue, required);
}
private void createClientRequest() {
@@ -66,11 +70,29 @@ public void testGetValueNoCookies() throws Exception {
}
};
- CookieProcessor processor = createProcessor("c1", String.class);
+ CookieProcessor processor = createProcessor("c1", String.class, null, false);
Object value = processor.getValue(request);
Assert.assertNull(value);
}
+ @Test
+ public void testNoCookieAndRequired() throws Exception {
+ new Expectations() {
+ {
+ request.getCookies();
+ result = null;
+ }
+ };
+
+ CookieProcessor processor = createProcessor("c1", String.class, null, true);
+ try {
+ processor.getValue(request);
+ Assert.assertEquals("required is true, throw exception", "not throw exception");
+ } catch (Exception e) {
+ Assert.assertTrue(e.getMessage().contains("Parameter is required."));
+ }
+ }
+
@Test
public void testGetValueCookiesNotFound() throws Exception {
Cookie[] cookies = new Cookie[] {new Cookie("c1", "c1v")};
@@ -81,7 +103,7 @@ public void testGetValueCookiesNotFound() throws Exception {
}
};
- CookieProcessor processor = createProcessor("c2", String.class);
+ CookieProcessor processor = createProcessor("c2", String.class, null, false);
Object value = processor.getValue(request);
Assert.assertNull(value);
}
@@ -101,6 +123,40 @@ public void testGetValueCookiesFound() throws Exception {
Assert.assertEquals("c1v", value);
}
+ @Test
+ public void testGetValueRequiredTrue() throws Exception {
+ Cookie[] cookies = new Cookie[] {new Cookie("c1", null)};
+ new Expectations() {
+ {
+ request.getCookies();
+ result = cookies;
+ }
+ };
+
+ CookieProcessor processor = createProcessor("c1", String.class, null, true);
+ try {
+ processor.getValue(request);
+ Assert.assertEquals("required is true, throw exception", "not throw exception");
+ } catch (Exception e) {
+ Assert.assertTrue(e.getMessage().contains("Parameter is required."));
+ }
+ }
+
+ @Test
+ public void testGetValueRequiredFalse() throws Exception {
+ Cookie[] cookies = new Cookie[] {new Cookie("c1", null)};
+ new Expectations() {
+ {
+ request.getCookies();
+ result = cookies;
+ }
+ };
+
+ CookieProcessor processor = createProcessor("c1", String.class, "test", false);
+ Object result = processor.getValue(request);
+ Assert.assertEquals("test", result);
+ }
+
@SuppressWarnings("deprecation")
@Test
public void testGetValueCookiesDate() throws Exception {
diff --git a/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestFormProcessor.java b/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestFormProcessor.java
index a75694058..c14403e6e 100644
--- a/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestFormProcessor.java
+++ b/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestFormProcessor.java
@@ -48,7 +48,11 @@
RestClientRequest clientRequest;
private FormProcessor createProcessor(String name, Class<?> type) {
- return new FormProcessor(name, TypeFactory.defaultInstance().constructType(type), null);
+ return new FormProcessor(name, TypeFactory.defaultInstance().constructType(type), null, true);
+ }
+
+ private FormProcessor createProcessor(String name, Class<?> type, String defaultValue, boolean required) {
+ return new FormProcessor(name, TypeFactory.defaultInstance().constructType(type), defaultValue, required);
}
private void createClientRequest() {
@@ -117,11 +121,29 @@ public void testGetValueContainerTypeNull() throws Exception {
}
};
- ParamValueProcessor processor = createProcessor("name", String[].class);
+ ParamValueProcessor processor = createProcessor("name", String[].class, null, false);
String[] value = (String[]) processor.getValue(request);
Assert.assertNull(value);
}
+ @Test
+ public void testGetValueNull() throws Exception {
+ new Expectations() {
+ {
+ request.getParameter("name");
+ result = null;
+ }
+ };
+
+ ParamValueProcessor processor = createProcessor("name", String.class, null, true);
+ try {
+ processor.getValue(request);
+ Assert.assertEquals("required is true, throw exception", "not throw exception");
+ } catch (Exception e) {
+ Assert.assertTrue(e.getMessage().contains("Parameter is required."));
+ }
+ }
+
@Test
public void testGetValueArray() throws Exception {
new Expectations() {
@@ -148,7 +170,7 @@ public void testGetValueList() throws Exception {
ParamValueProcessor processor =
new FormProcessor("name", TypeFactory.defaultInstance().constructCollectionType(List.class, String.class),
- null);
+ null, true);
Object value = processor.getValue(request);
Assert.assertThat((List<String>) value, Matchers.contains("value"));
}
@@ -164,7 +186,8 @@ public void testGetValueSet() throws Exception {
};
ParamValueProcessor processor =
- new FormProcessor("name", TypeFactory.defaultInstance().constructCollectionType(Set.class, String.class), null);
+ new FormProcessor("name", TypeFactory.defaultInstance().constructCollectionType(Set.class, String.class), null,
+ true);
Object value = processor.getValue(request);
Assert.assertThat((Set<String>) value, Matchers.contains("value"));
}
diff --git a/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestHeaderProcessor.java b/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestHeaderProcessor.java
index 667e53ba7..a20533660 100644
--- a/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestHeaderProcessor.java
+++ b/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestHeaderProcessor.java
@@ -49,7 +49,11 @@
RestClientRequest clientRequest;
private HeaderProcessor createProcessor(String name, Class<?> type) {
- return new HeaderProcessor(name, TypeFactory.defaultInstance().constructType(type), null);
+ return new HeaderProcessor(name, TypeFactory.defaultInstance().constructType(type), null, true);
+ }
+
+ private HeaderProcessor createProcessor(String name, Class<?> type, String defaultValue, boolean required) {
+ return new HeaderProcessor(name, TypeFactory.defaultInstance().constructType(type), defaultValue, required);
}
private void createClientRequest() {
@@ -102,11 +106,43 @@ public void testGetValueContainerTypeNull() throws Exception {
}
};
- HeaderProcessor processor = createProcessor("h1", String[].class);
+ HeaderProcessor processor = createProcessor("h1", String[].class, null, false);
String[] value = (String[]) processor.getValue(request);
Assert.assertNull(value);
}
+ @Test
+ public void testGetValueRequiredTrue() throws Exception {
+ new Expectations() {
+ {
+ request.getHeader("h1");
+ result = null;
+ }
+ };
+
+ HeaderProcessor processor = createProcessor("h1", String.class);
+ try {
+ processor.getValue(request);
+ Assert.assertEquals("required is true, throw exception", "not throw exception");
+ } catch (Exception e) {
+ Assert.assertTrue(e.getMessage().contains("Parameter is required."));
+ }
+ }
+
+ @Test
+ public void testGetValueRequiredFalse() throws Exception {
+ new Expectations() {
+ {
+ request.getHeader("h1");
+ result = null;
+ }
+ };
+
+ HeaderProcessor processor = createProcessor("h1", String.class, "test", false);
+ Object value = processor.getValue(request);
+ Assert.assertEquals("test", value);
+ }
+
@Test
public void testGetValueArray() throws Exception {
new Expectations() {
@@ -133,7 +169,7 @@ public void testGetValueList() throws Exception {
HeaderProcessor processor =
new HeaderProcessor("h1", TypeFactory.defaultInstance().constructCollectionType(List.class, String.class),
- null);
+ null, true);
Object value = processor.getValue(request);
Assert.assertThat((List<String>) value, Matchers.contains("h1v"));
}
@@ -149,7 +185,8 @@ public void testGetValueSet() throws Exception {
};
HeaderProcessor processor =
- new HeaderProcessor("h1", TypeFactory.defaultInstance().constructCollectionType(Set.class, String.class), null);
+ new HeaderProcessor("h1", TypeFactory.defaultInstance().constructCollectionType(Set.class, String.class), null,
+ true);
Object value = processor.getValue(request);
Assert.assertThat((Set<String>) value, Matchers.contains("h1v"));
}
diff --git a/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestPathProcessor.java b/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestPathProcessor.java
index 19cd51f7e..19cca94bb 100644
--- a/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestPathProcessor.java
+++ b/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestPathProcessor.java
@@ -41,7 +41,7 @@
ParamValueProcessor processor;
private void createProcessor(String name, Class<?> type) {
- processor = new PathProcessor(name, TypeFactory.defaultInstance().constructType(type), null);
+ processor = new PathProcessor(name, TypeFactory.defaultInstance().constructType(type), null, true);
}
private void prepareGetValue(String name, Class<?> type) {
diff --git a/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestQueryProcessor.java b/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestQueryProcessor.java
index ec896a2fb..4a3e6d70a 100644
--- a/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestQueryProcessor.java
+++ b/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/param/TestQueryProcessor.java
@@ -34,7 +34,13 @@
HttpServletRequest request;
private ParamValueProcessor createProcessor(String name, Class<?> type, String collectionFormat) {
- return new QueryProcessor(name, TypeFactory.defaultInstance().constructType(type), null, collectionFormat);
+ return new QueryProcessor(name, TypeFactory.defaultInstance().constructType(type), null, true, collectionFormat);
+ }
+
+ private ParamValueProcessor createProcessor(String name, Class<?> type, String defaultValue, boolean required,
+ String collectionFormat) {
+ return new QueryProcessor(name, TypeFactory.defaultInstance().constructType(type), defaultValue, required,
+ collectionFormat);
}
@Test
@@ -84,4 +90,36 @@ public void testGetProcessorType() {
ParamValueProcessor processor = createProcessor("name", String.class, "multi");
Assert.assertEquals("query", processor.getProcessorType());
}
+
+ @Test
+ public void testGetValueRequiredTrue() throws Exception {
+ new Expectations() {
+ {
+ request.getParameter("name");
+ result = null;
+ }
+ };
+
+ ParamValueProcessor processor = createProcessor("name", String.class, "multi");
+ try {
+ processor.getValue(request);
+ Assert.assertEquals("required is true, throw exception", "not throw exception");
+ } catch (Exception e) {
+ Assert.assertTrue(e.getMessage().contains("Parameter is required."));
+ }
+ }
+
+ @Test
+ public void testGetValueRequiredFalse() throws Exception {
+ new Expectations() {
+ {
+ request.getParameter("name");
+ result = null;
+ }
+ };
+
+ ParamValueProcessor processor = createProcessor("name", String.class, "test", false, "multi");
+ Object result = processor.getValue(request);
+ Assert.assertEquals("test", result);
+ }
}
diff --git a/demo/demo-schema/src/main/resources/microservices/pojo/server.yaml b/demo/demo-schema/src/main/resources/microservices/pojo/server.yaml
index 985fcb71e..15b1d8270 100644
--- a/demo/demo-schema/src/main/resources/microservices/pojo/server.yaml
+++ b/demo/demo-schema/src/main/resources/microservices/pojo/server.yaml
@@ -57,7 +57,7 @@ paths:
parameters:
- name: code
in: query
- required: true
+ required: false
type: string
responses:
200:
diff --git a/demo/demo-springmvc/springmvc-server/src/main/java/org/apache/servicecomb/demo/springmvc/server/SpringMvcDefaultValues.java b/demo/demo-springmvc/springmvc-server/src/main/java/org/apache/servicecomb/demo/springmvc/server/SpringMvcDefaultValues.java
index d6b33ebe4..3e9150962 100644
--- a/demo/demo-springmvc/springmvc-server/src/main/java/org/apache/servicecomb/demo/springmvc/server/SpringMvcDefaultValues.java
+++ b/demo/demo-springmvc/springmvc-server/src/main/java/org/apache/servicecomb/demo/springmvc/server/SpringMvcDefaultValues.java
@@ -61,7 +61,7 @@ public String query2(@RequestParam(name = "e", required = false) int e,
}
@GetMapping("/query3")
- public String query3(@RequestParam("a") @Min(value = 20) int a, @RequestParam("b") String b) {
+ public String query3(@RequestParam("a") @Min(value = 20) int a, @RequestParam(name = "b", required = false) String b) {
return "Hello " + a + b;
}
diff --git a/integration-tests/it-consumer/src/main/java/org/apache/servicecomb/it/testcase/TestAnnotatedAttribute.java b/integration-tests/it-consumer/src/main/java/org/apache/servicecomb/it/testcase/TestAnnotatedAttribute.java
index 732f62c20..232c1a10f 100644
--- a/integration-tests/it-consumer/src/main/java/org/apache/servicecomb/it/testcase/TestAnnotatedAttribute.java
+++ b/integration-tests/it-consumer/src/main/java/org/apache/servicecomb/it/testcase/TestAnnotatedAttribute.java
@@ -22,6 +22,7 @@
import java.util.Map;
import org.apache.servicecomb.it.Consumers;
+import org.apache.servicecomb.swagger.invocation.exception.InvocationException;
import org.junit.Test;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
@@ -53,6 +54,16 @@ public void fromCookie_springmvc_rt() {
fromCookie_rt(consumersSpringmvc);
}
+ @Test
+ public void fromCookieRequired_springmvc_rt() {
+ fromCookieRequired_rt(consumersSpringmvc);
+ }
+
+ @Test
+ public void fromCookieDefaultValue_springmvc_rt() {
+ fromCookieDefaultValue_rt(consumersSpringmvc);
+ }
+
@Test
public void fromPath_springmvc_rt() {
fromPath_rt(consumersSpringmvc);
@@ -109,6 +120,74 @@ protected void fromCookie_rt(Consumers<AnnotatedAttributeIntf> consumers) {
assertEquals("default,fromValue,fromName", result.getBody());
}
+ protected void fromCookieRequired_rt(Consumers<AnnotatedAttributeIntf> consumers) {
+ HttpHeaders headers = new HttpHeaders();
+ HttpEntity<?> requestEntity = new HttpEntity<>(headers);
+ try {
+ consumers.getSCBRestTemplate()
+ .exchange("/fromCookieRequired",
+ HttpMethod.GET,
+ requestEntity,
+ String.class);
+ assertEquals("required is true, throw exception", "but not throw exception");
+ } catch (InvocationException e) {
+ assertEquals(400, e.getStatusCode());
+ assertEquals("InvocationException: code=400;msg=CommonExceptionData [message=Parameter is not valid.]",
+ e.getMessage());
+ }
+ headers.add(HttpHeaders.COOKIE, "input1=default1");
+ requestEntity = new HttpEntity<>(headers);
+ try {
+ consumers.getSCBRestTemplate()
+ .exchange("/fromCookieRequired",
+ HttpMethod.GET,
+ requestEntity,
+ String.class);
+ assertEquals("required is true, throw exception", "but not throw exception");
+ } catch (InvocationException e) {
+ assertEquals(400, e.getStatusCode());
+ assertEquals("InvocationException: code=400;msg=CommonExceptionData [message=Parameter is not valid.]",
+ e.getMessage());
+ }
+ headers.add(HttpHeaders.COOKIE, "input=joker");
+ requestEntity = new HttpEntity<>(headers);
+ ResponseEntity<String> result = consumers.getSCBRestTemplate()
+ .exchange("/fromCookieRequired",
+ HttpMethod.GET,
+ requestEntity,
+ String.class);
+ assertEquals("joker", result.getBody());
+ }
+
+ protected void fromCookieDefaultValue_rt(Consumers<AnnotatedAttributeIntf> consumers) {
+ HttpHeaders headers = new HttpHeaders();
+ HttpEntity<?> requestEntity = new HttpEntity<>(headers);
+ ResponseEntity<String> result = consumers.getSCBRestTemplate()
+ .exchange("/fromCookieDefaultValue",
+ HttpMethod.GET,
+ requestEntity,
+ String.class);
+ assertEquals("default", result.getBody());
+
+ headers.add(HttpHeaders.COOKIE, "input1=jokers");
+ requestEntity = new HttpEntity<>(headers);
+ result = consumers.getSCBRestTemplate()
+ .exchange("/fromCookieDefaultValue",
+ HttpMethod.GET,
+ requestEntity,
+ String.class);
+ assertEquals("default", result.getBody());
+
+ headers.add(HttpHeaders.COOKIE, "input=joker");
+ requestEntity = new HttpEntity<>(headers);
+ result = consumers.getSCBRestTemplate()
+ .exchange("/fromCookieDefaultValue",
+ HttpMethod.GET,
+ requestEntity,
+ String.class);
+ assertEquals("joker", result.getBody());
+ }
+
protected void fromPath_rt(Consumers<AnnotatedAttributeIntf> consumers) {
String result = consumers.getSCBRestTemplate()
.getForObject("/fromPath/{1}/{2}/{3}",
diff --git a/integration-tests/it-consumer/src/main/java/org/apache/servicecomb/it/testcase/TestDefaultValue.java b/integration-tests/it-consumer/src/main/java/org/apache/servicecomb/it/testcase/TestDefaultValue.java
index d4ad947c5..d0b8039c2 100644
--- a/integration-tests/it-consumer/src/main/java/org/apache/servicecomb/it/testcase/TestDefaultValue.java
+++ b/integration-tests/it-consumer/src/main/java/org/apache/servicecomb/it/testcase/TestDefaultValue.java
@@ -19,6 +19,7 @@
import static org.junit.Assert.assertEquals;
import org.apache.servicecomb.it.Consumers;
+import org.apache.servicecomb.swagger.invocation.exception.InvocationException;
import org.junit.Test;
public class TestDefaultValue {
@@ -216,6 +217,17 @@ public void stringQuery_springmvc_rt() {
consumersSpringmvc.getSCBRestTemplate().getForObject("/stringQuery", String.class));
}
+ @Test
+ public void stringQueryRequiredTrue_springmvc_rt() {
+ try {
+ consumersSpringmvc.getSCBRestTemplate().getForObject("/stringQueryRequiredTrue", String.class);
+ assertEquals("required is true, throw exception", "not throw exception");
+ } catch (InvocationException e) {
+ assertEquals(400, e.getStatusCode());
+ assertEquals(true, e.getMessage().contains("Parameter is not valid"));
+ }
+ }
+
@Test
public void intHeader_springmvc_intf() {
assertEquals(defaultInt, consumersSpringmvc.getIntf().intHeader(null));
@@ -248,6 +260,17 @@ public void stringHeader_springmvc_rt() {
consumersSpringmvc.getSCBRestTemplate().getForObject("/stringHeader", String.class));
}
+ @Test
+ public void stringHeaderRequiredTrue_springmvc_rt() {
+ try {
+ consumersSpringmvc.getSCBRestTemplate().getForObject("/stringHeaderRequiredTrue", String.class);
+ assertEquals("required is true, throw exception", "not throw exception");
+ } catch (InvocationException e) {
+ assertEquals(400, e.getStatusCode());
+ assertEquals(true, e.getMessage().contains("Parameter is not valid"));
+ }
+ }
+
@Test
public void intForm_springmvc_intf() {
assertEquals(defaultInt, consumersSpringmvc.getIntf().intForm(null));
@@ -281,6 +304,17 @@ public void stringForm_springmvc_rt() {
consumersSpringmvc.getSCBRestTemplate().postForObject("/stringForm", null, String.class));
}
+ @Test
+ public void stringFormRequiredTrue_springmvc_rt() {
+ try {
+ consumersSpringmvc.getSCBRestTemplate().getForObject("/stringFormRequiredTrue", String.class);
+ assertEquals("required is true, throw exception", "not throw exception");
+ } catch (InvocationException e) {
+ assertEquals(400, e.getStatusCode());
+ assertEquals(true, e.getMessage().contains("Parameter is not valid"));
+ }
+ }
+
@Test
public void intQuery_require_springmvc_intf() {
assertEquals(defaultInt, consumersSpringmvc.getIntf().intQueryRequire(null));
diff --git a/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/AnnotatedAttributeSpringmvcSchema.java b/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/AnnotatedAttributeSpringmvcSchema.java
index 6b8691d2f..9439eeb94 100644
--- a/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/AnnotatedAttributeSpringmvcSchema.java
+++ b/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/AnnotatedAttributeSpringmvcSchema.java
@@ -49,6 +49,18 @@ public String fromCookie(@CookieValue("input") String inputs, @CookieValue(value
return inputs + "," + inputs2 + "," + inputs3;
}
+ @GetMapping("fromCookieRequired")
+ public String fromCookieRequired(
+ @CookieValue(name = "input", required = true) String input) {
+ return input;
+ }
+
+ @GetMapping("fromCookieDefaultValue")
+ public String fromCookieDefaultValue(
+ @CookieValue(name = "input", required = true, defaultValue = "default") String input) {
+ return input;
+ }
+
@GetMapping("fromPath/{input}/{input2}/{input3}")
public String fromPath(@PathVariable("input") String inputs, @PathVariable(value = "input2") String inputs2,
@PathVariable(name = "input3") String inputs3) {
diff --git a/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/DefaultValueSpringmvcSchema.java b/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/DefaultValueSpringmvcSchema.java
index 9ed160c41..f0501d2fb 100644
--- a/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/DefaultValueSpringmvcSchema.java
+++ b/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/DefaultValueSpringmvcSchema.java
@@ -22,6 +22,7 @@
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RequestPart;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
@@ -59,7 +60,7 @@ public int intHeaderRequire(@RequestHeader(name = "input", required = true, defa
}
@ApiImplicitParams({
- @ApiImplicitParam(name = "input", dataType = "integer", format = "int32", paramType = "form", value = "a required form param", required = true, defaultValue = "13")})
+ @ApiImplicitParam(name = "input", dataType = "integer", format = "int32", paramType = "form", value = "a defaultValue form param", required = false, defaultValue = "13")})
@PostMapping(path = "intFormRequire")
public int intFormRequire(int input) {
return input;
@@ -71,11 +72,21 @@ public String stringQuery(@RequestParam(value = "input", defaultValue = "string"
return input;
}
+ @GetMapping("stringQueryRequiredTrue")
+ public String stringQueryRequiredTrue(@RequestParam(value = "input") String input) {
+ return input;
+ }
+
@GetMapping("stringHeader")
public String stringHeader(@RequestHeader(value = "input", defaultValue = "string") String input) {
return input;
}
+ @GetMapping("stringHeaderRequiredTrue")
+ public String stringHeaderRequiredTrue(@RequestHeader(value = "input") String input) {
+ return input;
+ }
+
@ApiImplicitParams({
@ApiImplicitParam(name = "input", dataType = "string", paramType = "form", value = "", defaultValue = "string", required = false)})
@PostMapping(path = "stringForm")
@@ -83,6 +94,11 @@ public String stringForm(String input) {
return input;
}
+ @GetMapping("stringFormRequiredTrue")
+ public String stringFormRequiredTrue(@RequestPart(value = "input") String input) {
+ return input;
+ }
+
// springmvc rule: required should be false because defaultValue have value
@GetMapping(path = "stringQueryRequire")
public String stringQueryRequire(
@@ -98,7 +114,7 @@ public String stringHeaderRequire(
}
@ApiImplicitParams({
- @ApiImplicitParam(name = "input", dataType = "string", paramType = "form", value = "a required form param", required = true, defaultValue = "string")})
+ @ApiImplicitParam(name = "input", dataType = "string", paramType = "form", value = "a defalutValue form param", required = false, defaultValue = "string")})
@PostMapping(path = "stringFormRequire")
public String stringFormRequire(String input) {
return input;
@@ -137,7 +153,7 @@ public double doubleHeaderRequire(
}
@ApiImplicitParams({
- @ApiImplicitParam(name = "input", dataType = "number", format = "double", paramType = "form", value = "a required form param", required = true, defaultValue = "10.2")})
+ @ApiImplicitParam(name = "input", dataType = "number", format = "double", paramType = "form", value = "a defaultValue form param", required = false, defaultValue = "10.2")})
@PostMapping(path = "doubleFormRequire")
public double doubleFormRequire(double input) {
return input;
@@ -175,7 +191,7 @@ public float floatHeaderRequire(@RequestHeader(name = "input", required = true,
}
@ApiImplicitParams({
- @ApiImplicitParam(name = "input", dataType = "number", format = "float", paramType = "form", value = "a required form param", required = true, defaultValue = "10.2")})
+ @ApiImplicitParam(name = "input", dataType = "number", format = "float", paramType = "form", value = "a defaultValue form param", required = false, defaultValue = "10.2")})
@PostMapping(path = "floatFormRequire")
public float floatFormRequire(float input) {
return input;
diff --git a/integration-tests/springmvc-tests/springmvc-tests-common/src/test/java/org/apache/servicecomb/demo/springmvc/tests/SpringMvcIntegrationTestBase.java b/integration-tests/springmvc-tests/springmvc-tests-common/src/test/java/org/apache/servicecomb/demo/springmvc/tests/SpringMvcIntegrationTestBase.java
index c153a5ac5..c84ef3e52 100644
--- a/integration-tests/springmvc-tests/springmvc-tests-common/src/test/java/org/apache/servicecomb/demo/springmvc/tests/SpringMvcIntegrationTestBase.java
+++ b/integration-tests/springmvc-tests/springmvc-tests-common/src/test/java/org/apache/servicecomb/demo/springmvc/tests/SpringMvcIntegrationTestBase.java
@@ -48,6 +48,7 @@
import org.apache.servicecomb.demo.server.User;
import org.apache.servicecomb.provider.springmvc.reference.RestTemplateBuilder;
import org.apache.servicecomb.provider.springmvc.reference.async.CseAsyncRestTemplate;
+import org.apache.servicecomb.swagger.invocation.exception.InvocationException;
import org.junit.ClassRule;
import org.junit.Ignore;
import org.junit.Test;
@@ -66,6 +67,7 @@
import org.springframework.util.concurrent.ListenableFuture;
import org.springframework.util.concurrent.ListenableFutureCallback;
import org.springframework.web.client.AsyncRestTemplate;
+import org.springframework.web.client.RestClientException;
import org.springframework.web.client.RestTemplate;
@Ignore
@@ -321,10 +323,14 @@ public void blowsUpWhenFileNameDoesNotMatch() throws Exception {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.MULTIPART_FORM_DATA);
- ResponseEntity<String> response = restTemplate
- .postForEntity(codeFirstUrl + "uploadWithoutAnnotation", new HttpEntity<>(map, headers), String.class);
- assertThat(response.getStatusCodeValue(), is(590));
- assertThat(response.getBody(), is("CommonExceptionData [message=Cse Internal Server Error]"));
+ ResponseEntity<String> response = null;
+ try {
+ response = restTemplate
+ .postForEntity(codeFirstUrl + "uploadWithoutAnnotation", new HttpEntity<>(map, headers), String.class);
+ assertEquals("required is true, throw exception", "but not throw exception");
+ } catch (RestClientException e) {
+ assertEquals("400 Bad Request",e.getMessage());
+ }
}
@Test
diff --git a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/processor/parameter/AbstractParameterProcessor.java b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/processor/parameter/AbstractParameterProcessor.java
index 04d992cb5..54ec775a1 100644
--- a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/processor/parameter/AbstractParameterProcessor.java
+++ b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/processor/parameter/AbstractParameterProcessor.java
@@ -59,10 +59,9 @@ protected void setParameterName(Object annotation, OperationGenerator operationG
protected void setParameterDefaultValue(Object annotation, T parameter) {
String defaultValue = getAnnotationParameterDefaultValue(annotation);
- if (StringUtils.isNotEmpty(defaultValue)) {
- parameter.setDefaultValue(defaultValue);
+ if (StringUtils.isNotEmpty(defaultValue)) {
+ parameter.setDefaultValue(defaultValue);
}
-
}
protected String getAnnotationParameterDefaultValue(Object annotation) {
diff --git a/swagger/swagger-generator/generator-springmvc/src/main/java/org/apache/servicecomb/swagger/generator/springmvc/processor/annotation/CookieValueAnnotationProcessor.java b/swagger/swagger-generator/generator-springmvc/src/main/java/org/apache/servicecomb/swagger/generator/springmvc/processor/annotation/CookieValueAnnotationProcessor.java
index f96802d3e..7fb4d9181 100644
--- a/swagger/swagger-generator/generator-springmvc/src/main/java/org/apache/servicecomb/swagger/generator/springmvc/processor/annotation/CookieValueAnnotationProcessor.java
+++ b/swagger/swagger-generator/generator-springmvc/src/main/java/org/apache/servicecomb/swagger/generator/springmvc/processor/annotation/CookieValueAnnotationProcessor.java
@@ -19,6 +19,7 @@
import org.apache.servicecomb.swagger.generator.core.OperationGenerator;
import org.apache.servicecomb.swagger.generator.core.processor.parameter.AbstractParameterProcessor;
+import org.springframework.util.ObjectUtils;
import org.springframework.web.bind.annotation.CookieValue;
import org.springframework.web.bind.annotation.ValueConstants;
@@ -44,6 +45,11 @@ protected void fillParameter(Object annotation, OperationGenerator operationGene
CookieParameter parameter) {
super.fillParameter(annotation, operationGenerator, paramIdx, parameter);
+ Object defaultValue = parameter.getDefaultValue();
+ if (!ObjectUtils.isEmpty(defaultValue)) {
+ parameter.setRequired(false);
+ return;
+ }
CookieValue cookie = (CookieValue) annotation;
parameter.setRequired(cookie.required());
}
diff --git a/swagger/swagger-generator/generator-springmvc/src/main/java/org/apache/servicecomb/swagger/generator/springmvc/processor/annotation/RequestHeaderAnnotationProcessor.java b/swagger/swagger-generator/generator-springmvc/src/main/java/org/apache/servicecomb/swagger/generator/springmvc/processor/annotation/RequestHeaderAnnotationProcessor.java
index d34c296ab..63be3056e 100644
--- a/swagger/swagger-generator/generator-springmvc/src/main/java/org/apache/servicecomb/swagger/generator/springmvc/processor/annotation/RequestHeaderAnnotationProcessor.java
+++ b/swagger/swagger-generator/generator-springmvc/src/main/java/org/apache/servicecomb/swagger/generator/springmvc/processor/annotation/RequestHeaderAnnotationProcessor.java
@@ -19,6 +19,7 @@
import org.apache.servicecomb.swagger.generator.core.OperationGenerator;
import org.apache.servicecomb.swagger.generator.core.processor.parameter.AbstractParameterProcessor;
+import org.springframework.util.ObjectUtils;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.ValueConstants;
@@ -44,10 +45,15 @@ protected void fillParameter(Object annotation, OperationGenerator operationGene
HeaderParameter parameter) {
super.fillParameter(annotation, operationGenerator, paramIdx, parameter);
+ Object defaultValue = parameter.getDefaultValue();
+ if (!ObjectUtils.isEmpty(defaultValue)) {
+ parameter.setRequired(false);
+ return;
+ }
RequestHeader requestHeader = (RequestHeader) annotation;
parameter.setRequired(requestHeader.required());
}
-
+
@Override
protected String getAnnotationParameterDefaultValue(Object annotation) {
String defaultValue = ((RequestHeader) annotation).defaultValue();
@@ -56,5 +62,4 @@ protected String getAnnotationParameterDefaultValue(Object annotation) {
}
return defaultValue;
}
-
}
diff --git a/swagger/swagger-generator/generator-springmvc/src/main/java/org/apache/servicecomb/swagger/generator/springmvc/processor/annotation/RequestParamAnnotationProcessor.java b/swagger/swagger-generator/generator-springmvc/src/main/java/org/apache/servicecomb/swagger/generator/springmvc/processor/annotation/RequestParamAnnotationProcessor.java
index 8ad9a4b41..828a7828b 100644
--- a/swagger/swagger-generator/generator-springmvc/src/main/java/org/apache/servicecomb/swagger/generator/springmvc/processor/annotation/RequestParamAnnotationProcessor.java
+++ b/swagger/swagger-generator/generator-springmvc/src/main/java/org/apache/servicecomb/swagger/generator/springmvc/processor/annotation/RequestParamAnnotationProcessor.java
@@ -17,13 +17,14 @@
package org.apache.servicecomb.swagger.generator.springmvc.processor.annotation;
+import io.swagger.models.parameters.QueryParameter;
+
import org.apache.servicecomb.swagger.generator.core.OperationGenerator;
import org.apache.servicecomb.swagger.generator.core.processor.parameter.AbstractParameterProcessor;
+import org.springframework.util.ObjectUtils;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ValueConstants;
-import io.swagger.models.parameters.QueryParameter;
-
public class RequestParamAnnotationProcessor extends AbstractParameterProcessor<QueryParameter> {
@Override
public QueryParameter createParameter() {
@@ -44,6 +45,11 @@ protected void fillParameter(Object annotation, OperationGenerator operationGene
QueryParameter parameter) {
super.fillParameter(annotation, operationGenerator, paramIdx, parameter);
+ Object defaultValue = parameter.getDefaultValue();
+ if (!ObjectUtils.isEmpty(defaultValue)) {
+ parameter.setRequired(false);
+ return;
+ }
RequestParam requestParam = (RequestParam) annotation;
parameter.setRequired(requestParam.required());
}
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services