Динамічно ігноруйте поля з об’єкта Java, надсилаючи як JSON з Spring MVC


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

У весняному контролері 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.

Але я цього не хочу, я не хочу надсилати всі поля клієнтській стороні. Якщо я не хочу, щоб пароль, оновлений, створений за допомогою полів для надсилання, мій результат JSON повинен бути таким

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

Список полів, які я не хочу надсилати клієнтові з іншої таблиці баз даних. Отже, це зміниться залежно від користувача, який увійшов у систему. Як це зробити?

Я сподіваюся, Ви отримали моє запитання.


Що б ви сказали на цю відповідь? stackoverflow.com/a/30559076/3488143
Ірина

ця інформація може бути корисною 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

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

5
Це ігнорує як під час читання із запиту, так і під час надсилання відповіді. Я хочу ігнорувати лише під час надсилання відповіді, тому що мені потрібна ця властивість від об’єкта запиту. Якісь ідеї?
zulkarnain shah

32

Я знаю, що я трохи спізнююся на вечірку, але насправді я натрапив на це також на кілька місяців тому. Усі доступні рішення мені не надто привабливі (міксинговись!), Тож я закінчив створити нову бібліотеку, щоб зробити цей процес більш чистим. Він доступний тут, якщо хтось захоче спробувати його: 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"));
}

Ви також можете використовувати його поза весни:

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 класу (немає помилки часу виконання / компіляції), як для рядка, я зміг зареєструвати спеціальний серіалізатор.
Нінад

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
Це фантастична і мінімалістична відповідь! Я хотів повернути як JSON лише декілька полів із занотованого компонента @Configuration та пропускаючи всі внутрішні поля, які автоматично включаються. Дуже дякую!
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у поле пароля.

Звичайно, ви можете встановити і @JsonIgnoreна createBy та updatedBy, якщо завжди хочете ігнорувати тоді, а не лише в цьому конкретному випадку.

ОНОВЛЕННЯ

У випадку, якщо ви не хочете додавати примітку до самого POJO, відмінним варіантом є анотації Mixin від Джексона. Ознайомтеся з документацією


Чи можу я це зробити динамічно? Не в POJO? Чи можу я це зробити у своєму класі Controller?
iCode

Ви маєте на увазі, що не хочете додавати примітки до POJO?
гео та

Тому що іноді, можливо, я хочу надіслати всі поля клієнтській стороні. Іноді мало полів. Поля, які я повинен надсилати клієнтові, отримує лише з бази даних у класі контролера. Після цього потрібно лише встановити, які поля слід ігнорувати.
iCode

12

Так, ви можете вказати, які поля серіалізуються як відповідь JSON, а які - ігнорувати. Це те, що потрібно зробити для реалізації властивостей «Динамічно ігнорувати».

1) Спочатку вам потрібно додати @JsonFilter з com.fasterxml.jackson.annotation.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"
}

Тут ви можете бачити, що він ігнорує інші властивості (поле 3 у цьому випадку) у відповідь, крім поля властивостей1 та поля2.

Сподіваюся, це допомагає.


1
@Shafqat Чоловік, велике спасибі, ти мій рятівник. Провів майже день, намагаючись з'ясувати подібну функціональність. Це рішення настільки елегантне і просте? і робить саме те, що просили. Слід позначити як правильну відповідь.
Олег Куць

6

Якби я був ти і хотів це зробити, я б не використовував мою сутність користувача у шарі Controller. Я створюю та використовую UserDto (об’єкт передачі даних) для спілкування з бізнес-рівнем (Service) та Controller. Ви можете використовувати Apache BeanUtils (метод copyProperties), щоб скопіювати дані від об'єкта Користувача до UserDto.


3

Я створив JsonUtil, який можна використовувати для ігнорування полів під час виконання, надаючи відповідь.

Приклад використання: Першим аргументом повинен бути будь-який клас POJO (Student), а 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

Я знайшов рішення для мене із Спринг та Джексоном

Спочатку вкажіть назву фільтра в об'єкті

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

}

5
чому так ускладнення для легкого питання
Гумоюн Ахмад

1

Розмістіть @JsonIgnoreна полі чи його геттер або створіть спеціальний dto

@JsonIgnore
private String encryptedPwd;

або як зазначено вище, ceekayпримітивши його до того, @JsonPropertyде атрибут доступу встановлений лише для запису

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

0

Чи не створити UserJsonResponseклас та заповнити потрібні поля чистішим рішенням?

Повернення безпосередньо до JSON здається чудовим рішенням, коли ви хочете повернути всю модель назад. Інакше просто стає безладним.

У майбутньому, наприклад, можливо, ви хочете мати поле JSON, яке не відповідає жодному полі Model, і тоді у вас виникнуть великі проблеми.


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 для цього
Хаммад Дар
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.