Search the Community

Hello everyone! Many of you have decided to use Entity Framework instead of raw SQL but failed somehow in the process (myself included)! This is why I am creating this quick guide with some examples on how to use Entity Framework Core with MySQL database in RAGEMP C# gamemode. It's not perfect, but it will work just fine. If you find a mistake or have a better way of doing something, please let me know! Let's start! Requirements: - Visual Studio 17 or better - Net Core 2.2 - RageMP C# 0.3.7 - MySQL database (I use XAMPP) 1. First, you will need some dependencies. Open up the nuget package manager and add these dependencies to your project: Microsoft.EntityFrameworkCore - Version 2.2.0 Microsoft.EntityFrameworkCore.Tools - Version 2.2.0 Pomelo.EntityFrameworkCore.MySql - Version 2.1.4 Pomelo.EntityFrameworkCore.MySql.Design - Version 1.1.2 Pomelo.EntityFrameworkCore.MySql is a MySQL provider. There are many more providers, but Pomelo's is just fine. How it looks when everything's added: NOTE: As of writing this, you have to use exactly those versions I had screenshot above! 2. Now we are ready to create a DbContext class. I will just copy and paste and explain needed with comments! using System; using System.Collections.Generic; using System.Reflection; using System.Text; using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore.Design; namespace EFCoreTutorial { public class DefaultDbContext : DbContext { // Connection string, more details below private const string connectionString = "Server=localhost;Database=efcoretutorial;Uid=root;Pwd="; // Initialize a new MySQL connection with the given connection parameters protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) { optionsBuilder.UseMySql(connectionString); } // Account model class created somewhere else public DbSet<Account> Accounts { get; set; } } } Server = the address of the server, in this case localhost Database = name of the database Uid = user accessing the database Pwd = database password, leave empty if none 3. Create a model class, in this case it's called Account using System; using System.Collections.Generic; using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations.Schema; using System.Text; namespace EFCoreTutorial { public class Account { [Key] public int Id { get; set; } public string Username { get; set; } public string Password { get; set; } } } 4. Let's make a simple registration command. using System; using System.Collections.Generic; using System.Linq; using System.Text; using GTANetworkAPI; namespace EFCoreTutorial { public class Commands : Script { [Command("register")] public void AccountCmdRegister(Client player, string username, string password) { RegisterAccount(player, username, password); NAPI.Chat.SendChatMessageToPlayer(player, "~g~Registration successful!"); } public static void RegisterAccount(Client client, string username, string password) { // create a new Account object var account = new Account { Username = username, Password = password }; // When created like this, the context will be immediately deleted AKA disposed. // This will make sure you don't have slowdowns with database calls if one day your server becomes popular using (var dbContext = new DefaultDbContext()) { // Add this account data to the current context dbContext.Accounts.Add(account); // And finally insert the data into the database dbContext.SaveChanges(); } } } } 4a. To check if you are properly connected to the database without going into the game, make a query when a resource starts, for example: using System; using System.Collections.Generic; using System.Linq; using System.Text; using GTANetworkAPI; namespace EFCoreTutorial { public class Main : Script { [ServerEvent(Event.ResourceStart)] public void OnResourceStart() { using (var dbContext = new DefaultDbContext()) { var playerCount = dbContext.Accounts.Count(); NAPI.Util.ConsoleOutput("Total players in the database: " + playerCount); } } } } 5. Before we can test the command or the above example, we need to make a migration. Manual migrations are the only way as of EF Core. To use them in our gamemodes which are most often only libraries (.dlls), we need to "trick the system" into thinking our gamemode is executable. The easiest way is to "create" a console application. First, open your project properties, ALT + F7. Change output type to "Console Application" Save with CTRL + S! Create a new class called Program.cs with the code below: using System; using System.Collections.Generic; using System.Text; namespace EFCoreTutorial { public class Program { public static void Main(string[] args) { } } } Yes, that's right. You only need the Main method. It's because the console app approach looks for "Main" as a starting point. Save and build the project! Now let's make the first migration. Open up the Package Manager Console and type "add-migration FirstMigration" (FirstMigration is only the name). After the migration class has been created, type once again into the console "update-database". The very first migration is now added and inside your database you will find Accounts table: Note: If there are any errors by this stage, then you are most likely not connected to your Database. This guide will not cover that! 6. We are almost done. For server to properly work, it will need runtime dlls. When you first start RAGEMP client, you will download some runtime files. Those are not enough and you have to take some extra steps. Go to the "RAGEMP" root folder, then "dotnet" folder and copy everything. Paste it inside the "runtime" folder (RAGEMP\server-files\bridge\runtime). When you build your project, it will also give you runtime files. Copy everything from bin/debug/netcoreapp2.2 (default build path) except Bootstrapper.dll , Newtonsoft.Json.dll and everything that starts with YourProjectName (EFCoreTutorial in my case). Paste it once again inside the "runtime" folder (RAGEMP\server-files\bridge\runtime). Finally, open YourProjectName.csproj with notepad and add this line <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies> like so: Save and close. 7. You are all set up! From now on you don't have to worry about missing runtimes, errors and whatnot. This is everything Entity Framework Core requires to work properly in RAGEMP. Changelog: - Added appsettings.json, a better way of handling connection strings. Thanks @horseyhorsey! - Some clarification - Cleaned and updated the code per @Adam's suggestion This was my first tutorial/guide. Leave feedback and opinions. Thank you for reading! xForcer

