Shulou(Shulou.com)06/02 Report--

In this issue, the editor will bring you about how to integrate local HTTP requests and Spring Cloud RPC requests in the Spring MVC framework. The article is rich in content and analyzes and describes it from a professional point of view. I hope you can get something after reading this article.

Request distinction

Request path, for example: uri plus / rpc prefix is used to identify the RPC request

Request header information, such as: Accept:application/sc-rpc is used to identify the RPC request

Input parameters and response content

Method 1 (old):

Encapsulate the message transformation of Spring MVC:

Input (@ RequestBody): overrides the com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter#read method to be compatible with local and RPC requests.

@ Override public Object read (Type type, Class contextClass, HttpInputMessage inputMessage) throws IOException {try {/ / transform inputStream to string ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream (); IOUtils.copy (inputMessage.getBody (), byteArrayOutputStream); String str = byteArrayOutputStream.toString (StandardCharsets.UTF_8.name ()); / / parse json object JSONObject jsonObject = JSON.parseObject (str, super.getFastJsonConfig (). GetFeatures ()) / / if RPC, transform the data format if (jsonObject.containsKey ("data")) {return JSON.parseObject (jsonObject.getString ("data"), type, super.getFastJsonConfig (). GetFeatures ();} / / otherwise, call super method return readType (super.getType (type, contextClass), new ByteArrayInputStream (byteArrayOutputStream.toByteArray () } catch (JSONException ex) {throw new HttpMessageNotReadableException ("JSON parse error:" + ex.getMessage (), ex);} catch (IOException ex) {throw new IOException ("I error while reading input message", ex) }} private Object readType (Type type, InputStream in) {try {return JSON.parseObject (in, super.getFastJsonConfig (). GetCharset (), type, super.getFastJsonConfig (). GetParserConfig (), super.getFastJsonConfig (). GetParseProcess (), JSON.DEFAULT_PARSER_FEATURE Super.getFastJsonConfig () .getFeatures () } catch (JSONException ex) {throw new HttpMessageNotReadableException ("JSON parse error:" + ex.getMessage (), ex);} catch (IOException ex) {throw new HttpMessageNotReadableException ("I error while reading input message", ex);}}

Output (@ ResponseBody):

Override the com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter#writeInternal method to keep the data format of the local request consistent with the RPC request.

Package com.caiya.web.base;import com.alibaba.fastjson.JSONPObject;import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;import com.caiya.web.constant.CommonConstant;import com.google.common.base.Joiner;import org.springframework.http.HttpOutputMessage;import org.springframework.http.converter.HttpMessageNotWritableException;import java.io.IOException;/** * fastjson message converter. * / public class ExtendedFastJsonHttpMessageConverter extends FastJsonHttpMessageConverter {@ Override protected void writeInternal (Object object, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {super.writeInternal (wrapResult (object), outputMessage);} private Object wrapResult (Object object) {/ / prevent json requests from repeatedly packaging if (object instanceof ResponseDataWrapper) {return object;} if (object instanceof JSONPObject) {JSONPObject jsonpObject = (JSONPObject) object JSONPObject newJsonpObject = new JSONPObject (jsonpObject.getFunction ()); ResponseDataWrapper data; if (jsonpObject.getParameters (). Size () = = 1) {/ / prevent jsonp requests from repeatedly wrapping if (jsonpObject.getParameters (). Get (0) instanceof ResponseDataWrapper) {return object } data = ResponseDataWrapperBuilder.build (jsonpObject.getParameters (). Get (0));} else if (jsonpObject.getParameters (). Size () > 1) {data = ResponseDataWrapperBuilder.build (Joiner.on (",") .join (jsonpObject.getParameters ();} else {data = ResponseDataWrapperBuilder.build (CommonConstant.PLACEHOLDER_OBJECT_EMPTY) } newJsonpObject.addParameter (data); return newJsonpObject;} return ResponseDataWrapperBuilder.build (object);}}

Method 2:

Enter:

No processing is required. You can specify Accept when making a RPC request:

Package com.caiya.test.spring.cloud.configuration;import org.apache.http.HttpHost;import org.apache.http.client.HttpClient;import org.apache.http.client.config.RequestConfig;import org.apache.http.impl.client.DefaultConnectionKeepAliveStrategy;import org.apache.http.impl.client.HttpClientBuilder;import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;import org.apache.http.message.BasicHeader;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import java.util.Collections;import java.util.Timer Import java.util.TimerTask;import java.util.concurrent.TimeUnit;@Configurationpublic class FeignConfig {@ Bean public HttpClient httpClient () {System.out.println ("init feign httpclient configuration 1111"); / / generate default request configuration RequestConfig.Builder requestConfigBuilder = RequestConfig.custom (); / / timeout requestConfigBuilder.setSocketTimeout (5 * 1000); / / connection time requestConfigBuilder.setConnectTimeout (5 * 1000) / / set proxy / / requestConfigBuilder.setProxy (new HttpHost ("127.0.0.1", 8880)); RequestConfig defaultRequestConfig = requestConfigBuilder.build (); / / connection pool configuration / / persistent connections for 30 seconds final PoolingHttpClientConnectionManager pollingConnectionManager = new PoolingHttpClientConnectionManager (30, TimeUnit.MILLISECONDS); / / Total connections pollingConnectionManager.setMaxTotal (5000) / / concurrency of the same route pollingConnectionManager.setDefaultMaxPerRoute (100); / / httpclient configuration HttpClientBuilder httpClientBuilder = HttpClientBuilder.create (); / / persistent connection configuration, need to add Keep-Alive httpClientBuilder.setKeepAliveStrategy (new DefaultConnectionKeepAliveStrategy ()); httpClientBuilder.setConnectionManager (pollingConnectionManager); httpClientBuilder.setDefaultRequestConfig (defaultRequestConfig) in the header HttpClientBuilder.setDefaultHeaders (Collections.singleton (new BasicHeader ("Accept", "application/sc-rpc")); HttpClient client = httpClientBuilder.build (); / / start a timer to regularly reclaim expired connections / * Timer timer = new Timer () Timer.schedule (new TimerTask () {@ Override public void run () {/ / System.out.println ("= closeIdleConnections==="); pollingConnectionManager.closeExpiredConnections (); pollingConnectionManager.closeIdleConnections (5, TimeUnit.SECONDS);}, 10 * 1000, 5 * 1000) * / System.out.println ("= Apache httpclient initialization connection pool ="); return client;}}

Output:

Differentiate message transformations according to mediaType.

Package com.caiya.web.configuration;import com.alibaba.fastjson.serializer.SerializerFeature;import com.alibaba.fastjson.support.config.FastJsonConfig;import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;import com.caiya.web.base.ExtendedFastJsonHttpMessageConverter;import org.springframework.boot.autoconfigure.http.HttpMessageConverters;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.http.MediaType;import java.util.Arrays;import java.util.Collections;/** * fastjson message converter configuration. * * @ author caiya * @ since 1.0 * / @ Configurationpublic class FastJsonConfiguration {@ Bean public HttpMessageConverters extendedFastJsonHttpMessageConverter () {/ / for web controller FastJsonHttpMessageConverter fastJsonHttpMessageConverter = new ExtendedFastJsonHttpMessageConverter (); FastJsonConfig fastJsonConfig = new FastJsonConfig (); fastJsonConfig.setSerializerFeatures (SerializerFeature.DisableCircularReferenceDetect); / / fastJsonConfig.setSerializerFeatures (SerializerFeature.WriteMapNullValue); fastJsonHttpMessageConverter.setFastJsonConfig (fastJsonConfig); fastJsonHttpMessageConverter.setSupportedMediaTypes (Arrays.asList (MediaType.APPLICATION_JSON, MediaType.APPLICATION_JSON_UTF8)) / / for web resource (Spring Cloud RPC) FastJsonHttpMessageConverter fastJsonHttpMessageConverterPlain = new FastJsonHttpMessageConverter (); FastJsonConfig fastJsonConfigPlain = new FastJsonConfig (); fastJsonConfigPlain.setSerializerFeatures (SerializerFeature.DisableCircularReferenceDetect); / / fastJsonConfigPlain.setSerializerFeatures (SerializerFeature.WriteMapNullValue); fastJsonHttpMessageConverterPlain.setFastJsonConfig (fastJsonConfigPlain); fastJsonHttpMessageConverterPlain.setSupportedMediaTypes (Collections.singletonList (MediaType.valueOf ("application/sc-rpc"); return new HttpMessageConverters (fastJsonHttpMessageConverter, fastJsonHttpMessageConverterPlain);}}

Mode 3

In the method of each controller, the final response content is returned.

Mode 4

Different requests are processed through aop (RPC requests are not processed):

Package com.caiya.web.base;import com.alibaba.fastjson.JSONPObject;import com.caiya.web.constant.CommonConstant;import com.google.common.base.Joiner;import org.aspectj.lang.ProceedingJoinPoint;import org.aspectj.lang.annotation.Around;import org.aspectj.lang.annotation.Aspect;import org.aspectj.lang.annotation.Pointcut;import org.springframework.stereotype.Component;/** * wrapper processing of response content AOP. * / @ Component@Aspectpublic class ResponseDataWrapperAspect {@ Pointcut ("execution (* com.caiya.web.controller.rest..* (..)") Public void aspect () {} @ Around ("aspect ()") public Object around (ProceedingJoinPoint joinPoint) throws Throwable {Object object = joinPoint.proceed (joinPoint.getArgs ()); return wrapResult (object);} private Object wrapResult (Object object) {/ / prevent json requests from repeatedly wrapping if (object instanceof ResponseDataWrapper) {return object } if (object instanceof JSONPObject) {JSONPObject jsonpObject = (JSONPObject) object; JSONPObject newJsonpObject = new JSONPObject (jsonpObject.getFunction ()); ResponseDataWrapper data If (jsonpObject.getParameters (). Size () = 1) {/ / prevent jsonp requests from repeatedly wrapping if (jsonpObject.getParameters () .get (0) instanceof ResponseDataWrapper) {return object;} data = ResponseDataWrapperBuilder.build (jsonpObject.getParameters () .get (0)) } else if (jsonpObject.getParameters (). Size () > 1) {data = ResponseDataWrapperBuilder.build (Joiner.on (",") .join (jsonpObject.getParameters ();} else {data = ResponseDataWrapperBuilder.build (CommonConstant.PLACEHOLDER_OBJECT_EMPTY);} newJsonpObject.addParameter (data); return newJsonpObject } return ResponseDataWrapperBuilder.build (object);}} interceptor and filter

There is no need to intercept and release RPC requests (including session interceptor, permission interceptor, XSS filter, etc.)

Nginx

RPC requests can only be called in the form of [schema]: / / [ip]: [port] / [request_uri] through Spring Cloud registries, gateways, etc. Nginx needs to intercept RPC API calls whose path contains / rpc/ directory (complete isolation only needs to separate the applications of local requests and RPC requests):

Location ~ * / rpc/ {return 403;} Spring Cloud exception handling

Server exception handling

It is recommended that the outermost layer be wrapped with a Result object, which represents the execution result of the interface and contains processed exception information.

Client exception handling

Turn on the hystrix fuse of feignclient:

Feign: hystrix: enabled: true

Implement the interface feign.codec.ErrorDecoder to handle server-side exceptions:

Package com.caiya.web.configuration;import com.alibaba.fastjson.JSON;import com.alibaba.fastjson.JSONObject;import com.netflix.hystrix.exception.HystrixBadRequestException;import feign.Response;import feign.Util;import feign.codec.ErrorDecoder;import org.apache.commons.lang3.StringUtils;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.cloud.openfeign.FeignClientsConfiguration;import org.springframework.context.annotation.Configuration;import java.io.IOException;/** * Spring Cloud (feign with hystrix) Custom exception handling. * * @ see FeignClientsConfiguration.HystrixFeignConfiguration#feignHystrixBuilder () opens hystrix entry * @ see HystrixBadRequestException this exception type does not perform circuit breaker operation * HystrixBadRequestException.message: * {"path": "/ rpc/session/user/info", "error": "Internal Server Error", "message": "Illegal Agument Exception..", "timestamp": 1540266379459, "status": 500} * / @ Configurationpublic class FeignErrorDecoder implements ErrorDecoder {private static final Logger logger = LoggerFactory.getLogger (FeignErrorDecoder.class) @ Override public Exception decode (String methodKey, Response response) {String message = null; if (response.status () > = 400 & & response.status ()

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.