【小家Spring】Spring MVC容器的web九大组件之---HandlerAdapter源码详解---HttpMessageConverter 消息转换器详解(上)

<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.StringHttpMessageConverter">
            <property name="supportedMediaTypes">
                <list>
                    <value>text/plain;charset=UTF-8</value>
                    <value>text/html;charset=UTF-8</value>
                </list>
             </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

public interface HttpMessage {
  // Return the headers of this message
  HttpHeaders getHeaders();
}

public interface HttpInputMessage extends HttpMessage {
  InputStream getBody() throws IOException;
}
public interface HttpOutputMessage extends HttpMessage {
  OutputStream getBody() throws IOException;
}

public interface HttpRequest extends HttpMessage {
  @Nullable
  default HttpMethod getMethod() {
    // 可议根据String类型的值  返回一个枚举
    return HttpMethod.resolve(getMethodValue());
  }
  String getMethodValue();
  // 可以从请求消息里  拿到URL
  URI getURI();
}

// @since 3.0  Spring3.0后推出的   是个泛型接口
// 策略接口，指定可以从HTTP请求和响应转换为HTTP请求和响应的转换器
public interface HttpMessageConverter<T> {
  // 指定转换器可以读取的对象类型，即转换器可将请求信息转换为clazz类型的对象
  // 同时支持指定的MIME类型(text/html、application/json等)
  boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);
  // 指定转换器可以将clazz类型的对象写到响应流当中，响应流支持的媒体类型在mediaType中定义
  boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);
  // 返回当前转换器支持的媒体类型~~
  List<MediaType> getSupportedMediaTypes();
  // 将请求信息转换为T类型的对象 流对象为：HttpInputMessage
  T read(Class<? extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException;
  // 将T类型的对象写到响应流当中，同事指定响应的媒体类型为contentType 输出流为：HttpOutputMessage 
  void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException;
}

// @since 3.0
public class FormHttpMessageConverter implements HttpMessageConverter<MultiValueMap<String, ?>> {
  // 默认UTF-8编码  MediaType为：application/x-www-form-urlencoded
  public static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
  private static final MediaType DEFAULT_FORM_DATA_MEDIA_TYPE = new MediaType(MediaType.APPLICATION_FORM_URLENCODED, DEFAULT_CHARSET);
  // 缓存下它所支持的MediaType们
  private List<MediaType> supportedMediaTypes = new ArrayList<>();
  // 用于二进制内容的消息转换器们~~~ 毕竟此转换器还支持`multipart/form-data`这种  可以进行文件下载~~~~~
  private List<HttpMessageConverter<?>> partConverters = new ArrayList<>();
  private Charset charset = DEFAULT_CHARSET;
  @Nullable
  private Charset multipartCharset;
  // 唯一的一个构造函数~
  public FormHttpMessageConverter() {
    // 默认支持处理两种MediaType：application/x-www-form-urlencoded和multipart/form-data
    this.supportedMediaTypes.add(MediaType.APPLICATION_FORM_URLENCODED);
    this.supportedMediaTypes.add(MediaType.MULTIPART_FORM_DATA);
    StringHttpMessageConverter stringHttpMessageConverter = new StringHttpMessageConverter();
    stringHttpMessageConverter.setWriteAcceptCharset(false);  // see SPR-7316
    // === 它自己不仅是个转换器，还内置了这三个转换器 至于他们具体处理那种消息，请看下面 都有详细说明 ==
    // 注意：这些消息转换器都是去支持part的，支持文件下载
    this.partConverters.add(new ByteArrayHttpMessageConverter());
    this.partConverters.add(stringHttpMessageConverter);
    this.partConverters.add(new ResourceHttpMessageConverter());
    // 这是为partConverters设置默认的编码~~~
    applyDefaultCharset();
  }
  // 省略属性额get/set方法
  // 从这可以发现，只有Handler的入参类型是是MultiValueMap它才会去处理~~~~
  @Override
  public boolean canRead(Class<?> clazz, @Nullable MediaType mediaType) {
    if (!MultiValueMap.class.isAssignableFrom(clazz)) {
      return false;
    }
    // 若没指定MedieType  会认为是可读的~
    if (mediaType == null) {
      return true;
    }
    // 显然，只有我们Supported的MediaType才会是true（当然multipart/form-data例外，此处是不可读的）
    for (MediaType supportedMediaType : getSupportedMediaTypes()) {
      // We can't read multipart....
      if (!supportedMediaType.equals(MediaType.MULTIPART_FORM_DATA) && supportedMediaType.includes(mediaType)) {
        return true;
      }
    }
    return false;
  }
  // 注意和canRead的区别，有点对着干的意思~~~
  @Override
  public boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType) {
    if (!MultiValueMap.class.isAssignableFrom(clazz)) {
      return false;
    }
    // 如果是ALL 说明支持所有的类型  那就恒返回true  当然null也是的
    if (mediaType == null || MediaType.ALL.equals(mediaType)) {
      return true;
    }
    for (MediaType supportedMediaType : getSupportedMediaTypes()) {
      // isCompatibleWith是否是兼容的
      if (supportedMediaType.isCompatibleWith(mediaType)) {
        return true;
      }
    }
    return false;
  }
  // 把输入信息读进来，成为一个 MultiValueMap<String, String>
  // 注意：此处发现class这个变量并没有使用~
  @Override
  public MultiValueMap<String, String> read(@Nullable Class<? extends MultiValueMap<String, ?>> clazz,
      HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {
    // 拿到请求的ContentType请求头~~~~
    MediaType contentType = inputMessage.getHeaders().getContentType();
    // 这里面 编码放在contentType里面  若没有指定  走默认的编码
    // 类似这种形式就是我们自己指定了编码：application/json;charset=UTF-8
    Charset charset = (contentType != null && contentType.getCharset() != null ? contentType.getCharset() : this.charset);
    // 把body的内容读成字符串~
    String body = StreamUtils.copyToString(inputMessage.getBody(), charset);
    // 用"&"分隔   因为此处body一般都是hello=world&fang=shi这样传进来的
    String[] pairs = StringUtils.tokenizeToStringArray(body, "&");
    MultiValueMap<String, String> result = new LinkedMultiValueMap<>(pairs.length);
    // 这个就不说了，就是把键值对保存在map里面。注意：此处为何用多值Map呢？因为一个key可能是会有多个value的
    for (String pair : pairs) {
      int idx = pair.indexOf('=');
      if (idx == -1) {
        result.add(URLDecoder.decode(pair, charset.name()), null);
      }
      else {
        String name = URLDecoder.decode(pair.substring(0, idx), charset.name());
        String value = URLDecoder.decode(pair.substring(idx + 1), charset.name());
        result.add(name, value);
      }
    }
    return result;
  }
}