Hallo allerseits! Ich selber habe lange damit zugebracht zu schauen wie ich EntityFrameworkCore möglichst so nutzen kann wie EF6 (EntityFramework 6). Nach einer langen Zeit auf Google habe ich es mittlerweile auf eine recht einfache Art hinbekommen, die so jeder übernehmen kann. Ich spare mir die meisten Erklärungen, ich zeige die Schritte die ihr anwenden müsst. Inkompatibilität wenn schon andere MySQL Packages installiert sind, kann durchaus vorkommen, bitte vorher löschen. Erster Schritt Ladet folgende NuGet Packages herunter Microsoft.EntityFrameworkCore Microsoft.EntityFrameworkCore.Tools Pomelo.EntityFrameworkCore.MySQL Pomelo.EntityFrameworkCore.MySQL.Designer Der zweite Schritt Jetzt müsst ihr eurer Projekt entladen, und dann die CSProj Datei bearbeiten. Dort fügt ihr einfach folgende zwei Informationen ein: GenerateRuntimeConfigrationFiles ist ein Workaround was den Fehler behebt wenn er beim Datenbank-Model erzeugen den Net.Core nicht finden kann. Tools.DotNet... benötigen wir damit wir (dotnet ef...) nutzen können. <PropertyGroup> <GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles> </PropertyGroup> <ItemGroup> <DotNetCliToolReference Include="Microsoft.EntityFrameworkCore.Tools.DotNet" Version="2.0.0" /> </ItemGroup> Und jetzt der dritte Schritt Jetzt compilieren wir einmal das komplette Projekt (dafür das entladene Projekt wieder laden und dann neu erstellen). Wenn das erfolgreich war, können wir zum nächsten Schritt springen. Falls nicht, alle bisherigen MySQL Funktionen ausklammern, damit wir gleich das Model generieren können, müssen wir einmal compiliert haben. Jetzt der vierte Schritt, zusammgengefasst Wir öffnen jetzt Powershell oder CMD (am besten als Administrator). Jetzt navigieren wir zu unseren Projektfiles (wo die .csproj Datei liegt). Beispiel: "cd C:\Users\Administrator\ragemp_project\proj" Dort führen wir schnell noch einen kleinen Befehl aus - "dotnet restore" Um jetzt die Modelle zu generieren, müssen wir uns einen kleinen Befehl zusammenschreiben. dotnet ef dbcontext scaffold "Host=localhost;Port=3306;Database=vita;Username=root;Password=xxx" Pomelo.EntityFrameworkCore.MySql -o Model -f Hier die richtigen MySQL Daten hinterlegen. Wenn wir das jetzt ausführen, und wir keine Fehler erhalten, müssten im Projekt jetzt die Modelle liegen unter dem Ordner "Model". Wenn ihr Änderungen an der Datenbank durchführt, dann müsst ihr das nochmal ausführen, am besten schreibt ihr dafür eine .bat Datei! Der fünfte Schritt, ein Beispielcode Jetzt haben wir EntityFrameworkCore funktionsfähig in das Projekt integriert. Wir können jetzt auf die Datenbank zugreifen, siehe Beispiel! using System.Linq; using(var db = new Model.databasenameContext()) { var accounts = db.Accounts.FirstOrDefault(x => x.SocialClub == player.SocialClub); // Accounts = Model if(accounts == null) return; // Account wurde nicht gefunden accounts.Online = 1; db.SaveChanges(); } Bei Fragen einfach melden, oder falls ich etwas nicht richtig geschrieben habe einfach bescheid geben! Viel Spaß damit. Mit freundlichen Grüßen, Max Jackson

Всем привет!! Увидел тутер на английском по Entity Framework на MySql и решил сообразить свой вариант на Великом и Могучем, только для базы данных Postgresql. Надеюсь это кому-то будет полезным. Работать мне еще 3 часа, а значит должен успеть. Поехали Нам потребуется: Visual Studio Голова Руки Немного времени Установка необходимых библиотек Первое что нам нужно сделать это открыть наш Visual Studio и загрузить необходимые библиотеки. Для этого открываем диспетчер пакетов NuGet, ищем и устанавливаем следующие библиотеки: gtanetwork.api Microsoft.EntityFrameworkCore Microsoft.EntityFrameworkCore.Tools Npgsql Npgsql.EntityFrameworkCore.PostgreSQL Newtonsoft.Json Вот общая картина: Создание структуры классов Создадим следующие классы: Character - основной класс, модель которого мы и будем сохранять в базе Finances - будет хранить в себе информацию о финансах нашего игрока. States - будет содержать информацию о состоянии персонажа Item - будет представлять класс вещи из нашего инвентаря Login - отвечающий за авторизацию персонажа Registration - ... за его регистрацию Db - будет хранить подключение к базе данных AppDbContext - основной класс который и будет содержать практически все настройки для нашей базы данных Посмотреть более подробно содержимое можно скачав проект с репозитория на github. Для тех кто в теме: git clone https://github.com/SirEleot/EFCore_Npgsql.git Для начала давайте настроим подключение к базе данных, для этого создадим новый класс AppDbContext который будет включать в себя все основные настройки касающиеся базы данных. Давайте пока просто посмотрим на его содержимое, а чуть позже разберем более детально: class AppDbContext : DbContext { //сторка подключения к бд. private static string ConnectionString = "Host=localhost;Port=5432;Database=test;Uid=test;Password=test;"; //настройка подключения к базе данных protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) { optionsBuilder.UseNpgsql(ConnectionString); } //Добавляем класс для сохранения в дб //дочерние классы добавлять не нужно EFCore сам их подхватит public DbSet<Character> Characters { get; set; } // тут находится конфигурация наших сохроняемых классов protected override void OnModelCreating(ModelBuilder modelBuilder) { //настроим игнорирование свойства Data из класса Character //вот так игнорируются свойства класса modelBuilder.Entity<Character>().Ignore(c => c.Date); //также добавим будем игнорировать класс Item //так как он входит в состав нашего класса, то EFCore попытается для него создать таблицу //мы же решили что будем сохраять инвентарь в виде json строки //вот так игнорируются классы modelBuilder.Ignore<Item>(); //здесь здесь пример того как обработать данные при сохранении //мы будем преобразовывать массив с вещамивв строку json modelBuilder .Entity<Character>()//выбираем объект из контекста у нас он 1 .Property(c => c.Inventory)//выбираем свойство .HasConversion( //определяем кастомные методы для обработки данных i => JsonConvert.SerializeObject(i), // при сохранении i => JsonConvert.DeserializeObject<List<Item>>(i) // при загрузке ); //рассмотрим как сохранить отдельный объект в нашем случае Finance //в одной таблице с основным классом modelBuilder.Entity<Character>()//выбираем объект из контекста у нас он 1 .OwnsOne(c => c.Finance);//определяем свойство которое мы хотим добавить к текущей таблице в базе дбазе данных } } } Настройка базы данных Думаю что с ConnectionString проблемы возникнуть не должно. Хотя : Host=localhost; - расположение базы данных Port=5432; - прослушиваемый порт Database=test; - название базы данных Uid=test; - имя пользователя Password=test; - и соответственно пароль В функции OnConfiguring задаются настройки, которые необходимы при инициализации базы данных. В нашем случае это строка подключения к базе данных. Так же тут можно настроить автоматическую миграцию, но об этом поговорим позже. Давайте разберем содержимое нашего основного класса: class Character { //для элементов хранящихся в отдельных таблицах обязательно наличие поля с атрибутом primary key //но в EFCore достаточно создать для класса свойство Id и он сделает все за вас public int Id { get; set; } public string Social { get; set; } public string Name { get; set; } public string Lasname { get; set; } public string Password { get; set; } // поместим финансовую модель в одну таблицу с персонажем //состояние персонажа будет автоматом помещено в отдельную таблицу //все настройки производятся в классе AppDbContext public Finances Finance { get; set; } public States State { get; set; } //так же мы сохраним список вещей в основную таблицу персонажа в виде строки JSON //настройка так же в классе AppDbContext public List<Item> Inventory { get; set; } //это свойство создано для примера, мы его будем игнорировать при сохранении данных в базу //не поверите но это тоже настроим в классе AppDbContext public DateTime Date { get; set; } } Тут мы видим различные свойства персонажа: логин, имя, фамилия и пароль (не забывайте шифровать пароль при сохранении). Стоит обратить внимание на обязательный параметр Id, он необходим для корректного сохранения в базе данных. Все классы, которые предполагают сохранение в отдельной таблице, должны содержать свойство Id, либо любое другое предназначенное для хранения уникального ключа(но это другая история). Перейдем непосредственно к настройкам. Для начала нужно оповестить EF Core о том что мы собираемся сохранить данный класс, для этого добавим свойство Characters типа DbSet<T>, где Т - класс нашей модели Character public DbSet<Character> Characters { get; set; } Составим небольшой план действий. Допустим, что мы хотим чтобы информация о финансах находилась в одной таблице с нашим персонажем, а его состояние наоборот было вынесено в отдельную таблицу. Так же мы хотим что бы коллекция Inventory хранилась в виде строки Json. Еще у нас есть свойство Date и мы не хотим сохранять его в базе данных. План "накидали", теперь давайте попробуем воплотить его в код. Итак по порядку: Первым рассмотрим включаемый класс Finances: class Finances { //для элементов сохраняющихся в оттдельных таблицах обязательно поле с primary key //Достаточно создать свойство Id и EFCore сделает все за вас //В конкретном случае мы не добавляем свойство Id так как Finance будет помещен в одну таблицу с Character //смотрите настройки в классе AppDbContext //public int Id { get; set; } public int Bank { get; set; } = 5000; public int Cash { get; set; } = 500; //добавить деньги на счет public bool AddBank(int amount) { Bank += amount; return true; } //списать деньги со счета public bool SubBank(int amount) { if (amount > Bank) return false; Bank -= amount; return true; } //...... } Наш класс содержит информацию о счете игрока, а так же методы взаимодействия со счетом. Наличие методов никак не повлияет на корректность сохраняемых данных. Мы решили что класс Finances будет сохранятся в одной таблице с персонажем, а это значит что свойство Id можно опустить. Настройки записываются в переопределенном методе OnModelCreating класса AppDbContext: protected override void OnModelCreating(ModelBuilder modelBuilder) { modelBuilder. ....... } Перейдем непосредственно к настройке Finance: modelBuilder.Entity<Character>()//выбираем объект из контекста у нас он 1 .OwnsOne(c => c.Finance);//определяем свойство которое мы хотим добавить к текущей таблице в базе дбазе данных тут мы при помощи метода OwnsOne(c => c.Finance) говорим EF Core, что свойство Finance следует сохранять в одной таблице с Character. Обратите внимание на 6 и 7 колонки это и есть свойства нашего класса Finances включенного в состав таблицы Characters. Так же обратите внимание на 1 колонку Id с пометкой [PK], это и есть наше обязательное одноименное свойство. Дальше у нас идет класс States: class States { //для элементов сохраняющихся в отдельных таблицах обязательно поле с primary key //Достаточно создать свойство Id и EFCore сделает все за вас public int Id { get; set; } public int Health { get; set; } = 100; public int Armor { get; set; } = 100; } Ef Core, по умолчанию, пытается создать отдельную таблицу для каждого класса, включенного в состав нашего основного объекта, поэтому нам остается только создать уникальное свойство Id. Для нашего класса States была автоматически создана соответствующая таблица в базе данных, а ссылка на нее была добавлена в основную таблицу в колонку 8 с названием StateId Далее давайте рассмотрим пользовательские преобразование данных. У нас есть свойство Inventory которое является коллекцией классов Item, и мы решили сохраить его в виде строки json. Для этого в метод OnModelCreating класса AppDbContext добавим следующие строки кода: modelBuilder .Entity<Character>()//выбираем объект из контекста у нас он 1 .Property(c => c.Inventory)//выбираем свойство .HasConversion( //определяем кастомные методы для обработки данных i => JsonConvert.SerializeObject(i), // при сохранении i => JsonConvert.DeserializeObject<List<Item>>(i) // при загрузке ); За это отвечает метод HasConversion(), где первым параметром передается метод обработки данных при сохранении, а вторым при загрузке. В нашем случае это будет сериализация коллекции в строку при сохранении и обратно при загрузке. Для примера мы использовали методы из библиотеки Newtonsoft.Json В результате у нас добавилась колонка Inventory с типом text которая хранит нашу сериализованую коллекцию в виде строки, конечно пустой массив это не лучший пример, позже сделаю новый скриншот, если не забуду. Последним пунктом по настройке базы данных у нас будет исключение ненужных нам свойства Date, и класса Item. Так как класс Item включен в состав нашего основного класса Character, то EF Core попытается создать для него отдельную таблицу, а она нам не нужна. Тут все просто: modelBuilder.Ignore<Item>(); Вот так мы добавляем класс Item в список игнорируемых классов modelBuilder.Entity<Character>().Ignore(c => c.Date); А вот так Свойство Date класса Character Так выглядит общая структура созданной нами базы данных: Миграции базы данных Миграция базы данных это автоматическое созданная структура базы данных для нашего класса, в нашем случае SQL. Миграцию можно настроить как в автоматическом режиме, при запуске приложения, так и производить миграцию в ручном режиме. В рамках этого гайда мы не будем настраивать автоматический режим. В ручном режиме вы наглядно увидите что происходит. Для начала нам нужно отобразить окно с названием "Консоль диспетчера пакетов" для этого жмякаем : Вид -> Другие окна -> Консоль диспетчера пакетов В левом нижнем углу появится окно с названием, как ни странно "Консоль диспетчера пакетов". Давайте там пропишем команду для создания миграции: add-migration test_001 где add-migration это сама команда а test_001 это название будущей миграции и нажмем Enter Если мы все сделали правильно, мы должны увидеть сообщение следующего характера повествующее нам о том, что отменить это действие можно введя в консоли команду remove-migration: В проекте будет создана папка с файлами миграции Далее, чтобы развернуть саму базу данных введем команду update-database. Если строка подключения настроена корректна и база данных доступна вы увидите следующее сообщение об успешной миграции: В базе данных у нас должны появится таблицы соответствующие нашим настройкам. Дальнейшая работа с миграциями отличается больше чем никак: При изменении структуры класса мы создаем новую миграцию при помощи команды add-migration изменяя только имя самой миграции test_002 к примеру. Имя может быть произвольным, но уникальным. Для обновления базы введите команду update-database . В папке Migrations будет вестись история ваших миграций и вы в любой момент сможете откатить базу данных к любому этапу, используя команду update-database с именем миграции до которой нужно произвести откат изменений. Например последняя миграция у нас test_002 а нам нужно откатить до версии test_001, для этого мы должны ввести команду: update-database test_001 Думаю на этом этапе с миграциями мы закончим, если что-то непонятно по миграциям пишите в комментариях. Далее рассмотрим непосредственно работу с базой. Работа с базой данных Сохранение Для того чтобы добавить данные о персонаже в базу, нам нужно создать экземпляр нашего класса и добавить его в контекст при помощи метода Add(), после чего нужно сохранить все изменения из контекста данных непосредственно в базу при помощи метода SaveChanges() public void OnRegistration(Client client, string name, string lastname, string password) { //не забываем про хеширование пароля перед сохранением в бд //создаем нового персонажа Character Char = new Character { Social = client.SocialClubName, Name = name, Lasname = lastname, Password = password, Finance = new Finances(), State = new States(), Inventory = new List<Item>(), Date = DateTime.Now }; //добавляем его в контекст данных Db.Instance.Add(Char); //сохранянем изменения в базе данных Db.Instance.SaveChanges(); } Для обновления данных нужно воспользоваться методом Update() для обновления данных о персонаже, и так же зафиксировать их при помощи метода SaveChanges() //обновляем данные в контексте Db.Instance.Update(Char); //и сохраняем в бд Db.Instance.SaveChanges(); Загрузка С загрузкой дела немного обстоят по другому. Для начала нам не нужны данные находящиеся в другой таблице, будь то состояние персонажа в нашем примере, его кастомизация или что-то еще. Нам будет достаточно информации о его логине и пароле. Рассмотрим пример загрузки данных из бд: public void OnRegistration(Client client, string pwd) { //Получаем персонажа из бд Character Char = Db.Instance.Characters.SingleOrDefault(c=>c.Social == client.SocialClubName); //если записи соответствующей кретерию нашего запроса нет вернется Null if (Char == null) return; //проверяем пароль на совпадение (не забываем про хеш) if (Char.Password == pwd) { //подгружаем зависимые классы вынексеные в отдельную таблицу Db.Instance.Entry(Char).Reference(c => c.State).Load(); //создаем ссылку на нашу модель игрока client.SetData("Character", Char); //загружаем игрока //.............. } else { //если не прошел проверку отправляем на повторный логин //................ } } В этом методе, в первую очередь, мы получаем первое значение соответствующее критерию нашего запроса и возвращаем экземпляр объекта Character со свойствами взятыми из бд. Свойство State, хранящееся в отдельно таблице, будет иметь значение null,его нужно будет явно запросить из базы, но на данном этапе нам достаточно данных чтобы сверить полученный от клиента пароль с паролем из бд (не забывайте про шифрование паролей). Если ни одна одна запись не будет соответствовать критерию нашего запроса вернется Null, это скажет нам о том что пользователя с данным логином не существует. Если значение пароля совпадает то пришло время подгрузить недостающие данные. Делаем это мы при помощи метода Load() для необходимого свойства - в нашем случае это State Db.Instance.Entry(Char).Reference(c => c.State).Load(); На этом этапе наш класс загружен в полном объеме и готов к употреблению. Нам осталось сохранить ссылку на него что бы в дальнейшем можно было манипулировать данными. На этом думаю закончу, если что-то непонятно пишите, постараюсь дополнить. А я устал - я ухожу...