VSS-DEV / ConsoleEF

Проект примера использования БД в консольном приложении

Проект-пример использования БД в консольном приложении

Проект предназначен для того, что бы показать как можно за минимальное число шагов добавить себе возможность работать с любой БД

Необходимые шаги для создания инфраструктуры

1. Добавить в проект NuGet-пакет с требуемым поставщиком БД

К примеру, для добавления подключения к MS SQL-Server требуется

<PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="6.0.0" />

2. Добавить в проект описание таблиц БД в виде классов-сущностей

Каждая сущность должна иметь первичный ключ: свойство типа int, long, uint, ulong..., string, Guid

public class Student
{
    public int Id { get; set; }

    // ...
}

Сущности определяют структуру таблиц: каждое свойство - столбец таблицы. Имя сущности - имя таблицы (во множественном числе), имя свойства - имя столбца. Имена можно изменить с помощью атрибутов, либо в настройках модели БД в классе контекста БД.

3. Добавить класс контекста БД

Через объект этого класса будет в дальнейшем осуществляться взаимодействие с БД.

public class StudentsDB : DbContext
{
    public StudentsDB(DbContextOptions<StudentsDB> opt) : base(opt)
    {
        
    }
}

У класса-контекста БД должен быть конструктор, передающий конструктору базового класса набор параметров.

4. Добавить в класс контекста БД набор свойств типа DbSet<T>, определяющих возможности доступа к нужным таблицам БД

public class StudentsDB : DbContext
{
    public DbSet<Student> Students { get; set; }

    public DbSet<Group> Groups { get; set; }

    public StudentsDB(DbContextOptions<StudentsDB> opt) : base(opt)
    {
        
    }
}

Инфраструктура доступа к БД готова.

Работа с контекстом БД и его конфигурирование

1. Для соединения с БД необходимо создать объект контекста БД

Для этого требуется выполнить его конфигурирование (как минимум, указать строку подключения).

Пусть строка подключения будет

Data Source=(localdb)\MSSQLLocalDB;Initial Catalog=Students.Test.db

Нужно создать объект класса DbContextOptions<StudentsDB> и указать ему строку подключения. Делается это с помощью билдера.

var connection_options = new DbContextOptionsBuilder<StudentsDB>()
   .UseSqlServer(sql_server_connection_string)
   .Options;

Полученный объект настроек подключения можно использовать для создания экземпляров контекста БД.

using (var db = new StudentsDB(connection_options))
{
    // ...
}

using (var db = new StudentsDB(new DbContextOptionsBuilder<StudentsDB>().UseSqlServer(sql_server_connection_string).Options))
{
    // ...
}

Первый вариант удобнее.

2. Инициализация БД исходными данными

При первом обращении к серверу БД база на сервере может отсутствовать. Её можно создать программно.

using (var db = new StudentsDB(connection_options))
{
    db.Database.EnsureCreated();
}

3. При обращении к существующей БД можно выполнить проверку наличия в ней необходимых исходных данных, и в случае их отсусттвия добавить их

using (var db = new StudentsDB(connection_options))
{
    db.Database.EnsureCreated();

    if (!db.Students.Any())
    {
        var ivanov = new Student
        {
            LastName = "Иванов",
            Name = "Иван",
            Patronymic = "Иванович",
            Birthday = DateTime.Now.AddYears(-21),
        };

        var petrov = new Student
        {
            LastName = "Петров",
            Name = "Пётр",
            Patronymic = "Петрович",
            Birthday = DateTime.Now.AddYears(-24),
        };

        var sidorov = new Student
        {
            LastName = "Сидоров",
            Name = "Сидор",
            Patronymic = "Сидорович",
            Birthday = DateTime.Now.AddYears(-22),
        };

        var group1 = new Group { Name = "Группа 1" };
        var group2 = new Group { Name = "Группа 2" };

        group1.Students.Add(ivanov);
        group1.Students.Add(petrov);

        group2.Students.Add(sidorov);

        db.Groups.Add(group1);
        db.Groups.Add(group2);

        db.SaveChanges();
    }
}

Важно не забыть вызвать метод SaveChanges(). И также важно не хранить долго экземпляр контекста БД дабы он не забивался кешируемыми данными и не замедлял работу. Контекст БД должен создаваться на время выполнения одной (возможно комплексной) операции взаимодействия с БД.

Использование конфигурации приложения

Строку подключения к БД целесообразно хранить не в коде приложения, а в файле конфигурации. Для работы с конфигурацией приложения целесообразно использовать современные инструменты платформы в виде пакетов

• Microsoft.Extensions.Configuration.Abstractions - общие положения, интерфейсы, классы
• Microsoft.Extensions.Configuration.Json - работа с файлами конфигурации в формате json

Для работы с файлами конфигурации достаточно использовать пакет Microsoft.Extensions.Configuration.Json.

1. Для использования конфигурации добавляем в проект файл appsettings.json - стандартное название для файла конфигурации приложения. Можно придумать своё.

2. Не забываем настроить проект таким образом, что бы файл конфигурации копировался в выходной каталог при сборке (если файл изменился)

<ItemGroup>
  <None Update="appsettings.json">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
  </None>
</ItemGroup>

3. В кода программы для чтения файла используем готовый механизм построителя конфигурации

var configuration = new ConfigurationBuilder()
   .AddJsonFile("appsettings.json")
   .Build();

4. В файле конфигурации предусмотрена стандартная секция для хранения строк подключения

{
  "ConnectionStrings": {
    "Default": "Data Source=(localdb)\\MSSQLLocalDB;Initial Catalog=Students.Test.db"
  }
}

5. Что бы получить строку подключения из объекта конфигурации предусмотрен специальный метод GetConnectionString("name"):

Так как мы разместили в файле конфигурации строку подключения с идентификатором "Default", то и запрашивать будем её.

var db_options = new DbContextOptionsBuilder<StudentsDB>()
   .UseSqlServer(configuration.GetConnectionString("Default"))
   .Options;

using (var db = new StudentsDB(db_options))
{
    var grous_with_max_students = db.Groups
       .Include(g => g.Students)
       .OrderByDescending(g => g.Students.Count())
       .First();

    Console.WriteLine(grous_with_max_students.Name);
    foreach (var student in grous_with_max_students.Students)
        Console.WriteLine("{0} {1} {2}", student.LastName, student.Name, student.Patronymic);
}