Instrukcja tworzenia kontekstu bazy danych SQLite w C# z użyciem Entity Framework Core
Ta instrukcja krok po kroku wyjaśnia, jak stworzyć i skonfigurować kontekst bazy danych SQLite w aplikacji C# wykorzystując Entity Framework Core (EF Core). Wykorzystuje ona dostarczony kod źródłowy i opisuje poszczególne elementy.
Wymagania wstępne:
Visual Studio: Zainstalowany Visual Studio (lub inny IDE obsługujący C#).
.NET SDK: Zainstalowany .NET SDK (minimum wersja .NET 6, ale zalecana nowsza).
Entity Framework Core: Dodanie zależności EF Core do projektu. Można to zrobić za pomocą NuGet Package Manager:
dotnet add package Microsoft.EntityFrameworkCore.SQLite dotnet add package Microsoft.EntityFrameworkCore.ToolsBiblioteka SQLite: Upewnij się, że masz zainstalowaną bibliotekę SQLite dla platformy, na której uruchamiasz aplikację (np.
SQLite.Interopw przypadku Windows). NuGet może to zrobić automatycznie, ale warto sprawdzić.
Kroki:
Struktura projektu: Upewnij się, że masz strukturę projektu odpowiadającą podanemu kodowi. Kod zakłada, że znajduje się wewnątrz namespace
SafeNote.Inne.Analiza kodu i wyjaśnienie poszczególnych fragmentów:
using Microsoft.EntityFrameworkCore;: Importuje niezbędne klasy z biblioteki EF Core.using System;,using System.IO;: Importują klasęEnvironmenti funkcje obsługi plików, używane do określenia ścieżki bazy danych w folderzeAppData.AppDbContext : DbContext: Tworzy klasę kontekstu bazy danychAppDbContext, dziedzicząc po klasieDbContextz EF Core. Kontekst ten odpowiada za interakcję z bazą danych.private readonly string _dbPath;: Definiuje prywatną, niezmienną zmienną_dbPathtypustring, która przechowuje pełną ścieżkę do pliku bazy danych SQLite.AppDbContext()(konstruktor):- Określa folder aplikacji
Safenotew kataloguAppDataużytkownika za pomocąEnvironment.GetFolderPath(Environment.SpecialFolder.ApplicationData). Jest to standardowe miejsce dla przechowywania plików aplikacji na platformie Windows. - Sprawdza, czy folder
Safenoteistnieje. Jeśli nie, tworzy go za pomocąDirectory.CreateDirectory(). - Tworzy pełną ścieżkę do pliku bazy danych (np.
C:\Users\Użytkownik\AppData\Roaming\Safenote\safenote.db) łącząc folderSafenotei nazwę pliku "safenote.db" za pomocąPath.Combine(). - Wywołuje
this.Database.EnsureCreated(), która gwarantuje, że baza danych zostanie utworzona, jeśli nie istnieje. Jest to wygodne rozwiązanie zapewniające spójność bazy danych.
- Określa folder aplikacji
OnConfiguring(DbContextOptionsBuilder optionsBuilder):- To metoda nadpisująca, która pozwala skonfigurować połączenie z bazą danych. Używa
optionsBuilderdo ustawienia connection stringa dla SQLite:optionsBuilder.UseSqlite($"Data Source={_dbPath}");. To właśnie tutaj określamy ścieżkę do pliku bazy danych.
- To metoda nadpisująca, która pozwala skonfigurować połączenie z bazą danych. Używa
OnModelCreating(ModelBuilder modelBuilder):- To metoda nadpisująca, która pozwala na definiowanie mapowań między klasami C# (modelami danych) a tabelami w bazie danych. Można tutaj zdefiniować relacje między tabelami i ustawić klucze podstawowe/obce. W podanym kodzie jest pusta, ale można ją rozbudować o definicje modeli danych.
public DbSet<Uzytkownik> Uzytkownicy { get; set; },public DbSet<Kategoria> Kategorie { get; set; },public DbSet<Notatka> Notatki { get; set; }:- Definiują
DbSetdla każdego modelu danych (klasy reprezentujące tabele w bazie danych).DbSetjest używany do zarządzania tabelami w bazie danych i umożliwia wykonywanie operacji CRUD (Create, Read, Update, Delete) na tych tabelach.
- Definiują
Użycie kontekstu bazy danych: Po utworzeniu klasy
AppDbContext, można ją użyć do interakcji z bazą danych:using (var dbContext = new AppDbContext()) { // Dodawanie nowych notatek var nowaNotatka = new Notatka { Tytul = "Moja pierwsza notatka", Zawartosc = "Tekst notatki" }; dbContext.Notatki.Add(nowaNotatka); // Zapisywanie zmian w bazie danych dbContext.SaveChanges(); // Odczytanie wszystkich notatek var wszystkieNotatki = dbContext.Notatki.ToList(); foreach (var notatka in wszystkieNotatki) { Console.WriteLine($"Tytuł: {notatka.Tytul}, Zawartość: {notatka.Zawartosc}"); } }
Pełna klasa AppDbContext:
using Microsoft.EntityFrameworkCore;
using System;
using System.IO;
using SafeNote.Models;
namespace SafeNote.Inne
{
internal class AppDbContext : DbContext
{
private readonly string _dbPath;
public AppDbContext()
{
// Ścieżka do folderu aplikacji Safenote w AppData
string safenoteFolder = Path.Combine(
Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
"Safenote");
// Jeśli folder nie istnieje, tworzymy go
if (!Directory.Exists(safenoteFolder))
{
Directory.CreateDirectory(safenoteFolder);
}
// Pełna ścieżka do pliku bazy
_dbPath = Path.Combine(safenoteFolder, "safenote.db");
this.Database.EnsureCreated();
}
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
// Ustaw poprawny connection string do SQLite
optionsBuilder.UseSqlite($"Data Source={_dbPath}");
}
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
// Możesz tutaj mapować relacje i klucze, jeśli jest potrzeba
}
public DbSet<Uzytkownik> Uzytkownicy { get; set; }
public DbSet<Kategoria> Kategorie { get; set; }
public DbSet<Notatka> Notatki { get; set; }
}
}
Tutaj kolejny przykład z wygodniejszym kontekstem wystarczy wkleić i dodać dbsety:
using Microsoft.EntityFrameworkCore; using OrganizatorPracyPremiumV1.Models; using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace OrganizatorPracyPremiumV1.Baza { internal class AppDbContext:DbContext { private readonly string _dbPath; string nazwaProgramu = "OrganizatorPracyPremium"; public AppDbContext() { // Ścieżka do folderu aplikacji Safenote w AppData string safenoteFolder = Path.Combine( Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), nazwaProgramu); // Jeśli folder nie istnieje, tworzymy go if (!Directory.Exists(safenoteFolder)) { Directory.CreateDirectory(safenoteFolder); } // Pełna ścieżka do pliku bazy _dbPath = Path.Combine(safenoteFolder, nazwaProgramu); this.Database.EnsureCreated(); } protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) { // Ustaw poprawny connection string do SQLite optionsBuilder.UseSqlite($"Data Source={_dbPath}"); } protected override void OnModelCreating(ModelBuilder modelBuilder) { // Możesz tutaj mapować relacje i klucze, jeśli jest potrzeba } public DbSet<User> Uzytkownicy { get; set; } } }
Dodatkowe uwagi:
- Obsługa błędów: W środowisku produkcyjnym należy dodać obsługę wyjątków (try-catch) do operacji bazy danych, aby obsłużyć potencjalne błędy i zapobiec awarii aplikacji.
- Transakcje: Używaj transakcji (
dbContext.Database.BeginTransaction()) dla krytycznych operacji, które muszą być wykonywane w sposób atomowy (wszystkie zmiany są albo zapisywane, albo cofane). - Konfiguracja SQLite: Możesz rozważyć dodatkową konfigurację biblioteki
SQLite(np. ustawienie rozmiaru bufora) dla poprawy wydajności. Database.EnsureCreated(): Ta metoda automatycznie tworzy bazę danych i tabele na podstawie modeli danych (klasUzytkownik,Kategoria,Notatka). Jeśli modele danych się zmienią, należy ponownie uruchomić tę metodę, aby zaktualizować strukturę bazy danych.- Bezpieczeństwo: Zabezpiecz plik bazy danych, szczególnie jeśli zawiera wrażliwe dane. Upewnij się, że uprawnienia dostępu do pliku są odpowiednio ustawione.
Podsumowanie:
Powyższe instrukcje pokazują, jak skutecznie skonfigurować kontekst bazy danych SQLite w aplikacji C# przy użyciu EF Core. Dzięki temu można łatwo i bezpiecznie zarządzać danymi w bazie danych SQLite. Pamiętaj o odpowiedniej konfiguracji i obsłudze błędów dla stabilnej pracy aplikacji.
Komentarze
Prześlij komentarz