Spring MVCからJSONとして送信している間、Javaオブジェクトのフィールドを動的に無視します


105

私はこのようなモデルクラスを持っています

@Entity
@Table(name = "user", catalog = "userdb")
@JsonIgnoreProperties(ignoreUnknown = true)
public class User implements java.io.Serializable {

    private Integer userId;
    private String userName;
    private String emailId;
    private String encryptedPwd;
    private String createdBy;
    private String updatedBy;

    @Id
    @GeneratedValue(strategy = IDENTITY)
    @Column(name = "UserId", unique = true, nullable = false)
    public Integer getUserId() {
        return this.userId;
    }

    public void setUserId(Integer userId) {
        this.userId = userId;
    }

    @Column(name = "UserName", length = 100)
    public String getUserName() {
        return this.userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    @Column(name = "EmailId", nullable = false, length = 45)
    public String getEmailId() {
        return this.emailId;
    }

    public void setEmailId(String emailId) {
        this.emailId = emailId;
    }

    @Column(name = "EncryptedPwd", length = 100)
    public String getEncryptedPwd() {
        return this.encryptedPwd;
    }

    public void setEncryptedPwd(String encryptedPwd) {
        this.encryptedPwd = encryptedPwd;
    }

    public void setCreatedBy(String createdBy) {
        this.createdBy = createdBy;
    }

    @Column(name = "UpdatedBy", length = 100)
    public String getUpdatedBy() {
        return this.updatedBy;
    }

    public void setUpdatedBy(String updatedBy) {
        this.updatedBy = updatedBy;
    }
}

Spring MVCコントローラーでは、DAOを使用してオブジェクトを取得できます。JSONオブジェクトとして返されます。

@Controller
public class UserController {

    @Autowired
    private UserService userService;

    @RequestMapping(value = "/getUser/{userId}", method = RequestMethod.GET)
    @ResponseBody
    public User getUser(@PathVariable Integer userId) throws Exception {

        User user = userService.get(userId);
        user.setCreatedBy(null);
        user.setUpdatedBy(null);
        return user;
    }
}

ビュー部分はAngularJSを使用して行われるため、このようにJSONを取得します

{
  "userId" :2,
  "userName" : "john",
  "emailId" : "john@gmail.com",
  "encryptedPwd" : "Co7Fwd1fXYk=",
  "createdBy" : null,
  "updatedBy" : null
}

暗号化されたパスワードを設定したくない場合は、そのフィールドもnullに設定します。

しかし、私はこのようにしたくないので、すべてのフィールドをクライアント側に送信したくありません。パスワード、updatedby、createdbyフィールドを送信したくない場合、結果のJSONは次のようになります

{
  "userId" :2,
  "userName" : "john",
  "emailId" : "john@gmail.com"
}

他のデータベーステーブルからのクライアントに送信したくないフィールドのリスト。そのため、ログインしているユーザーに応じて変更されます。どうすればよいですか?

あなたが私の質問を受けたことを願っています。


この答えについてどう思いますか?stackoverflow.com/a/30559076/3488143
Iryna

この情報が役立つ場合があります。stackoverflow.com/questions/12505141/…
Musa

回答:


142

@JsonIgnoreProperties("fieldname")注釈をPOJOに追加します。

または@JsonIgnore、JSONを逆シリアル化するときに無視するフィールドの名前の前に使用できます。例:

@JsonIgnore
@JsonProperty(value = "user_password")
public String getUserPassword() {
    return userPassword;
}

GitHubの例


63
動的にできますか?POJOにありませんか?Controllerクラスでそれを行うことはできますか?
iCode、2014

3
@iProgrammer:ここにあなたと同様ですが欲しい:stackoverflow.com/questions/8179986/...
user3145373ツ

3
@iProgrammer:ここでは非常に印象的な答えstackoverflow.com/questions/13764280/...
user3145373ツ

11
備考:@JsonIgnoreはありcom.fasterxml.jackson.annotation.JsonIgnoreませんorg.codehaus.jackson.annotate.JsonIgnore
xiaohuo 2016

5
これは、要求からの読み取り中と応答の送信中の両方を無視します。リクエストオブジェクトからそのプロパティを取得する必要があるため、応答の送信中のみ無視したいと思います。何か案は?
zulkarnain shah 2017

32

私はパーティーに少し遅れていることを知っていますが、実際には数ヶ月前にこれに遭遇しました。利用可能なソリューションはすべて私にとってあまり魅力的ではなかった(mixins?ugh!)ので、このプロセスをよりクリーンにする新しいライブラリを作成することになりました。誰かが試してみたい場合は、こちらから入手できます:https : //github.com/monitorjbl/spring-json-view

基本的な使い方は非常に簡単です。次のようJsonViewに、コントローラのメソッドでオブジェクトを使用します。

import com.monitorjbl.json.JsonView;
import static com.monitorjbl.json.Match.match;

@RequestMapping(method = RequestMethod.GET, value = "/myObject")
@ResponseBody
public void getMyObjects() {
    //get a list of the objects
    List<MyObject> list = myObjectService.list();

    //exclude expensive field
    JsonView.with(list).onClass(MyObject.class, match().exclude("contains"));
}

Spring以外でも使用できます。

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;
import static com.monitorjbl.json.Match.match;

ObjectMapper mapper = new ObjectMapper();
SimpleModule module = new SimpleModule();
module.addSerializer(JsonView.class, new JsonViewSerializer());
mapper.registerModule(module);

mapper.writeValueAsString(JsonView.with(list)
      .onClass(MyObject.class, match()
        .exclude("contains"))
      .onClass(MySmallObject.class, match()
        .exclude("id"));

5
ありがとうございました!これは私のために行く方法でした。異なる場所に同じオブジェクトを含むカスタムJSONビューが必要でしたが、@ JsonIgnoreが機能しませんでした。このライブラリーは、それを完全に簡単なものにしました。
ジェフ

2
あなたは私のコードをより簡潔にし、実装をより簡単にしました。ありがとう
anindis

@monitorjbl:これは少し軌道から外れています。私はjsonビューを使用して、目的を解決しました。しかし、java.util.Dateクラスのカスタムシリアライザーを登録できません(ランタイム/コンパイル時エラーなし)。文字列と同様に、カスタムシリアライザーを登録できました。
Ninad

17

動的にできますか?

ビュークラスを作成します。

public class View {
    static class Public { }
    static class ExtendedPublic extends Public { }
    static class Internal extends ExtendedPublic { }
}

モデルに注釈を付ける

@Document
public class User {

    @Id
    @JsonView(View.Public.class)
    private String id;

    @JsonView(View.Internal.class)
    private String email;

    @JsonView(View.Public.class)
    private String name;

    @JsonView(View.Public.class)
    private Instant createdAt = Instant.now();
    // getters/setters
}

コントローラでビュークラスを指定します

@RequestMapping("/user/{email}")
public class UserController {

    private final UserRepository userRepository;

    @Autowired
    UserController(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    @RequestMapping(method = RequestMethod.GET)
    @JsonView(View.Internal.class)
    public @ResponseBody Optional<User> get(@PathVariable String email) {
        return userRepository.findByEmail(email);
    }

}

データ例:

{"id":"5aa2496df863482dc4da2067","name":"test","createdAt":"2018-03-10T09:35:31.050353800Z"}

1
これは素晴らしくてミニマルな答えです!@Configurationアノテーションが付けられたコンポーネントからほんのわずかなフィールドをJSONとして返し、自動的に含まれるすべての内部フィールドをスキップしたかったのです。どうもありがとう!
stx

15

これを行うにはJsonProperty.Access.WRITE_ONLY、プロパティを宣言するときにアクセスを設定します。

@JsonProperty( value = "password", access = JsonProperty.Access.WRITE_ONLY)
@SerializedName("password")
private String password;

12

@JsonInclude(JsonInclude.Include.NON_NULL)クラスと@JsonIgnoreパスワードフィールドに(Jacksonにnull値をシリアル化させる)を追加します。

もちろん設定できます @JsonIgnore、この特定のケースだけでなく、常にそのときに無視したい場合は、createdByとupdatedByをます。

更新

POJO自体に注釈を追加したくない場合は、JacksonのMixin注釈が最適なオプションです。ドキュメントをチェックしてください


動的にできますか?POJOにありませんか?Controllerクラスでそれを行うことはできますか?
iCode 14

POJOに注釈を追加したくないということですか?
ジオおよび2014

時々私はすべてのフィールドをクライアント側に送りたいかもしれません。いくつかのフィールド。クライアント側に送信する必要があるフィールドは、コントローラークラスのデータベースからのみ取得しています。その後は、無視するフィールドを設定するだけです。
iCode、2014

12

はい。JSONレスポンスとしてシリアル化するフィールドと無視するフィールドを指定できます。これは、動的に無視するプロパティを実装するために必要なことです。

1)最初に、エンティティクラスとしてcom.fasterxml.jackson.annotation.JsonFilterから@JsonFilterを追加する必要があります。

import com.fasterxml.jackson.annotation.JsonFilter;

@JsonFilter("SomeBeanFilter")
public class SomeBean {

  private String field1;

  private String field2;

  private String field3;

  // getters/setters
}

2)次に、コントローラーで、MappingJacksonValueオブジェクトを作成してフィルターを設定し、最後にこのオブジェクトを返す必要があります。

import java.util.Arrays;
import java.util.List;

import org.springframework.http.converter.json.MappingJacksonValue;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import com.fasterxml.jackson.databind.ser.FilterProvider;
import com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter;
import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;

@RestController
public class FilteringController {

  // Here i want to ignore all properties except field1,field2.
  @GetMapping("/ignoreProperties")
  public MappingJacksonValue retrieveSomeBean() {
    SomeBean someBean = new SomeBean("value1", "value2", "value3");

    SimpleBeanPropertyFilter filter = SimpleBeanPropertyFilter.filterOutAllExcept("field1", "field2");

    FilterProvider filters = new SimpleFilterProvider().addFilter("SomeBeanFilter", filter);

    MappingJacksonValue mapping = new MappingJacksonValue(someBean);

    mapping.setFilters(filters);

    return mapping;
  }
}

これはあなたが応答で得るものです:

{
  field1:"value1",
  field2:"value2"
}

これの代わりに:

{
  field1:"value1",
  field2:"value2",
  field3:"value3"
}

ここでは、プロパティfield1とfield2を除いて、他のプロパティ(この場合はfield3)を無視して応答していることがわかります。

お役に立てれば。


1
@Shafqat男、どうもありがとう、あなたは私の救世主です。この種の機能を見つけるために、ほぼ1日を費やしました。このソリューションはとてもエレガントでシンプルですか?そして、要求されたとおりのことを行います。正解としてマークする必要があります。
Oleg Kuts 2018年

6

私があなたであり、そうしたいと思っていた場合は、コントローラーレイヤーでユーザーエンティティを使用しません。代わりに、UserDto(データ転送オブジェクト)を作成して使用して、ビジネス(サービス)レイヤーおよびコントローラーと通信します。Apache BeanUtils(copyPropertiesメソッド)を使用して、UserエンティティからUserDtoにデータをコピーできます。


3

実行時にフィールドを無視して応答を返すために使用できるJsonUtilを作成しました。

使用例:最初の引数は任意のPOJOクラス(学生)である必要があり、ignoreFieldsは応答で無視するコンマ区切りフィールドです。

 Student st = new Student();
 createJsonIgnoreFields(st,"firstname,age");

import java.util.logging.Logger;

import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.ObjectWriter;
import org.codehaus.jackson.map.ser.FilterProvider;
import org.codehaus.jackson.map.ser.impl.SimpleBeanPropertyFilter;
import org.codehaus.jackson.map.ser.impl.SimpleFilterProvider;

public class JsonUtil {

  public static String createJsonIgnoreFields(Object object, String ignoreFields) {
     try {
         ObjectMapper mapper = new ObjectMapper();
         mapper.getSerializationConfig().addMixInAnnotations(Object.class, JsonPropertyFilterMixIn.class);
         String[] ignoreFieldsArray = ignoreFields.split(",");
         FilterProvider filters = new SimpleFilterProvider()
             .addFilter("filter properties by field names",
                 SimpleBeanPropertyFilter.serializeAllExcept(ignoreFieldsArray));
         ObjectWriter writer = mapper.writer().withFilters(filters);
         return writer.writeValueAsString(object);
     } catch (Exception e) {
         //handle exception here
     }
     return "";
   }

