You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by li...@apache.org on 2020/04/13 08:27:58 UTC
[servicecomb-java-chassis] 03/04: [SCB-1828] Support @JsonView:
support @requestBody
This is an automated email from the ASF dual-hosted git repository.
liubao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-java-chassis.git
commit 06f7b4fe07f19a3c4946c8b06ef6be3bc96a42f8
Author: heyile <25...@qq.com>
AuthorDate: Sun Apr 5 21:08:10 2020 +0800
[SCB-1828] Support @JsonView: support @requestBody
---
.../common/rest/codec/RestObjectMapperFactory.java | 7 +++
.../rest/codec/param/BodyProcessorCreator.java | 50 +++++++++++----
.../rest/codec/param/ParamValueProcessor.java | 10 ++-
.../rest/codec/produce/ProduceJsonProcessor.java | 8 ++-
.../common/rest/definition/RestOperationMeta.java | 3 +
.../common/rest/codec/TestRestObjectMapper.java | 12 +++-
.../servicecomb/it/testcase/TestJsonView.java | 73 ++++++++++++++++++++++
.../servicecomb/it/schema/JsonViewJaxrsSchema.java | 22 +++++++
.../servicecomb/it/schema/JsonViewPojoSchema.java | 14 +++++
.../it/schema/JsonViewSpringmvcSchema.java | 19 ++++++
.../processor/parameter/JsonViewProcessor.java | 63 +++++++++++++++++++
...ervicecomb.swagger.generator.ParameterProcessor | 3 +-
12 files changed, 267 insertions(+), 17 deletions(-)
diff --git a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/RestObjectMapperFactory.java b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/RestObjectMapperFactory.java
index 683aa31..6c70b20 100644
--- a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/RestObjectMapperFactory.java
+++ b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/RestObjectMapperFactory.java
@@ -32,10 +32,13 @@ import com.fasterxml.jackson.databind.ObjectMapper;
public class RestObjectMapperFactory {
private static AbstractRestObjectMapper defaultMapper = new RestObjectMapper();
+ private static AbstractRestObjectMapper viewMapper = new RestObjectMapper();
+
private static AbstractRestObjectMapper consumerWriterMapper = defaultMapper;
static {
registerModules(defaultMapper);
+ registerModules(viewMapper);
}
private static void registerModules(ObjectMapper mapper) {
@@ -53,6 +56,10 @@ public class RestObjectMapperFactory {
return defaultMapper;
}
+ public static AbstractRestObjectMapper getRestViewMapper() {
+ return viewMapper;
+ }
+
public static void setConsumerWriterMapper(AbstractRestObjectMapper customMapper) {
registerModules(customMapper);
consumerWriterMapper = customMapper;
diff --git a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/BodyProcessorCreator.java b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/BodyProcessorCreator.java
index 0fdda61..ffce833 100644
--- a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/BodyProcessorCreator.java
+++ b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/BodyProcessorCreator.java
@@ -20,6 +20,7 @@ package org.apache.servicecomb.common.rest.codec.param;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Type;
+import java.nio.charset.StandardCharsets;
import java.util.Locale;
import javax.servlet.http.HttpServletRequest;
@@ -33,11 +34,13 @@ import org.apache.servicecomb.common.rest.codec.RestObjectMapperFactory;
import org.apache.servicecomb.foundation.vertx.stream.BufferOutputStream;
import org.apache.servicecomb.swagger.SwaggerUtils;
import org.apache.servicecomb.swagger.converter.ConverterMgr;
+import org.apache.servicecomb.swagger.generator.core.processor.parameter.JsonViewProcessor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.StringUtils;
import com.fasterxml.jackson.databind.JavaType;
+import com.fasterxml.jackson.databind.ObjectReader;
import com.fasterxml.jackson.databind.exc.MismatchedInputException;
import com.fasterxml.jackson.databind.type.SimpleType;
import com.fasterxml.jackson.databind.type.TypeFactory;
@@ -64,17 +67,35 @@ public class BodyProcessorCreator implements ParamValueProcessorCreator {
public static class BodyProcessor implements ParamValueProcessor {
protected JavaType targetType;
+ protected Class<?> serialViewClass;
+
private boolean isString;
protected boolean isRequired;
public BodyProcessor(JavaType targetType, boolean isString, boolean isRequired) {
+ this(targetType, null, isString, isRequired);
+ }
+
+ public BodyProcessor(JavaType targetType, String serialViewClass, boolean isString, boolean isRequired) {
+ if (serialViewClass != null) {
+ try {
+ this.serialViewClass = Class.forName(serialViewClass);
+ } catch (Throwable e) {
+ //ignore
+ }
+ }
this.targetType = targetType;
this.isString = isString;
this.isRequired = isRequired;
}
@Override
+ public Class<?> getSerialViewClass() {
+ return serialViewClass;
+ }
+
+ @Override
public Object getValue(HttpServletRequest request) throws Exception {
Object body = request.getAttribute(RestConst.BODY_PARAMETER);
if (body != null) {
@@ -99,16 +120,17 @@ public class BodyProcessorCreator implements ParamValueProcessorCreator {
if (!contentType.isEmpty() && !contentType.startsWith(MediaType.APPLICATION_JSON)) {
// TODO: we should consider body encoding
- return IOUtils.toString(inputStream, "UTF-8");
+ return IOUtils.toString(inputStream, StandardCharsets.UTF_8);
}
-
try {
+ ObjectReader reader = serialViewClass != null
+ ? RestObjectMapperFactory.getRestObjectMapper().readerWithView(serialViewClass)
+ : RestObjectMapperFactory.getRestObjectMapper().reader();
if (decodeAsObject) {
- return RestObjectMapperFactory.getRestObjectMapper()
- .readValue(inputStream, OBJECT_TYPE);
+ return reader.forType(OBJECT_TYPE).readValue(inputStream);
}
- return RestObjectMapperFactory.getRestObjectMapper()
- .readValue(inputStream, targetType == null ? OBJECT_TYPE : targetType);
+ return reader.forType(targetType == null ? OBJECT_TYPE : targetType)
+ .readValue(inputStream);
} catch (MismatchedInputException e) {
// there is no way to detect InputStream is empty, so have to catch the exception
if (!isRequired && e.getMessage().contains("No content to map due to end-of-input")) {
@@ -138,7 +160,7 @@ public class BodyProcessorCreator implements ParamValueProcessorCreator {
*/
private Buffer createBodyBuffer(String contentType, Object arg) throws IOException {
if (MediaType.TEXT_PLAIN.equals(contentType)) {
- if (!String.class.isInstance(arg)) {
+ if (!(arg instanceof String)) {
throw new IllegalArgumentException("Content-Type is text/plain while arg type is not String");
}
return new BufferImpl().appendBytes(((String) arg).getBytes());
@@ -180,7 +202,11 @@ public class BodyProcessorCreator implements ParamValueProcessorCreator {
public static class RawJsonBodyProcessor extends BodyProcessor {
public RawJsonBodyProcessor(JavaType targetType, boolean isString, boolean isRequired) {
- super(targetType, isString, isRequired);
+ this(targetType, null, isString, isRequired);
+ }
+
+ public RawJsonBodyProcessor(JavaType targetType, String serialViewClass, boolean isString, boolean isRequired) {
+ super(targetType, serialViewClass, isString, isRequired);
}
@Override
@@ -196,7 +222,7 @@ public class BodyProcessorCreator implements ParamValueProcessorCreator {
}
// TODO: we should consider body encoding
- return IOUtils.toString(inputStream, "UTF-8");
+ return IOUtils.toString(inputStream, StandardCharsets.UTF_8);
}
@Override
@@ -228,9 +254,11 @@ public class BodyProcessorCreator implements ParamValueProcessorCreator {
genericParamType == null ? null : TypeFactory.defaultInstance().constructType(genericParamType);
boolean rawJson = SwaggerUtils.isRawJsonType(parameter);
if (rawJson) {
- return new RawJsonBodyProcessor(targetType, isString, parameter.getRequired());
+ return new RawJsonBodyProcessor(targetType, (String) parameter.getVendorExtensions().get(
+ JsonViewProcessor.VENDOR_EXTENSION_KEY), isString, parameter.getRequired());
}
- return new BodyProcessor(targetType, isString, parameter.getRequired());
+ return new BodyProcessor(targetType, (String) parameter.getVendorExtensions().get(
+ JsonViewProcessor.VENDOR_EXTENSION_KEY), isString, parameter.getRequired());
}
}
diff --git a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/ParamValueProcessor.java b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/ParamValueProcessor.java
index 414e913..8c933a2 100644
--- a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/ParamValueProcessor.java
+++ b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/param/ParamValueProcessor.java
@@ -33,7 +33,11 @@ public interface ParamValueProcessor {
if (value == null || targetType == null) {
return value;
}
-
+ if (getSerialViewClass() != null) {
+ return RestObjectMapperFactory.getRestViewMapper().setConfig(
+ RestObjectMapperFactory.getRestViewMapper().getDeserializationConfig().withView(getSerialViewClass()))
+ .convertValue(value, targetType);
+ }
return RestObjectMapperFactory.getRestObjectMapper()
.convertValue(value, targetType);
}
@@ -41,4 +45,8 @@ public interface ParamValueProcessor {
String getParameterPath();
String getProcessorType();
+
+ default Class<?> getSerialViewClass() {
+ return null;
+ }
}
diff --git a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/produce/ProduceJsonProcessor.java b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/produce/ProduceJsonProcessor.java
index ab0df60..c25f6f2 100644
--- a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/produce/ProduceJsonProcessor.java
+++ b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/produce/ProduceJsonProcessor.java
@@ -32,7 +32,7 @@ public class ProduceJsonProcessor implements ProduceProcessor {
@Override
public String getSerializationView() {
- return serializationView == null ? ProduceProcessorManager.DEFAULT_SERIAL_CLASS
+ return serializationView == null ? ProduceProcessor.super.getSerializationView()
: serializationView.getCanonicalName();
}
@@ -60,7 +60,11 @@ public class ProduceJsonProcessor implements ProduceProcessor {
@Override
public Object doDecodeResponse(InputStream input, JavaType type) throws Exception {
- return RestObjectMapperFactory.getRestObjectMapper().readValue(input, type);
+ if (serializationView == null) {
+ return RestObjectMapperFactory.getRestObjectMapper().readValue(input, type);
+ }
+ return RestObjectMapperFactory.getRestObjectMapper().readerWithView(serializationView)
+ .forType(type).readValue(input);
}
@Override
diff --git a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/definition/RestOperationMeta.java b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/definition/RestOperationMeta.java
index d559231..c952221 100644
--- a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/definition/RestOperationMeta.java
+++ b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/definition/RestOperationMeta.java
@@ -279,6 +279,9 @@ public class RestOperationMeta {
public ProduceProcessor ensureFindProduceProcessor(HttpServletRequestEx requestEx) {
String acceptType = requestEx.getHeader(HttpHeaders.ACCEPT);
SwaggerProducerOperation producerOperation = operationMeta.getExtData(Const.PRODUCER_OPERATION);
+ if (producerOperation == null || producerOperation.getProducerMethod() == null) {
+ return ensureFindProduceProcessor(acceptType);
+ }
return ensureFindProduceProcessor(acceptType, producerOperation.getProducerMethod().getDeclaredAnnotations());
}
diff --git a/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/TestRestObjectMapper.java b/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/TestRestObjectMapper.java
index f73e0a7..8f26c26 100644
--- a/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/TestRestObjectMapper.java
+++ b/common/common-rest/src/test/java/org/apache/servicecomb/common/rest/codec/TestRestObjectMapper.java
@@ -17,6 +17,8 @@
package org.apache.servicecomb.common.rest.codec;
+import static org.junit.Assert.assertFalse;
+
import java.io.ByteArrayInputStream;
import java.io.InputStream;
@@ -26,6 +28,7 @@ import org.junit.Test;
import com.fasterxml.jackson.core.JsonParser.Feature;
import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.MapperFeature;
import com.fasterxml.jackson.databind.exc.MismatchedInputException;
import com.fasterxml.jackson.databind.type.TypeFactory;
@@ -35,16 +38,21 @@ public class TestRestObjectMapper {
@Test
public void testAutoCloseSource() {
- Assert.assertFalse(RestObjectMapperFactory.getRestObjectMapper().getFactory().isEnabled(Feature.AUTO_CLOSE_SOURCE));
+ assertFalse(RestObjectMapperFactory.getRestObjectMapper().getFactory().isEnabled(Feature.AUTO_CLOSE_SOURCE));
}
@Test
public void testDeserializationFeature() {
- Assert.assertFalse(
+ assertFalse(
RestObjectMapperFactory.getRestObjectMapper().isEnabled(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES));
}
@Test
+ public void testDefaultViewInclusionFeature() {
+ assertFalse(RestObjectMapperFactory.getRestObjectMapper().isEnabled(MapperFeature.DEFAULT_VIEW_INCLUSION));
+ }
+
+ @Test
public void testJsonObjectWork() {
JsonObject obj = new JsonObject();
obj.put("name", "a");
diff --git a/integration-tests/it-consumer/src/main/java/org/apache/servicecomb/it/testcase/TestJsonView.java b/integration-tests/it-consumer/src/main/java/org/apache/servicecomb/it/testcase/TestJsonView.java
index af5a7a2..cb53270 100644
--- a/integration-tests/it-consumer/src/main/java/org/apache/servicecomb/it/testcase/TestJsonView.java
+++ b/integration-tests/it-consumer/src/main/java/org/apache/servicecomb/it/testcase/TestJsonView.java
@@ -41,6 +41,12 @@ public class TestJsonView {
String jsonViewPlainDefaultWithSummary();
String jsonViewPlainDefaultWithSummaryDetails();
+
+ PersonViewModel jsonViewPostDefault(PersonViewModel personViewModel);
+
+ PersonViewModel jsonViewPostDefaultWithSummary(PersonViewModel personViewModel);
+
+ PersonViewModel jsonViewPostDefaultWithSummaryDetails(PersonViewModel personViewModel);
}
private static Consumers<JsonViewRestIntf> consumersPojo = new Consumers<>("jsonViewPojoSchema",
@@ -248,4 +254,71 @@ public class TestJsonView {
String pojoConsumersPojo = consumersPojo.getIntf().jsonViewPlainDefaultWithSummaryDetails();
assertEquals(EXPECT_NO_VIEW.toString(), pojoConsumersPojo);
}
+
+ @Test
+ public void testJsonViewPostDefault() {
+ PersonViewModel restPersonViewSpringMvc = consumersSpringmvc.getSCBRestTemplate()
+ .postForObject("/jsonViewPostDefault", EXPECT_NO_VIEW, PersonViewModel.class);
+ assertEquals(EXPECT_NO_VIEW, restPersonViewSpringMvc);
+ PersonViewModel pojoPersonViewSpringMvc = consumersSpringmvc.getIntf()
+ .jsonViewPostDefault(EXPECT_NO_VIEW);
+ assertEquals(EXPECT_NO_VIEW, pojoPersonViewSpringMvc);
+
+ PersonViewModel restPersonViewJaxrs = consumersJaxrs.getSCBRestTemplate()
+ .postForObject("/jsonViewPostDefault", EXPECT_NO_VIEW, PersonViewModel.class);
+ assertEquals(EXPECT_NO_VIEW, restPersonViewJaxrs);
+ PersonViewModel pojoPersonViewJaxrs = consumersJaxrs.getIntf().jsonViewPostDefault(EXPECT_NO_VIEW);
+ assertEquals(EXPECT_NO_VIEW, pojoPersonViewJaxrs);
+
+ PersonViewModel restPersonViewPojo = consumersPojo.getSCBRestTemplate()
+ .postForObject("/jsonViewPostDefault", EXPECT_NO_VIEW, PersonViewModel.class);
+ assertEquals(EXPECT_NO_VIEW, restPersonViewPojo);
+ PersonViewModel pojoPersonViewPojo = consumersPojo.getIntf().jsonViewPostDefault(EXPECT_NO_VIEW);
+ assertEquals(EXPECT_NO_VIEW, pojoPersonViewPojo);
+ }
+
+ @Test
+ public void testJsonViewPostDefaultWithSummary() {
+ PersonViewModel restPersonViewSpringMvc = consumersSpringmvc.getSCBRestTemplate()
+ .postForObject("/jsonViewPostDefaultWithSummary", EXPECT_NO_VIEW, PersonViewModel.class);
+ assertEquals(EXPECT_SUMMARY_VIEW, restPersonViewSpringMvc);
+ PersonViewModel pojoPersonViewSpringMvc = consumersSpringmvc.getIntf()
+ .jsonViewPostDefaultWithSummary(EXPECT_NO_VIEW);
+ assertEquals(EXPECT_SUMMARY_VIEW, pojoPersonViewSpringMvc);
+
+ PersonViewModel restPersonViewJaxrs = consumersJaxrs.getSCBRestTemplate()
+ .postForObject("/jsonViewPostDefaultWithSummary", EXPECT_NO_VIEW, PersonViewModel.class);
+ assertEquals(EXPECT_SUMMARY_VIEW, restPersonViewJaxrs);
+ PersonViewModel pojoPersonViewJaxrs = consumersJaxrs.getIntf().jsonViewPostDefaultWithSummary(EXPECT_NO_VIEW);
+ assertEquals(EXPECT_SUMMARY_VIEW, pojoPersonViewJaxrs);
+
+ PersonViewModel restPersonViewPojo = consumersPojo.getSCBRestTemplate()
+ .postForObject("/jsonViewPostDefaultWithSummary", EXPECT_NO_VIEW, PersonViewModel.class);
+ assertEquals(EXPECT_SUMMARY_VIEW, restPersonViewPojo);
+ PersonViewModel pojoPersonViewPojo = consumersPojo.getIntf().jsonViewPostDefaultWithSummary(EXPECT_NO_VIEW);
+ assertEquals(EXPECT_SUMMARY_VIEW, pojoPersonViewPojo);
+ }
+
+ @Test
+ public void testJsonViewPostDefaultWithSummaryDetails() {
+ PersonViewModel restPersonViewSpringMvc = consumersSpringmvc.getSCBRestTemplate()
+ .postForObject("/jsonViewPostDefaultWithSummaryDetails", EXPECT_NO_VIEW, PersonViewModel.class);
+ assertEquals(EXPECT_SUMMARY_DETAILS_VIEW, restPersonViewSpringMvc);
+ PersonViewModel pojoPersonViewSpringMvc = consumersSpringmvc.getIntf()
+ .jsonViewPostDefaultWithSummaryDetails(EXPECT_NO_VIEW);
+ assertEquals(EXPECT_SUMMARY_DETAILS_VIEW, pojoPersonViewSpringMvc);
+
+ PersonViewModel restPersonViewJaxrs = consumersJaxrs.getSCBRestTemplate()
+ .postForObject("/jsonViewPostDefaultWithSummaryDetails", EXPECT_NO_VIEW, PersonViewModel.class);
+ assertEquals(EXPECT_SUMMARY_DETAILS_VIEW, restPersonViewJaxrs);
+ PersonViewModel pojoPersonViewJaxrs = consumersJaxrs.getIntf()
+ .jsonViewPostDefaultWithSummaryDetails(EXPECT_NO_VIEW);
+ assertEquals(EXPECT_SUMMARY_DETAILS_VIEW, pojoPersonViewJaxrs);
+
+ PersonViewModel restPersonViewPojo = consumersPojo.getSCBRestTemplate()
+ .postForObject("/jsonViewPostDefaultWithSummaryDetails", EXPECT_NO_VIEW, PersonViewModel.class);
+ assertEquals(EXPECT_SUMMARY_DETAILS_VIEW, restPersonViewPojo);
+ PersonViewModel pojoPersonViewPojo = consumersPojo.getIntf().jsonViewPostDefaultWithSummaryDetails(EXPECT_NO_VIEW);
+ assertEquals(EXPECT_SUMMARY_DETAILS_VIEW, pojoPersonViewPojo);
+ }
}
diff --git a/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/JsonViewJaxrsSchema.java b/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/JsonViewJaxrsSchema.java
index 05c6ffe..f973f2d 100644
--- a/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/JsonViewJaxrsSchema.java
+++ b/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/JsonViewJaxrsSchema.java
@@ -17,10 +17,12 @@
package org.apache.servicecomb.it.schema;
import javax.ws.rs.GET;
+import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import org.apache.servicecomb.provider.rest.common.RestSchema;
+import org.springframework.web.bind.annotation.RequestBody;
import com.fasterxml.jackson.annotation.JsonView;
@@ -93,4 +95,24 @@ public class JsonViewJaxrsSchema {
public String jsonViewPlainDefaultWithSummaryDetails() {
return PersonViewModel.generatePersonViewModel().toString();
}
+
+ @POST
+ @Path("jsonViewPostDefault")
+ public PersonViewModel jsonViewPostDefault(@RequestBody PersonViewModel personViewModel) {
+ return personViewModel;
+ }
+
+ @POST
+ @Path("jsonViewPostDefaultWithSummary")
+ public PersonViewModel jsonViewPostDefaultWithSummary(
+ @JsonView(PersonViewModel.Summary.class) @RequestBody PersonViewModel personViewModel) {
+ return personViewModel;
+ }
+
+ @POST
+ @Path("jsonViewPostDefaultWithSummaryDetails")
+ public PersonViewModel jsonViewPostDefaultWithSummaryDetails(
+ @JsonView(PersonViewModel.SummaryWithDetails.class) @RequestBody PersonViewModel personViewModel) {
+ return personViewModel;
+ }
}
diff --git a/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/JsonViewPojoSchema.java b/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/JsonViewPojoSchema.java
index b778905..e637567 100644
--- a/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/JsonViewPojoSchema.java
+++ b/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/JsonViewPojoSchema.java
@@ -66,4 +66,18 @@ public class JsonViewPojoSchema {
public String jsonViewPlainDefaultWithSummaryDetails() {
return PersonViewModel.generatePersonViewModel().toString();
}
+
+ public PersonViewModel jsonViewPostDefault(PersonViewModel personViewModel) {
+ return personViewModel;
+ }
+
+ public PersonViewModel jsonViewPostDefaultWithSummary(
+ @JsonView(PersonViewModel.Summary.class) PersonViewModel personViewModel) {
+ return personViewModel;
+ }
+
+ public PersonViewModel jsonViewPostDefaultWithSummaryDetails(
+ @JsonView(PersonViewModel.SummaryWithDetails.class) PersonViewModel personViewModel) {
+ return personViewModel;
+ }
}
diff --git a/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/JsonViewSpringmvcSchema.java b/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/JsonViewSpringmvcSchema.java
index 39a1b11..c2ad8b7 100644
--- a/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/JsonViewSpringmvcSchema.java
+++ b/integration-tests/it-producer/src/main/java/org/apache/servicecomb/it/schema/JsonViewSpringmvcSchema.java
@@ -18,6 +18,8 @@ package org.apache.servicecomb.it.schema;
import org.apache.servicecomb.provider.rest.common.RestSchema;
import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import com.fasterxml.jackson.annotation.JsonView;
@@ -76,4 +78,21 @@ public class JsonViewSpringmvcSchema {
public String jsonViewPlainDefaultWithSummaryDetails() {
return PersonViewModel.generatePersonViewModel().toString();
}
+
+ @PostMapping("/jsonViewPostDefault")
+ public PersonViewModel jsonViewPostDefault(@RequestBody PersonViewModel personViewModel) {
+ return personViewModel;
+ }
+
+ @PostMapping("/jsonViewPostDefaultWithSummary")
+ public PersonViewModel jsonViewPostDefaultWithSummary(
+ @JsonView(PersonViewModel.Summary.class) @RequestBody PersonViewModel personViewModel) {
+ return personViewModel;
+ }
+
+ @PostMapping("/jsonViewPostDefaultWithSummaryDetails")
+ public PersonViewModel jsonViewPostDefaultWithSummaryDetails(
+ @JsonView(PersonViewModel.SummaryWithDetails.class) @RequestBody PersonViewModel personViewModel) {
+ return personViewModel;
+ }
}
diff --git a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/processor/parameter/JsonViewProcessor.java b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/processor/parameter/JsonViewProcessor.java
new file mode 100644
index 0000000..e157e5c
--- /dev/null
+++ b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/processor/parameter/JsonViewProcessor.java
@@ -0,0 +1,63 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.servicecomb.swagger.generator.core.processor.parameter;
+
+import java.lang.annotation.Annotation;
+import java.lang.reflect.Type;
+
+import org.apache.servicecomb.swagger.generator.ParameterProcessor;
+import org.apache.servicecomb.swagger.generator.core.model.HttpParameterType;
+
+import com.fasterxml.jackson.annotation.JsonView;
+
+import io.swagger.models.Operation;
+import io.swagger.models.Swagger;
+import io.swagger.models.parameters.Parameter;
+
+public class JsonViewProcessor implements ParameterProcessor<Parameter, Annotation> {
+ public static final String VENDOR_EXTENSION_KEY = "x-json-view";
+
+ @Override
+ public Type getProcessType() {
+ return JsonView.class;
+ }
+
+ @Override
+ public String getParameterName(Annotation parameterAnnotation) {
+ return null;
+ }
+
+ @Override
+ public HttpParameterType getHttpParameterType(Annotation parameterAnnotation) {
+ return null;
+ }
+
+ @Override
+ public void fillParameter(Swagger swagger, Operation operation, Parameter parameter, Type type,
+ Annotation annotation) {
+ if (!(annotation instanceof JsonView)) {
+ throw new IllegalArgumentException(
+ "JsonViewProcessor only support process parameter with annotation @JsonView");
+ }
+ Class<?>[] jvValue = ((JsonView) annotation).value();
+ if (jvValue.length != 1) {
+ throw new IllegalArgumentException(
+ "@JsonView only supported for exactly 1 class argument ");
+ }
+ parameter.getVendorExtensions().put(VENDOR_EXTENSION_KEY, jvValue[0].getName());
+ }
+}
\ No newline at end of file
diff --git a/swagger/swagger-generator/generator-core/src/main/resources/META-INF/services/org.apache.servicecomb.swagger.generator.ParameterProcessor b/swagger/swagger-generator/generator-core/src/main/resources/META-INF/services/org.apache.servicecomb.swagger.generator.ParameterProcessor
index 6848c9b..ffce477 100644
--- a/swagger/swagger-generator/generator-core/src/main/resources/META-INF/services/org.apache.servicecomb.swagger.generator.ParameterProcessor
+++ b/swagger/swagger-generator/generator-core/src/main/resources/META-INF/services/org.apache.servicecomb.swagger.generator.ParameterProcessor
@@ -20,4 +20,5 @@ org.apache.servicecomb.swagger.generator.core.processor.parameter.ApiParamProces
org.apache.servicecomb.swagger.generator.core.processor.parameter.RawJsonRequestBodyProcessor
org.apache.servicecomb.swagger.generator.core.processor.parameter.PartProcessor
org.apache.servicecomb.swagger.generator.core.processor.parameter.PartArrayProcessor
-org.apache.servicecomb.swagger.generator.core.processor.parameter.PartListProcessor
\ No newline at end of file
+org.apache.servicecomb.swagger.generator.core.processor.parameter.PartListProcessor
+org.apache.servicecomb.swagger.generator.core.processor.parameter.JsonViewProcessor
\ No newline at end of file