web-dev-qa-db-ja.com

Springは@ResponseBody JSON形式を設定します

Spring 3の@Controllerにこの注釈付きメソッドがあると想像してください

@RequestMapping("")
public @ResponseBody MyObject index(@RequestBody OtherObject obj) {
    MyObject result = ...;
    return result;
}

しかし、私がやっているように、出力json形式を設定する必要があります：

ObjectMapper om = new ObjectMapper();
om.configure(JsonGenerator.Feature.QUOTE_FIELD_NAMES, true);
om.getSerializationConfig()
        .setSerializationInclusion(JsonSerialize.Inclusion.NON_DEFAULT);
om.getSerializationConfig()
        .set(SerializationConfig.Feature.INDENT_OUTPUT, false);

この動作を設定する方法はありますか？

関連する質問をいくつか見つけましたが、特定のケースにそれらを適応させる方法がわかりません。

  1. springbodyとresponsebodyのプレフィックス
  2. Spring MVCで応答コンテンツタイプを設定するユーザー（@ResponseBody）

ありがとうございました ！

javaspringspring-mvcjackson
39
Guido

AngerClown 私を指した 正しい方向に。

誰かがそれを便利だと思ったときのために、これが私がついにやったことです。

<bean
    class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
    <property name="messageConverters">
        <list>
            <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
                <property name="objectMapper" ref="jacksonObjectMapper" />
            </bean>
        </list>
    </property>
</bean>

<!-- jackson configuration : https://stackoverflow.com/questions/3661769 -->
<bean id="jacksonObjectMapper" class="org.codehaus.jackson.map.ObjectMapper" />
<bean id="jacksonSerializationConfig" class="org.codehaus.jackson.map.SerializationConfig"
    factory-bean="jacksonObjectMapper" factory-method="getSerializationConfig" />
<bean
    class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
    <property name="targetObject" ref="jacksonSerializationConfig" />
    <property name="targetMethod" value="setSerializationInclusion" />
    <property name="arguments">
        <list>
            <value type="org.codehaus.jackson.map.annotate.JsonSerialize.Inclusion">NON_DEFAULT</value>
        </list>
    </property>
</bean>

私はまだ次のような他のプロパティを設定する方法を理解する必要があります：

om.configure(JsonGenerator.Feature.QUOTE_FIELD_NAMES, true);
15
Guido

JavaベースのSpring設定を使用しているユーザー向け：

@Configuration
@ComponentScan(basePackages = "com.domain.sample")
@EnableWebMvc
public class SpringConfig extends WebMvcConfigurerAdapter {
....

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        final MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        final ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
        converter.setObjectMapper(objectMapper);
        converters.add(converter);
        super.configureMessageConverters(converters);
    }

....

}

MappingJackson2HttpMessageConverterを使用しています。これは、fasterxmlからのものです。

<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-databind</artifactId>
  <version>2.3.1</version>
</dependency>

Codehaus-jacksonマッパーを使用する場合は、代わりにこれを使用しますMappingJacksonHttpMessageConverter

 <dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-mapper-asl</artifactId>
    <version>${codehaus.jackson.version}</version>
 </dependency>
31
Õzbek

ジャクソンマッパーを「キリストのためにnull値をシリアル化しないでください!!!」に設定するという非常に似た問題を解決する必要がありました。

派手なmvc：annotation-drivenタグを残したくなかったので、mvc：annotation-drivenを削除せずに、本当に派手ではないContentNegotiatingViewResolverを追加せずにJacksonのObjectMapperを構成する方法を見つけました。

美しいことは、Java自分でコードを書く必要がないことです！

そして、ここにXML構成があります（ジャクソンクラスの異なる名前空間と混同しないでください。単に新しいJakson 2.xライブラリを使用しました...ジャクソン1.xライブラリでも同じように動作します）。

<mvc:annotation-driven>
    <mvc:message-converters register-defaults="true">
        <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
            <property name="objectMapper">
                <bean class="com.fasterxml.jackson.databind.ObjectMapper">
                    <property name="serializationInclusion">
                        <value type="com.fasterxml.jackson.annotation.JsonInclude.Include">NON_NULL</value>
                    </property>
                </bean>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>
28
tkuty

Springバージョン4.1.3以降の場合

Jamaのソリューションを試しましたが、生成されたメインのHTMLページを含むContent-type 'application/json'ですべての応答が返されました。

configureMessageConverters(...)をオーバーライドすると、スプリングがデフォルトのコンバーターを設定できなくなります。 Spring 4.1.3では、extendMessageConverters(...)をオーバーライドすることにより、既に構成されたコンバーターを変更できます。

_@Configuration
public class ConverterConfig extends WebMvcConfigurerAdapter {
    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        for (HttpMessageConverter<?> converter : converters) {
            if (converter instanceof AbstractJackson2HttpMessageConverter) {
                AbstractJackson2HttpMessageConverter c = (AbstractJackson2HttpMessageConverter) converter;
                ObjectMapper objectMapper = c.getObjectMapper();
                objectMapper.setSerializationInclusion(Include.NON_NULL);
            }
        }

