web-dev-qa-db-ja.com

Jsonのことを行う@ResponseBodyを持つカスタムHttpMessageConverter

私はジャクソンが好きではありません。

Ajaxを使用したいのですが、Google Gsonを使用します。

そこで、@ ResponseBodyアノテーションで使用するために独自のHttpMessageConverterを実装する方法を見つけようとしています。誰かが私が行くべき方法を私に見せるために時間をかけることができますか？どの構成をオンにする必要がありますか？また、これを行うことができ、それでも<mvc：annotation-driven />を使用できるかどうか疑問に思っていますか？

前もって感謝します。

すでに3日前にSpring Community Forunsで答えを出さずに質問しました。 私の質問へのSpring Community Forumsリンク

私もウェブで徹底的に検索し、このテーマで何か面白いものを見つけましたが、彼らはそれをSpring 3.1に入れることを考えているようで、私はまだspring 3.0.5を使用しています： Jira's Spring Improvement ask

さて...今、私はこれを行う方法を見つけるためにSpringコードをデバッグしようとしていますが、ここで言ったようないくつかの問題があります： Spring Framework Build Error

これを行う別の方法があり、私がそれを逃している場合は、お知らせください。

jsonspringspring-mvcgson
31
Iogui

ええと...答えを見つけるのはとても難しく、不完全な情報への多くの手がかりに従わなければならなかったので、ここに完全な答えを投稿するのが良いと思います。そのため、次を検索する方が簡単になります。

最初に、カスタムHttpMessageConverterを実装する必要がありました。


package net.iogui.web.spring.converter;

import Java.io.BufferedReader;
import Java.io.IOException;
import Java.io.InputStream;
import Java.io.InputStreamReader;
import Java.io.Reader;
import Java.io.StringWriter;
import Java.io.Writer;
import Java.nio.charset.Charset;

import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.AbstractHttpMessageConverter;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;

import com.google.gson.Gson;
import com.google.gson.JsonSyntaxException;

public class GsonHttpMessageConverter extends AbstractHttpMessageConverter<Object> {

    private Gson gson = new Gson();

    public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");

    public GsonHttpMessageConverter(){
        super(new MediaType("application", "json", DEFAULT_CHARSET));
    }

    @Override
    protected Object readInternal(Class<? extends Object> clazz,
                                  HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {

        try{
            return gson.fromJson(convertStreamToString(inputMessage.getBody()), clazz);
        }catch(JsonSyntaxException e){
            throw new HttpMessageNotReadableException("Could not read JSON: " + e.getMessage(), e);
        }

    }

    @Override
    protected boolean supports(Class<?> clazz) {
        return true;
    }

    @Override
    protected void writeInternal(Object t, 
                                 HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {

        //TODO: adapt this to be able to receive a list of json objects too

        String json = gson.toJson(t);

        outputMessage.getBody().write(json.getBytes());
    }

    //TODO: move this to a more appropriated utils class
    public String convertStreamToString(InputStream is) throws IOException {
        /*
         * To convert the InputStream to String we use the Reader.read(char[]
         * buffer) method. We iterate until the Reader return -1 which means
         * there's no more data to read. We use the StringWriter class to
         * produce the string.
         */
        if (is != null) {
            Writer writer = new StringWriter();

            char[] buffer = new char[1024];
            try {
                Reader reader = new BufferedReader(new InputStreamReader(is, "UTF-8"));
                int n;
                while ((n = reader.read(buffer)) != -1) {
                    writer.write(buffer, 0, n);
                }
            } finally {
                is.close();
            }
            return writer.toString();
        } else {
            return "";
        }
    }

}

それから、annnotaion-drivenタグを取り除き、spring-mvc構成ファイルですべて自分の手で構成する必要がありました。


<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd">

    <!-- Configures the @Controller programming model -->

    <!-- To use just with a JSR-303 provider in the classpath 
    <bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean" />
    -->

    <bean id="conversionService" class="org.springframework.format.support.FormattingConversionServiceFactoryBean" />

    <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
        <property name="webBindingInitializer">
            <bean class="net.iogui.web.spring.util.CommonWebBindingInitializer" />
        </property>
        <property name="messageConverters">
            <list>
                <bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter" />
                <bean class="org.springframework.http.converter.StringHttpMessageConverter" />
                <bean class="org.springframework.http.converter.ResourceHttpMessageConverter" />
                <bean class="net.iogui.web.spring.converter.GsonHttpMessageConverter" />
                <bean class="org.springframework.http.converter.xml.SourceHttpMessageConverter" />
                <bean class="org.springframework.http.converter.xml.XmlAwareFormHttpMessageConverter" />
                <!-- bean class="org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter" /-->
            </list>
        </property>
    </bean>
    <bean id="handlerMapping" class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping" />


    <context:component-scan base-package="net.iogui.teste.web.controller"/>

    <!-- Forwards requests to the "/" resource to the "login" view -->
    <mvc:view-controller path="/" view-name="home"/>

    <!-- Handles HTTP GET requests for /resources/** by efficiently serving up static resources in the ${webappRoot}/resources/ directory -->
    <mvc:resources mapping="/resources/**" location="/resources/" />

    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
        <property name="prefix" value="/WEB-INF/view/"/>
        <property name="suffix" value=".jsp"/>
    </bean>

</beans>

FormaterおよびValidatorを機能させるには、カスタムwebBindingInitializerもビルドするには：


package net.iogui.web.spring.util;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.convert.ConversionService;
import org.springframework.validation.Validator;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.support.WebBindingInitializer;
import org.springframework.web.context.request.WebRequest;

public class CommonWebBindingInitializer implements WebBindingInitializer {

    @Autowired(required=false)
    private Validator validator;

    @Autowired
    private ConversionService conversionService;

    @Override
    public void initBinder(WebDataBinder binder, WebRequest request) {
        binder.setValidator(validator);
        binder.setConversionService(conversionService);
    }

}

興味深いのは、annotaion-drivenタグなしで構成を機能させるために、手動でAnnotationMethodHandlerAdapterおよびDefaultAnnotationHandlerMapping。そして、AnnotationMethodHandlerAdapterでフォーマットと検証を処理できるようにするには、validator、conversionServiceおよびカスタムwebBindingInitializer。

これが私のほかの誰かに役立つことを願っています。

私の必死の検索では、 this @Bozhoの投稿は非常に役に立ちました。彼の答えが @ Bozho post に私を連れて行ってくれたので、@ GaryFにも感謝しています。 Spring 3.1でこれを行おうとしているあなたには、@ Robby Pondの回答を参照してください。はるかに簡単ですよね。

37
Iogui

AbstractHttpMessageConverter を拡張するGsonMessageConverterを作成し、m vc-message-converters タグを使用してメッセージコンバーターを登録する必要があります。このタグにより、コンバーターがJacksonのものよりも優先されます。

16
Robby Pond

Xmlをいじらずにメッセージコンバーターを追加する場合は、簡単な例を次に示します。

@Autowired
private RequestMappingHandlerAdapter adapter;

@PostConstruct
public void initStuff() {
    List<HttpMessageConverter<?>> messageConverters = adapter.getMessageConverters();
    BufferedImageHttpMessageConverter imageConverter = new BufferedImageHttpMessageConverter();;
    messageConverters.add(0,imageConverter);
}
5
Erik Martino

ジャクソンを使用するには、他のグループ（同じ会社）のコードを変更する必要がある状況がありました。好きじゃなかった。そこで、必要に応じてGsonを使用してTypeAdaptersを登録することにしました。

コンバーターを接続し、spring-test（spring-mvc-testであった）を使用していくつかの統合テストを作成しました。どのようなバリエーションを試しても（mvc：annotation-driven OR beanの手動定義）を使用します。いずれも機能しませんでした。

Answer> MockMvcBuildersのstandaloneSetupメソッドは、メッセージコンバーターをデフォルトバージョンに「ハード」コーディングし、上記のすべての変更を無視したことがわかりました。これがうまくいったものです：

@Autowired
private RequestMappingHandlerAdapter adapter;

public void someOperation() {
  StandaloneMockMvcBuilder smmb = MockMvcBuilders.standaloneSetup(controllerToTest);
  List<HttpMessageConverter<?>> converters = adapter.getMessageConverters();
  HttpMessageConverter<?> ary[] = new HttpMessageConverter[converters.size()];
  smmb.setMessageConverters(conveters.toArray(ary));
  mockMvc = smmb.build();
   .
   .
}

これが誰かを助けることを願っています、最終的にはアノテーション駆動型のAndroidのコンバーターを再利用しました

5
ravinukala

GsonHttpMessageConverter が最近Spring（4.1）に追加されたことに注意してください。

4
maxb3k

または JiraのSpring Improvement ask で述べたように、HttpMessageConvertorをAnnotationMethodHandlerAdapterに追加するBeanPostProcessorを記述します

3
NevinJ

Robby Pondは基本的に正しいですが、mvc：message-convertersタグを使用するという彼の提案では、3.1を使用する必要があることに注意してください。 3.1は現在マイルストーンリリース（M1）に過ぎないため、コンバータを作成した後、この方法で登録することをお勧めします。

<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
    <property name="messageConverters">
      <util:list id="beanList">
        <ref bean="someMessageConverter"/>
        <ref bean="someOtherMessageConverter"/>
      </util:list>
    </property>
</bean>
3
GaryF

これを行うには、WebConfigファイルをJava File。コンバータを最後に追加しますどうやらリストを完全に制御でき、リストのどこにでも追加できます。

@Configuration
@EnableWebMvc
@ComponentScan(basePackageClasses={WebConfig.class})
public class WebConfig extends WebMvcConfigurerAdapter {
    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
      converters.add(new GsonHttpMessageConverter());
   }
}

package net.iogui.web.spring.converter;

import Java.io.BufferedReader;
import Java.io.IOException;
import Java.io.InputStream;
import Java.io.InputStreamReader;
import Java.io.Reader;
import Java.io.StringWriter;
import Java.io.Writer;
import Java.nio.charset.Charset;

import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.AbstractHttpMessageConverter;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;

import com.google.gson.Gson;
import com.google.gson.JsonSyntaxException;

public class GsonHttpMessageConverter extends AbstractHttpMessageConverter<Object> {

private Gson gson = new Gson();

public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");

public GsonHttpMessageConverter(){
    super(new MediaType("application", "json", DEFAULT_CHARSET));
}

@Override
protected Object readInternal(Class<? extends Object> clazz,
                              HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {

    try{
        return gson.fromJson(convertStreamToString(inputMessage.getBody()), clazz);
    }catch(JsonSyntaxException e){
        throw new HttpMessageNotReadableException("Could not read JSON: " + e.getMessage(), e);
    }

}

@Override
protected boolean supports(Class<?> clazz) {
    return true;
}

@Override
protected void writeInternal(Object t, 
                             HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {

    //TODO: adapt this to be able to receive a list of json objects too

    String json = gson.toJson(t);

    outputMessage.getBody().write(json.getBytes());
}

//TODO: move this to a more appropriated utils class
public String convertStreamToString(InputStream is) throws IOException {
    /*
     * To convert the InputStream to String we use the Reader.read(char[]
     * buffer) method. We iterate until the Reader return -1 which means
     * there's no more data to read. We use the StringWriter class to
     * produce the string.
     */
    if (is != null) {
        Writer writer = new StringWriter();

        char[] buffer = new char[1024];
        try {
            Reader reader = new BufferedReader(new InputStreamReader(is, "UTF-8"));
            int n;
            while ((n = reader.read(buffer)) != -1) {
                writer.write(buffer, 0, n);
            }
        } finally {
            is.close();
        }
        return writer.toString();
    } else {
        return "";
    }
}
0
PRABHU P.S