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

Question

このようなモデルクラスがあり、休止状態になります。

@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;
    }
}

DAOを使用するSpring MVCコントローラーでは、オブジェクトを取得できます。 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" : "[email protected]",
  "encryptedPwd" : "Co7Fwd1fXYk=",
  "createdBy" : null,
  "updatedBy" : null
}

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

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

{
  "userId" :2,
  "userName" : "john",
  "emailId" : "[email protected]"
}

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

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

Answer 1

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

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

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

GitHubの例

Answer 2

私はパーティーに少し遅れていることを知っていますが、実際には数か月前にこれに遭遇しました。すべての利用可能なソリューションは私にはあまり魅力的ではありませんでした（ミックスイン？誰でも試してみたい場合は、こちらから入手できます。 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"));

Answer 3

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

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

UPDATE

POJO自体に注釈を追加したくない場合、ジャクソンのMixin注釈が最適なオプションです。 ドキュメント をご覧ください

Answer 4

はい、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）を無視することがわかります。

お役に立てれば。

Answer 5

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

Answer 6

これを行うには、プロパティを宣言しながらJsonProperty.Access.WRITE_ONLYへのアクセスを設定します。

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

Answer 7

動的に実行できますか？

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

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"}

Answer 8

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

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

もちろん、 here のように、フィールド、セッター、またはゲッターに@JsonIgnoreを設定できます。

そして、シリアル化側でのみ暗号化されたパスワードを保護したい場合（たとえば、ユーザーにログインする必要がある場合）、この@JsonProperty注釈をfieldに追加します：

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

詳細 こちら 。

Answer 9

応答時に応答を実行中にフィールドを無視するために使用できる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 "";
   }
 }    

Answer 10

私は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);

}

その後、スプリング設定で使用されるデフォルトの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;

}

Answer 11

これは、上記のクリーンなユーティリティツールです answer ：

@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;
    }
}

Answer 12

UserJsonResponseクラスを作成し、必要なフィールドを入力することは、よりクリーンなソリューションではないでしょうか？

すべてのモデルを返したい場合、JSONを直接返すことは素晴らしい解決策のようです。それ以外の場合は、単に乱雑になります。

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

Answer 13

@JsonIgnoreをフィールドまたはそのゲッターに配置するか、カスタムdtoを作成します

@JsonIgnore
private String encryptedPwd;

または、ceekayで前述したように、アクセス属性が書き込み専用に設定されている@JsonPropertyアノテーションを付けます

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