SpringBoot Implementation Gets HttpServletRequest Objects at Any Location

  • 2021-12-12 08:22:41
  • OfStack

Obtaining HttpServletRequest Object at Any Location in Directory Method 1 Method 2 HttpServletRequest can only be read once

Get an HttpServletRequest object anywhere

Method 1


// Get RequestAttributes
 RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
 // Get from RequestAttributes Get from HttpServletRequest Information of 
 HttpServletRequest request = (HttpServletRequest)requestAttributes.resolveReference(RequestAttributes.REFERENCE_REQUEST);

Method 2


ServletRequestAttributes attributes = (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();

HttpServletRequest can only be read once

The business logic reads the requested request through filter, obtains token, and transfers token to the following process for use

BodyReaderHttpServletRequestWrapper:


public class BodyReaderHttpServletRequestWrapper extends HttpServletRequestWrapper {
    private final byte[] body;
    public BodyReaderHttpServletRequestWrapper(HttpServletRequest request) throws IOException {
        super(request);
        body = HttpHelper.getBodyString(request).getBytes(Charset.forName("UTF-8"));
    }
    @Override
    public BufferedReader getReader() throws IOException {
        return new BufferedReader(new InputStreamReader(getInputStream()));
    }
    @Override
    public ServletInputStream getInputStream() throws IOException {
        final ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(body);
        return new ServletInputStream() {
            @Override
            public int read() throws IOException {
                return byteArrayInputStream.read();
            }
            @Override
            public boolean isFinished() {
                return false;
            }
            @Override
            public boolean isReady() {
                return false;
            }
            @Override
            public void setReadListener(ReadListener readListener) {
            }
        };
    }
}

RepeatReadFilter:


/**
 *  Encapsulation HttpServletRequest Repeatable Read Request 
 **/
public class RepeatReadFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest httpServletRequest = (HttpServletRequest) request;
        //  Prevent stream reading 1 There will be no more after the second time ,  So you need to continue writing out the stream 
        ServletRequest requestWrapper = new BodyReaderHttpServletRequestWrapper(httpServletRequest);
        // Get user credentials 
        String token = httpServletRequest.getHeader(Constants.USER_TOKEN);
        if(StringUtils.isBlank(token)){
            token = httpServletRequest.getParameter(Constants.USER_TOKEN);
        }
        //================= Get json Format token Field =========================
        String body = HttpHelper.getBodyString(requestWrapper);
        if (StringUtils.isNotBlank(body)) {
            JSONObject jsonObject = JSONObject.parseObject(body);
            Object obj = jsonObject.get("token");
            if (null != obj) {
                token = obj.toString();
            }
        }
        requestWrapper.setAttribute(Constants.USER_TOKEN,token);
        chain.doFilter(requestWrapper, response);
    }
    @Override
    public void destroy() {
    }
}

FilterConfig:


@Configuration
public class FilterConfig {
    @Bean
    public FilterRegistrationBean registFilter() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(new RepeatReadFilter());
        registration.addUrlPatterns("/app/*");
        registration.setName("UrlFilter");
        registration.setOrder(1);
        return registration;
    }
}

AuthorizationInterceptor:


@Component
public class AuthorizationInterceptor extends HandlerInterceptorAdapter {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        AuthIgnore annotation;
        if(handler instanceof HandlerMethod) {
            annotation = ((HandlerMethod) handler).getMethodAnnotation(AuthIgnore.class);
        }else{
            return true;
        }
        // If there is @AuthIgnore Annotation, do not validate token
        if(annotation != null){
            return true;
        }
        // Get user credentials 
        String token = request.getHeader(Constants.USER_TOKEN);
        if(StringUtils.isBlank(token)){
            token = request.getParameter(Constants.USER_TOKEN);
        }
        if(StringUtils.isBlank(token)){
            Object obj = request.getAttribute(Constants.USER_TOKEN);
            if(null!=obj){
                token=obj.toString();
            }
        }
        //token Voucher is empty 
        if(StringUtils.isBlank(token)){
            throw new AuthException(Constants.USER_TOKEN + " Cannot be empty ", HttpStatus.UNAUTHORIZED.value());
        }
        return true;
    }
}

WebMvcConfig:


@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {
    @Autowired
    private AuthorizationInterceptor authorizationInterceptor;
//    @Autowired
//    private LoginUserHandlerMethodArgumentResolver loginUserHandlerMethodArgumentResolver;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(authorizationInterceptor).addPathPatterns("/**");
        super.addInterceptors(registry);
    }
    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        //argumentResolvers.add(loginUserHandlerMethodArgumentResolver);
    }
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        super.configureMessageConverters(converters);
    }
    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
    }
}

Read token in filter and use it for reading judgment in interceptor

HttpHelper:


public class HttpHelper {
    /**
     *  Acquisition request Body
     *
     * @param request
     * @return
     */
    public static String getBodyString(ServletRequest request) {
        StringBuilder sb = new StringBuilder();
        InputStream inputStream = null;
        BufferedReader reader = null;
        try {
            inputStream = request.getInputStream();
            reader = new BufferedReader(new InputStreamReader(inputStream, Charset.forName("UTF-8")));
            String line = "";
            while ((line = reader.readLine()) != null) {
                sb.append(line);
            }
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (inputStream != null) {
                try {
                    inputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
            if (reader != null) {
                try {
                    reader.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
        return sb.toString();
    }
}

Related articles: