Українська
Конфігурації
Крок 1. Чого не можуть знати угоди
Навіщо. EF Core відображає більшу частину моделі за угодами, але деякі рішення можемо ухвалити лише ми:
- Довжини.
stringстаєtextнеобмеженої довжини. Відображуване ім’я завбільшки з мегабайт – це помилка або атака; база даних має це відхилити.HasMaxLength(64)робить стовпецьvarchar(64). - Індекси. Кожен запит, що фільтрує або сортує за стовпцем, потребує індексу на ньому, інакше PostgreSQL читає всю таблицю. EF Core за угодою створює індекси для зовнішніх ключів; усі інші – наша справа, зокрема унікальні, що забезпечують правила на кшталт «один особистий чат на пару».
- Ключі, що не відповідають угоді
Id: складений ключChatMember, ключUserIdвUserProfile. - Що відбувається під час видалення. Коли видаляють користувача, чи треба видалити й його повідомлення, чи відмовити у видаленні?
- Переліки як рядки та обмеження перевірки.
Кожна сутність отримує клас IEntityTypeConfiguration<T> у папці Configurations. Класи мають модифікатори internal sealed: ніхто поза рівнем даних їх не використовує, а ApplyConfigurationsFromAssembly і так знаходить їх через рефлексію.
Крок 2. Користувачі, профілі й токени
Що зробити. Конфігурація користувача оголошує зв’язок «один до одного» з профілем:
cs
using Chatex.Data.Entities;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Builders;
namespace Chatex.Data.Configurations;
internal sealed class UserConfiguration : IEntityTypeConfiguration<User>
{
public void Configure(EntityTypeBuilder<User> builder)
{
builder.HasOne(u => u.Profile)
.WithOne(p => p.User)
.HasForeignKey<UserProfile>(p => p.UserId)
.OnDelete(DeleteBehavior.Cascade);
}
}У зв’язку «один до одного» немає боку «багато», тож EF Core не може вгадати, яка з двох таблиць містить зовнішній ключ. HasForeignKey<UserProfile>(p => p.UserId) каже: його містить профіль. Оскільки ключ профілю – це той самий стовпець, кожен користувач має щонайбільше один профіль.
cs
using Chatex.Data.Entities;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Builders;
namespace Chatex.Data.Configurations;
internal sealed class UserProfileConfiguration : IEntityTypeConfiguration<UserProfile>
{
public void Configure(EntityTypeBuilder<UserProfile> builder)
{
builder.HasKey(p => p.UserId);
builder.Property(p => p.DisplayName).HasMaxLength(64);
builder.Property(p => p.Bio).HasMaxLength(500);
builder.Property(p => p.AvatarPath).HasMaxLength(260);
}
}HasKey(p => p.UserId) потрібен, бо угода шукає властивість з іменем Id або UserProfileId. Довжини відповідають правилам перевірки з теми 9: база даних – це остання лінія оборони, а перевірки (валідатори) спочатку дають користувачеві зрозуміле повідомлення.
cs
using Chatex.Data.Entities;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Builders;
namespace Chatex.Data.Configurations;
internal sealed class RefreshTokenConfiguration : IEntityTypeConfiguration<RefreshToken>
{
public void Configure(EntityTypeBuilder<RefreshToken> builder)
{
builder.Property(t => t.TokenHash).HasMaxLength(128);
builder.Property(t => t.UserAgent).HasMaxLength(512);
builder.Property(t => t.CreatedByIp).HasMaxLength(45);
builder.HasIndex(t => t.TokenHash).IsUnique();
builder.HasIndex(t => t.UserId);
builder.HasOne(t => t.User)
.WithMany(u => u.RefreshTokens)
.HasForeignKey(t => t.UserId)
.OnDelete(DeleteBehavior.Cascade);
}
}Токен шукають за його хешем під час кожного оновлення, тож хеш отримує унікальний індекс: пошук швидкий, а два токени ніколи не матимуть однакового хеша. 45 символів – це найдовша текстова форма адреси IPv6.
Крок 3. Чати й учасники
Що зробити.
cs
using Chatex.Data.Entities;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Builders;
namespace Chatex.Data.Configurations;
internal sealed class ChatConfiguration : IEntityTypeConfiguration<Chat>
{
public void Configure(EntityTypeBuilder<Chat> builder)
{
builder.ToTable(t => t.HasCheckConstraint(
"ck_chats_direct_key",
"(type = 'Direct') = (direct_key IS NOT NULL)"));
builder.Property(c => c.Type).HasConversion<string>().HasMaxLength(16);
builder.Property(c => c.Title).HasMaxLength(128);
builder.Property(c => c.Description).HasMaxLength(1000);
builder.Property(c => c.AvatarPath).HasMaxLength(260);
builder.Property(c => c.PublicHandle).HasMaxLength(32);
builder.Property(c => c.DirectKey).HasMaxLength(65);
builder.HasIndex(c => c.PublicHandle).IsUnique();
builder.HasIndex(c => c.DirectKey).IsUnique();
builder.HasOne(c => c.CreatedBy)
.WithMany()
.HasForeignKey(c => c.CreatedById)
.OnDelete(DeleteBehavior.Restrict);
}
}Тут з’являються три нові засоби:
- Обмеження перевірки (check constraint) – це умова, яку база даних перевіряє для кожного рядка.
(type = 'Direct') = (direct_key IS NOT NULL)порівнює два логічні значення: тип дорівнюєDirectсаме тоді, коли заданоdirect_key. Групу з прямим ключем або особистий чат без нього відхилить сам PostgreSQL, що б не робив код C#. SQL використовує імена стовпців бази даних, уже в snake_case. HasConversion<string>()зберігає перелік за іменем ('Direct'), а не за номером. На цьому тримається обмеження перевірки: воно порівнюєtypeіз текстом'Direct'.- Унікальні індекси на стовпцях, що допускають NULL.
public_handleіdirect_keyунікальні, але в більшості чатів тамNULL. PostgreSQL вважаєNULLрізними значеннями в унікальному індексі, тож приватних чатів може бути скільки завгодно, а двох однакових ідентифікаторів – ні.
DirectKey має 65 символів: два ідентифікатори по 32 шістнадцяткові цифри й двокрапка між ними.
cs
using Chatex.Data.Entities;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Builders;
namespace Chatex.Data.Configurations;
internal sealed class ChatMemberConfiguration : IEntityTypeConfiguration<ChatMember>
{
public void Configure(EntityTypeBuilder<ChatMember> builder)
{
builder.HasKey(m => new { m.ChatId, m.UserId });
builder.Property(m => m.Role).HasConversion<string>().HasMaxLength(16);
// Lists the chats of a user; the primary key already covers lookups by chat.
builder.HasIndex(m => m.UserId);
builder.HasOne(m => m.Chat)
.WithMany(c => c.Members)
.HasForeignKey(m => m.ChatId)
.OnDelete(DeleteBehavior.Cascade);
builder.HasOne(m => m.User)
.WithMany(u => u.Memberships)
.HasForeignKey(m => m.UserId)
.OnDelete(DeleteBehavior.Cascade);
}
}HasKey(m => new { m.ChatId, m.UserId }) оголошує складений первинний ключ за допомогою анонімного типу. Первинний ключ має індекс, перший стовпець якого – chat_id, тож «учасники чату» читаються швидко; «чати користувача» потребують другого індексу за user_id, як сказано в коментарі.
Крок 4. Повідомлення й вкладення
Що зробити.
cs
using Chatex.Data.Entities;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Builders;
namespace Chatex.Data.Configurations;
internal sealed class MessageConfiguration : IEntityTypeConfiguration<Message>
{
public const int MaxBodyLength = 4000;
public void Configure(EntityTypeBuilder<Message> builder)
{
builder.Property(m => m.Body).HasMaxLength(MaxBodyLength);
// Keyset pagination: WHERE chat_id = @c AND id < @cursor ORDER BY id DESC.
builder.HasIndex(m => new { m.ChatId, m.Id }).IsDescending(false, true);
builder.HasIndex(m => m.SenderId);
builder.HasOne(m => m.Chat)
.WithMany(c => c.Messages)
.HasForeignKey(m => m.ChatId)
.OnDelete(DeleteBehavior.Cascade);
builder.HasOne(m => m.Sender)
.WithMany()
.HasForeignKey(m => m.SenderId)
.OnDelete(DeleteBehavior.Restrict);
builder.HasOne(m => m.ReplyTo)
.WithMany()
.HasForeignKey(m => m.ReplyToMessageId)
.OnDelete(DeleteBehavior.SetNull);
}
}Найважливіший рядок рівня даних – індекс (chat_id, id DESC). Завантаження сторінки історії – найчастіший запит месенджера:
sql
SELECT ... FROM messages
WHERE chat_id = @chat AND id < @cursor
ORDER BY id DESC
LIMIT 51З цим індексом PostgreSQL переходить до чату, потім до курсора й читає наступні 51 запис по порядку – з однаковою швидкістю для першої сторінки й для сторінки трирічної давності. IsDescending(false, true) робить перший стовпець висхідним, а другий – спадним. Константа MaxBodyLength дає назву межі в 4000 символів; валідатор повідомлення з теми 11 перевіряє те саме число (MessageLimits.MaxBody у Chatex.Core), ще до того, як запит дійде до бази даних.
cs
using Chatex.Data.Entities;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Builders;
namespace Chatex.Data.Configurations;
internal sealed class AttachmentConfiguration : IEntityTypeConfiguration<Attachment>
{
public void Configure(EntityTypeBuilder<Attachment> builder)
{
builder.Property(a => a.FileName).HasMaxLength(255);
builder.Property(a => a.ContentType).HasMaxLength(127);
builder.Property(a => a.StoragePath).HasMaxLength(260);
builder.HasIndex(a => a.MessageId);
builder.HasIndex(a => a.UploaderId);
builder.HasOne(a => a.Message)
.WithMany(m => m.Attachments)
.HasForeignKey(a => a.MessageId)
.OnDelete(DeleteBehavior.SetNull);
builder.HasOne(a => a.Uploader)
.WithMany()
.HasForeignKey(a => a.UploaderId)
.OnDelete(DeleteBehavior.Restrict);
}
}Крок 5. Правила видалення
Навіщо. Кожен зв’язок визначає, що станеться із залежними рядками, коли видалять головний рядок. Вибір Chatex (табл. 4.1) іде за одним питанням: чи втрачає залежний рядок сенс без головного, чи це запис, який не можна втратити непомітно?
Таблиця 4.1. Правила видалення зв’язків
| Коли видаляють | ці рядки | правило | чому |
|---|---|---|---|
| користувача | профіль, токени оновлення, членство | Cascade | без користувача вони не мають сенсу |
| користувача | створені ним чати, надіслані повідомлення, завантажені файли | Restrict | видалення користувача не повинно стирати чужі розмови; видалення завершується помилкою, доки з даними не впораються свідомо |
| чат | учасники, повідомлення | Cascade | чат видаляють повністю (на практиці чати видаляють «м’яко», тож це трапляється лише під час очищення) |
| повідомлення | відповіді на нього | SetNull | відповідь лишається; вона просто більше не вказує на оригінал |
| повідомлення | його вкладення | SetNull | файл стає непов’язаним завантаженням, яке прибирає завдання очищення |
OnDelete скрізь записано явно, навіть там, де воно повторює угоду, щоб рішення було видно в коді.
Кілька каскадних шляхів
Дозволено не кожну комбінацію. Якби видалення користувача каскадно зачіпало його повідомлення і його чати, які теж каскадно зачіпають повідомлення, база даних мала б два шляхи видалення до тих самих рядків. SQL Server відхиляє таку модель одразу; PostgreSQL приймає її, але результат залежить від порядку видалень. Restrict для зв’язків «створено ким» і «відправник» усуває проблему.
Перевірка
powershell
dotnet buildЗбірка успішна, а Source/Chatex.Data/Configurations містить сім файлів – по одному на сутність Chatex (власні сутності Identity налаштовує IdentityDbContext).