美文网首页
API-Server构建指南(1)-请求格式篇

API-Server构建指南(1)-请求格式篇

作者: 东阿 | 来源:发表于2019-12-06 10:54 被阅读0次

    一个现代化的生产环境可用的APIServer需要具备什么样的素质?
    服务端开发人员常被戏称为 CRUDer,被嘲讽就会写 增删改查,现实情况是,大多数时候,确实是在变着花样的写增删改查。
    那么同样是提供增删改查的APIServer,差距都在哪里?
    性能?
    安全?
    高可用?
    这些,都不是我今天要说的东西。第一课,让我们从最基本的 一个项目请求说起。
    (阅读此文章需要较少的Spring Boot使用基础)
    首先,我们新建一个默认的 Spring Boot 项目 spring boot 快速开始
    一个 入口类
    然后,写一个controller
    我们的项目就就可以本地启动,发布使用了,是不是很简单,但是实际的使用过程中,我们会产生一些疑问。

    1. 我们如何调用接口,传递参数。
      Http请求,根据method区分,我们重点需要关注的有
      Get 查
      Post 增
      Delete 删
      Put 改
      Options 跨域请求的排头兵。
      参数放在Url里 还是 body里?
      放在body里的话,参数格式 是用 application/x-www-form-urlencoded 还是 application/json?
      其实最开始的时候,是都识别的,比如某post请求,参数放url,或者放 body 里,都是可以识别的。
      实际上,同一个接口,使用三种参数传递方式,都可以调用,spring 的服务端是可以做到都识别的。
      但是,统一优于不统一。
      我们规定,除get请求,参数要放在body里传递。
      规定如何生效?
      spring MVC,是无论参数传递方式,都能识别的。强制修改spring不识别url参数?这个思路还行。
      后来我就写了一个Filter,检测每个请求,只要不是get请求。其他请求,只要url里存在 queryString。则报错。
      好的,功能完成了。
      但是问题出现了,我发现 Put请求,通过body传递过来的参数,服务端无法接收。但是使用body传参是相当必要的,body传参,在我们传递敏感信息的时候,显然更加安全,同时,我已经通知给客户端,用body传参了,不好意思撤回。
      经过百度,得知,可以通过修改tomcat的配置,让tomcat增加解析put 请求的body,就可以了,但是轻推惯例为,尽量不修改服务器配置和tomcat配置。以防止不必要的影响,和一些其他未知的次生灾害。
      后继续百度,得到了另一个解决方案。
      spring 提供的 一个 Filter 叫 HttpPutFormContentFilter。
      只要添加此Filter,程序就可以解析put请求和patch请求 的body传参了。
      结果,问题又来了,Delete请求,也存在此问题,but,spring 没有提供HttpDeleteFormContentFilter。
      自然而然的,我抄袭HttpPutFormContentFilter做了简单的修改用于支持delete请求的body传参。
    /*
     * Copyright 2002-2017 the original author or authors.
     *
     * Licensed 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.
     */
    
    
    
    import java.io.IOException;
    import java.io.InputStream;
    import java.nio.charset.Charset;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Collections;
    import java.util.Enumeration;
    import java.util.LinkedHashMap;
    import java.util.LinkedHashSet;
    import java.util.List;
    import java.util.Map;
    import java.util.Set;
    import javax.servlet.FilterChain;
    import javax.servlet.ServletException;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletRequestWrapper;
    import javax.servlet.http.HttpServletResponse;
    import org.springframework.http.HttpInputMessage;
    import org.springframework.http.MediaType;
    import org.springframework.http.converter.FormHttpMessageConverter;
    import org.springframework.http.converter.support.AllEncompassingFormHttpMessageConverter;
    import org.springframework.http.server.ServletServerHttpRequest;
    import org.springframework.util.Assert;
    import org.springframework.util.LinkedMultiValueMap;
    import org.springframework.util.MultiValueMap;
    import org.springframework.web.filter.OncePerRequestFilter;
    
    /**
     * http 请求 form传参 的支持 拷贝并抄袭 org.springframework.web.filter.HttpPutFormContentFilter 为了增加对delete body传参请求的支持
     *
     * @author Rossen Stoyanchev
     * @since 3.1
     */
    public class HttpFormContentFilter extends OncePerRequestFilter {
    
        private FormHttpMessageConverter formConverter = new AllEncompassingFormHttpMessageConverter();
    
    
        /**
         * Set the converter to use for parsing form content.
         * <p>By default this is an instnace of {@link AllEncompassingFormHttpMessageConverter}.
         */
        public void setFormConverter(FormHttpMessageConverter converter) {
            Assert.notNull(converter, "FormHttpMessageConverter is required.");
            this.formConverter = converter;
        }
    
        public FormHttpMessageConverter getFormConverter() {
            return this.formConverter;
        }
    
        /**
         * The default character set to use for reading form data. This is a shortcut for:<br> {@code getFormConverter.setCharset(charset)}.
         */
        public void setCharset(Charset charset) {
            this.formConverter.setCharset(charset);
        }
    
    
        @Override
        protected void doFilterInternal(final HttpServletRequest request, HttpServletResponse response,
            FilterChain filterChain) throws ServletException, IOException {
    
            if (("PUT".equals(request.getMethod())
                || "PATCH".equals(request.getMethod())
                // 增加对DELETE 的支持
                || "DELETE".equals(request.getMethod())
            )
                && isFormContentType(request)) {
                HttpInputMessage inputMessage = new ServletServerHttpRequest(request) {
                    @Override
                    public InputStream getBody() throws IOException {
                        return request.getInputStream();
                    }
                };
                MultiValueMap<String, String> formParameters = this.formConverter.read(null, inputMessage);
                if (!formParameters.isEmpty()) {
                    HttpServletRequest wrapper = new HttpPutFormContentRequestWrapper(request, formParameters);
                    filterChain.doFilter(wrapper, response);
                    return;
                }
            }
    
            filterChain.doFilter(request, response);
        }
    
        private boolean isFormContentType(HttpServletRequest request) {
            String contentType = request.getContentType();
            if (contentType != null) {
                try {
                    MediaType mediaType = MediaType.parseMediaType(contentType);
                    return (MediaType.APPLICATION_FORM_URLENCODED.includes(mediaType));
                } catch (IllegalArgumentException ex) {
                    return false;
                }
            } else {
                return false;
            }
        }
    
    
        private static class HttpPutFormContentRequestWrapper extends HttpServletRequestWrapper {
    
            private MultiValueMap<String, String> formParameters;
    
            public HttpPutFormContentRequestWrapper(HttpServletRequest request, MultiValueMap<String, String> parameters) {
                super(request);
                this.formParameters = (parameters != null ? parameters : new LinkedMultiValueMap<String, String>());
            }
    
            @Override
            public String getParameter(String name) {
                String queryStringValue = super.getParameter(name);
                String formValue = this.formParameters.getFirst(name);
                return (queryStringValue != null ? queryStringValue : formValue);
            }
    
            @Override
            public Map<String, String[]> getParameterMap() {
                Map<String, String[]> result = new LinkedHashMap<String, String[]>();
                Enumeration<String> names = getParameterNames();
                while (names.hasMoreElements()) {
                    String name = names.nextElement();
                    result.put(name, getParameterValues(name));
                }
                return result;
            }
    
            @Override
            public Enumeration<String> getParameterNames() {
                Set<String> names = new LinkedHashSet<String>();
                names.addAll(Collections.list(super.getParameterNames()));
                names.addAll(this.formParameters.keySet());
                return Collections.enumeration(names);
            }
    
            @Override
            public String[] getParameterValues(String name) {
                String[] parameterValues = super.getParameterValues(name);
                List<String> formParam = this.formParameters.get(name);
                if (formParam == null) {
                    return parameterValues;
                }
                if (parameterValues == null || getQueryString() == null) {
                    return formParam.toArray(new String[formParam.size()]);
                } else {
                    List<String> result = new ArrayList<String>(parameterValues.length + formParam.size());
                    result.addAll(Arrays.asList(parameterValues));
                    result.addAll(formParam);
                    return result.toArray(new String[result.size()]);
                }
            }
        }
    
    }
    
    

    相关文章

      网友评论

          本文标题:API-Server构建指南(1)-请求格式篇

          本文链接:https://www.haomeiwen.com/subject/umndgctx.html