        super.extendMessageConverters(converters);
    }
}
_

org.springframework..WebMvcConfigurationSupport#getMessageConverters()を参照してください

org.springframework..WebMvcConfigurationSupport#addDefaultHttpMessageConverters(...)を参照してください

10
Melv

Spring3.2では、新しいソリューションが導入されます： http://static.springsource.org/spring/docs/3.2.0.BUILD-SNAPSHOT/api/org/springframework/http/converter/json/Jackson2ObjectMapperFactoryBean .html 、以下は私の例です：

 <mvc:annotation-driven>
   ​<mvc:message-converters>
     ​​<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
       ​​​<property name="objectMapper">
         ​​​​<bean
 class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
           ​​​​​<property name="featuresToEnable">
             ​​​​​​<array>
               ​​​​​​​<util:constant static-field="com.fasterxml.jackson.core.JsonParser.Feature.ALLOW_SINGLE_QUOTES" />
             ​​​​​​</array>
           ​​​​​</property>
         ​​​​</bean>
       ​​​</property>
     ​​</bean>
   ​</mvc:message-converters>
 </mvc:annotation-driven>
10
Tody.Lu

ObjectMapper（簡易バージョン）をインスタンス化する独自のFactoryBeanを作成しました。

 public class ObjectMapperFactoryBean implements FactoryBean<ObjectMapper>{

        @Override
        public ObjectMapper getObject() throws Exception {
                ObjectMapper mapper = new ObjectMapper();
                mapper.getSerializationConfig().setSerializationInclusion(JsonSerialize.Inclusion.NON_NULL);
                return mapper;
        }

        @Override
        public Class<?> getObjectType() {
                return ObjectMapper.class;
        }

        @Override
        public boolean isSingleton() {
                return true;
        }

}

そして、スプリング構成での使用：

<bean
    class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
    <property name="messageConverters">
        <list>
            <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
                <property name="objectMapper" ref="jacksonObjectMapper" />
            </bean>
        </list>
    </property>
</bean>
4
oehmiche

質問には答えませんが、これはGoogleの上位の結果です。

誰かがここに来て、Spring 4でそれをやりたい場合（私に起こったように）、あなたはアノテーションを使用することができます

@JsonInclude(Include.NON_NULL)

返されるクラスで。

4
Mário Fernandes

Rick Hightowerのアプローチをご覧ください。彼のアプローチは、ObjectMapperをシングルトンとして構成することを避け、各リクエストメソッドごとに異なる方法で同じオブジェクトのJSON応答をフィルター処理できるようにします。

http://www.jroller.com/RickHigh/entry/filtering_json_feeds_from_spring

3
Greg Sheremeta

Spring xmlファイルでObjectMapperをBeanとして構成できます。 ObjectMapperへの参照を保持しているのは、MappingJacksonJsonViewクラスです。次に、ビューをViewResolverにアタッチする必要があります。

このような何かが動作するはずです：

<bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
      <property name="mediaTypes">
      <map>
        <entry key="json" value="application/json" />
        <entry key="html" value="text/html" />
      </map>
    </property>
    <property name="viewResolvers">
      <list>
        <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
          <property name="prefix" value="/WEB-INF/jsp/" />
          <property name="suffix" value=".jsp" />
        </bean>
      </list>
    </property>
    <property name="defaultViews">
      <list>
        <bean class="org.springframework.web.servlet.view.json.MappingJacksonJsonView">
          <property name="prefixJson" value="false" />
          <property name="objectMapper" value="customObjectMapper" />
        </bean>
      </list>
    </property>
  </bean>

customObjectMapperは、xmlファイルの別の場所で定義されています。 Enums Jacksonが定義したSpringプロパティ値を直接設定できることに注意してください。 この質問 を参照してください。

また、ContentNegotiatingViewResolverはおそらく必要ではなく、既存のプロジェクトで使用しているコードだけです。

2
AngerClown

以下を実行できます（ジャクソンバージョン<2）：

カスタムマッパークラス：

import org.codehaus.jackson.JsonGenerator;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.SerializationConfig;
import org.codehaus.jackson.map.annotate.JsonSerialize;

public class CustomObjectMapper extends ObjectMapper {
    public CustomObjectMapper() {
        super.configure(JsonGenerator.Feature.QUOTE_FIELD_NAMES, true);
        super.getSerializationConfig()
                .setSerializationInclusion(JsonSerialize.Inclusion.NON_DEFAULT);
        super.getSerializationConfig()
                .set(SerializationConfig.Feature.INDENT_OUTPUT, false);
    }
}

Spring config：

<mvc:annotation-driven>
    <mvc:message-converters register-defaults="false">
        <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
            <property name="objectMapper">
                <bean class="package.CustomObjectMapper"/>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>
2
I V

はい。ただし、たとえばミックスインを使用し始めた場合、ObjectMapperをシングルトンとして使用することはできません。これは、構成をグローバルに適用するためです。したがって、同じObjectMapperインスタンスにmixinクラスを追加または設定しますか？

1
serge