Spring HttpMessageConverterの役割と置換解析

この記事ではSpring HttpMessageConverterの機能と置換解析を中心に紹介します。

Spring を使用した開発者は、Json への入力と Json への出力を直接解析できる @RequestBody および @ResponseBody アノテーションを使用していると思いますが、HTTP リクエストと応答はテキストベースであるため、ブラウザーとサーバーはオリジナルのメッセージを交換します。テキストは通信に使用されますが、ここで HttpMessageConverter が実際に役割を果たします。

HttpMessageConverter

HTTP リクエストおよびレスポンスメッセージは実際には文字列です。リクエストメッセージが Java プログラムに送信されると、ServletInputStream ストリームにカプセル化されます。開発者はメッセージを読み取り、レスポンスメッセージは ServletOutputStream ストリームを通じて出力されます。

ストリームから読み取ることができるのは元の文字列メッセージのみであり、出力ストリームにも同じことが当てはまります。次に、メッセージが SpringMVC/SpringBoot に到着し、SpringMVC/SpringBoot から出力されるときに、文字列から Java オブジェクトへの変換の問題が発生します。SpringMVC/SpringBoot では、このプロセスは HttpMessageConverter を通じて解決されます。HttpMessageConverter インターフェイスのソースコード:

public interface HttpMessageConverter<T> {
    
    

  boolean canRead(Class<?> clazz, MediaType mediaType);

  boolean canWrite(Class<?> clazz, MediaType mediaType);

  List<MediaType> getSupportedMediaTypes();

  T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
      throws IOException, HttpMessageNotReadableException;

  void write(T t, MediaType contentType, HttpOutputMessage outputMessage)
      throws IOException, HttpMessageNotWritableException;
}

以下に例を示します。

@RequestMapping("/test")
@ResponseBody
public String test(@RequestBody String param) {
    
    
  return "param '" + param + "'";
}

リクエストがテストメソッドに入る前に、対応する HttpMessageConverter 実装クラスが @RequestBody アノテーションに基づいて選択され、リクエストパラメータが param 変数に解析されます。ここでのパラメータは String 型であるため、ここでは StringHttpMessageConverter クラスが使用されます。 canRead() メソッドは true を返し、read() メソッドはリクエストからリクエストパラメータを読み取り、test() メソッドの param 変数にバインドします。

同様に、テストメソッドの実行後、戻り値が @ResponseBody を識別するため、SpringMVC/SpringBoot は StringHttpMessageConverter の write() メソッドを使用して、結果を String 値として応答メッセージに書き込みます。現時点では本当です。

次の図を使用して、プロセス全体を簡単に説明します。

Spring の処理中に、リクエストメッセージとレスポンスメッセージはそれぞれリクエストメッセージ HttpInputMessage とレスポンスメッセージ HttpOutputMessage に抽象化されます。

リクエストを処理するとき、適切なメッセージコンバータはリクエストメッセージをメソッド内の仮パラメータオブジェクトにバインドします。ここで、同じオブジェクトが、json や xml などの複数の異なるメッセージ形式で表示される場合があります。リクエストへの対応も同様です。

Spring では、さまざまなメッセージフォームを処理するためのさまざまな HttpMessageConverter 実装クラスがあり、さまざまなメッセージ解析の実装については、さまざまな HttpMessageConverter 実装クラスにあります。

@ResponseBody のデフォルトの HttpMessageConverter を置き換えます

ここでは SpringBoot のデモンストレーション例が使用されています。SpringMVC/SpringBoot では、@RequestBody などのアノテーションはデフォルトで jackson を使用して json を解析します。次の例を参照してください。

@Controller
@RequestMapping("/user")
public class UserController {
    
    

  @RequestMapping("/testt")
  @ResponseBody
  public User testt() {
    
    
    User user = new User("name", 18);
    return user;
  }
}

public class User {
    
    

  private String username;

  private Integer age;
  
  private Integer phone;
  
  private String email;

  public User(String username, Integer age) {
    
    
  super();
  this.username = username;
  this.age = age;
  }
}

ブラウザーアクセス /user/testt は次を返します。

これは、jackson を使用して解析した結果です。次に、fastjson を使用してオブジェクトを解析することに変更しましょう。ここでは、デフォルトの HttpMessageConverter を置き換えます。これは、FastJsonHttpMessageConverter を使用して、Java オブジェクトと HttpInputMessage/HttpOutputMessage の間の変換を処理します。

まず、FastJsonHttpMessageConverter を追加して構成する新しい構成クラスを作成します。Spring 4.x では、特に Spring Boot に対して、Java 構成とアノテーションの使用、つまり XML ファイルの使用を推奨し始めています。

import com.alibaba.fastjson.serializer.SerializerFeature;
import com.alibaba.fastjson.support.config.FastJsonConfig;
import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
import org.springframework.boot.autoconfigure.web.HttpMessageConverters;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;

import java.nio.charset.Charset;

@Configuration
public class HttpMessageConverterConfig {
    
    

  //引入Fastjson解析json，不使用默认的jackson
  //必须在pom.xml引入fastjson的jar包，并且版必须大于1.2.10
  @Bean
  public HttpMessageConverters fastJsonHttpMessageConverters() {
    
    
    //1、定义一个convert转换消息的对象
    FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter();

    //2、添加fastjson的配置信息
    FastJsonConfig fastJsonConfig = new FastJsonConfig();

    SerializerFeature[] serializerFeatures = new SerializerFeature[]{
    
    
        //  输出key是包含双引号
//        SerializerFeature.QuoteFieldNames,
        //  是否输出为null的字段,若为null 则显示该字段
//        SerializerFeature.WriteMapNullValue,
        //  数值字段如果为null，则输出为0
        SerializerFeature.WriteNullNumberAsZero,
        //   List字段如果为null,输出为[],而非null
        SerializerFeature.WriteNullListAsEmpty,
        //  字符类型字段如果为null,输出为"",而非null
        SerializerFeature.WriteNullStringAsEmpty,
        //  Boolean字段如果为null,输出为false,而非null
        SerializerFeature.WriteNullBooleanAsFalse,
        //  Date的日期转换器
        SerializerFeature.WriteDateUseDateFormat,
        //  循环引用
        SerializerFeature.DisableCircularReferenceDetect,
    };

    fastJsonConfig.setSerializerFeatures(serializerFeatures);
    fastJsonConfig.setCharset(Charset.forName("UTF-8"));

    //3、在convert中添加配置信息
    fastConverter.setFastJsonConfig(fastJsonConfig);

    //4、将convert添加到converters中
    HttpMessageConverter<?> converter = fastConverter;

    return new HttpMessageConverters(converter);
  }
}

ここでは、文字列型の値が null の場合は "" が返され、数値型の値が null の場合は 0 が返されます。アプリケーションを再起動し、再度 /user/testt インターフェイスにアクセスして、次のように戻ります。

このときnullは""または0に変換されることがわかります。

Spring HttpMessageConverterの役割と置換解析

Spring HttpMessageConverterの役割と置換解析

おすすめ