Java tutorial
/* * 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.common.rest.codec.param; import java.io.IOException; import java.io.InputStream; import java.lang.reflect.Type; import java.util.Locale; import javax.servlet.http.HttpServletRequest; import javax.ws.rs.core.HttpHeaders; import javax.ws.rs.core.MediaType; import org.apache.commons.io.IOUtils; import org.apache.servicecomb.common.rest.RestConst; import org.apache.servicecomb.common.rest.codec.RestClientRequest; import org.apache.servicecomb.common.rest.codec.RestObjectMapperFactory; import org.apache.servicecomb.foundation.vertx.stream.BufferOutputStream; import org.apache.servicecomb.swagger.generator.core.utils.ClassUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.util.StringUtils; import com.fasterxml.jackson.databind.JavaType; import com.fasterxml.jackson.databind.exc.MismatchedInputException; import com.fasterxml.jackson.databind.type.SimpleType; import com.fasterxml.jackson.databind.type.TypeFactory; import com.netflix.config.DynamicPropertyFactory; import io.swagger.models.parameters.Parameter; import io.vertx.core.buffer.Buffer; import io.vertx.core.buffer.impl.BufferImpl; public class BodyProcessorCreator implements ParamValueProcessorCreator { private static final Logger LOGGER = LoggerFactory.getLogger(BodyProcessorCreator.class); public static final String PARAMTYPE = "body"; private static final JavaType OBJECT_TYPE = SimpleType.constructUnsafe(Object.class); // This configuration is used for temporary use only. Do not use it if you are sure how it works. And may be deleted in future. private static boolean decodeAsObject = DynamicPropertyFactory.getInstance() .getBooleanProperty("servicecomb.rest.parameter.decodeAsObject", false).get(); public static class BodyProcessor implements ParamValueProcessor { protected JavaType targetType; protected boolean isRequired; public BodyProcessor(JavaType targetType, boolean isRequired) { this.targetType = targetType; this.isRequired = isRequired; } @Override public Object getValue(HttpServletRequest request) throws Exception { Object body = request.getAttribute(RestConst.BODY_PARAMETER); if (body != null) { return convertValue(body, targetType); } // edge support convert from form-data or x-www-form-urlencoded to json automatically String contentType = request.getContentType(); contentType = contentType == null ? "" : contentType.toLowerCase(Locale.US); if (contentType.startsWith(MediaType.MULTIPART_FORM_DATA) || contentType.startsWith(MediaType.APPLICATION_FORM_URLENCODED)) { return convertValue(request.getParameterMap(), targetType); } // for standard HttpServletRequest, getInputStream will never return null // but for mocked HttpServletRequest, maybe get a null // like org.apache.servicecomb.provider.springmvc.reference.ClientToHttpServletRequest InputStream inputStream = request.getInputStream(); if (inputStream == null) { return null; } if (!contentType.isEmpty() && !contentType.startsWith(MediaType.APPLICATION_JSON)) { // TODO: we should consider body encoding return IOUtils.toString(inputStream, "UTF-8"); } try { if (decodeAsObject) { return RestObjectMapperFactory.getRestObjectMapper().readValue(inputStream, OBJECT_TYPE); } return RestObjectMapperFactory.getRestObjectMapper().readValue(inputStream, targetType); } 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")) { LOGGER.info("Empty content and required is false, taken as null"); return null; } LOGGER.warn("Mismatched content. Msg=" + e.getMessage()); throw e; } } @Override public void setValue(RestClientRequest clientRequest, Object arg) throws Exception { ensureContentType(clientRequest); if (arg != null) { Buffer buffer = createBodyBuffer(clientRequest.getHeaders().get(HttpHeaders.CONTENT_TYPE), arg); clientRequest.write(buffer); } } /** * Deserialize body object into body buffer, according to the Content-Type. * * @param contentType the Content-Type of request * @param arg body param object * @return the deserialized body buffer * @throws IOException */ private Buffer createBodyBuffer(String contentType, Object arg) throws IOException { if (MediaType.TEXT_PLAIN.equals(contentType)) { if (!String.class.isInstance(arg)) { throw new IllegalArgumentException("Content-Type is text/plain while arg type is not String"); } return new BufferImpl().appendBytes(((String) arg).getBytes()); } try (BufferOutputStream output = new BufferOutputStream()) { RestObjectMapperFactory.getConsumerWriterMapper().writeValue(output, arg); return output.getBuffer(); } } /** * If the Content-Type has not been set yet, set application/json as default value. */ private void ensureContentType(RestClientRequest clientRequest) { if (null == clientRequest.getHeaders() || StringUtils.isEmpty(clientRequest.getHeaders().get(HttpHeaders.CONTENT_TYPE))) { clientRequest.putHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON); } } @Override public String getParameterPath() { return ""; } @Override public String getProcessorType() { return PARAMTYPE; } } public static class RawJsonBodyProcessor extends BodyProcessor { public RawJsonBodyProcessor(JavaType targetType, boolean isRequired) { super(targetType, isRequired); } @Override public Object getValue(HttpServletRequest request) throws Exception { Object body = request.getAttribute(RestConst.BODY_PARAMETER); if (body != null) { return convertValue(body, targetType); } InputStream inputStream = request.getInputStream(); if (inputStream == null) { return null; } // TODO: we should consider body encoding return IOUtils.toString(inputStream, "UTF-8"); } @Override public void setValue(RestClientRequest clientRequest, Object arg) throws Exception { clientRequest.putHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON); clientRequest.write(Buffer.buffer((String) arg)); } } public BodyProcessorCreator() { ParamValueProcessorCreatorManager.INSTANCE.register(PARAMTYPE, this); } @Override public ParamValueProcessor create(Parameter parameter, Type genericParamType) { JavaType targetType = TypeFactory.defaultInstance().constructType(genericParamType); boolean rawJson = ClassUtils.isRawJsonType(parameter); if (genericParamType.getTypeName().equals(String.class.getTypeName()) && rawJson) { return new RawJsonBodyProcessor(targetType, parameter.getRequired()); } return new BodyProcessor(targetType, parameter.getRequired()); } }