   public static String createJson(Object object) {
        try {
         ObjectMapper mapper = new ObjectMapper();
         ObjectWriter writer = mapper.writer().withDefaultPrettyPrinter();
         return writer.writeValueAsString(object);
        }catch (Exception e) {
         //handle exception here
        }
        return "";
   }
 }    

2

@JsonIgnore@krygerが提案したような方法でのみ解決しました。したがって、ゲッターは次のようになります。

@JsonIgnore
public String getEncryptedPwd() {
    return this.encryptedPwd;
}

あなたは、設定することができます@JsonIgnore説明したように、フィールド、セッターやゲッターに当然のことながら、ここ

また、シリアル化側のみで暗号化パスワードを保護する場合(たとえば、ユーザーにログインする必要がある場合)は、この@JsonProperty注釈をフィールドに追加します。

@JsonProperty(access = Access.WRITE_ONLY)
private String encryptedPwd;

詳細はこちら


1

Springとjacksonで解決策を見つけました

最初にエンティティでフィルター名を指定します

@Entity
@Table(name = "SECTEUR")
@JsonFilter(ModelJsonFilters.SECTEUR_FILTER)
public class Secteur implements Serializable {

/** Serial UID */
private static final long serialVersionUID = 5697181222899184767L;

/**
 * Unique ID
 */
@Id
@JsonView(View.SecteurWithoutChildrens.class)
@Column(name = "id")
@GeneratedValue(strategy = GenerationType.IDENTITY)
private long id;

@JsonView(View.SecteurWithoutChildrens.class)
@Column(name = "code", nullable = false, length = 35)
private String code;

/**
 * Identifiant du secteur parent
 */
@JsonView(View.SecteurWithoutChildrens.class)
@Column(name = "id_parent")
private Long idParent;

@OneToMany(fetch = FetchType.LAZY)
@JoinColumn(name = "id_parent")
private List<Secteur> secteursEnfants = new ArrayList<>(0);

}

次に、Spring構成で使用されるデフォルトのFilterProviderで定数フィルター名クラスを確認できます

public class ModelJsonFilters {

public final static String SECTEUR_FILTER = "SecteurFilter";
public final static String APPLICATION_FILTER = "ApplicationFilter";
public final static String SERVICE_FILTER = "ServiceFilter";
public final static String UTILISATEUR_FILTER = "UtilisateurFilter";

public static SimpleFilterProvider getDefaultFilters() {
    SimpleBeanPropertyFilter theFilter = SimpleBeanPropertyFilter.serializeAll();
    return new SimpleFilterProvider().setDefaultFilter(theFilter);
}

}

スプリング構成:

@EnableWebMvc
@Configuration
@ComponentScan(basePackages = "fr.sodebo")

public class ApiRootConfiguration extends WebMvcConfigurerAdapter {

@Autowired
private EntityManagerFactory entityManagerFactory;


/**
 * config qui permet d'éviter les "Lazy loading Error" au moment de la
 * conversion json par jackson pour les retours des services REST<br>
 * on permet à jackson d'acceder à sessionFactory pour charger ce dont il a
 * besoin
 */
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {

    super.configureMessageConverters(converters);
    MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
    ObjectMapper mapper = new ObjectMapper();

    // config d'hibernate pour la conversion json
    mapper.registerModule(getConfiguredHibernateModule());//

    // inscrit les filtres json
    subscribeFiltersInMapper(mapper);

    // config du comportement de json views
    mapper.configure(MapperFeature.DEFAULT_VIEW_INCLUSION, false);

    converter.setObjectMapper(mapper);
    converters.add(converter);
}

/**
 * config d'hibernate pour la conversion json
 * 
 * @return Hibernate5Module
 */
private Hibernate5Module getConfiguredHibernateModule() {
    SessionFactory sessionFactory = entityManagerFactory.unwrap(SessionFactory.class);
    Hibernate5Module module = new Hibernate5Module(sessionFactory);
    module.configure(Hibernate5Module.Feature.FORCE_LAZY_LOADING, true);

    return module;

}

/**
 * inscrit les filtres json
 * 
 * @param mapper
 */
private void subscribeFiltersInMapper(ObjectMapper mapper) {

    mapper.setFilterProvider(ModelJsonFilters.getDefaultFilters());

}

}

最後に、必要なときにrestConstollerで特定のフィルターを指定できます。

@RequestMapping(value = "/{id}/droits/", method = RequestMethod.GET)
public MappingJacksonValue getListDroits(@PathVariable long id) {

    LOGGER.debug("Get all droits of user with id {}", id);

    List<Droit> droits = utilisateurService.findDroitsDeUtilisateur(id);

    MappingJacksonValue value;

    UtilisateurWithSecteurs utilisateurWithSecteurs = droitsUtilisateur.fillLists(droits).get(id);

    value = new MappingJacksonValue(utilisateurWithSecteurs);

    FilterProvider filters = ModelJsonFilters.getDefaultFilters().addFilter(ModelJsonFilters.SECTEUR_FILTER, SimpleBeanPropertyFilter.serializeAllExcept("secteursEnfants")).addFilter(ModelJsonFilters.APPLICATION_FILTER,
            SimpleBeanPropertyFilter.serializeAllExcept("services"));

    value.setFilters(filters);
    return value;

}

5
なぜ簡単な質問で複雑なのか
Humoyun Ahmad

1

場所@JsonIgnoreフィールド上またはそのゲッター、またはカスタムDTOを作成します

@JsonIgnore
private String encryptedPwd;

または上記のように、アクセス属性が書き込み専用に設定されceekayている@JsonProperty場所で注釈を付ける

@JsonProperty( value = "password", access = JsonProperty.Access.WRITE_ONLY)
private String encryptedPwd;

0

作成しません UserJsonResponseクラスをし、必要なフィールドを入力するほうが、よりクリーンなソリューションになりますか?

すべてのモデルを返却したい場合、JSONを直接返すことは優れたソリューションのようです。それ以外の場合は、単に乱雑になります。

将来的には、たとえば、どのModelフィールドとも一致しないJSONフィールドが必要になる可能性があり、その場合はさらに大きな問題が発生します。


0

これは上記の答えのためのクリーンなユーティリティツールです:

@GetMapping(value = "/my-url")
public @ResponseBody
MappingJacksonValue getMyBean() {
    List<MyBean> myBeans = Service.findAll();
    MappingJacksonValue mappingValue = MappingFilterUtils.applyFilter(myBeans, MappingFilterUtils.JsonFilterMode.EXCLUDE_FIELD_MODE, "MyFilterName", "myBiggerObject.mySmallerObject.mySmallestObject");
    return mappingValue;
}

//AND THE UTILITY CLASS
public class MappingFilterUtils {

    public enum JsonFilterMode {
        INCLUDE_FIELD_MODE, EXCLUDE_FIELD_MODE
    }
    public static MappingJacksonValue applyFilter(Object object, final JsonFilterMode mode, final String filterName, final String... fields) {
        if (fields == null || fields.length == 0) {
            throw new IllegalArgumentException("You should pass at least one field");
        }
        return applyFilter(object, mode, filterName, new HashSet<>(Arrays.asList(fields)));
    }

    public static MappingJacksonValue applyFilter(Object object, final JsonFilterMode mode, final String filterName, final Set<String> fields) {
        if (fields == null || fields.isEmpty()) {
            throw new IllegalArgumentException("You should pass at least one field");
        }

        SimpleBeanPropertyFilter filter = null;
        switch (mode) {
            case EXCLUDE_FIELD_MODE:
                filter = SimpleBeanPropertyFilter.serializeAllExcept(fields);
                break;
            case INCLUDE_FIELD_MODE:
                filter = SimpleBeanPropertyFilter.filterOutAllExcept(fields);
                break;
        }

        FilterProvider filters = new SimpleFilterProvider().addFilter(filterName, filter);
        MappingJacksonValue mapping = new MappingJacksonValue(object);
        mapping.setFilters(filters);
        return mapping;
    }
}

-5

エンティティクラスに@JsonInclude(JsonInclude.Include.NON_NULL)注釈を追加して問題を解決します

それは次のようになります

@Entity
@JsonInclude(JsonInclude.Include.NON_NULL)

まったく関係なく答えた。質問の目的は異なりますが、答えは別のものです。そのため-1
Hammad Dar
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.