Часть VI Работа с файлами, сериализация объектов и доступ к данным
Глава 20 Файловый ввод-вывод и сериализация объектов
При создании настольных приложений возможность сохранения информации между пользовательскими сеансами является привычным делом. В настоящей главе рассматривается несколько тем, касающихся ввода-вывода, с точки зрения платформы .NET Core. Первая задача связана с исследованием основных типов, определенных в пространстве имен
System.IOПосле изучения способов манипулирования файлами и каталогами с использованием основных типов ввода-вывода вы ознакомитесь со связанной темой — сериализацией объектов. Сериализацию объектов можно применять для сохранения и извлечения состояния объекта с помощью любого типа, производного от
System.IO.StreamНа заметку! Чтобы можно было успешно выполнять примеры в главе, IDE-среда Visual Studio должна быть запущена с правами администратора (для этого нужно просто щелкнуть правой кнопкой мыши на значке Visual Studio и выбрать в контекстном меню пункт Запуск от имени администратора). В противном случае при доступе к файловой системе компьютера могут возникать исключения, связанные с безопасностью.
Исследование пространства имен System.IO
В рамках платформы .NET Core пространство имен
System.IOSystem.IOmscorlib.dllmscorlib.dllSystem.dllSystem.IOМногие типы из пространства имен
System.IOSystem.IO
В дополнение к описанным конкретным классам внутри
System.IOStreamTextReaderТехtWriterSystem.IOКлассы Directory(Directorylnfо) и File(FileInfo)
Пространство имен
System.IODirectoryFileFileInfoDirectoryInfonewDirectoryFileSystem.ObjectDirectoryInfoFileInfoFileSystemInfoОбычно классы
FileInfoDirectoryInfoDirectoryFileFile/FileInfoDirectory/DirectoryInfoАбстрактный базовый класс FileSystemInfo
Классы
DirectoryInfoFileInfoFileSystemInfoFileSystemInfo
В классе
FileSystemInfоDelete()Refresh()Работа с типом DirectoryInfо
Первый неабстрактный тип, связанный с вводом-выводом, который мы исследуем здесь —
DirectoryInfoFileSystemInfоDirectoryInfo
Работа с типом
DirectoryInfo.// Привязаться к текущему рабочему каталогу.DirectoryInfo dir1 = new DirectoryInfo(".");// Привязаться к C:\Windows, используя дословную строку.DirectoryInfo dir2 = new DirectoryInfo(@"C:\Windows");Во втором примере предполагается, что путь, передаваемый конструктору (
С:\WindowsSystem.IO.DirectoryNotFoundExceptionCreate()// Привязаться к несуществующему каталогу, затем создать его.DirectoryInfo dir3 = new DirectoryInfo(@"C:\MyCode\Testing");dir3.Create();Синтаксис пути, используемый в предыдущем примере, ориентирован на Windows. Если вы разрабатываете приложения .NET Core для разных платформ, тогда должны применять конструкции
Path.VolumeSeparatorCharPath.DirectorySeparatorCharDirectoryInfo dir3 = new DirectoryInfo( $@"C{Path.VolumeSeparatorChar}{Path.DirectorySeparatorChar} MyCode{Path.DirectorySeparatorChar}Testing");После создания объекта
DirectoryInfoFileSystemInfoDirectorуАррSystemSystem.IOProgramDirectoryInfoС:\Windowsusing System;using System.IO;Console.WriteLine("***** Fun with Directory(Info) *****\n");ShowWindowsDirectoryInfo();Console.ReadLine();static void ShowWindowsDirectoryInfo(){ // Вывести информацию о каталоге. В случае работы не под // управлением Windows подключитесь к другому каталогу. DirectoryInfo dir = new DirectoryInfo($@"C{Path.VolumeSeparatorChar} {Path.DirectorySeparatorChar}Windows"); Console.WriteLine("***** Directory Info *****"); // Информация о каталоге Console.WriteLine("FullName: {0}", dir.FullName); // Полное имя Console.WriteLine("Name: {0}", dir.Name); // Имя каталога Console.WriteLine("Parent: {0}", dir.Parent); // Родительский каталог Console.WriteLine("Creation: {0}", dir.CreationTime); // Время создания Console.WriteLine("Attributes: {0}", dir.Attributes); // Атрибуты Console.WriteLine("Root: {0}", dir.Root); // Корневой каталог Console.WriteLine("**************************\n");}Вывод у вас может отличаться, но быть похожим:
***** Fun with Directory(Info) ********** Directory Info *****FullName: C:\WindowsName: WindowsParent:Creation: 3/19/2019 00:37:22Attributes: DirectoryRoot: C:\**************************Перечисление файлов с помощью типа DirectoryInfо
В дополнение к получению базовых сведений о существующем каталоге текущий пример можно расширить, чтобы задействовать некоторые методы типа
DirectoryInfоGetFiles()*.jpgС:\Windows\Web\WallpaperНа заметку! Если вы не работаете на машине с Windows, тогда модифицируйте код, чтобы читать файлы в каком-нибудь каталоге на вашей машине Не забудьте использовать
Path.VolumeSeparatorCharPath.DirectorySeparatorCharМетод
GetFiles()FileInfoFileInfoProgramstatic void DisplayImageFiles(){ DirectoryInfo dir = new DirectoryInfo(@"C:\Windows\Web\Wallpaper"); // Получить все файлы с расширением *.jpg. FileInfo[] imageFiles = dir.GetFiles("*.jpg", SearchOption.AllDirectories); // Сколько файлов найдено? Console.WriteLine("Found {0} *.jpg files\n", imageFiles.Length); // Вывести информацию о каждом файле. foreach (FileInfo f in imageFiles) { Console.WriteLine("***************************"); Console.WriteLine("File name: {0}", f.Name // Имя файла Console.WriteLine("File size: {0}", f.Length); // Размер Console.WriteLine("Creation: {0}", f.CreationTime); // Время создания Console.WriteLine("Attributes: {0}", f.Attributes); // Атрибуты Console.WriteLine("***************************\n"); }}Обратите внимание на указание в вызове
GetFiles()SearchOption.AllDirectoriesСоздание подкаталогов с помощью типа DirectoryInfo
Посредством метода
DirectoryInfo.CreateSubdirectory().static void ModifyAppDirectory(){ DirectoryInfo dir = new DirectoryInfo("."); // Создать \MyFolder в каталоге запуска приложения. dir.CreateSubdirectory("MyFolder"); // Создать \MyFolder2\Data в каталоге запуска приложения. dir.CreateSubdirectory( $@"MyFolder2{Path.DirectorySeparatorChar}Data");}Получать возвращаемое значение метода
CreateSubdirectory()DirectoryInfostatic void ModifyAppDirectory(){ DirectoryInfo dir = new DirectoryInfo("."); // Создать \MyFolder в начальном каталоге. dir.CreateSubdirectory("MyFolder"); // Получить возвращенный объект DirectoryInfo. DirectoryInfo myDataFolder = dir.CreateSubdirectory( $@"MyFolder2{Path.DirectorySeparatorChar}Data"); // Выводит путь к ..\MyFolder2\Data. Console.WriteLine("New Folder is: {0}", myDataFolder);}Вызвав метод
ModifyAppDirectory()Работа с типом Directory
Вы видели тип
DirectoryInfoDirectoryDirectoryDirectoryInfoDirectoryFileInfo/DirectoryInfoДавайте взглянем на функциональность типа Directory; показанный ниже вспомогательный метод отображает имена всех логических устройств на текущем компьютере (с помощью метода
Directory.GetLogicalDrives()Directory.Delete()\MyFolder\MyFolder2\Datastatic void FunWithDirectoryType(){ // Вывести список всех логических устройств на текущем компьютере. string[] drives = Directory.GetLogicalDrives(); Console.WriteLine("Here are your drives:"); foreach (string s in drives) { Console.WriteLine("--> {0} ", s); } // Удалить ранее созданные подкаталоги. Console.WriteLine("Press Enter to delete directories"); Console.ReadLine(); try { Directory.Delete("MyFolder"); // Второй параметр указывает, нужно ли удалять внутренние подкаталоги. Directory.Delete("MyFolder2", true); } catch (IOException e) { Console.WriteLine(e.Message); }}Работа с типом DriveInfo
Пространство имен
System.IODriveInfoDirectory.GetLogicalDrives()DriveInfo.GetDrives()Directory.GetLogicalDrives()DriveInfo.GetDrives()DriveInfоАррusing System;using System.IO;// Получить информацию обо всех устройствах.DriveInfo[] myDrives = DriveInfo.GetDrives();// Вывести сведения об устройствах.foreach(DriveInfo d in myDrives){ Console.WriteLine("Name: {0}", d.Name); // имя Console.WriteLine("Type: {0}", d.DriveType); // тип // Проверить, смонтировано ли устройство. if(d.IsReady) { Console.WriteLine("Free space: {0}", d.TotalFreeSpace); // свободное пространство Console.WriteLine("Format: {0}", d.DriveFormat); // формат устройства Console.WriteLine("Label: {0}", d.VolumeLabel); // метка тома } Console.WriteLine();}Console.ReadLine();Вот возможный вывод:
***** Fun with DriveInfo *****Name: C:\Type: FixedFree space: 284131119104Format: NTFSLabel: OSName: M:\Type: NetworkFree space: 4711871942656Format: NTFSLabel: DigitalMediaК этому моменту вы изучили несколько основных линий поведения классов
DirectoryDirectoryInfоDriveInfoРабота с типом FileInfo
Как было показано в предыдущем примере
DirectoryAppFileInfoFileSystemInfoFileInfo
Обратите внимание, что большинство методов класса
FileInfoFileStreamStreamWriterFileInfoМетод FileInfo.Create()
Следующий набор примеров находится в проекте консольного приложения по имени
SimpleFileIOFileInfo.Create()using System;using System.IO;Console.WriteLine("***** Simple IO with the File Type *****\n");// Измените это на папку на своей машине, к которой вы имеете доступ// по чтению/записи или запускайте приложение от имени администратора.var fileName = $@"C{Path.VolumeSeparatorChar} {Path.DirectorySeparatorChar}temp {Path.DirectorySeparatorChar}Test.dat";// Создать новый файл на диске С:.FileInfo f = new FileInfo(fileName);FileStream fs = f.Create();// Использовать объект FileStream...// Закрыть файловый поток.fs.Close();На заметку! В зависимости от имеющихся у вас пользовательских разрешений и конфигурации системы примеры, которые здесь рассматриваются, могут требовать запуска Visual Studio от имени администратора.
Метод
FileInfo.Create()FileStreamFileStreamFileInfo.Create()Также обратите внимание, что после окончания работы с текущим объектом
FileStreamFileStreamIDisposableusingvar fileName = $@"C{Path.VolumeSeparatorChar} {Path.DirectorySeparatorChar}Test.dat";...// Поместить файловый поток внутрь оператора using.FileInfo f1 = new FileInfo(fileName);using (FileStream fs1 = f1.Create()){ // Использовать объект FileStream...}f1.Delete();На заметку! Почти все примеры в этой главе содержат операторы
usingusingusingSystem.IOМетод FileInfо.Open()
С помощью метода
FileInfo.Open()FileInfo.Create()Open()Open()FileStreamvar fileName = $@"C{Path.VolumeSeparatorChar} {Path.DirectorySeparatorChar}Test.dat";...// Создать новый файл посредством FileInfо.Open().FileInfo f2 = new FileInfo(fileName);using(FileStream fs2 = f2.Open(FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.None)){ // Использовать объект FileStream...}f2.Delete();Эта версия перегруженного метода
Open()FileMode
public enum FileMode{ CreateNew, Create, Open, OpenOrCreate, Truncate, Append}Второй параметр метода
Open()FileAccesspublic enum FileAccess{ Read, Write, ReadWrite}Наконец, третий параметр метода
Open()FileSharepublic enum FileShare{ None, Read, Write, ReadWrite, Delete, Inheritable}Методы FileInfо.OpenRead() и FileInfо.OpenWrite()
Метод
FileInfо.Open()FileInfоOpenRead()OpenWrite()FileStreamFileInfо.Create()FileInfо.Open()OpenRead()OpenWrite()FileStreamОбратите внимание, что метод
OpenRead()FileStreamOpenRead()f3.Create().Close();Вот полный пример:
var fileName = $@"C{Path.VolumeSeparatorChar} {Path.DirectorySeparatorChar}Test.dat";...// Получить объект FileStream с правами только для чтения.FileInfo f3 = new FileInfo(fileName);// Перед использованием OpenRead() файл должен существовать.f3.Create().Close();using(FileStream readOnlyStream = f3.OpenRead()){ // Использовать объект FileStream...}f3.Delete();// Теперь получить объект FileStream с правами только для записи.FileInfo f4 = new FileInfo(fileName);using(FileStream writeOnlyStream = f4.OpenWrite()){ // Использовать объект FileStream...}f4.Delete();Метод FileInfо.OpenText()
Еще одним членом типа
FileInfoOpenText()Create()Open()OpenRead()OpenWrite()OpenText()StreamReaderFileStreamboot.inivar fileName = $@"C{Path.VolumeSeparatorChar} {Path.DirectorySeparatorChar}Test.dat";...// Получить объект StreamReader.// Если вы работаете не на машине с Windows,// тогда измените имя файла надлежащим образом.FileInfo f5 = new FileInfo(fileName);// Перед использованием OpenText() файл должен существовать.f5.Create().Close();using(StreamReader sreader = f5.OpenText()){ // Использовать объект StreamReader...}f5.Delete();Вскоре вы увидите, что тип
StreamReaderМетоды FileInfo.CreateText() и FileInfo.AppendText()
Последними двумя методами, представляющими интерес в данный момент, являются
CreateText()AppendText()StreamWritervar fileName = $@"C{Path.VolumeSeparatorChar} {Path.DirectorySeparatorChar}Test.dat";...FileInfo f6 = new FileInfo(fileName);using(StreamWriter swriter = f6.CreateText()){ // Использовать объект StreamWriter...}f6.Delete();FileInfo f7 = new FileInfo(fileName);using(StreamWriter swriterAppend = f7.AppendText()){ // Использовать объект StreamWriter...}f7.Delete();Как и можно было ожидать, тип
StreamWriterРабота с типом File
В типе
FileFileInfoFileInfоFileAppendText()Create()CreateText()Open()OpenRead()OpenWrite()OpenText()FileFileInfoOpenText()OpenRead()FileFileStreamFilevar fileName = $@"C{Path.VolumeSeparatorChar} {Path.DirectorySeparatorChar}Test.dat";...// Использование File вместо FileInfo.using (FileStream fs8 = File.Create(fileName)){ // Использовать объект FileStream...}File.Delete(fileName);// Создать новый файл через File.Open().using(FileStream fs9 = File.Open(fileName, FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.None)){ // Использовать объект FileStream...}// Получить объект FileStream с правами только для чтения.using(FileStream readOnlyStream = File.OpenRead(fileName)){}File.Delete(fileName);// Получить объект FileStream с правами только для записи.using(FileStream writeOnlyStream = File.OpenWrite(fileName)){}// Получить объект StreamReader.using(StreamReader sreader = File.OpenText(fileName)){}File.Delete(fileName);// Получить несколько объектов StreamWriter.using(StreamWriter swriter = File.CreateText(fileName)){}File.Delete(fileName);using(StreamWriter swriterAppend = File.AppendText(fileName)){}File.Delete(fileName);Дополнительные члены типа File
Тип
File
Приведенные в табл. 20.6 методы типа
FileSimpleFileIOSystem.IOConsole.WriteLine("***** Simple I/O with the File Type *****\n");string[] myTasks = { "Fix bathroom sink", "Call Dave", "Call Mom and Dad", "Play Xbox One"};// Записать все данные в файл на диске С:.File.WriteAllLines(@"tasks.txt", myTasks);// Прочитать все данные и вывести на консоль.foreach (string task in File.ReadAllLines(@"tasks.txt")){ Console.WriteLine("TODO: {0}", task);}Console.ReadLine();File.Delete("tasks.txt");Из продемонстрированного примера можно сделать вывод: когда необходимо быстро получить файловый дескриптор, тип
FileFileInfoFileSystemInfoАбстрактный класс Stream
Вы уже видели много способов получения объектов
FileStreamStreamReaderStreamWriterАбстрактный класс
System.IO.StreamНа заметку! Концепция потока не ограничена файловым вводом-выводом. Естественно, библиотеки .NET Core предлагают потоковый доступ к сетям, областям памяти и прочим абстракциям, связанным с потоками.
Потомки класса
StreamStreamStream
Работа с типом FileStream
Класс
FileStreamStreamFileStreamFileStreamПусть имеется новый проект консольного приложения под названием
FileStreamAppSystem.IOSystem.TextmyMessage.datFileStreamSystem.StringSystem.TextEncodingПосле кодирования байтовый массив сохраняется в файле с помощью метода
FileStream.Write()PositionReadByte()using System;using System.IO;using System.Text;// He забудьте импортировать пространства имен System.Text и System.IO.Console.WriteLine("***** Fun with FileStreams *****\n");// Получить объект FileStream.using(FileStream fStream = File.Open("myMessage.dat", FileMode.Create)){ // Закодировать строку в виде массива байтов. string msg = "Hello!"; byte[] msgAsByteArray = Encoding.Default.GetBytes(msg); // Записать byte[] в файл. fStream.Write(msgAsByteArray, 0, msgAsByteArray.Length); // Сбросить внутреннюю позицию потока. fStream.Position = 0; // Прочитать byte[] из файла и вывести на консоль. Console.Write("Your message as an array of bytes: "); byte[] bytesFromFile = new byte[msgAsByteArray.Length]; for (int i = 0; i < msgAsByteArray.Length; i++) { bytesFromFile[i] = (byte)fStream.ReadByte(); Console.Write(bytesFromFile[i]); } // Вывести декодированное сообщение. Console.Write("\nDecoded Message: "); Console.WriteLine(Encoding.Default.GetString(bytesFromFile)); Console.ReadLine();}File.Delete("myMessage.dat");В приведенном примере не только производится наполнение файла данными, но также демонстрируется основной недостаток прямой работы с типом
FileStreamStreamMemoryStreamКак упоминалось ранее, в пространстве имен
System.IOStreamРабота с типами StreamWriter и StreamReader
Классы
StreamWriterStreamReaderSystem.Text.EncodingКласс
StreamReaderTextReaderStringReaderTextReaderКласс
StreamWriterStringWriterTextWriterЧтобы содействовать пониманию основных возможностей записи в классах
StreamWriterStringWriterTextWriter
На заметку! Вероятно, последние два члена класса
TextWriterSystem.ConsoleWrite()WriteLine()Console.InTextWriterConsole.OutTextWriterПроизводный класс
StreamWriterWrite()Close()Flush()AutoFlushtrueStreamWriterAutoFlushfalseStreamWriterClose()Запись в текстовый файл
Чтобы увидеть класс
StreamWriterStreamWriterReaderAppSystem.IOSystem.TextFile.CreateText()reminders.txtStreamWriterusing System;using System.IO;using System.Text;Console.WriteLine("***** Fun with StreamWriter / StreamReader *****\n");// Получить объект StreamWriter и записать строковые данные.using(StreamWriter writer = File.CreateText("reminders.txt")){ writer.WriteLine("Don't forget Mother's Day this year..."); writer.WriteLine("Don't forget Father's Day this year..."); writer.WriteLine("Don't forget these numbers:"); for(int i = 0; i < 10; i++) { writer.Write(i + " "); } // Вставить новую строку. writer.Write(writer.NewLine);}Console.WriteLine("Created file and wrote some thoughts...");Console.ReadLine();//File.Delete("reminders.txt");После выполнения программы можете просмотреть содержимое созданного файла, который будет находиться в корневом каталоге проекта (Visual Studio Code) или в подкаталоге
bin\Debug\net5.0CreateText()Чтение из текстового файла
Далее вы научитесь программно читать данные из файла, используя соответствующий тип
StreamReaderStreamReaderTextReader
Расширьте текущий пример приложения с целью применения класса
StreamReaderreminders.txtConsole.WriteLine("***** Fun with StreamWriter/StreamReader *****\n");...// Прочитать данные из файла.Console.WriteLine("Here are your thoughts:\n");using(StreamReader sr = File.OpenText("reminders.txt")){ string input = null; while ((input = sr.ReadLine()) != null) { Console.WriteLine (input); }}Console.ReadLine();После запуска программы в окне консоли отобразятся символьные данные из файла
reminders.txtПрямое создание объектов типа StreamWriter/StreamReader
Один из запутывающих аспектов работы с типами пространства имен
System.IOCreateText()StreamWriterFileFileInfoStreamWriterStreamReaderConsole.WriteLine("***** Fun with StreamWriter/StreamReader *****\n");// Получить объект StreamWriter и записать строковые данные.using(StreamWriter writer = new StreamWriter("reminders.txt")){ ...}// Прочитать данные из файла.using(StreamReader sr = new StreamReader("reminders.txt")){ ...}Несмотря на то что существование такого количества на первый взгляд одинаковых подходов к файловому вводу-выводу может сбивать с толку, имейте в виду,что конечным результатом является высокая гибкость. Теперь, когда вам известно, как перемещать символьные данные в файл и из файла с применением классов
StreamWriterStreamReaderStringWriterStringReaderРабота с типами StringWriter и StringReader
Классы
StringWriterStringReaderStringReaderWriterAppStringWriterSystem.IOSystem.Textusing System;using System.IO;using System.Text;Console.WriteLine("***** Fun with StringWriter/StringReader *****\n");// Создать объект StringWriter и записать символьные данные в память.using(StringWriter strWriter = new StringWriter()){ strWriter.WriteLine("Don't forget Mother's Day this year..."); // Получить копию содержимого (хранящегося в строке) и вывести на консоль. Console.WriteLine("Contents of StringWriter:\n{0}", strWriter);}Console.ReadLine();Классы
StringWriterStreamWriterTextWriterStringWriterGetStringBuilder()System.Text.StringBuilderusing (StringWriter strWriter = new StringWriter()){ strWriter.WriteLine("Don't forget Mother's Day this year..."); Console.WriteLine("Contents of StringWriter:\n{0}", strWriter); // Получить внутренний объект StringBuilder. StringBuilder sb = strWriter.GetStringBuilder(); sb.Insert(0, "Hey!! "); Console.WriteLine("-> {0}", sb.ToString()); sb.Remove(0, "Hey!! ".Length); Console.WriteLine("-> {0}", sb.ToString());}Когда необходимо прочитать из потока строковые данные, можно использовать соответствующий тип
StringReaderStreamReaderStringReaderusing (StringWriter strWriter = new StringWriter()){ strWriter.WriteLine("Don't forget Mother's Day this year..."); Console.WriteLine("Contents of StringWriter:\n{0}", strWriter); // Читать данные из объекта StringWriter. using (StringReader strReader = new StringReader(strWriter.ToString())) { string input = null; while ((input = strReader.ReadLine()) != null) { Console.WriteLine(input); } }}Работа с типами BinaryWriter и BinaryReader
Последним набором классов средств чтения и записи, которые рассматриваются в настоящем разделе, являются
BinaryWriterBinaryReaderSystem.ObjectBinaryWriterBinaryReaderBinaryWriterWrite()Write()BinaryWriterBinaryWriter
Класс
BinaryReaderBinaryWriter
В показанном далее примере (проект консольного приложения по имени
BinaryWriterReaderusingSystem.IO*.datusing System;using System.IO;Console.WriteLine("***** Fun with Binary Writers / Readers *****\n");// Открыть средство двоичной записи в файл.FileInfo f = new FileInfo("BinFile.dat");using(BinaryWriter bw = new BinaryWriter(f.OpenWrite())){ // Вывести на консоль тип BaseStream // (System.IO. Filestream в этом случае). Console.WriteLine("Base stream is: {0}", bw.BaseStream); // Создать некоторые данные для сохранения в файле. double aDouble = 1234.67; int anInt = 34567; string aString = "A, B, C"; // Записать данные. bw.Write(aDouble); bw.Write(anInt); bw.Write(aString);}Console.WriteLine("Done!");Console.ReadLine();Обратите внимание, что объект
FileStreamFileInfo.OpenWrite()BinaryWriterBinaryWriterStreamFileStreamMemoryStreamBufferedStreamMemoryStreamДля чтения данных из файла
BinFile.datBinaryReader...FileInfo f = new FileInfo("BinFile.dat");...// Читать двоичные данные из потока.using(BinaryReader br = new BinaryReader(f.OpenRead())){ Console.WriteLine(br.ReadDouble()); Console.WriteLine(br.ReadInt32()); Console.WriteLine(br.ReadString());}Console.ReadLine();Программное слежение за файлами
Теперь, когда вы знаете, как применять различные средства чтения и записи, давайте займемся исследованием роли класса
FileSystemWatcherFileSystemWatcherSystemIO.NotifyFilters:public enum NotifyFilters{ Attributes, CreationTime, DirectoryName, FileName, LastAccess, LastWrite, Security, Size}Чтобы начать работу с типом
FileSystemWatcherPathFilterВ настоящий момент можно выбрать обработку событий
ChangedCreatedDeletedFileSystemEventHandler// Делегат FileSystemEventHandler должен указывать// на методы, соответствующие следующей сигнатуре.void MyNotificationHandler(object source, FileSystemEventArgs e)Событие
RenamedRenamedEventHandler// Делегат RenamedEventHandler должен указывать// на методы, соответствующие следующей сигнатуре.void MyRenamedHandler(object source, RenamedEventArgs e)В то время как для обработки каждого события можно применять традиционный синтаксис делегатов/событий, вы определенно будете использовать синтаксис лямбда-выражений.
Давайте взглянем на процесс слежения за файлом. Показанный ниже проект консольного приложения(
MyDirectoryWatcherusingSystem.IO*.txtbin\debug\net5.0using System;using System.IO;Console.WriteLine("***** The Amazing File Watcher App *****\n");// Установить путь к каталогу, за которым нужно наблюдать.FileSystemWatcher watcher = new FileSystemWatcher();try{ watcher.Path = @".";}catch(ArgumentException ex){ Console.WriteLine(ex.Message); return;}// Указать цели наблюдения.watcher.NotifyFilter = NotifyFilters.LastAccess | NotifyFilters.LastWrite | NotifyFilters.FileName | NotifyFilters.DirectoryName;// Следить только за текстовыми файлами.watcher.Filter = "*.txt";// Добавить обработчики событий.// Указать, что будет происходить при изменении,// создании или удалении файла.watcher.Changed += (s, e) => Console.WriteLine($"File: {e.FullPath} {e.ChangeType}!");watcher.Created += (s, e) => Console.WriteLine($"File: {e.FullPath} {e.ChangeType}!");watcher.Deleted += (s, e) => Console.WriteLine($"File: {e.FullPath} {e.ChangeType}!");// Указать, что будет происходить при переименовании файла.watcher.Renamed += (s, e) => Console.WriteLine($"File: {e.OldFullPath} renamed to {e.FullPath}");// Начать наблюдение за каталогом.watcher.EnableRaisingEvents = true;// Ожидать от пользователя команды завершения программы.Console.WriteLine(@"Press 'q' to quit app.");// Сгенерировать несколько событий.using (var sw = File.CreateText("Test.txt")){ sw.Write("This is some text");}File.Move("Test.txt","Test2.txt");File.Delete("Test2.txt");while(Console.Read()!='q');При запуске данной программы последние ее строки будут создавать, изменять, переименовывать и затем удалять текстовый файл, попутно генерируя события. Кроме того, вы можете перейти в каталог
bin\debug\net5.0*.txt***** The Amazing File Watcher App *****Press 'q' to quit app.File: .\Test.txt Created!File: .\Test.txt Changed!File: .\Test.txt renamed to .\Test2.txtFile: .\Test2.txt Deleted!На этом знакомство с фундаментальными операциями ввода-вывода, предлагаемыми платформой .NET Core, завершено. Вы наверняка будете применять все продемонстрированные приемы во многих приложениях. Вдобавок вы обнаружите, что службы сериализации объектов способны значительно упростить задачу сохранения больших объемов данных.
Понятие сериализации объектов
Термин сериализация описывает процесс сохранения (и возможно передачи) состояния объекта в потоке (например, файловом потоке или потоке в памяти). Сохраненная последовательность данных содержит всю информацию, необходимую для воссоздания (или десериализации) открытого состояния объекта с целью последующего использования. Применение такой технологии делает тривиальным сохранение крупных объемов данных (в разнообразных форматах). Во многих случаях сохранение данных приложения с использованием служб сериализации дает в результате меньше кода, чем с применением средств чтения/записи из пространства имен
System.IOНапример, пусть требуется создать настольное приложение с графическим пользовательским интерфейсом, которое должно предоставлять конечным пользователям возможность сохранения их предпочтений (цвета окон, размер шрифта и т.д.). Для этого можно определить класс по имени
UserPrefsSystem.IO.BinaryWriterUserPrefsSystem.IO.BinaryReaderUserPrefsВсе это выполнимо, но вы можете сэкономить значительное время за счет использования сериализации XML (eXtensible Markup Language — расширяемый язык разметки) или JSON (JavaScript Object Notation — запись объектов JavaScript). Каждый из указанных форматов состоит из пар "имя-значение", позволяя представлять открытое состояние объекта в одиночном блоке текста, который можно потреблять между платформами и языками программирования. В итоге полное открытое состояние объекта может быть сохранено с помощью лишь нескольких строк кода.
На заметку! Применение типа
BinaryFormatterhttps://docs.microsoft.com/ru-ru/dotnet/api/system.runtime.serialization.formatters.binary.binaryformatter?view=net-5.0BinaryReader/BinaryWriterСериализация объектов .NET Core упрощает сохранение объектов, но ее внутренний процесс довольно сложен. Например, когда объект сохраняется в потоке, все ассоциированные с ним открытые данные (т.е. данные базового класса и содержащиеся в нем объекты) также автоматически сериализируются. Следовательно, при попытке сериализации производного класса в игру вступают также все открытые данные по цепочке наследования. Вы увидите, что для представления множества взаимосвязанных объектов используется граф объектов.
Наконец, имейте в виду, что граф объектов может быть сохранен в любом типе, производном от
System.IO.StreamРоль графов объектов
Как упоминалось ранее, среда CLR будет учитывать все связанные объекты, чтобы обеспечить корректное сохранение данных, когда объект сериализируется. Такой набор связанных объектов называется графом объектов. Графы объектов предоставляют простой способ документирования взаимосвязи между множеством элементов. Следует отметить, что графы объектов не обозначают отношения "является" и "имеет" объектно-ориентированного программирования. Взамен стрелки в графе объектов можно трактовать как "требует" или "зависит от".
Каждый объект в графе получает уникальное числовое значение. Важно помнить, что числа, присвоенные объектам в графе, являются произвольными и не имеют никакого смысла для внешнего мира. После того как всем объектам назначены числовые значения, граф объектов может записывать набор зависимостей для каждого объекта.
В качестве примера предположим, что создано множество классов, которые моделируют автомобили. Существует базовый класс по имени
CarRadioJamesBondCarCarНа рис. 20.1 показан возможный граф объектов, моделирующий такие отношения. При чтении графов объектов для описания соединяющих стрелок можно использовать выражение "зависит от" или "ссылается на". Таким образом, на рис. 20.1 видно, что класс
CarRadioJamesBondCarCarRadio
Разумеется, исполняющая среда не рисует картинки в памяти для представления графа связанных объектов. Взамен отношение, показанное на рис. 20.1, представляется математической формулой, которая выглядит следующим образом:
[Car 3, ref 2], [Radio 2], [JamesBondCar 1, ref 3, ref 2]Проанализировав формулу, вы заметите, что объект 3 (
CarRadioRadioJamesBondCarJamesBondCarRadioCarПривлекательность процесса сериализации заключается в том, что граф, представляющий отношения между объектами, устанавливается автоматически "за кулисами". Как будет показано позже в главе, при желании в конструирование графа объектов можно вмешиваться, настраивая процесс сериализации с применением атрибутов и интерфейсов.
Создание примеров типов и написание операторов верхнего уровня
Создайте новый проект консольного приложения .NET 5 по имени
SimpleSerializeRadio.csusing System;using System.Linq;using System.Collections.Generic;using System.Text.Json.Serialization;using System.Xml;using System.Xml.Serialization;namespace SimpleSerialize{ public class Radio { public bool HasTweeters; public bool HasSubWoofers; public List StationPresets; public string RadioId = "XF-552RR6"; public override string ToString() { var presets = string.Join(",", StationPresets.Select(i => i.ToString()).ToList()); return $"HasTweeters:{HasTweeters} HasSubWoofers:{HasSubWoofers} Station Presets:{presets}"; } }}Добавьте еще один файл класса по имени
Car.csusing System;using System.Text.Json.Serialization;using System.Xml;using System.Xml.Serialization;namespace SimpleSerialize{ public class Car { public Radio TheRadio = new Radio(); public bool IsHatchBack; public override string ToString() => $"IsHatchback:{IsHatchBack} Radio:{TheRadio.ToString()}"; }}Затем добавьте очередной файл класса по имени
JamesBondCar.csusing System;using System.Text.Json.Serialization;using System.Xml;using System.Xml.Serialization;namespace SimpleSerialize{ public class JamesBondCar : Car { public bool CanFly; public bool CanSubmerge; public override string ToString() => $"CanFly:{CanFly}, CanSubmerge:{CanSubmerge} {base.ToString()}"; }}Ниже показан код финального файла класса
Person.csusing System;using System.Text.Json.Serialization;using System.Xml;using System.Xml.Serialization;namespace SimpleSerialize{ public class Person { // Открытое поле. public bool IsAlive = true; /// Закрытое поле. private int PersonAge = 21; // Открытое свойство/закрытые данные. private string _fName = string.Empty; public string FirstName { get { return _fName; } set { _fName = value; } } public override string ToString() => $"IsAlive:{IsAlive} FirstName:{FirstName} Age:{PersonAge} "; }}В заключение модифицируйте содержимое файла
Program.csusing System;using System.Collections.Generic;using System.IO;using System.Text.Json;using System.Text.Json.Serialization;using System.Xml;using System.Xml.Serialization;using SimpleSerialize;Console.WriteLine("***** Fun with Object Serialization *****\n");// Создать объект JamesBondCar и установить состояние.JamesBondCar jbc = new(){ CanFly = true, CanSubmerge = false, TheRadio = new() { StationPresets = new() {89.3, 105.1, 97.1}, HasTweeters = true }};Person p = new(){ FirstName = "James", IsAlive = true};Итак, все готово для того, чтобы приступить к исследованию сериализации XML и JSON.
Сериализация и десериализация с помощью XmlSerializer
Пространство имен
System.XmlSystem.Xml.Serialization.XmlSerializerXmlSerializerУправление генерацией данных XML
Если у вас есть опыт работы с технологиями XML, то вы знаете, что часто важно гарантировать соответствие данных внутри документа XML набору правил, которые устанавливают действительность данных. Понятие действительного документа XML не имеет никакого отношения к синтаксической правильности элементов XML (вроде того, что все открывающие элементы должны иметь закрывающие элементы). Действительные документы отвечают согласованным правилам форматирования (например, поле
XПо умолчанию класс
XmlSerializerXmlSerializerSystem.Xml.Serialization
Разумеется, для управления тем, как
XmlSerializerSystem.Xml.SerializationНа заметку! Класс
XmlSerializerСериализация объектов с использованием XmlSerializer
Добавьте в свой файл
Program.csstatic void SaveAsXmlFormat(T objGraph, string fileName) { // В конструкторе XmlSerializer должен быть объявлен тип. XmlSerializer xmlFormat = new XmlSerializer(typeof(T)); using (Stream fStream = new FileStream(fileName, FileMode.Create, FileAccess.Write, FileShare.None)) { xmlFormat.Serialize(fStream, objGraph); }}Добавьте к операторам верхнего уровня такой код:
SaveAsXmlFormat(jbc, "CarData.xml");Console.WriteLine("=> Saved car in XML format!");SaveAsXmlFormat(p, "PersonData.xml");Console.WriteLine("=> Saved person in XML format!");Заглянув внутрь сгенерированного файла
CarData.xml xmlns:xsd= "http://www.w3.org/2001/XMLSchema" xmlns="http://www.MyCompany.com"> true false 89.3 105.1 97.1 XF-552RR6 false true false Если вы хотите указать специальное пространство имен XML, которое уточняет
JamesBondCarcanFlycanSubmergeJamesBondCar[Serializable, XmlRoot(Namespace = "http://www.MyCompany.com")]public class JamesBondCar : Car{ [XmlAttribute] public bool CanFly; [XmlAttribute] public bool CanSubmerge;...}Вот как будет выглядеть результирующий XML-документ (обратите внимание на открывающий элемент
xmlns:xsd="http://www.w3.org/2001/XMLSchema" CanFly="true" CanSubmerge="false" xmlns="http://www.MyCompany.com">...Исследуйте содержимое файла
PersonData.xml xmlns:xsd= "http://www.w3.org/2001/XMLSchema"> true James Важно отметить, что свойство
PersonAgeСериализация коллекций объектов
Теперь, когда вы видели, каким образом сохранять одиночный объект в потоке, давайте посмотрим,как сохранить набор объектов. Создайте локальную функцию, которая инициализирует список объектов
JamesBondCarstatic void SaveListOfCarsAsXml(){ // Сохранить список List объектов JamesBondCar. List myCars = new() { new JamesBondCar{CanFly = true, CanSubmerge = true}, new JamesBondCar{CanFly = true, CanSubmerge = false}, new JamesBondCar{CanFly = false, CanSubmerge = true}, new JamesBondCar{CanFly = false, CanSubmerge = false}, }; using (Stream fStream = new FileStream("CarCollection.xml", FileMode.Create, FileAccess.Write, FileShare.None)) { XmlSerializer xmlFormat = new XmlSerializer(typeof(List)); xmlFormat.Serialize(fStream, myCars); } Console.WriteLine("=> Saved list of cars!");}Наконец, добавьте следующую строку, чтобы задействовать новую функцию:
SaveListOfCarsAsXml(); Десериализация объектов и коллекций объектов
Десериализация XML буквально противоположна сериализации объектов (и коллекций объектов). Рассмотрим показанную далее локальную функцию для десериализации XML-разметки обратно в граф объектов. И снова обратите внимание, что тип, с которым нужно работать, должен быть передан конструктору
XmlSerializerstatic T ReadAsXmlFormat(string fileName) { // Создать типизированный экземпляр класса XmlSerializer. XmlSerializer xmlFormat = new XmlSerializer(typeof(T)); using (Stream fStream = new FileStream(fileName, FileMode.Open)) { T obj = default; obj = (T)xmlFormat.Deserialize(fStream); return obj; }}Добавьте к операторам верхнего уровня следующий код, чтобы восстановить XML-разметку обратно в объекты (или списки объектов):
JamesBondCar savedCar = ReadAsXmlFormat("CarData.xml"); Console.WriteLine("Original Car: {0}",savedCar.ToString());Console.WriteLine("Read Car: {0}",savedCar.ToString());List savedCars = ReadAsXmlFormat>("CarCollection.xml"); Сериализация и десериализация с помощью System.Text.Json
В пространстве имен
System.Text.JsonSystem.Text.Json.JsonSerializerУправление генерацией данных JSON
По умолчанию
JsonSerializer
Сериализация объектов с использованием JsonSerializer
Класс
JsonSerializerSerialize()Program.csstatic void SaveAsJsonFormat(T objGraph, string fileName) { File.WriteAllText(fileName, System.Text.Json.JsonSerializer.Serialize(objGraph));}Добавьте к своим операторам верхнего уровня следующий код:
SaveAsJsonFormat(jbc, "CarData.json");Console.WriteLine("=> Saved car in JSON format!");SaveAsJsonFormat(p, "PersonData.json");Console.WriteLine("=> Saved person in JSON format!");Когда вы будете исследовать файлы JSON, вас может удивить тот факт, что файл
CarData.jsonPersonData.jsonFirstnameJsonSerializerВключение полей
Включить открытые поля в генерируемые данные JSON можно двумя способами. Первый способ предусматривает использование класса
JsonSerializerOptionsJsonSerialize[Jsonlnclude]JsonSerializationOptionsJsonExcludeМодифицируйте метод
SaveAsJsonFormat()static void SaveAsJsonFormat(T objGraph, string fileName) { var options = new JsonSerializerOptions { IncludeFields = true, }; File.WriteAllText(fileName, System.Text.Json.JsonSerializer.Serialize(objGraph, options));}Вместо применения класса
JsonSerializerOptionsXmlJsonSerializer// Radio.cspublic class Radio{ [JsonInclude] public bool HasTweeters; [JsonInclude] public bool HasSubWoofers; [JsonInclude] public List StationPresets; [JsonInclude] public string RadioId = "XF-552RR6"; ...}// Car.cspublic class Car{ [JsonInclude] public Radio TheRadio = new Radio(); [JsonInclude] public bool IsHatchBack; ...}// JamesBondCar.cspublic class JamesBondCar : Car{ [XmlAttribute] [JsonInclude] public bool CanFly; [XmlAttribute] [JsonInclude] public bool CanSubmerge; ...}// Person.cspublic class Person{ // Открытое поле. [JsonInclude] public bool IsAlive = true; ...}Теперь в результате запуска кода любым способом все открытые свойства и поля записываются в файл. Однако, заглянув содержимое файла, вы увидите, что данные JSON были записаны в минифицированном виде, т.е. в формате, в котором все незначащие пробельные символы и разрывы строк удаляются. Формат является стандартным во многом из-за широкого использования JSON для служб REST и уменьшения размера пакета данных при передаче информации между службами по HTTP/HTTPS.
На заметку! Поля для сериализации JSON обрабатываются точно так же, как для десериализации JSON. Если вы выбирали вариант включения полей при сериализации JSON, то также должны делать это при десериализации JSON.
Понятный для человека вывод данных JSON
В дополнение к варианту с включением открытых полей экземпляр класса
JsonSerializerstatic void SaveAsJsonFormat(T objGraph, string fileName) { var options = new JsonSerializerOptions { IncludeFields = true, WriteIndented = true }; File.WriteAllText(fileName, System.Text.Json.JsonSerializer.Serialize(objGraph, options));}Заглянув в файл
CarData.json{ "CanFly": true, "CanSubmerge": false, "TheRadio": { "HasTweeters": true, "HasSubWoofers": false, "StationPresets": [ 89.3, 105.1, 97.1 ], "RadioId": "XF-552RR6" }, "IsHatchBack": false}Именование элементов JSON в стиле Pascal или в "верблюжьем" стиле
Стиль Pascal представляет собой формат, в котором первый символ и каждая важная часть имени начинается с символа в верхнем регистре. В предыдущем листинге данных JSON примером стиля Pascal служит
CanSubmergecanSubmergeПочему это важно? Дело в том, что большинство популярных языков (в том числе С#) чувствительно к регистру. Таким образом,
CanSubmergecanSubmergeК счастью,
JsonSerializerJsonSerializerstatic void SaveAsJsonFormat(T objGraph, string fileName) { JsonSerializerOptions options = new() { PropertyNamingPolicy = JsonNamingPolicy.CamelCase, IncludeFields = true, WriteIndented = true, }; File.WriteAllText(fileName, System.Text.Json.JsonSerializer.Serialize(objGraph, options));}Теперь выпускаемые данные JSON будут представлены в "верблюжьем" стиле:
{ "canFly": true, "canSubmerge": false, "theRadio": { "hasTweeters": true, "hasSubWoofers": false, "stationPresets": [ 89.3, 105.1, 97.1 ], "radioId": "XF-552RR6" }, "isHatchBack": false}При чтении данных JSON в коде C# по умолчанию поддерживается чувствительность к регистру символов. Политика именования соответствует настройке
PropertyNamingPolicyPropertyNamingPolicyCamelCaseПри десериализации JSON существует третий вариант — нейтральность к политике именования. Установка параметра
PropertyNameCaseInsensitivetruecanSubmergeCanSubmergeJsonSerializerOptions options = new(){ PropertyNameCaseInsensitive = true, IncludeFields = true};Обработка чисел с помощью JsonSerializer
Стандартным режимом обработки чисел является
StrictJsonSerializerOptionsNumberHandlingJsonNumberHandling
Перечисление
JsonNumberHandlingflagsJsonSerializerOptions options = new(){ ... NumberHandling = JsonNumberHandling.AllowReadingFromString & JsonNumberHandling.WriteAsString};При таком изменении данные JSON, созданные для класса
Car{ "canFly": true, "canSubmerge": false, "theRadio": { "hasTweeters": true, "hasSubWoofers": false, "stationPresets": [ "89.3", "105.1", "97.1" ], "radioId": "XF-552RR6" }, "isHatchBack": false}Потенциальные проблемы, связанные с производительностью, при использовании JsonSerializerOption
В случае применения класса
JsonSerializerOptionJsonSerializerOptions options = new(){ PropertyNameCaseInsensitive = true, PropertyNamingPolicy = JsonNamingPolicy.CamelCase, IncludeFields = true, WriteIndented = true, NumberHandling = JsonNumberHandling.AllowReadingFromString | JsonNumberHandling.WriteAsString};SaveAsJsonFormat(options, jbc, "CarData.json");Console.WriteLine("=> Saved car in JSON format!");SaveAsJsonFormat(options, p, "PersonData.json");Console.WriteLine("=> Saved person in JSON format!");static void SaveAsJsonFormat(JsonSerializerOptions options, T objGraph, string fileName)=> File.WriteAllText(fileName, System.Text.Json.JsonSerializer.Serialize(objGraph, options));Стандартные настройки свойств JsonSerializer для веб-приложений
При построении веб-приложений вы можете применять специализированный конструктор для установки следующих свойств:
PropertyNameCaseInsensitive = true,PropertyNamingPolicy = JsonNamingPolicy.CamelCase,NumberHandling = JsonNumberHandling.AllowReadingFromStringВы по-прежнему можете устанавливать дополнительные свойства через инициализацию объектов, например:
JsonSerializerOptions options = new(JsonSerializerDefaults.Web){ WriteIndented = true};Сериализация коллекций объектов
Сериализация коллекций объектов в данные JSON выполняется аналогично сериализации одиночного объекта. Поместите приведенную далее локальную функцию в конец операторов верхнего уровня:
static void SaveListOfCarsAsJson(JsonSerializerOptions options, string fileName){ // Сохранить список List объектов JamesBondCar. List myCars = new() { new JamesBondCar { CanFly = true, CanSubmerge = true }, new JamesBondCar { CanFly = true, CanSubmerge = false }, new JamesBondCar { CanFly = false, CanSubmerge = true }, new JamesBondCar { CanFly = false, CanSubmerge = false }, }; File.WriteAllText(fileName, System.Text.Json.JsonSerializer.Serialize(myCars, options)); Console.WriteLine("=> Saved list of cars!");}В заключение добавьте следующую строку, чтобы задействовать новую функцию:
SaveListOfCarsAsJson(options, "CarCollection.json");Десериализация объектов и коллекций объектов
Как и десериализация XML, десериализация JSON является противоположностью сериализации. Показанная ниже функция будет десериализировать данные JSON в тип, заданный при вызове обобщенной версии метода:
static T ReadAsJsonFormat(JsonSerializerOptions options, string fileName) => System.Text.Json.JsonSerializer.Deserialize (File.ReadAllText(fileName), options);Добавьте к операторам верхнего уровня следующий код для восстановления объектов (или списка объектов) из данных JSON:
JamesBondCar savedJsonCar = ReadAsJsonFormat(options, "CarData.json"); Console.WriteLine("Read Car: {0}", savedJsonCar.ToString());List savedJsonCars = ReadAsJsonFormat>(options, "CarCollection.json");Console.WriteLine("Read Car: {0}", savedJsonCar.ToString());Резюме
Глава начиналась с демонстрации использования типов
Directory(Info)File(Info)StreamStreamSystem.IOStreamWriterStringWriterBinaryWriterDriveTypeFileSystemWatcherВ главе также рассматривались службы сериализации объектов. Вы видели, что платформа .NET Core использует граф объектов, чтобы учесть полный набор связанных объектов, которые должны сохраняться в потоке. В заключение вы поработали с сериализацией и десериализацией XML и JSON.
Глава 21 Доступ к данным с помощью ADO.NET
Внутри платформы .NET Core определено несколько пространств имен, которые позволяют взаимодействовать с реляционными базами данных. Все вместе эти пространства имен известны как ADO.NET. В настоящей главе вы сначала ознакомитесь с общей ролью инфраструктуры ADO.NET, а также основными типами и пространствами имен, после чего будет обсуждаться тема поставщиков данных ADO.NET. Платформа .NET Core поддерживает многочисленные поставщики данных (как являющиеся частью .NET Core, так и доступные от независимых разработчиков), каждый из которых оптимизирован для взаимодействия с конкретной системой управления базами данных (СУБД), например, Microsoft SQL Server, Oracle, MySQL и т.д.
Освоив общую функциональность, предлагаемую различными поставщиками данных, вы узнаете о паттерне фабрики поставщиков данных. Вы увидите, что с использованием типов из пространства имен
System.DataSystem.Data.CommonMicrosoft.Data.SqlClientSystem.Data.OdbcSystem.Data.OledbДалее вы научитесь работать напрямую с поставщиком баз данных SQL Server, создавая и открывая подключения для извлечения данных и затем вставляя, обновляя и удаляя данные, и ознакомитесь с темой транзакций базы данных. Наконец, вы запустите средство массового копирования SQL Server с применением ADO.NET для загрузки списка записей внутрь базы данных.
На заметку! Внимание в настоящей главе сконцентрировано на низкоуровневой инфраструктуре ADO.NET. Начиная с главы 22, будет раскрываться инфраструктура объектно-реляционного отображения (object-relational mapping — ORM) производства Microsoft под названием Entity Framework (EF) Core. Поскольку инфраструктура EF Core для доступа к данным внутренне использует ADO.NET, хорошее понимание принципов работы ADO.NET жизненно важно при поиске и устранении проблем при доступе к данным. Кроме того, существуют задачи, решить которые с помощью EF Core не удастся (такие как выполнение массового копирования данных в SQL), и для их решения требуются знания ADO.NET.
Сравнение ADO.NET и ADO
Если у вас есть опыт работы с предшествующей моделью доступа к данным на основе СОМ от Microsoft (Active Data Objects — ADO) и вы только начинаете использовать платформу .NET Core, то имейте в виду, что инфраструктура ADO. NET имеет мало общего с ADO помимо наличия в своем названии букв "A", "D" и "О". В то время как определенная взаимосвязь между двумя системами действительно существует (скажем, в обеих присутствует концепция объектов подключений и объектов команд), некоторые знакомые по ADO типы (например,
RecordsetПоставщики данных ADO.NET
В ADO.NET нет единого набора типов, которые взаимодействовали бы с множеством СУБД. Взамен ADO.NET поддерживает многочисленные поставщики данных, каждый из которых оптимизирован для взаимодействия со специфичной СУБД. Первое преимущество такого подхода в том, что вы можете запрограммировать специализированный поставщик данных для доступа к любым уникальным средствам отдельной СУБД. Второе преимущество связано с тем, что поставщик данных может подключаться непосредственно к механизму интересующей СУБД без какого-либо промежуточного уровня отображения.
Выражаясь просто, поставщик данных — это набор типов, определенных в отдельном пространстве имен, которым известно, как взаимодействовать с конкретным источником данных. Безотносительно к тому, какой поставщик данных применяется, каждый из них определяет набор классов, предоставляющих основную функциональность. В табл. 21.1 описаны распространенные основные базовые классы и ключевые интерфейсы, которые они реализуют.
Хотя конкретные имена основных классов будут отличаться между поставщиками данных (например,
SqlConnectionOdbcConnectionDbConnectionIDbConnectionНа заметку! Когда речь идет об объекте подключения в ADO.NET, то на самом деле имеется в виду специфичный тип, производный от
DbConnectionSqlConnectionSqlCommandSqlDataReaderНа рис. 21.1 иллюстрируется место поставщиков данных в инфраструктуре ADO.NET. Клиентская сборка может быть приложением .NET Core любого типа: консольной программой, приложением Windows Forms, приложением WPF, веб-страницей ASP.NET Core, библиотекой кода .NET Core и т.д.
Кроме типов, показанных на рис. 21.1, поставщики данных будут предоставлять и другие типы; однако эти основные объекты определяют общие характеристики для всех поставщиков данных.
Поставщики данных ADO.NET
Подобно всем компонентам .NET Core поставщики данных поступают в виде пакетов NuGet. В их число входят поставщики, поддерживаемые Microsoft, но доступно и множество сторонних поставщиков. В табл. 21.2 описаны некоторые поставщики данных, поддерживаемые Microsoft.
Поставщик данных Microsoft SQL Server предлагает прямой доступ к хранилищам данных Microsoft SQL Server — и только к ним (включая SQL Azure). Пространство имен
Microsoft.Data.SqlClientНа заметку! Хотя
System.Data.SqlClientMicrosoft.Data.SqlClientПоставщик ODBC (
System.Data.OdbcSystem.Data.OdbcПоставщик данных OLE DB, который состоит из типов, определенных в пространстве имен
System.Data.OleDbТипы из пространства имен System.Data
Из всех пространств имен, относящихся к ADO.NET,
System.DataNoNullAllowedExceptionRowNotlnTableExceptionMissingPrimaryKeyExceptionSystem.Data
Следующей задачей будет исследование основных интерфейсов
System.DataРоль интерфейса IDbConnection
Интерфейс
IDbConnectionIDbConnectionpublic interface IDbConnection : IDisposable{ string ConnectionString { get; set; } int ConnectionTimeout { get; } string Database { get; } ConnectionState State { get; } IDbTransaction BeginTransaction(); IDbTransaction BeginTransaction(IsolationLevel il); void ChangeDatabase(string databaseName); void Close(); IDbCommand CreateCommand(); void Open(); void Dispose();}Роль интерфейса IDbTransaction
Перегруженный метод
BeginTransaction()IDbConnectionIDbTransactionpublic interface IDbTransaction : IDisposable{ IDbConnection Connection { get; } IsolationLevel IsolationLevel { get; } void Commit(); void Rollback(); void Dispose();}Роль интерфейса IDbCommand
Интерфейс
IDbCommandExecuteReader()public interface IDbCommand : IDisposable{ string CommandText { get; set; } int CommandTimeout { get; set; } CommandType CommandType { get; set; } IDbConnection Connection { get; set; } IDbTransaction Transaction { get; set; } IDataParameterCollection Parameters { get; } UpdateRowSource UpdatedRowSource { get; set; } void Prepare(); void Cancel(); IDbDataParameter CreateParameter(); int ExecuteNonQuery(); IDataReader ExecuteReader(); IDataReader ExecuteReader(CommandBehavior behavior); object ExecuteScalar(); void Dispose();}Роль интерфейсов IDbDataParameter и IDataParameter
Обратите внимание, что свойство
ParametersIDbCommandIDataParameterCollectionIDbDataParameterpublic interface IDbDataParameter : IDataParameter{// Плюс члены интерфейса IDataParameter. byte Precision { get; set; } byte Scale { get; set; } int Size { get; set; }}Интерфейс
IDbDataParameterIDataParameterpublic interface IDataParameter{ DbType DbType { get; set; } ParameterDirection Direction { get; set; } bool IsNullable { get; } string ParameterName { get; set; } string SourceColumn { get; set; } DataRowVersion SourceVersion { get; set; } object Value { get; set; }}Вы увидите, что функциональность интерфейсов I
DbDataParameterIDataParameterРоль интерфейсов IDbDataAdapter и IDataAdapter
Адаптеры данных используются для помещения объектов
DataSetIDbDataAdapterpublic interface IDbDataAdapter : IDataAdapter{ // Плюс члены интерфейса IDataAdapter. IDbCommand SelectCommand { get; set; } IDbCommand InsertCommand { get; set; } IDbCommand UpdateCommand { get; set; } IDbCommand DeleteCommand { get; set; }}В дополнение к показанным четырем свойствам адаптер данных ADO.NET также получает линии поведения, определенные базовым интерфейсом, т.е.
IDataAdapterIDataAdapterDataSetFill()Update()IDataAdapterTableMappingspublic interface IDataAdapter{ MissingMappingAction MissingMappingAction { get; set; } MissingSchemaAction MissingSchemaAction { get; set; } ITableMappingCollection TableMappings { get; } DataTable[] FillSchema(DataSet dataSet, SchemaType schemaType); int Fill(DataSet dataSet); IDataParameter[] GetFillParameters(); int Update(DataSet dataSet);}Роль интерфейсов IDataReader и IDataRecord
Следующим основным интерфейсом является
IDataReaderIDataReaderpublic interface IDataReader : IDisposable, IDataRecord{ // Плюс члены интерфейса IDataRecord int Depth { get; } bool IsClosed { get; } int RecordsAffected { get; } void Close(); DataTable GetSchemaTable(); bool NextResult(); bool Read(); Dispose();}Наконец, интерфейс
IDataReaderIDataRecordIDataRecordSystem.ObjectIDataRecordpublic interface IDataRecord{ int FieldCount { get; } object this[ int i ] { get; } object this[ string name ] { get; } bool GetBoolean(int i); byte GetByte(int i); long GetBytes(int i, long fieldOffset, byte[] buffer, int bufferoffset, int length); char GetChar(int i); long GetChars(int i, long fieldoffset, char[] buffer, int bufferoffset, int length); IDataReader GetData(int i); string GetDataTypeName(int i); DateTime GetDateTime(int i); Decimal GetDecimal(int i); double GetDouble(int i); Type GetFieldType(int i); float GetFloat(int i); Guid GetGuid(int i); short GetInt16(int i); int GetInt32(int i); long GetInt64(int i); string GetName(int i); int GetOrdinal(string name); string GetString(int i); object GetValue(int i); int GetValues(object[] values); bool IsDBNull(int i);}На заметку! Метод
IDataReader.IsDBNull()nullnullnullАбстрагирование поставщиков данных с использованием интерфейсов
К настоящему моменту вы должны лучше понимать общую функциональность, присущую всем поставщикам данных .NET Core. Вспомните, что хотя точные имена реализуемых типов будут отличаться между поставщиками данных, в коде такие типы применяются в схожей манере — в том и заключается преимущество полиморфизма на основе интерфейсов. Скажем, если определить метод, который принимает параметр
IDbConnectionpublic static void OpenConnection(IDbConnection cn){ // Открыть входное подключение для вызывающего кода. connection.Open();}На заметку! Использовать интерфейсы вовсе не обязательно; аналогичного уровня абстракции можно достичь путем применения абстрактных базовых классов (таких как
DbConnectionТо же самое справедливо для возвращаемых значений. Создайте новый проект консольного приложения .NET Core по имени
MyConnectionFactoryOleDbMicrosoft.Data.SqlClientSystem.Data.CommonSystem.Data.OdbcSystem.Data.OleDbДалее добавьте в проект новый файл по имени
DataProviderEnum.csnamespace MyConnectionFactory{ // Пакет OleDb предназначен только для Windows и в .NET Core не поддерживается. enum DataProviderEnum { SqlServer,#if PC OleDb,#endif Odbc, None }}Если на своей машине обработки вы работаете в среде Windows, тогда модифицируйте файл проекта, чтобы определить символ условной компиляции PC:
PC В случае использования Visual Studio щелкните правой кнопкой мыши на имени проекта и выберите в контекстном меню пункт Properties (Свойства). В открывшемся диалоговом окне Properties (Свойства) перейдите на вкладку Build (Сборка) и введите нужное значение в поле Conditional compiler symbols (Символы условной компиляции).
Следующий пример кода позволяет выбирать специфический объект подключения на основе значения из специального перечисления. В целях диагностики мы просто выводим лежащий в основе объект подключения с применением служб рефлексии.
using System;using System.Data;using System.Data.Odbc;#if PC using System.Data.OleDb;#endifusing Microsoft.Data.SqlClient;using MyConnectionFactory;Console.WriteLine("**** Very Simple Connection Factory *****\n");Setup(DataProviderEnum.SqlServer);#if PC Setup(DataProviderEnum.OleDb); // He поддерживается в macOS#endifSetup(DataProviderEnum.Odbc);Setup(DataProviderEnum.None);Console.ReadLine();void Setup(DataProviderEnum provider){ // Получить конкретное подключение. IDbConnection myConnection = GetConnection(provider); Console.WriteLine($"Your connection is a {myConnection?.GetType().Name ?? "unrecognized type"}"); // Открыть, использовать и закрыть подключение...}// Этот метод возвращает конкретный объект подключения// на основе значения перечисления DataProvider.IDbConnection GetConnection(DataProviderEnum dataProvider) => dataProvider switch { DataProviderEnum.SqlServer => new SqlConnection(),#if PC // He поддерживается в macOS DataProviderEnum.OleDb => new OleDbConnection(),#endif DataProviderEnum.Odbc => new OdbcConnection(), _ => null, };Преимущество работы с общими интерфейсами из пространства имен
System.DataSystem.Data.CommonSystem.Data.SqlClientК настоящему моменту вы написали (довольно простой) код ADO.NET, который позволяет создавать различные типы объектов подключений, специфичные для поставщика. Тем не менее, получение объекта подключения — лишь один аспект работы с ADO.NET. Чтобы построить полезную библиотеку фабрики поставщиков данных, необходимо также учитывать объекты команд, объекты чтения данных, адаптеры данных, объекты транзакций и другие типы, связанные с данными. Создание подобной библиотеки кода не обязательно будет трудным, но все-таки потребует написания значительного объема кода и затрат времени.
Начиная с версии .NET 2.0, такая функциональность встроена прямо в библиотеки базовых классов .NET. В .NET Core эта функциональность была значительно обновлена.
Вскоре мы исследуем упомянутый формальный API-интерфейс, но сначала понадобится создать специальную базу данных для применения в настоящей главе (и во многих последующих главах).
Установка SQL Server и Azure Data Studio
На протяжении оставшегося материала главы мы будем выполнять запросы в отношении простой тестовой базы данных SQL Server по имени
AutoLotAutoLotInventoryMakesOrdersCustomersCreditRisksНа заметку! Если ваша машина для разработки функционирует под управлением Windows и вы установили Visual Studio 2019, то уже имеете установленный экземпляр SQL Server Express (под названием
localdbУстановка SQL Server
В текущей главе и многих оставшихся главах книги вам будет нужен доступ к экземпляру SQL Server. Если вы применяете машину разработки, на которой установлена ОС, отличающаяся от Windows, и у вас нет доступного внешнего экземпляра SQL Server, или вы решили не использовать внешний экземпляр SQL Server, то можете запустить SQL Server внутри контейнера Docker на рабочей станции Мае или Linux. Контейнер Docker функционирует и на машинах Windows, поэтому вы можете выполнять примеры в книге с применением Docker независимо от выбранной ОС.
Установка SQL Server в контейнер Docker
В случае использования машины разработки, основанной не на Windows, и отсутствии доступного для примеров экземпляра SQL Server вы можете запустить SQL Server внутри контейнера Docker на рабочей станции Мае или Linux. Контейнер Docker работает также на машинах Windows, поэтому вы можете выполнять примеры в книге с применением Docker независимо от выбранной ОС.
На заметку! Контейнеризация является крупной темой, и в этой книге просто нет места, чтобы углубиться в подробности контейнеров или Docker. Книга охватывает ровно столько, чтобы вы могли проработать примеры.
Docker Desktop можно загрузить по ссылке
www.docker.com/get-startedНа заметку! Выбранный вариант контейнера (Windows или Linux) — это ОС, функционирующая внутри контейнера, а не ОС, установленная на рабочей станции.
Получение образа и запуск SQL Server 2019
Контейнеры основаны на образах, а каждый образ представляет собой многоуровневый набор, из которого образован финальный продукт. Чтобы получить образ, необходимый для запуска SQL Server 2019 в контейнере, откройте окно командной строки и введите следующую команду:
docker pull mcr.microsoft.com/mssql/server:2019-latestПосле загрузки образа на машину вам понадобится запустить SQL Server, для чего ввести следующую команду (целиком в одной строке):
docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=P@ssw0rd" -p 5433:1433 --name AutoLot -d mcr.microsoft.com/mssql/server:2019-latestПредыдущая команда принимает лицензионное соглашение конечного пользователя. устанавливает пароль (в реальности будет использоваться строгий пароль), устанавливает отображение портов (порт 5433 на вашей машине отображается на стандартный порт для SQL Server в контейнере (1433)), указывает имя контейнера (
AutoLotНа заметку! Это не те настройки, которые вы захотите использовать в реальной разработке. Информация о том, как изменить пароль системного администратора, и другие сведения доступны по ссылке
https://docs.microsoft.com/ru-ru/sql/linux/quickstart-install-connect-docker?view=sql-server-verl5&pivots=cs1-bashЧтобы убедиться в том, что Docker функционирует, введите в окне командной строки команду
docker ps -аC:\Users\japik>docker ps -aCONTAINER ID IMAGE STATUS PORTS NAMES347475cfb823 mcr.microsoft.com/mssql/server:2019-latest Up 6 minutes 0.0.0.0:5433->1433/tcp AutoLotЧтобы остановить контейнер, введите
docker stop 3474734747docker start 34747На заметку! Вы также можете использовать с командами Docker CLI имя контейнера (
AutoLotdocker start AutoLotЕсли вы желаете поработать с инструментальной панелью Docker, щелкните правой кнопкой мыши на значке Docker (в системном лотке) и выберите в контекстном меню пункт Dashboard (Инструментальная панель); вы должны увидеть образ, функционирующий на порте 5433. Наведите курсор мыши на имя образа и появятся команды для остановки, запуска и удаления (помимо прочих), как показано на рис. 21.2.
Установка SQL Server 2019
Вместе с Visual Studio 2019 устанавливается специальный экземпляр SQL Server (по имени (localdb)\mssqllocaldb). Если вы решили не использовать SQL Server Express LocalDB (или Docker) и работаете на машине Windows, тогда можете установить SQL Server 2019 Developer Edition. Продукт SQL Server 2019 Developer Edition бесплатен и доступен для загрузки по следующей ссылке:
https://www.microsoft.com/ru-ru/sql-server/sqlserver-downloadsИмея другую версию экземпляра, вы можете применять ее в этой книге; понадобится лишь надлежащим образом изменить параметры на экране подключения.
Установка IDE-среды SQL Server
Azure Data Studio — это новая IDE-среда для использования с SQL Server. Она является бесплатной и межплатформенной, а потому будет работать под управлением Windows, Mac или Linux. Загрузить ее можно по ссылке:
https://www.microsoft.com/en-us/sql-server/sql-server-downloadsНа заметку! Если вы работаете на машине Windows и отдаете предпочтение среде управления SQL Server (SQL Server Management Studio — SSMS), то можете загрузить последнюю версию по ссылке
https://docs.microsoft.com/ru-ru/sql/ssms/download-sql-server-management-studio-ssmsПодключение к SQL Server
После установки Azure Data Studio или SSMS настало время подключиться к экземпляру СУБД. В последующих разделах описано подключение к SQL Server в контейнере Docker или LocalDb. Если вы используете другой экземпляр SQL Server, тогда соответствующим образом обновите строку подключения.
Подключение к SQL Server в контейнере Docker
Чтобы подключиться к экземпляру SQL Server, функционирующему в контейнере Docker, сначала убедитесь, что он запущен и работает. Затем щелкните на элементе Create a connection (Создать подключение) в Azure Data Studio (рис. 21.3).
В диалоговом окне Connection Details (Детали подключения) введите
.,5433,5433sa
Подключение к SQL Server LocalDb
Чтобы подключиться к версии SQL Server Express LocalDb, установленной вместе с Visual Studio, приведите информацию о подключении в соответствие с показанной на рис. 21.5.
При подключении к LocalDb вы можете использовать аутентификацию Windows, поскольку экземпляр работает на той же машине, что и Azure Data Studio, и в том же контексте безопасности, что и текущий вошедший в систему пользователь.
Подключение к любому другому экземпляру SQL Server
Если вы подключаетесь к любому другому экземпляру SQL Server, тогда соответствующим образом обновите параметры подключения.
Восстановление базы данных AutoLot из резервной копии
Вместо того чтобы создавать базу данных с нуля, вы можете воспользоваться SSMS или Azure Data Studio для восстановления одной из резервных копий, содержащихся в папке
Chapter_21AutoLotWindows.ba_AutoLotDocker.ba_На заметку! GitHub по умолчанию игнорирует файлы с расширением
bakЬаbakКопирование файла резервной копии в имеющийся контейнер
Если вы работаете с SQL Server в контейнере Docker, то сначала должны скопировать файл резервной копии в контейнер. К счастью, Docker CLI предлагает механизм для взаимодействия с файловой системой контейнера. Первым делом создайте новый каталог для резервной копии с помощью следующей команды в окне командной троки на хост-машине:
docker exec -it AutoLot mkdir var/opt/mssql/backupСтруктура пути должна соответствовать ОС контейнера (в данном случае Ubuntu), даже если хост-машина функционирует под управлением Windows. Затем скопируйте резервную копию с применением показанной ниже команды (укажите для местоположения файла
AutoLotDocker.bak[Windows]docker cp .\AutoLotDocker.bak AutoLot:var/opt/mssql/backup[Non-Windows]docker cp ./AutoLotDocker.bak AutoLot:var/opt/mssql/backupОбратите внимание, что исходная структура каталогов соответствует хост-машине (в этом примере Windows), тогда как цель выглядит как имя контейнера и затем путь к каталогу (в формате целевой ОС).
Восстановление базы данных с помощью SSMS
Чтобы восстановить базу данных с применением SSMS, щелкните правой кнопкой мыши на узле Databases (Базы данных) в проводнике объектов и выберите в контекстном меню пункт Restore Database (Восстановить базу данных). Укажите вариант Device (Устройство) и щелкните на символе троеточия. Откроется диалоговое окно Select Backup Device (Выбор устройства с резервной копией).
Восстановление базы данных в экземпляр SQL Server (Docker)
Оставив в раскрывающемся списке Backup media type (Тип носителя резервной копии) выбранным вариант File (Файл), щелкните на кнопке Add (Добавить), перейдите к файлу
AutoLotDocker.bak
Восстановление базы данных в экземпляр SQL Server (Windows)
Оставив в раскрывающемся списке Backup media type выбранным вариант File, щелкните на кнопке Add, перейдите к файлу
AutoLotWindows.bak
Восстановление базы данных с помощью Azure Data Studio
Чтобы восстановить базу данных с использованием Azure Data Studio, выберите в области Tasks (Задачи) вариант Restore (Восстановить). Укажите в раскрывающемся списке Restore from (Восстановить из) вариант Backup file (Файл резервной копии) и затем выберите только что скопированный файл. Целевая база данных и связанные поля заполнятся автоматически, как показано на рис. 21.8.
На заметку! Процесс восстановления версии Windows резервной копии посредством Azure Data Studio аналогичен. Понадобится просто скорректировать имя файла и пути.
Создание базы данных AutoLot
Весь этот раздел посвящен созданию базы данных
AutoLotНа заметку! Все файлы сценариев находятся в подпапке по имени
ScriptsChapter_21Создание базы данных
Для создания базы данных AutoLot подключитесь к своему серверу баз данных с использованием Azure Data Studio. Откройте окно нового запроса, выбрав пункт меню File►New Query (Файл►Новый запрос) или нажав комбинацию <Ctrl+N>, и введите следующие команды SQL:
USE [master]GO/****** Object: Database [AutoLot50] Script Date: 12/20/2020 01:48:05 ******/CREATE DATABASE [AutoLot]GOALTER DATABASE [AutoLot50] SET RECOVERY SIMPLEGOКроме изменения режима восстановления на простой команда создает базу данных
AutoLotСоздание таблиц
База данных
AutoLotInventoryMakesCustomersOrdersCreditRisksСоздание таблицы Inventory
После создания базы данных можно приступать к созданию таблиц. Первой таблицей будет
InventoryUSE [AutoLot]GOCREATE TABLE [dbo].[Inventory]( [Id] [int] IDENTITY(1,1) NOT NULL, [MakeId] [int] NOT NULL, [Color] [nvarchar](50) NOT NULL, [PetName] [nvarchar](50) NOT NULL, [TimeStamp] [timestamp] NULL, CONSTRAINT [PK_Inventory] PRIMARY KEY CLUSTERED( [Id] ASC) ON [PRIMARY]) ON [PRIMARY]GOЩелкните на кнопке Run (или нажмите <F5>), чтобы создать таблицу
InventoryСоздание таблицы Makes
Таблица
InventoryMakesMakesUSE [AutoLot]GOCREATE TABLE [dbo].[Makes]([Id] [int] IDENTITY(1,1) NOT NULL, [Name] [nvarchar](50) NOT NULL, [TimeStamp] [timestamp] NULL, CONSTRAINT [PK_Makes] PRIMARY KEY CLUSTERED( [Id] ASC) ON [PRIMARY]) ON [PRIMARY]GOЩелкните на кнопке Run (или нажмите <F5>), чтобы создать таблицу
MakesСоздание таблицы Customers
Таблица
CustomersUSE [AutoLot]GOCREATE TABLE [dbo].[Customers]( [Id] [int] IDENTITY(1,1) NOT NULL, [FirstName] [nvarchar](50) NOT NULL, [LastName] [nvarchar](50) NOT NULL, [TimeStamp] [timestamp] NULL, CONSTRAINT [PK_Customers] PRIMARY KEY CLUSTERED( [Id] ASC) ON [PRIMARY]) ON [PRIMARY]GOЩелкните на кнопке Run (или нажмите <F5>), чтобы создать таблицу
CustomersСоздание таблицы Orders
Создаваемая следующей таблица
OrdersUSE [AutoLot]GOCREATE TABLE [dbo].[Orders]( [Id] [int] IDENTITY(1,1) NOT NULL, [CustomerId] [int] NOT NULL, [CarId] [int] NOT NULL, [TimeStamp] [timestamp] NULL, CONSTRAINT [PK_Orders] PRIMARY KEY CLUSTERED( [Id] ASC) ON [PRIMARY]) ON [PRIMARY]GOСоздание таблицы CreditRisks
Финальная таблица
CreditRisksUSE [AutoLot]GOCREATE TABLE [dbo].[CreditRisks]( [Id] [int] IDENTITY(1,1) NOT NULL, [FirstName] [nvarchar](50) NOT NULL, [LastName] [nvarchar](50) NOT NULL, [CustomerId] [int] NOT NULL, [TimeStamp] [timestamp] NULL, CONSTRAINT [PK_CreditRisks] PRIMARY KEY CLUSTERED( [Id] ASC) ON [PRIMARY]) ON [PRIMARY]GOСоздание отношений между таблицами
В последующих разделах будут добавляться отношения внешнего ключа между взаимосвязанными таблицами.
Создание отношения между таблицами Inventory и Makes
Откройте окно нового запроса, введите показанные далее команды SQL и щелкните на кнопке Run (или нажмите <F5>):
USE [AutoLot]GOCREATE NONCLUSTERED INDEX [IX_Inventory_MakeId] ON [dbo].[Inventory]( [MakeId] ASC) ON [PRIMARY]GOALTER TABLE [dbo].[Inventory] WITH CHECK ADD CONSTRAINT [FK_Make_Inventory] FOREIGN KEY([MakeId])REFERENCES [dbo].[Makes] ([Id])GOALTER TABLE [dbo].[Inventory] CHECK CONSTRAINT [FK_Make_Inventory]GOСоздание отношения между таблицами Inventory и Orders
Откройте окно нового запроса, введите следующие команды SQL и щелкните на кнопке Run (или нажмите <F5>):
USE [AutoLot]GOCREATE NONCLUSTERED INDEX [IX_Orders_CarId] ON [dbo].[Orders]( [CarId] ASC) ON [PRIMARY]GOALTER TABLE [dbo].[Orders] WITH CHECK ADD CONSTRAINT [FK_Orders_Inventory] FOREIGN KEY([CarId])REFERENCES [dbo].[Inventory] ([Id])GOALTER TABLE [dbo].[Orders] CHECK CONSTRAINT [FK_Orders_Inventory]GOСоздание отношения между таблицами Orders и Customers
Откройте окно нового запроса, введите приведенные ниже команды SQL и щелкните на кнопке Run (или нажмите <F5>):
USE [AutoLot]GOCREATE UNIQUE NONCLUSTERED INDEX [IX_Orders_CustomerId_CarId] ON [dbo].[Orders]( [CustomerId] ASC, [CarId] ASC) ON [PRIMARY]GOALTER TABLE [dbo].[Orders] WITH CHECK ADD CONSTRAINT [FK_Orders_Customers] FOREIGN KEY([CustomerId])REFERENCES [dbo].[Customers] ([Id])ON DELETE CASCADEGOALTER TABLE [dbo].[Orders] CHECK CONSTRAINT [FK_Orders_Customers]GOСоздание отношения между таблицами Customers и CreditRisks
Откройте окно нового запроса, введите приведенные ниже команды SQL и щелкните на кнопке Run (или нажмите <F5>):
USE [AutoLot]GOCREATE NONCLUSTERED INDEX [IX_CreditRisks_CustomerId] ON [dbo].[CreditRisks]( [CustomerId] ASC) ON [PRIMARY]GOALTER TABLE [dbo].[CreditRisks] WITH CHECK ADD CONSTRAINT [FK_CreditRisks_Customers] FOREIGN KEY([CustomerId])REFERENCES [dbo].[Customers] ([Id])ON DELETE CASCADEGOALTER TABLE [dbo].[CreditRisks] CHECK CONSTRAINT [FK_CreditRisks_Customers]GOНа заметку! Наличие столбцов
FirstName/LastNameСоздание хранимой процедуры GetPetName
Позже в главе вы узнаете, как использовать ADO.NET для вызова хранимых процедур. Возможно, вам уже известно, что хранимые процедуры — это подпрограммы кода, хранящиеся внутри базы данных, которые выполняют какие-то действия. Подобно методам C# хранимые процедуры могут возвращать данные или просто работать с данными, ничего не возвращая. Добавьте одиночную хранимую процедуру, которая будет возвращать дружественное имя автомобиля на основе предоставленного
carIdUSE [AutoLot]GOCREATE PROCEDURE [dbo].[GetPetName]@carID int,@petName nvarchar(50) outputASSELECT @petName = PetName from dbo.Inventory where Id = @carIDGOЩелкните на кнопке Run (или нажмите <F5>), чтобы создать хранимую процедуру.
Добавление тестовых записей
В отсутствие данных базы данных не особо интересны, поэтому удобно иметь сценарии, которые способны быстро загрузить тестовые записи в базу данных.
Записи таблицы Makes
Создайте новый запрос и выполните показанные далее операторы SQL для добавления записей в таблицу
MakesUSE [AutoLot]GOSET IDENTITY_INSERT [dbo].[Makes] ONINSERT INTO [dbo].[Makes] ([Id], [Name]) VALUES (1, N'VW')INSERT INTO [dbo].[Makes] ([Id], [Name]) VALUES (2, N'Ford')INSERT INTO [dbo].[Makes] ([Id], [Name]) VALUES (3, N'Saab')INSERT INTO [dbo].[Makes] ([Id], [Name]) VALUES (4, N'Yugo')INSERT INTO [dbo].[Makes] ([Id], [Name]) VALUES (5, N'BMW')INSERT INTO [dbo].[Makes] ([Id], [Name]) VALUES (6, N'Pinto')SET IDENTITY_INSERT [dbo].[Makes] OFFЗаписи таблицы Inventory
Чтобы добавить записи в таблицу
InventoryUSE [AutoLot]GOSET IDENTITY_INSERT [dbo].[Inventory] ONGOINSERT INTO [dbo].[Inventory] ([Id], [MakeId], [Color], [PetName]) VALUES (1, 1, N'Black', N'Zippy')INSERT INTO [dbo].[Inventory] ([Id], [MakeId], [Color], [PetName]) VALUES (2, 2, N'Rust', N'Rusty')INSERT INTO [dbo].[Inventory] ([Id], [MakeId], [Color], [PetName]) VALUES (3, 3, N'Black', N'Mel')INSERT INTO [dbo].[Inventory] ([Id], [MakeId], [Color], [PetName]) VALUES (4, 4, N'Yellow', N'Clunker')INSERT INTO [dbo].[Inventory] ([Id], [MakeId], [Color], [PetName]) VALUES (5, 5, N'Black', N'Bimmer')INSERT INTO [dbo].[Inventory] ([Id], [MakeId], [Color], [PetName]) VALUES (6, 5, N'Green', N'Hank')INSERT INTO [dbo].[Inventory] ([Id], [MakeId], [Color], [PetName]) VALUES (7, 5, N'Pink', N'Pinky')INSERT INTO [dbo].[Inventory] ([Id], [MakeId], [Color], [PetName]) VALUES (8, 6, N'Black', N'Pete')INSERT INTO [dbo].[Inventory] ([Id], [MakeId], [Color], [PetName]) VALUES (9, 4, N'Brown', N'Brownie')SET IDENTITY_INSERT [dbo].[Inventory] OFFGOДобавление тестовых записей в таблицу Customers
Чтобы добавить записи в таблицу
CustomersUSE [AutoLot]GOSET IDENTITY_INSERT [dbo].[Customers] ONINSERT INTO [dbo].[Customers] ([Id], [FirstName], [LastName]) VALUES (1, N'Dave', N'Brenner')INSERT INTO [dbo].[Customers] ([Id], [FirstName], [LastName]) VALUES (2, N'Matt', N'Walton')INSERT INTO [dbo].[Customers] ([Id], [FirstName], [LastName]) VALUES (3, N'Steve', N'Hagen')INSERT INTO [dbo].[Customers] ([Id], [FirstName], [LastName]) VALUES (4, N'Pat', N'Walton')INSERT INTO [dbo].[Customers] ([Id], [FirstName], [LastName]) VALUES (5, N'Bad', N'Customer')SET IDENTITY_INSERT [dbo].[Customers] OFFДобавление тестовых записей в таблицу Orders
Теперь добавьте данные в таблицу
OrdersUSE [AutoLot]GOSET IDENTITY_INSERT [dbo].[Orders] ONINSERT INTO [dbo].[Orders] ([Id], [CustomerId], [CarId]) VALUES (1, 1, 5)INSERT INTO [dbo].[Orders] ([Id], [CustomerId], [CarId]) VALUES (2, 2, 1)INSERT INTO [dbo].[Orders] ([Id], [CustomerId], [CarId]) VALUES (3, 3, 4)INSERT INTO [dbo].[Orders] ([Id], [CustomerId], [CarId]) VALUES (4, 4, 7)SET IDENTITY_INSERT [dbo].[Orders] OFFДобавление тестовых записей в таблицу CreditRisks
Финальный шаг связан с добавлением данных в таблицу
CreditRisksUSE [AutoLot]GOSET IDENTITY_INSERT [dbo].[CreditRisks] ONINSERT INTO [dbo].[CreditRisks] ([Id], [FirstName], [LastName], [CustomerId]) VALUES (1, N'Bad', N'Customer', 5)SET IDENTITY_INSERT [dbo].[CreditRisks] OFFНа этом создание базы данных
AutoLotМодель фабрики поставщиков данных ADO.NET
Модель фабрики поставщиков данных .NET Core позволяет строить единую кодовую базу, используя обобщенные типы доступа к данным. Чтобы разобраться в реализации фабрики поставщиков данных, вспомните из табл. 21.1, что все классы внутри поставщика данных являются производными от тех же самых базовых классов, определенных внутри пространства имен
System.Data.Common•
DbCommand•
DbConnection•
DbDataAdapter•
DbDataReader•
DbParameter•
DbTransactionКаждый поставщик данных, совместимый с .NET Core, содержит класс, производный от
System.Data.Common.DbProviderFactoryDbProviderFactorypublic abstract class DbProviderFactory{ public virtual bool CanCreateDataAdapter { get;}; public virtual bool CanCreateCommandBuilder { get;}; public virtual DbCommand CreateCommand(); public virtual DbCommandBuilder CreateCommandBuilder(); public virtual DbConnection CreateConnection(); public virtual DbConnectionStringBuilder CreateConnectionStringBuilder(); public virtual DbDataAdapter CreateDataAdapter(); public virtual DbParameter CreateParameter(); public virtual DbDataSourceEnumerator CreateDataSourceEnumerator();}Чтобы получить производный от
DbProviderFactoryDbProviderFactory// Получить фабрику для поставщика данных SQL.DbProviderFactory sqlFactory = Microsoft.Data.SqlClient.SqlClientFactory.Instance;Чтобы сделать программу более универсальной, вы можете создать фабрику
DbProviderFactoryDbProviderFactoryappsettings.jsonПолный пример фабрики поставщиков данных
В качестве завершенного примера создайте новый проект консольного приложения C# (по имени
DataProviderFactoryAutoLotDataProviderFactory.exeНачните с добавления нового элемента
ItemGroupMicrosoft.Extensions.Configuration.JsonSystem.Data.CommonSystem.Data.OdbcSystem.Data.OleDbMicrosoft.Data.SqlClientdotnet add DataProviderFactory package Microsoft.Data.SqlClientdotnet add DataProviderFactory package System.Data.Commondotnet add DataProviderFactory package System.Data.Odbcdotnet add DataProviderFactory package System.Data.OleDbdotnet add DataProviderFactory package Microsoft.Extensions.Configuration.JsonОпределите символ условной компиляции PC (в случае применения Windows):
PC Далее добавьте новый файл по имени
DataProviderEnum.csnamespace DataProviderFactory{ // OleDb поддерживается только в Windows, но не в .NET Core. enum DataProviderEnum { SqlServer, #if PC OleDb, #endif Odbc } } Добавьте в проект новый файл JSON по имени
appsettings.json{ "ProviderName": "SqlServer", //"ProviderName": "OleDb", //"ProviderName": "Odbc", "SqlServer": { // Для localdb используйте @"Data Source=(localdb)\ // mssqllocaldb;Integrated Security=true; Initial Catalog=AutoLot" "ConnectionString": "Data Source=.,5433;User Id=sa;Password=P@ssw0rd;Initial Catalog=AutoLot" }, "Odbc": { // Для localdb используйте @"Driver={ODBC Driver 17 for SQL Server}; Server=(localdb)\mssqllocaldb;Database=AutoLot;Trusted_Connection=Yes"; "ConnectionString": "Driver={ODBC Driver 17 for SQL Server}; Server=localhost,5433; Database=AutoLot;UId=sa;Pwd=P@ssw0rd;" }, "OleDb": { // Для localdb используйте @"Provider=SQLNCLI11; // Data Source=(localdb)\mssqllocaldb;Initial Catalog=AutoLot;Integrated Security=SSPI"), "ConnectionString": "Provider=SQLNCLI11;Data Source=.,5433; User Id=sa;Password=P@ssw0rd; Initial Catalog=AutoLot;" }}Сообщите MSBuild о необходимости копировать файл JSON в выходной каталог при каждой компиляции. Модифицируйте файл проекта, как показано ниже:
Always На заметку! Элемент
CopyToOutputDirectoryAlwaysТеперь, располагая подходящим файлом
appsettings.jsonproviderconnectionstringusingProgram.csusing System;using System.Data.Common;using System.Data.Odbc;#if PC using System.Data.OleDb;#endifusing System.IO;using Microsoft.Data.SqlClient;using Microsoft.Extensions.Configuration;Очистите весь код в
Program.csusing System;using System.Data.Common;using System.Data.Odbc;#if PC using System.Data.OleDb;#endifusing System.IO;using Microsoft.Data.SqlClient;using Microsoft.Extensions.Configuration;using DataProviderFactory;Console.WriteLine("***** Fun with Data Provider Factories *****\n");var (provider, connectionString) = GetProviderFromConfiguration();DbProviderFactory factory = GetDbProviderFactory(provider);// Теперь получить объект подключения.using (DbConnection connection = factory.CreateConnection()){ if (connection == null) { Console.WriteLine($"Unable to create the connection object"); // He удалось создать объект подключения return; } Console.WriteLine($"Your connection object is a: {connection.GetType().Name}"); connection.ConnectionString = connectionString; connection.Open(); // Создать объект команды. DbCommand command = factory.CreateCommand(); if (command == null) { Console.WriteLine($"Unable to create the command object"); // He удалось создать объект команды return; } Console.WriteLine($"Your command object is a: {command.GetType().Name}"); command.Connection = connection; command.CommandText = "Select i.Id, m.Name From Inventory i inner join Makes m on m.Id = i.MakeId "; // Вывести данные с помощью объекта чтения данных. using (DbDataReader dataReader = command.ExecuteReader()) { Console.WriteLine($"Your data reader object is a: {dataReader.GetType().Name}"); Console.WriteLine("\n***** Current Inventory *****"); while (dataReader.Read()) { Console.WriteLine($"-> Car #{dataReader["Id"]} is a {dataReader["Name"]}."); } }}Console.ReadLine();Добавьте приведенный далее код в конец файла
Program.csDataProviderEnumDbProviderFactorystatic DbProviderFactory GetDbProviderFactory(DataProviderEnum provider) => provider switch{ DataProviderEnum.SqlServer => SqlClientFactory.Instance, DataProviderEnum.Odbc => OdbcFactory.Instance,#if PC DataProviderEnum.OleDb => OleDbFactory.Instance,#endif _ => null};static (DataProviderEnum Provider, string ConnectionString) GetProviderFromConfiguration(){ IConfiguration config = new ConfigurationBuilder() .SetBasePath(Directory.GetCurrentDirectory()) .AddJsonFile("appsettings.json", true, true) .Build(); var providerName = config["ProviderName"]; if (Enum.TryParse (providerName, out DataProviderEnum provider)) { return (provider,config[$"{providerName}:ConnectionString"]); }; throw new Exception("Invalid data provider value supplied.");}Обратите внимание, что в целях диагностики с помощью служб рефлексии выводятся имена лежащих в основе объектов подключения, команды и чтения данных. В результате запуска приложения в окне консоли отобразятся текущие данные из таблицы
InventoryAutoLot***** Fun with Data Provider Factories *****Your connection object is a: SqlConnectionYour command object is a: SqlCommandYour data reader object is a: SqlDataReader***** Current Inventory *****-> Car #1 is a VW.-> Car #2 is a Ford.-> Car #3 is a Saab.-> Car #4 is a Yugo.-> Car #9 is a Yugo.-> Car #5 is a BMW.-> Car #6 is a BMW.-> Car #7 is a BMW.-> Car #8 is a Pinto.Измените файл настроек, чтобы указать другого поставщика. Код выберет связанную строку подключения и произведет тот же вывод, что и ранее, исключая специфичную для типа информацию.
Конечно, в зависимости от опыта работы с ADO.NET у вас может не быть полного понимания того, что в действительности делают объекты подключений, команд и чтения данных. Не вдаваясь в детали, пока просто запомните, что модель фабрики поставщиков данных ADO.NET позволяет строить единственную кодовую базу, которая способна потреблять разнообразные поставщики данных в декларативной манере.
Потенциальный недостаток модели фабрики поставщиков данных
Хотя модель фабрики поставщиков данных характеризуется высокой мощностью, вы должны обеспечить применение в кодовой базе только типов и методов, общих для всех поставщиков, посредством членов абстрактных базовых классов. Следовательно, при разработке кодовой базы вы ограничены членами
DbConnectionDbCommandSystem.Data.CommonС учетом сказанного вы можете прийти к заключению, что такой обобщенный подход предотвращает прямой доступ к дополнительным возможностям отдельной СУБД. Если вы должны быть в состоянии обращаться к специфическим членам лежащего в основе поставщика (например,
SqlConnectionif (connection is SqlConnection sqlConnection){ // Вывести информацию об используемой версии SQL Server. WriteLine(sqlConnection.ServerVersion);}Однако в таком случае кодовая база становится чуть труднее в сопровождении (и менее гибкой), потому что придется добавить некоторое количество проверок времени выполнения. Тем не менее, если необходимо строить библиотеки доступа к данным наиболее гибким способом из числа возможных, тогда модель фабрики поставщиков данных предлагает замечательный механизм для решения такой задачи.
На заметку! Инфраструктура Entity Framework Core и ее поддержка внедрения зависимостей значительно упрощает построение библиотек доступа к данным, которым необходим доступ к разрозненным источникам данных.
Первый пример завершен, и теперь можно углубляться в детали работы с ADO.NET.
Погружение в детали объектов подключений, команд и чтения данных
Как было показано в предыдущем примере, ADO.NET позволяет взаимодействовать с базой данных с помощью объектов подключения, команд и чтения данных имеющегося поставщика данных. Для более глубокого понимания упомянутых объектов в ADO.NET будет создан расширенный пример.
В предыдущем примере демонстрировалось, что для подключения к базе данных и чтения записей посредством объекта чтения данных, необходимо было выполнить следующие шаги.
1. Создать, сконфигурировать и открыть объект подключения.
2. Создать и сконфигурировать объект команды, указав объект подключения в аргументе конструктора или через свойство
Connection3. Вызвать метод
ExecuteReader()4. Обработать каждую запись с применением метода
Read()Для начала создайте новый проект консольного приложения по имени
AutoLot.DataReaderMicrosoft.Data.SqlClientProgram.csusing System;using Microsoft.Data.SqlClient;Console.WriteLine("***** Fun with Data Readers *****\n");// Создать и открыть подключение.using (SqlConnection connection = new SqlConnection()){ connection.ConnectionString = @" Data Source=.,5433;User Id=sa;Password=P@ssw0rd;Initial Catalog=AutoLot"; connection.Open(); // Создать объект команды SQL. string sql = @"Select i.id, m.Name as Make, i.Color, i.Petname FROM Inventory i INNER JOIN Makes m on m.Id = i.MakeId"; SqlCommand myCommand = new SqlCommand(sql, connection); // Получить объект чтения данных с помощью ExecuteReader(). using (SqlDataReader myDataReader = myCommand.ExecuteReader()) { // Пройти в цикле по результатам. while (myDataReader.Read()) { Console.WriteLine($"-> Make: {myDataReader["Make"]}, PetName: {myDataReader ["PetName"]}, Color: {myDataReader["Color"]}."); } }}Console.ReadLine();Работа с объектами подключений
При работе с поставщиком данных первым делом понадобится установить сеанс с источником данных, используя объект подключения (производного от
DbConnectionИз приведенного выше кода можно сделать вывод, что имя
Initial CatalogData Source"., 5433"localhostимя_машины,порт\экземплярMYSERVER\SQLSERVER2019MYSERVERSQLSERVER2019.localhostAutoLot"Data Source=localhost"Кроме того, можно указать любое количество конструкций, которые представляют учетные данные безопасности. Если
Integrated SecuritytrueКогда строка подключения готова, можно вызывать метод
Open()ConnectionstringOpen()Close()DbConnection
Свойства типа
DbConnectionConnect Timeoutusing(SqlConnection connection = new SqlConnection()){ connection.ConnectionString = @" Data Source=.,5433;User Id=sa;Password=P@ssw0rd; Initial Catalog=AutoLot;Connect Timeout=30"; connection.Open();}Следующий код выводит детали о переданной ему строке подключения
SqlConnectionstatic void ShowConnectionStatus(SqlConnection connection){ // Вывести различные сведения о текущем объекте подключения. Console.WriteLine("***** Info about your connection *****"); Console.WriteLine($@"Database location: {connection.DataSource}"); // Местоположение базы данных Console.WriteLine($"Database name: {connection.Database}"); // Имя базы данных Console.WriteLine($@"Timeout: {connection.ConnectionTimeout}"); // Таймаут Console.WriteLine($"Connection state: {connection.State}\n"); // Состояние подключения}Большинство этих свойств понятно без объяснений, но свойство
StateConnectionStatepublic enum ConnectionState{ Broken, Closed, Connecting, Executing, Fetching, Open}Однако допустимыми значениями
ConnectionStateConnectionState.OpenConnectionState.ConnectingConnectionState.ClosedConnectionState.ClosedРабота с объектами ConnectionStringBuilder
Работа со строками подключения в коде может быть утомительной, т.к. они часто представлены в виде строковых литералов, которые в лучшем случае трудно обрабатывать и контролировать на предмет ошибок. Совместимые с .NET Core поставщики данных поддерживают объекты построителей строк подключения, которые позволяют устанавливать пары "имя-значение" с применением строго типизированных свойств. Взгляните на следующую модификацию текущего кода:
var connectionStringBuilder = new SqlConnectionStringBuilder{ InitialCatalog = "AutoLot", DataSource = ".,5433", UserID = "sa", Password = "P@ssw0rd", ConnectTimeout = 30}; connection.ConnectionString = connectionStringBuilder.ConnectionString;В этой версии создается экземпляр класса
SqlConnectionStringBuilderConnectionStringРабота с объектами команд
Теперь, когда вы лучше понимаете роль объекта подключения, следующей задачей будет выяснение, каким образом отправлять SQL-запросы базе данных. Тип
SqlCommandDbCommandCommandTypeCommandTypepublic enum CommandType{ StoredProcedure, TableDirect, Text // Стандартное значение.}При создании объекта команды SQL-запрос можно указывать как параметр конструктора или устанавливать свойство
CommandTextConnection// Создать объект команды посредством аргументов конструктора.string sql = @"Select i.id, m.Name as Make, i.Color, i.Petname FROM Inventory i INNER JOIN Makes m on m.Id = i.MakeId";SqlCommand myCommand = new SqlCommand(sql, connection);// Создать еще один объект команды через свойства.SqlCommand testCommand = new SqlCommand();testCommand.Connection = connection;testCommand.CommandText = sql;Учтите, что в текущий момент вы еще фактически не отправили SQL-запрос базе данных
AutoLotВ табл. 21.5 описаны некоторые дополнительные члены типа
DbCommand
Работа с объектами чтения данных
После установления активного подключения и объекта команды SQL следующим действием будет отправка запроса источнику данных. Как вы наверняка догадались, это можно делать несколькими путями. Самый простой и быстрый способ получения информации из хранилища данных предлагает тип
DbDataReaderIDataReaderОбъекты чтения данных удобны, если нужно быстро пройти по большому объему данных без необходимости иметь их представление в памяти. Например, в случае запрашивания 20 000 записей из таблицы с целью их сохранения в текстовом файле помещение такой информации в объект
DataSetDataSetБолее эффективный подход предусматривает создание объекта чтения данных, который максимально быстро проходит по всем записям. Тем не менее, имейте в виду, что объекты чтения данных (в отличие от объектов адаптеров данных, которые рассматриваются позже) удерживают подключение к источнику данных открытым до тех пор, пока вы его явно не закроете.
Объекты чтения данных получаются из объекта команды с применением вызова
ExecuteReader()[]В приведенном ниже примере использования объекта чтения данных задействован метод
Read()falseClose()...// Получить объект чтения данных посредством ExecuteReader().using(SqlDataReader myDataReader = myCommand.ExecuteReader()){ // Пройти в цикле по результатам. while (myDataReader.Read()) { WriteLine($"-> Make: { myDataReader["Make"]}, PetName: { myDataReader["PetName"]}, Color: { myDataReader["Color"]}."); }}ReadLine();Индексатор объекта чтения данных перегружен для приема либо значения
stringintFieldCountwhile (myDataReader.Read()){ for (int i = 0; i < myDataReader.FieldCount; i++) { Console.Write(i != myDataReader.FieldCount - 1 ? $"{myDataReader.GetName(i)} = {myDataReader.GetValue(i)}, " : $"{myDataReader.GetName(i)} = {myDataReader.GetValue(i)} "); } Console.WriteLine();}Если в настоящий момент скомпилировать проект и запустить его на выполнение, то должен отобразиться список всех автомобилей из таблицы Inventory базы данных
AutoLot***** Fun with Data Readers ********** Info about your connection *****Database location: .,5433Database name: AutoLotTimeout: 30Connection state: Openid = 1, Make = VW, Color = Black, Petname = Zippyid = 2, Make = Ford, Color = Rust, Petname = Rustyid = 3, Make = Saab, Color = Black, Petname = Melid = 4, Make = Yugo, Color = Yellow, Petname = Clunkerid = 5, Make = BMW, Color = Black, Petname = Bimmerid = 6, Make = BMW, Color = Green, Petname = Hankid = 7, Make = BMW, Color = Pink, Petname = Pinkyid = 8, Make = Pinto, Color = Black, Petname = Peteid = 9, Make = Yugo, Color = Brown, Petname = BrownieПолучение множества результирующих наборов с использованием объекта чтения данных
Объекты чтения данных могут получать несколько результирующих наборов с применением одиночного объекта команды. Например, если вы хотите получить все строки из таблицы
InventoryCustomersSelectsql += ";Select * from Customers;";На заметку! Точка с запятой в начале строки опечаткой не является. В случае использования множества операторов они должны разделяться точками с запятой. И поскольку начальный оператор не содержал точку с запятой, она добавлена здесь в начало второго оператора.
После получения объекта чтения данных можно выполнить проход по каждому результирующему набору, используя метод
NextResult()do{ while (myDataReader.Read()) { for (int i = 0; i < myDataReader.FieldCount; i++) { Console.Write(i != myDataReader.FieldCount - 1 ? $"{myDataReader.GetName(i)} = {myDataReader.GetValue(i)}, " : $"{myDataReader.GetName(i)} = {myDataReader.GetValue(i)} "); } Console.WriteLine(); } Console.WriteLine();} while (myDataReader.NextResult());К этому моменту вы уже должны лучше понимать функциональность, предлагаемую объектами чтения данных. Не забывайте, что объект чтения данных способен обрабатывать только SQL-операторы
SelectInsertUpdateDeleteРабота с запросами создания обновления и удаления
Метод
ExecuteReader()ExecuteNonQuery()На заметку! Говоря формально, "отличающийся от запроса" означает оператор SQL, который не возвращает результирующий набор. Таким образом, операторы Select являются запросами, тогда как
InsertUpdateDeleteExecuteNonQuery()intВсе примеры взаимодействия с базами данных, рассмотренные в настоящей главе до сих пор, располагали только открытыми подключениями и применяли их для извлечения данных. Это лишь одна часть работы с базами данных; инфраструктура доступа к данным не приносила бы так много пользы, если бы полностью не поддерживала также функциональность создания, чтения, обновления и удаления (
createreadupdatedeleteExecuteNonQuery()Начните с создания нового проекта библиотеки классов C# по имени
AutoLot.DALAutoLotMicrosoft.Data.SqlClientПеред построением класса, который будет управлять операциями с данными, сначала понадобится создать класс С#, представляющий запись из таблицы
InventoryСоздание классов Car и CarViewModel
В современных библиотеках доступа к данным применяются классы (обычно называемые моделями или сущностями), которые используются для представления и транспортировки данных из базы данных. Кроме того, классы могут применяться для представления данных, которое объединяет две и большее количество таблиц, делая данные более значимыми. Сущностные классы используются при работе с каталогом базы данных (для операторов обновления), а классы модели представления применяются для отображения данных в осмысленной манере. В следующей главе вы увидите, что такие концепции являются основой инфраструктур объектно-реляционного отображения (object relational mapping — ORM) вроде Entity Framework Core, но пока вы просто собираетесь создать одну модель (для низкоуровневой строки хранилища) и одну модель представления (объединяющую строку хранилища и связанные данные в таблице
MakesModelsCar.csCarViewModel.cs// Car.csnamespace AutoLot.Dal.Models{ public class Car { public int Id { get; set; } public string Color { get; set; } public int MakeId { get; set; } public string PetName { get; set; } public byte[] TimeStamp {get;set;} }}// CarViewModel.csnamespace AutoLot.Dal.Models{ public class CarViewModel : Car { public string Make { get; set; } }}На заметку! Если вы не знакомы с типом данных
TimeStampbyte[]Новые классы будут применяться вскоре.
Добавление класса InventoryDal
Далее добавьте новую папку по имени
DataOperationsInventoryDal.cspublicInventoryAutoLotusing System; using System.Collections.Generic;using System.Data;using AutoLot.Dal.Models;using Microsoft.Data.SqlClient;Добавление конструкторов
Создайте конструктор, который принимает строковый параметр (
connectionStringnamespace AuoLot.Dal.DataOperations{ public class InventoryDal { private readonly string _connectionString; public InventoryDal() : this( @"Data Source=.,5433;User Id=sa;Password=P@ssw0rd; Initial Catalog=AutoLot") { } public InventoryDal(string connectionString) => _connectionString = connectionString; }}Открытие и закрытие подключения
Добавьте переменную уровня класса, которая будет хранить подключение, применяемое кодом доступа к данным. Добавьте также два метода: один для открытия подключения
(OpenConnection()CloseConnection()CloseConnection()Close()private SqlConnection _sqlConnection = null;private void OpenConnection(){ _sqlConnection = new SqlConnection { ConnectionString = _connectionString }; _sqlConnection.Open();}private void CloseConnection(){ if (_sqlConnection?.State != ConnectionState.Closed) { _sqlConnection?.Close(); }}Ради краткости в большинстве методов класса
InventoryDaltry/catchДобавление реализации IDisposable
Добавьте к определению класса интерфейс
IDisposablepublic class InventoryDal : IDisposable{ ...}Затем реализуйте шаблон освобождения, вызывая
Dispose()SqlConnectionbool _disposed = false;protected virtual void Dispose(bool disposing){ if (_disposed) { return; } if (disposing) { _sqlConnection.Dispose(); } _disposed = true;}public void Dispose(){ Dispose(true); GC.SuppressFinalize(this);}Добавление методов выборки
Для начала объедините имеющиеся сведения об объектах команд, чтения данных и обобщенных коллекциях, чтобы получить записи из таблицы
InventoryRead()CommandBehaviorDataReaderGetAllInventory()ListInventorypublic List GetAllInventory() { OpenConnection(); // Здесь будут храниться записи. List inventory = new List(); // Подготовить объект команды. string sql = @"SELECT i.Id, i.Color, i.PetName,m.Name as Make FROM Inventory i INNER JOIN Makes m on m.Id = i.MakeId"; using SqlCommand command = new SqlCommand(sql, _sqlConnection) { CommandType = CommandType.Text }; command.CommandType = CommandType.Text; SqlDataReader dataReader = command.ExecuteReader(CommandBehavior.CloseConnection); while (dataReader.Read()) { inventory.Add(new CarViewModel { Id = (int)dataReader["Id"], Color = (string)dataReader["Color"], Make = (string)dataReader["Make"], PetName = (string)dataReader["PetName"] }); } dataReader.Close(); return inventory;}Следующий метод выборки получает одиночный объект
CarViewModelCarIdpublic CarViewModel GetCar(int id){ OpenConnection(); CarViewModel car = null; // Параметры должны применяться по причинам, связанным с безопасностью. string sql = $@"SELECT i.Id, i.Color, i.PetName,m.Name as Make FROM Inventory i INNER JOIN Makes m on m.Id = i.MakeId WHERE i.Id = {id}"; using SqlCommand command = new SqlCommand(sql, _sqlConnection) { CommandType = CommandType.Text }; SqlDataReader dataReader = command.ExecuteReader(CommandBehavior.CloseConnection); while (dataReader.Read()) { car = new CarViewModel { Id = (int) dataReader["Id"], Color = (string) dataReader["Color"], Make = (string) dataReader["Make"], PetName = (string) dataReader["PetName"] }; } dataReader.Close(); return car;}На заметку! Помещение пользовательского ввода внутрь низкоуровневых операторов SQL, как делалось здесь, обычно считается неудачной практикой. Позже в главе код будет модифицирован для использования параметров.
Вставка новой записи об автомобиле
Вставка новой записи в таблицу Inventory сводится к построению SQL-оператора
InsertExecuteNonQuery()InventoryDalInsertAuto()InventoryColorMakePetNameSqlConnectionpublic void InsertAuto(string color, int makeId, string petName){ OpenConnection(); // Сформатировать и выполнить оператор SQL. string sql = $"Insert Into Inventory (MakeId, Color, PetName) Values ('{makeId}', '{color}', '{petName}')"; // Выполнить, используя наше подключение. using (SqlCommand command = new SqlCommand(sql, _sqlConnection)) { command.CommandType = CommandType.Text; command.ExecuteNonQuery(); } CloseConnection();}Приведенный выше метод принимает три значения для
CarCarСоздание строго типизированного метода InsertCar()
Добавьте в класс
InventoryDalInsertAuto()Carpublic void InsertAuto(Car car){ OpenConnection(); // Сформатировать и выполнить оператор SQL. string sql = "Insert Into Inventory (MakeId, Color, PetName) Values " + $"('{car.MakeId}', '{car.Color}', '{car.PetName}')"; // Выполнить, используя наше подключение. using (SqlCommand command = new SqlCommand(sql, _sqlConnection)) { command.CommandType = CommandType.Text; command.ExecuteNonQuery(); } CloseConnection();}Добавление логики удаления
Удаление существующей записи не сложнее вставки новой записи. В отличие от метода
InsertAuto()try/catchCustomersINSERTUPDATESqlExceptionВ реальной программе была бы предусмотрена логика обработки такой ошибки, но в рассматриваемом примере просто генерируется новое исключение. Добавьте в класс
InventoryDalpublic void DeleteCar(int id){ OpenConnection(); // Получить идентификатор автомобиля, подлежащего удалению, // и удалить запись о нем. string sql = $"Delete from Inventory where Id = '{id}'"; using (SqlCommand command = new SqlCommand(sql, _sqlConnection)) { try { command.CommandType = CommandType.Text; command.ExecuteNonQuery(); } catch (SqlException ex) { Exception error = new Exception("Sorry! That car is on order!", ex); throw error; } } CloseConnection();}Добавление логики обновления
Когда речь идет об обновлении существующей записи в таблице
InventorystringВ идеале лучше иметь набор методов, которые позволяют вызывающему коду обновлять запись разнообразными способами. Тем не менее, определите для такой простой библиотеки доступа к данным единственный метод, который дает вызывающему коду возможность обновить дружественное имя указанного автомобиля:
public void UpdateCarPetName(int id, string newPetName){ OpenConnection(); // Получить идентификатор автомобиля для модификации дружественного имени. string sql = $"Update Inventory Set PetName = '{newPetName}' Where Id = '{id}'"; using (SqlCommand command = new SqlCommand(sql, _sqlConnection)) { command.ExecuteNonQuery(); } CloseConnection();}Работа с параметризированным и объектами команд
В настоящий момент внутри логики вставки, обновления и удаления для типа
InventoryDalCommandTextДля поддержки параметризированных запросов объекты команд ADO.NET содержат коллекцию индивидуальных объектов параметров. По умолчанию коллекция пуста, но в нее можно вставить любое количество объектов параметров, которые отображаются на параметры-заполнители в запросе SQL. Чтобы ассоциировать параметр внутри запроса SQL с членом коллекции параметров в объекте команды, параметр запроса SQL необходимо снабдить префиксом в виде символа
@Указание параметров с использованием типа DbParameter
Перед построением параметризированного запроса вы должны ознакомиться с типом
DbParameterDbParameterDbParameter
Давайте теперь посмотрим, как заполнять коллекцию совместимых с
DBParameterInventoryDalОбновление метода GetCar()
В исходной реализации метода
GetCar()GetCar()SqlParameterSqlParameter param = new SqlParameter{ ParameterName = "@carId", Value = id, SqlDbType = SqlDbType.Int, Direction = ParameterDirection.Input}Значение
ParameterNameParameterDirection.InputParameterDirection.OutputInputOutputReturnValueМодифицируйте строку SQL для использования имени параметра (
"@carid""{id}"string sql = @"SELECT i.Id, i.Color, i.PetName,m.Name as Make FROM Inventory i INNER JOIN Makes m on m.Id = i.MakeId WHERE i.Id = @CarId";Последнее обновление связано с добавлением нового объекта параметра в коллекцию
Parameterscommand.Parameters.Add(param);Обновление метода DeleteCar()
Аналогично в исходной реализации метода
DeleteCar()SqlParameterSqlParameter param = new SqlParameter{ ParameterName = "@carId", Value = id, SqlDbType = SqlDbType.Int, Direction = ParameterDirection.Input};Обновите строку SQL для использования имени параметра
("@ carId"string sql = "Delete from Inventory where Id = @carId";В заключение добавьте новый объект параметра в коллекцию
Parameterscommand.Parameters.Add(param);Обновление метода UpdateCarPetName()
Метод
UpdateCarPetName()IdPetNameNVarCharPetNameInventorySizeSqlParameter paramId = new SqlParameter{ ParameterName = "@carId", Value = id, SqlDbType = SqlDbType.Int, Direction = ParameterDirection.Input};SqlParameter paramName = new SqlParameter{ ParameterName = "@petName", Value = newPetName, SqlDbType = SqlDbType.NVarChar, Size = 50, Direction = ParameterDirection.Input};Модифицируйте строку SQL для применения параметров:
string sql = $"Update Inventory Set PetName = @petName Where Id = @carId";Последнее обновление касается добавления новых параметров в коллекцию
Parameterscommand.Parameters.Add(paramId);command.Parameters.Add(paramName);Обновление метода InsertAuto()
Добавьте следующую версию метода
InsertAuto()public void InsertAuto(Car car){ OpenConnection(); // Обратите внимание на "заполнители" в запросе SQL. string sql = "Insert Into Inventory" + "(MakeId, Color, PetName) Values" + "(@MakeId, @Color, @PetName)"; // Эта команда будет иметь внутренние параметры. using (SqlCommand command = new SqlCommand(sql, _sqlConnection)) { // Заполнить коллекцию параметров. SqlParameter parameter = new SqlParameter { ParameterName = "@MakeId", Value = car.MakeId, SqlDbType = SqlDbType.Int, Direction = ParameterDirection.Input }; command.Parameters.Add(parameter); parameter = new SqlParameter { ParameterName = "@Color", Value = car.Color, SqlDbType = SqlDbType. NVarChar, Size = 50, Direction = ParameterDirection.Input }; command.Parameters.Add(parameter); parameter = new SqlParameter { ParameterName = "@PetName", Value = car.PetName, SqlDbType = SqlDbType. NVarChar, Size = 50, Direction = ParameterDirection.Input }; command.Parameters.Add(parameter); command.ExecuteNonQuery(); CloseConnection(); }}В то время как построение параметризированного запроса часто требует большего объема кода, в результате получается более удобный способ для программной настройки операторов SQL и достигается лучшая производительность. Параметризированные запросы также чрезвычайно удобны, когда нужно запускать хранимые процедуры.
Выполнение хранимой процедуры
Вспомните, что хранимая процедура представляет собой именованный блок кода SQL, сохраненный в базе данных. Хранимые процедуры можно конструировать так, чтобы они возвращали набор строк либо скалярных типов данных или выполняли еще какие-то осмысленные действия (например, вставку, обновление или удаление записей); в них также можно предусмотреть любое количество необязательных параметров. Конечным результатом будет единица работы, которая ведет себя подобно типичной функции, но только находится в хранилище данных, а не в двоичном бизнес-объекте. В текущий момент в базе данных
AutoLotGetPetNameРассмотрим следующий (пока что) финальный метод типа
InventoryDalGetPetNamepublic string LookUpPetName(int carId){ OpenConnection(); string carPetName; // Установить имя хранимой процедуры. using (SqlCommand command = new SqlCommand("GetPetName", _sqlConnection)) { command.CommandType = CommandType.StoredProcedure; // Входной параметр. SqlParameter param = new SqlParameter { ParameterName = "@carId", SqlDbType = SqlDbType.Int, Value = carId, Direction = ParameterDirection.Input }; command.Parameters.Add(param); // Выходной параметр. param = new SqlParameter { ParameterName = "@petName", SqlDbType = SqlDbType.NVarChar, Size = 50, Direction = ParameterDirection.Output }; command.Parameters.Add(param); // Выполнить хранимую процедуру. command.ExecuteNonQuery(); // Возвратить выходной параметр. carPetName = (string)command.Parameters["@petName"].Value; CloseConnection(); } return carPetName;}С вызовом хранимых процедур связан один важный аспект: объект команды может представлять оператор SQL (по умолчанию) либо имя хранимой процедуры. Когда объекту команды необходимо сообщить о том, что он будет вызывать хранимую процедуру, потребуется указать имя этой процедуры (в аргументе конструктора или в свойстве
CommandTextCommandTypeCommandType.StoredProcedureДалее обратите внимание, что свойство
Direction@petNameParameterDirection.OutputПосле того, как хранимая процедура, запущенная вызовом метода
ExecuteNonQuery()// Возвратить выходной параметр.carPetName = (string)command.Parameters["@petName"].Value;К настоящему моменту вы располагаете простейшей библиотекой доступа к данным, которую можно задействовать при построении клиента для отображения и редактирования данных. Вопросы создания графических пользовательских интерфейсов пока не обсуждались, поэтому мы протестируем полученную библиотеку доступа к данным с помощью нового консольного приложения.
Создание консольного клиентского приложения
Добавьте к решению
AutoLot.DalAutoLot.ClientAutoLot.DaldotnetChapter21_А11Projects.sindotnet new console -lang c# -n AutoLot.Client -o .\AutoLot.Client -f net5.0dotnet sln .\Chapter21_AllProjects.sln add .\AutoLot.Clientdotnet add AutoLot.Client package Microsoft.Data.SqlClientdotnet add AutoLot.Client reference AutoLot.DalВ случае использования Visual Studio щелкните правой кнопкой мыши на имени решения и выберите в контекстном меню пункт Add►New Project (Добавить►Новый проект). Установите новый проект в качестве стартового (щелкнув правой кнопкой мыши на имени проекта в окне Solution Explorer и выбрав в контекстном меню пункт Set as Startup Project (Установить как стартовый проект)). Это обеспечит запуск нового проекта при инициировании отладки в Visual Studio. Если вы применяете Visual Studio Code, тогда перейдите в каталог
AutoLot.Testdotnet runОчистите код, сгенерированный в
Program.csProgram.csusingusing System;using System.Linq;using AutoLot.Dal;using AutoLot.Dal.Models;using AutoLot.Dal.DataOperations;using System.Collections.Generic;Чтобы задействовать
AutoLot.DalMain()InventoryDal dal = new InventoryDal();List list = dal.GetAllInventory(); Console.WriteLine(" ************** All Cars ************** ");Console.WriteLine("Id\tMake\tColor\tPet Name");foreach (var itm in list){ Console.WriteLine($"{itm.Id}\t{itm.Make}\t{itm.Color}\t{itm.PetName}");}Console.WriteLine();CarViewModel car = dal.GetCar(list.OrderBy(x=>x.Color).Select(x => x.Id).First());Console.WriteLine(" ************** First Car By Color ************** ");Console.WriteLine("CarId\tMake\tColor\tPet Name");Console.WriteLine($"{car.Id}\t{car.Make}\t{car.Color}\t{car.PetName}");try{ // Это потерпит неудачу из-за наличия связанных данных в таблице Orders. dal.DeleteCar(5); Console.WriteLine("Car deleted."); // Запись об автомобиле удалена.}catch (Exception ex){ Console.WriteLine($"An exception occurred: {ex.Message}"); // Сгенерировано исключение}dal.InsertAuto(new Car { Color = "Blue", MakeId = 5, PetName = "TowMonster" });list = dal.GetAllInventory();var newCar = list.First(x => x.PetName == "TowMonster");Console.WriteLine(" ************** New Car ************** ");Console.WriteLine("CarId\tMake\tColor\tPet Name");Console.WriteLine($"{newCar.Id}\t{newCar.Make}\t{newCar.Color}\t{newCar.PetName}");dal.DeleteCar(newCar.Id);var petName = dal.LookUpPetName(car.Id);Console.WriteLine(" ************** New Car ************** ");Console.WriteLine($"Car pet name: {petName}");Console.Write("Press enter to continue...");Console.ReadLine();Понятие транзакций базы данных
Давайте завершим исследование ADO.NET рассмотрением концепции транзакций базы данных. Выражаясь просто, транзакция — это набор операций базы данных, которые успешно выполняются или терпят неудачу как единая группа. Если одна из операций отказывает, тогда осуществляется откат всех остальных операций, как будто ничего не происходило. Несложно предположить, что транзакции по-настоящему важны для обеспечения безопасности, достоверности и согласованности табличных данных.
Транзакции также важны в ситуациях, когда операция базы данных включает в себя взаимодействие с множеством таблиц или хранимых процедур (либо с комбинацией атомарных элементов базы данных). Классическим примером транзакции может служить процесс перевода денежных средств с одного банковского счета на другой. Например, если вам понадобилось перевести $500 с депозитного счета на текущий чековый счет, то следующие шаги должны быть выполнены в транзакционной манере.
1. Банк должен снять $500 с вашего депозитного счета.
2. Банк должен добавить $500 на ваш текущий чековый счет.
Вряд ли бы вам понравилось, если бы деньги были сняты с депозитного счета, но не переведены (из-за какой-то ошибки со стороны банка) на текущий чековый счет, потому что вы попросту лишились бы $500. Однако если поместить указанные шаги внутрь транзакции базы данных, тогда СУБД гарантирует, что все взаимосвязанные шаги будут выполнены как единое целое. Если любая часть транзакции откажет, то будет произведен откат всей операции в исходное состояние. С другой стороны, если все шаги выполняются успешно, то транзакция будет зафиксирована.
На заметку! Из литературы, посвященной транзакциям, вам может быть известно сокращение АСЮ. Оно обозначает четыре ключевых характеристики транзакций: атомарность (atomic; все или ничего), согласованность (consistent; данные остаются устойчивыми на протяжении транзакции), изоляция (isolated; транзакции не влияют друг на друга) и постоянство (durable; транзакции сохраняются и протоколируются в журнале).
В свою очередь платформа .NET Core поддерживает транзакции различными способами. Здесь мы рассмотрим объект транзакции поставщика данных ADO.NET (
SqlTransactionMicrosoft.Data.SqlClientВ дополнение к готовой поддержке транзакций внутри библиотек базовых классов .NET Core можно также использовать язык SQL имеющейся СУБД. Например, вы могли бы написать хранимую процедуру, в которой применяются операторы
BEGIN TRANSACTIONROLLBACKCOMMITОсновные члены объекта транзакции ADO.NET
Все транзакции, которые будут использоваться, реализуют интерфейс
IDbTransactionIDbTransactionpublic interface IDbTransaction : IDisposable{ IDbConnection Connection { get; } IsolationLevel IsolationLevel { get; } void Commit(); void Rollback();}Обратите внимание на свойство
ConnectionCommit()Rollback()На заметку! Свойство
IsolationLevelПомимо членов, определенных в интерфейсе
IDbTransactionSqlTransactionSave()Save()SqlTransactionRollback()Rollback()Добавление метода транзакции в inventoryDal
Давайте посмотрим, как работать с транзакциями ADO.NET программным образом. Начните с открытия созданного ранее проекта библиотеки кода
AutoLot.DalInventoryDalProcessCreditRisk()CreditRiskspublic void ProcessCreditRisk(bool throwEx, int customerId){ OpenConnection(); // Найти имя текущего клиента по идентификатору. string fName; string lName; var cmdSelect = new SqlCommand( "Select * from Customers where Id = @customerId", _sqlConnection); SqlParameter paramId = new SqlParameter { ParameterName = "@customerId", SqlDbType = SqlDbType.Int, Value = customerId, Direction = ParameterDirection.Input }; cmdSelect.Parameters.Add(paramId); using (var dataReader = cmdSelect.ExecuteReader()) { if (dataReader.HasRows) { dataReader.Read(); fName = (string) dataReader["FirstName"]; lName = (string) dataReader["LastName"]; } else { CloseConnection(); return; } } cmdSelect.Parameters.Clear(); // Создать объекты команды, представляющие каждый шаг операции. var cmdUpdate = new SqlCommand( "Update Customers set LastName = LastName + ' (CreditRisk) ' where Id = @customerId", _sqlConnection); cmdUpdate.Parameters.Add(paramId); var cmdInsert = new SqlCommand( "Insert Into CreditRisks (CustomerId,FirstName, LastName) Values( @CustomerId, @FirstName, @LastName)", _sqlConnection); SqlParameter parameterId2 = new SqlParameter { ParameterName = "@CustomerId", SqlDbType = SqlDbType.Int, Value = customerId, Direction = ParameterDirection.Input }; SqlParameter parameterFirstName = new SqlParameter { ParameterName = "@FirstName", Value = fName, SqlDbType = SqlDbType.NVarChar, Size = 50, Direction = ParameterDirection.Input }; SqlParameter parameterLastName = new SqlParameter { ParameterName = "@LastName", Value = lName, SqlDbType = SqlDbType.NVarChar, Size = 50, Direction = ParameterDirection.Input }; cmdInsert.Parameters.Add(parameterId2); cmdInsert.Parameters.Add(parameterFirstName); cmdInsert.Parameters.Add(parameterLastName); // Это будет получено из объекта подключения. SqlTransaction tx = null; try { tx = _sqlConnection.BeginTransaction(); // Включить команды в транзакцию. cmdInsert.Transaction = tx; cmdUpdate.Transaction = tx; // Выполнить команды. cmdInsert.ExecuteNonQuery(); cmdUpdate.ExecuteNonQuery(); // Эмулировать ошибку. if (throwEx) { throw new Exception("Sorry! Database error! Tx failed..."); // Возникла ошибка, связанная с базой данных! Отказ транзакции... } // Зафиксировать транзакцию! tx.Commit(); } catch (Exception ex) { Console.WriteLine(ex.Message); // Любая ошибка приведет к откату транзакции. // Использовать условную операцию для проверки на предмет null. tx?.Rollback(); } finally { CloseConnection(); }}Здесь используется входной параметр типа
boolОбратите внимание на применение двух объектов
SqlCommandcustomerIDBeginTransaction()SqlTransactionTransactionПосле вызова метода
ExecuteNonQuery()booltrueCommit()Тестирование транзакции базы данных
Выберите одного из клиентов, добавленных в таблицу
CustomersDave BennerId = 1Program.csAutoLot.ClientFlagCustomer()void FlagCustomer(){ Console.WriteLine("***** Simple Transaction Example *****\n"); // Простой способ позволить транзакции успешно завершиться или отказать. bool throwEx = true; Console.Write("Do you want to throw an exception (Y or N): "); // Хотите ли вы сгенерировать исключение? var userAnswer = Console.ReadLine(); if (string.IsNullOrEmpty(userAnswer) || userAnswer.Equals("N",StringComparison.OrdinalIgnoreCase)) { throwEx = false; } var dal = new InventoryDal(); // Обработать клиента 1 - ввести идентификатор клиента, // подлежащего перемещению. dal.ProcessCreditRisk(throwEx, 1); Console.WriteLine("Check CreditRisk table for results"); // Результаты ищите в таблице CreditRisk Console.ReadLine();}Если вы запустите программу и укажете на необходимость генерации исключения, то обнаружите, что фамилия клиента в таблице
CustomersCustomersCreditRisksВыполнение массового копирования с помощью ADO.NET
В случае, когда необходимо загрузить много записей в базу данных, показанные до сих пор методы будут довольно неэффективными. В SQL Server имеется средство, называемое массовым копированием, которое предназначено специально для таких сценариев, и в ADO.NET для него предусмотрена оболочка в виде класса
SqlBulkCopyИсследование класса SqlBulkCopy
Класс
SqlBulkCopyWriteToServer()WriteToServerAsync()InsertWriteToServer()DataTableDataReaderDataRowWriteToServer()DataReaderСоздание специального класса чтения данных
Желательно, чтобы специальный класс чтения данных был обобщенным и содержал список моделей, которые нужно импортировать. Создайте в проекте
AutoLot.DALBulkImportIMyDataReader.csIDataReaderusing System.Collections.Generic;using System.Data;namespace AutoLot.Dal.BulkImport{ public interface IMyDataReader : IDataReader { List Records { get; set; } }}Далее реализуйте специальный класс чтения данных. Как вы уже видели, классы чтения данных содержат много частей, отвечающих за перемещение данных. Хорошая новость в том, что для
SqlBulkCopyMyDataReader.csusingusing System;using System.Collections.Generic;using System.Data;using System.Linq;using System.Reflection;Сделайте класс открытым и запечатанным и обеспечьте реализацию классом интерфейса
IMyDataReaderpublic sealed class MyDataReader : IMyDataReader { public List Records { get; set; } public MyDataReader(List records) { Records = records; }}Предложите Visual Studio или Visual Studio Code самостоятельно реализовать все методы (либо скопировать их), что даст вам отправную точку для специального класса чтения данных. В рассматриваемом сценарии потребуется реализовать лишь члены, кратко описанные в табл. 21.7.
Начните с метода
Read()falsetrueListRead()public class MyDataReader : IMyDataReader { ... private int _currentIndex = -1; public bool Read() { if (_currentIndex + 1 >= Records.Count) { return false; } _currentIndex++; return true; }}Каждый метод
GetXXX()FieldCountGetValue()CarViewModelpublic object GetValue(int i){ Car currentRecord = Records[_currentIndex] as Car; return i switch { 0 => currentRecord.Id, 1 => currentRecord.MakeId, 2 => currentRecord.Color, 3 => currentRecord.PetName, 4 => currentRecord.TimeStamp, _ => string.Empty, };}База данных содержит только четыре таблицы, но это означает необходимость в наличии четырех вариаций класса чтения данных. А подумайте о реальной производственной базе данных, в которой таблиц гораздо больше!Решить проблему можно более эффективно с применением рефлексии (см. главу 17) и LINQ to Objects (см. главу 13).
Добавьте переменные
readonlyPropertyInfoDictionaryprivate readonly PropertyInfo[] _propertyInfos;private readonly Dictionary _nameDictionary; public MyDataReader(List records) { Records = records; _propertyInfos = typeof(T).GetProperties(); _nameDictionary = new Dictionary(); }Модифицируйте конструктор, чтобы он принимал строку подключения
SQLConnectionprivate readonly SqlConnection _connection;private readonly string _schema;private readonly string _tableName;public MyDataReader(List records, SqlConnection connection, string schema, string tableName){ Records = records; _propertyInfos = typeof(T).GetProperties(); _nameDictionary = new Dictionary(); _connection = connection; _schema = schema; _tableName = tableName;}Далее реализуйте метод
GetSchemaTable()public DataTable GetSchemaTable(){ using var schemaCommand = new SqlCommand($"SELECT * FROM {_schema}.{_tableName}", _connection); using var reader = schemaCommand.ExecuteReader(CommandBehavior.SchemaOnly); return reader.GetSchemaTable();}Модифицируйте конструктор, чтобы использовать
SchemaTablepublic MyDataReader(List records, SqlConnection connection, string schema, string tableName){ ... DataTable schemaTable = GetSchemaTable(); for (int x = 0; x { DataRow col = schemaTable.Rows[x]; var columnName = col.Field("ColumnName"); _nameDictionary.Add(x,columnName); }}Теперь показанные далее методы могут быть реализованы обобщенным образом, используя полученную посредством рефлексии информацию:
public int FieldCount => _propertyInfos.Length;public object GetValue(int i) => _propertyInfos .First(x=>x.Name.Equals(_nameDictionary[i], StringComparison.OrdinalIgnoreCase)) .GetValue(Records[_currentIndex]);Для справки ниже приведены остальные методы, которые должны присутствовать (но не реализованы):
public string GetName(int i) => throw new NotImplementedException();public int GetOrdinal(string name) => throw new NotImplementedException();public string GetDataTypeName(int i) => throw new NotImplementedException();public Type GetFieldType(int i) => throw new NotImplementedException();public int GetValues(object[] values) => throw new NotImplementedException();public bool GetBoolean(int i) => throw new NotImplementedException();public byte GetByte(int i) => throw new NotImplementedException();public long GetBytes(int i, long fieldOffset, byte[] buffer, int bufferoffset, int length) => throw new NotImplementedException();public char GetChar(int i) => throw new NotImplementedException();public long GetChars(int i, long fieldoffset, char[] buffer, int bufferoffset, int length) => throw new NotImplementedException();public Guid GetGuid(int i) => throw new NotImplementedException();public short GetInt16(int i) => throw new NotImplementedException();public int GetInt32(int i) => throw new NotImplementedException();public long GetInt64(int i) => throw new NotImplementedException();public float GetFloat(int i) => throw new NotImplementedException();public double GetDouble(int i) => throw new NotImplementedException();public string GetString(int i) => throw new NotImplementedException();public decimal GetDecimal(int i) => throw new NotImplementedException();public DateTime GetDateTime(int i) => throw new NotImplementedException();public IDataReader GetData(int i) => throw new NotImplementedException();public bool IsDBNull(int i) => throw new NotImplementedException();object IDataRecord.this[int i] => throw new NotImplementedException();object IDataRecord.this[string name] => throw new NotImplementedException();public void Close() => throw new NotImplementedException();public DataTable GetSchemaTable() => throw new NotImplementedException();public bool NextResult() => throw new NotImplementedException();public int Depth { get; }public bool IsClosed { get; }public int RecordsAffected { get; }Выполнение массового копирования
Добавьте в папку
BulkImportProcessBulkImport.csusingusing System;using System.Collections.Generic;using System.Data;using System.Linq;using Microsoft.Data.SqlClient;Добавьте код для поддержки открытия и закрытия подключений (похожий на код в классе
InventoryDalprivate const string ConnectionString = @"Data Source=.,5433;User Id=sa;Password=P@ssw0rd;Initial Catalog=AutoLot";private static SqlConnection _sqlConnection = null;private static void OpenConnection(){ _sqlConnection = new SqlConnection { ConnectionString = ConnectionString }; _sqlConnection.Open();}private static void CloseConnection(){ if (_sqlConnection?.State != ConnectionState.Closed) { _sqlConnection?.Close(); }}Для обработки записей классу
SqlBulkCopydboSqlBulkCopyDestinationTableNameWriteToServer()ExecuteBulklmport()public static void ExecuteBulkImport(IEnumerable records, string tableName){ OpenConnection(); using SqlConnection conn = _sqlConnection; SqlBulkCopy bc = new SqlBulkCopy(conn) { DestinationTableName = tableName }; var dataReader = new MyDataReader(records.ToList(),_sqlConnection, "dbo",tableName); try { bc.WriteToServer(dataReader); } catch (Exception ex) { // Здесь должно что-то делаться. } finally { CloseConnection(); }}Тестирование массового копирования
Возвратите в проект
AutoLot.ClientProgram.csusingusing AutoLot.Dal.BulkImport;using SystemCollections.Generic;Добавьте в файл
Program.csDoBulkCopy()CarExecuteBulklmport()void DoBulkCopy(){ Console.WriteLine(" ************** Do Bulk Copy ************** "); var cars = new List { new Car() {Color = "Blue", MakeId = 1, PetName = "MyCar1"}, new Car() {Color = "Red", MakeId = 2, PetName = "MyCar2"}, new Car() {Color = "White", MakeId = 3, PetName = "MyCar3"}, new Car() {Color = "Yellow", MakeId = 4, PetName = "MyCar4"} }; ProcessBulkImport.ExecuteBulkImport(cars, "Inventory"); InventoryDal dal = new InventoryDal(); List list = dal.GetAllInventory(); Console.WriteLine(" ************** All Cars ************** "); Console.WriteLine("CarId\tMake\tColor\tPet Name"); foreach (var itm in list) { Console.WriteLine( $"{itm.Id}\t{itm.Make}\t{itm.Color}\t{itm.PetName}"); } Console.WriteLine();}Хотя добавление четырех новых объектов
CarSqlBulkCopyCustomersSqlBulkCopyРезюме
Инфраструктура ADO.NET представляет собой собственную технологию доступа к данным платформы .NET Core. В настоящей главе было начато исследование роли поставщиков данных, которые по существу являются конкретными реализациями нескольких абстрактных базовых классов (из пространства имен
System.Data.CommonSystem.DataВы также узнали, что с помощью объектов подключений, объектов транзакций, объектов команд и объектов чтения данных можно выбирать, обновлять, вставлять и удалять записи. Кроме того, было показано, что объекты команд поддерживают внутреннюю коллекцию параметров, которые можно использовать для обеспечения безопасности к типам в запросах SQL; они также удобны при запуске хранимых процедур.
Наконец, вы научились защищать код манипулирования данными с помощью транзакций и ознакомились с применением класса
SqlBulkCopy
ТЕЛЕГРАМКанал с обзорами, анонсами новинок и книжными подборками
Книжный Вестник
Бот для удобного поиска книг (если не нашлось на сайте)
Поиск книг
Свежие любовные романы в удобных форматах
Любовные романы
О психологии, саморазвитии и личностном росте
Саморазвитие
Детективы и триллеры, все новинки
Детективы
Фантастика и фэнтези, все новинки
Фантастика
Отборные классические книги
Классика
ВКОНТАКТЕБиблиотека с любовными романами, которая наверняка придётся по вкусу женской части аудитории
Любовные романы
Библиотека с фантастикой и фэнтези, а также смежных жанров
Фантастика
Самые популярные книги в формате фб2
Топ фб2
книги