maxchistt Aug 6 2023 at 17:00

JsonProperty.EFCore: Упрощаем работу с JSON-полями в Entity Framework Core

4 min

3.6K

Иногда перед разработчиками встает задача использования JSON-полей в Entity Framework Core. Традиционный подход с использованием Fluent API требует написания дополнительного кода, что может усложнить проект. Пакет JsonProperty.EFCore решает эту проблему. Эта статья расскажет о пользе JsonProperty.EFCore и о том, как он упрощает работу с JSON-полями, что делает его удобным инструментом для разработчиков.

Проблема: Сложное управление JSON-полями

Entity Framework Core отлично поддерживает работу с реляционными базами данных, но управление JSON-полями может стать непростой задачей. Настройка Fluent API для отображения JSON-полей на свойства сущностей требует написания дополнительного кода, что может увеличить сложность проекта. С учетом возникающей иногда необходимости хранить данные в формате JSON разработчикам необходимо эффективное решение для интеграции JSON-полей в модели EF Core.

JsonProperty.EFCore: Упрощенный подход

JsonProperty.EFCore предлагает новое решение для управления JSON-полями. Он позволяет использовать JSON-поля в EF Core без необходимости настройки сложного Fluent API. Благодаря этому открытому проекту NuGet, разработчики могут упростить свой рабочий процесс и сосредоточиться на создании логики приложения, минуя сложные настройки EF Core.

Особенности и преимущества

Простая интеграция: JsonProperty.EFCore предлагает простой процесс интеграции. Разработчики просто добавляют пакет, указывают директиву using и создают модель сущности, как обычно - не требуется дополнительная настройка для JSON-полей.
Поддержка обобщенных типов: Пакет поддерживает обобщенные типы, такие как JsonEnumerable<T> и JsonDictionary<TKey, TValue>, что позволяет разработчикам работать с пользовательскими типами элементов в коллекциях JSON без усилий.
Безупречное управление JSON: С JsonProperty.EFCore управление JSON-полями становится намного проще. Разработчики могут непосредственно добавлять свойства типов JsonEnumerable, JsonList, JsonDictionary или JsonItem в свои модели сущностей и легко управлять JSON-полями.
Строгая сериализация типов: Пакет позволяет разработчикам включить строгую сериализацию типов. При включении типы данных включаются в JSON, обеспечивая повышенную целостность и последовательность преобразования данных.
Полиморфизм: строгая типизация позволяет сохранить полиморфные типы при сериализации и десериализации в JSON.

Примеры использования

Давайте рассмотрим несколько примеров использования JsonProperty.EFCore, чтобы продемонстрировать его полезность и удобство:

Хранение параметров продукта:
Допустим, у нас есть сущность "Product" с различными параметрами, сохраняемыми в JSON-полях. С JsonProperty.EFCore добавление и управление этими параметрами становится невероятно простым:
```
public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public JsonDictionary Parameters { get; set; } = new();
}
```
Запись JsonDictionary аналогична JsonDictionary<string, object>. При этом полиморфизм позволяет хранить значения любых типов в таком словаре.
А вот пример управления коллекцией JsonDictionary:
```
Product product = new() {Name="Phone",Price=500.95m,Amount=21,Parameters={
    VirtualDictionary = new Dictionary<string,object>() {
        {"Camera",13.5 },{"OS","Android" },{"Screen","1080x900"},{"Storage",32}
    }
}};
db.Goods.Add(product);
db.SaveChanges();
```
Это сгенерирует следующие данные для поля в формате JSON, если настройка JsonSettings.StrictTypeSerialization имеет значение true (по умолчанию):
```
{
  "Camera": [13.5, "System.Double"],
  "OS": ["Android", "System.String"],
  "Screen": ["1080x900", "System.String"],
  "Storage": [32, "System.Int32"]
}
```
Также можно добавлять и редактировать элементы поля JsonDictionary:
```
Product product = db.Goods.FirstOrDefault();
product.Parameters.Add("Battery capacity", 3000);
product.Parameters.Edit(dict => {
  dict["Battery capacity"] = 4000;
  dict["Storage"] = 64;
  dict.Add("RAM", 4);
  return dict;
});
```
После этого JSON-поле примет следующий вид:
```
{
  "Camera": [13.5, "System.Double"],
  "OS": ["Android", "System.String"],
  "Screen": ["1080x900", "System.String"],
  "Storage": [64, "System.Int32"],
  "Battery capacity": [4000, "System.Int32"],
  "RAM": [4, "System.Int32"]
}
```
Управление элементами списка дел:
Предположим, у нас есть сущность "Note" с коллекцией элементов "TodoItem", сохраняемых в JSON. JsonProperty.EFCore облегчает работу с коллекциями JSON:
```
public class Note
{
    public int Id { get; set; }
    public string Header { get; set; }
    public JsonList<TodoItem> Todos { get; set; } = new();
}
```
При этом в списке JsonList<TodoItem> можно также хранить элементы с типом, наследуемым от TodoItem.
Простое добавление полиморфного поля:
Допустим, нам надо добавить в нашу сущность поле с абстрактным или просто полиморфным типом, без организации сложной системы сущностей и таблиц для наследуемых типов. Здесь отлично поможет JsonProperty.EFCore:
```
using JsonProperty.EFCore;

class MyEntity
{
    public int Id { get; set; }
    public int Title { get; set; }
    public JsonItem<Base> Content { get; set; } = new();
}
```
Теперь можно использовать полиморфное поле:
```
MyEntity myEntity = new();
myEntity.Content.Serialize(new DerivedType1());
Base val = myEntity.Content.Deserialize();
Console.WriteLine(val is DerivedType1); //true
```

Заключение

JsonProperty.EFCore - это ценный открытый проект, который упрощает управление JSON-полями в Entity Framework Core. Избавляя от необходимости настройки Fluent API, он дает возможность разработчикам проще работать с JSON-полями, обеспечивая простоту и эффективность разработки. Простая интеграция, поддержка обобщенных типов и полиморфизм делают JsonProperty.EFCore полезным инструментом для разработчиков приложений.

Если вы хотите упростить управление JSON-полями в EF Core, попробуйте JsonProperty.EFCore. Посетите репозиторий на GitHub, чтобы узнать больше и оценить проект. Удачной разработки!

Tags:

Hubs: