spring-cloud-zuul文件上传中文名乱码解决过程

       由于项目中用到了zuul作为网关,所有的请求都要经过zuul转发,因此上传请求也被代理了。经过辛辛苦苦的敲代码,终于完成了功能开发,上传非中文名的文件一切都很完美,可是到了中文文件名时,文件服务器收到的请求里面中文名全部变成了 ‘?’ ,我也是有很多疑问了,同样的功能,咋就中文名称不行呢?难道这也有字符编码的问题?于是乎,开始网上找了,竟然发现都有同样的问题,不过zuul官方给出了解决方案,使用/zuul开头的请求可以避免中文名乱码以及支持大文件上传,于是乎,按照文档改了一波,没想到又有了新的问题,上传文件不能成功,服务器接收到的文件流总是不完整,经过断点调试,最终发现是某位同学挖的坑(自定义的可重复读过滤器中处理了所有的请求,应该放过上传文件的请求),填完后发现可以上传了,而且中文名也解决了,算是完成了整个功能。

      鉴于强迫症,为啥使用不带/zuul的请求上传就会有中文乱码呢,于是开始了跟踪定位。FormBodyWrapperFilter过滤器是zuul处理请求的第二个过滤器,主要功能就是将请求的流进行重新包装,主要逻辑是首先取contentData(从reqeust.getInputStream()来)数据,如果为空,则取request.getParts()数据,由于请求首先经过了dispatchServlet,因此只能从request.getParts()取数据,然后进行处理,具体处理的调用栈如图:

FormBodyWrapperFilter.FormBodyRequestWrapper类的getContentType()方法中调用了buildContentData(),也就是去获取contentData,上图的程序调用栈很清晰的反映了调用过程。FormBodyWrapperFilter中有个AllEncompassingFormHttpMessageConverter的对象作为convert的成员变量,而AllEncompassingFormHttpMessageConverter是FormHttpMessageConverter的子类,这个类的功能就是对请求form-data进行处理,而对于multipart/form-data请求处理时会用到FormHttpMessageConverter.MultipartHttpOutputMessage,是一个私有的静态类,也就是说无法对该类进行重写,该类中最终处理文件名的方法也就是调用栈图中的最后一个方法writeHeaders(),看下该方法的源码:

private void writeHeaders() throws IOException {
       if (!this.headersWritten) {
          for (Map.Entry<String, List<String>> entry : this.headers.entrySet()) {
               byte[] headerName = getAsciiBytes(entry.getKey());
               for (String headerValueString : entry.getValue()) {
                    byte[] headerValue = getAsciiBytes(headerValueString);
                    this.outputStream.write(headerName);
                    this.outputStream.write(':');
                    this.outputStream.write(' ');
                    this.outputStream.write(headerValue);
                    writeNewLine(this.outputStream);
               }
           }      
         writeNewLine(this.outputStream);
         this.headersWritten = true;
      }
}

private byte[] getAsciiBytes(String name) {
     try {
           return name.getBytes("US-ASCII");
         }catch (UnsupportedEncodingException ex) {
         // Should not happen - US-ASCII is always supported.
            throw new IllegalStateException(ex);
         }
}

可以看到在遍历headers时,对于head中值的处理使用了getAsciiBytes(String name)方法,该方法的实现就是取字符串的“US-ASCII”编码的字节数组,那么对于中文字符串的处理就会有乱码的问题了。这里就是使用zuul代理上传时为什么中文名会乱码的根本原因了,那么问题来了,这个问题要怎么解决呢?可以看到该类是私有的内部类,是无法重写的,按理说这个问题应该早都有人发现了吧,于是乎,将spring-web版本升级到5.0.6.RELEASE版本后,查看该类的源代码:

private void writeHeaders() throws IOException {
   if (!this.headersWritten) {
      for (Map.Entry<String, List<String>> entry : this.headers.entrySet()) {
           byte[] headerName = getBytes(entry.getKey());
           for (String headerValueString : entry.getValue()) {
               byte[] headerValue = getBytes(headerValueString);
               this.outputStream.write(headerName);
               this.outputStream.write(':');
               this.outputStream.write(' ');
               this.outputStream.write(headerValue);
               writeNewLine(this.outputStream);
            }
         }
       writeNewLine(this.outputStream);
       this.headersWritten = true;
   }
}

private byte[] getBytes(String name) {
    return name.getBytes(this.charset);
}

果然,源代码已经变了,从原来的getAsciiBytes(String name)变为了getBytes(String name),而getBytes(String  name)的实现会根据设定的字符编码来获取对应的字节数组,而这个字符编码是可以通过FormHttpMessageConverter.setCharset()方法来修改的,这样就不会有乱码的问题了。因此如果用zuul代理上传请求,且不能忽略中文名乱码时,要将spring-web版本升级到5.0.x

      至此,zuul代理上传请求,中文名乱码的问题算是解决了,虽然最终的解决方式很简单,只需要升级一下sping-web的版本,但是定位问题的过程还是比较有重要的,起码也熟悉了zuul处理请求的过程。

猜你喜欢

转载自blog.csdn.net/schzrj/article/details/81147656
今日推荐