{"id":1439,"date":"2023-05-24T12:42:52","date_gmt":"2023-05-24T10:42:52","guid":{"rendered":"https:\/\/fileidea.com\/?p=1439"},"modified":"2023-05-29T10:35:52","modified_gmt":"2023-05-29T08:35:52","slug":"loosly-coupled-database-class-example","status":"publish","type":"post","link":"https:\/\/fileidea.com\/2023\/05\/24\/loosly-coupled-database-class-example\/","title":{"rendered":"Loosly Coupled Database Class – example"},"content":{"rendered":"\n
I thought I would practice on creating a loosly coupled database model in .NET. Here is in my opinion, a good way to implement mongodb. Nothing else included than the connect part.<\/p>\n\n\n\n
\n
Create a folder Models<\/strong><\/li>\n\n\n\n
Then create a file called Database.cs<\/strong>. Let’s keep it simple and have everything in the same file (even though you should have separate for easier readability) <\/li>\n\n\n\n
Download the Package: MongoDB.Driver<\/strong><\/li>\n\n\n\n
In the file Database.cs, let’s create an interface for database clients, it can by any client therefore a name like IDatabaseClient will suffice.<\/li>\n<\/ul>\n\n\n\n
public interface IDatabaseClient\n {\n public void Connect(string connectionString);\n public void Disconnect();\n }<\/code><\/pre><\/div>\n\n\n\n
This is what all our clients can do which is Connect and Disconnect. Seems reasonble enough.<\/p>\n\n\n\n
Then let’s make a client utulizing this interface, in my case I want mongo database going so we will add the functions we need along with the mongo specific client like this.<\/p>\n\n\n\n
internal class MongoDatabaseClient : IDatabaseClient\n {\n public IMongoClient? MongoClient { get; set; } = null;\n public IMongoDatabase? MongoDatabase { get; set; } = null;\n\n public void Disconnect()\n {\n MongoClient = null;\n MongoDatabase = null;\n }\n\n public void Connect(string connectionString)\n {\n MongoClient = new MongoClient(connectionString);\n MongoDatabase = MongoClient.GetDatabase(MongoDatabaseConstants.Database);\n \/\/ Lets try create a collection\n MongoDatabase.CreateCollection(MongoDatabaseConstants.Collection);\n }\n }<\/code><\/pre><\/div>\n\n\n\n
Now we can initalize a MongoDatabaseClient and connect with it if we want. Also, almost forgot, create a file in the Models folder called MongoDatabaseConstants.cs which contains the Database and Collection name.<\/p>\n\n\n\n
namespace Tet.Models\n{\n public static class MongoDatabaseConstants\n {\n public static readonly string Database = "TestDb";\n public static readonly string Collection = "TestCollection";\n }\n}\n<\/code><\/pre><\/div>\n\n\n\n
To make things more clear and easier to use, we can make a kind of wrapper class which takes in any database client in its constructor and thus can connect any database client. The connect method also do a try catch there so you can retrive the error and do whatever you want.<\/p>\n\n\n\n
public class DatabaseClient\n {\n private readonly IDatabaseClient _databaseClient;\n\n public DatabaseClient(IDatabaseClient databaseClient)\n {\n _databaseClient = databaseClient;\n }\n\n public void Connect(string connectionString)\n {\n try {\n _databaseClient.Connect(connectionString);\n }\n catch (Exception e) {\n Console.WriteLine(e);\n }\n }\n public void Disconnect()\n {\n try\n {\n _databaseClient.Disconnect();\n }\n catch (Exception e)\n {\n Console.WriteLine(e);\n }\n }\n }<\/code><\/pre><\/div>\n\n\n\n
Now we have a loosly coupled class structure for our database. Initalize it like this:<\/p>\n\n\n\n
MongoDatabaseClient mongo = new MongoDatabaseClient();\nDatabaseClient db = new DatabaseClient(mongo);\ndb.Connect("mongodb:\/\/localhost:27017");<\/code><\/pre><\/div>\n\n\n\n
If you have any reflections or questions please share!<\/p>\n\n\n\n
Write to mongodb<\/h2>\n\n\n\n
Okay let’s take this into action in a web application. With some small modifications. <\/p>\n\n\n\n
\n
Create a ClassLibrary to keep better structure<\/li>\n\n\n\n
Move in your Models <\/strong>folder into the project<\/li>\n\n\n\n
Create a Repository <\/strong>folder<\/li>\n\n\n\n
Create a Services <\/strong>folder<\/li>\n\n\n\n
Create Constans <\/strong>folder and move your Constants file in there.<\/li>\n\n\n\n
Let’s create a ASP WebApplication with MVC in our solution<\/li>\n<\/ul>\n\n\n\n<\/figure>\n\n\n\n
\n
Then in our database.cs <\/strong>let’s add some more methods which all database clients can have. Let’s add \n
\n
Insert<\/li>\n\n\n\n
Update<\/li>\n\n\n\n
Delete<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n
public interface IDatabaseClient\n {\n public void Connect(string connectionString);\n public void Disconnect();\n\n public void Insert<T>(T document);\n public void Update<T>(string collectionName, FilterDefinition<T> filter, UpdateDefinition<T> update);\n public void Delete<T>(string collectionName, FilterDefinition<T> filter);\n }<\/code><\/pre><\/div>\n\n\n\n
With the new functions, we can now take in any object of any class and utilize this in the other parts of the application. Let’s implement these functions in our MongoDatabaseClient class.<\/p>\n\n\n\n
public class MongoDatabaseClient : IDatabaseClient\n {\n public IMongoClient? MongoClient { get; set; } = null;\n public IMongoDatabase? MongoDatabase { get; set; } = null;\n\n public void Disconnect()\n {\n MongoClient = null;\n MongoDatabase = null;\n }\n\n public void Connect(string connectionString)\n {\n MongoClient = new MongoClient(connectionString);\n MongoDatabase = MongoClient.GetDatabase(MongoDatabaseConstants.Database);\n }\n\n public void Insert<T>(T document)\n {\n var coll = MongoDatabase.GetCollection<T>(MongoDatabaseConstants.Collection);\n coll.InsertOne(document);\n }\n\n public void Update<T>(string collectionName, FilterDefinition<T> filter, UpdateDefinition<T> update)\n {\n throw new NotImplementedException();\n }\n\n public void Delete<T>(string collectionName, FilterDefinition<T> filter)\n {\n throw new NotImplementedException();\n }\n }\n\n public class DatabaseClient\n {\n private readonly IDatabaseClient _databaseClient;\n\n public DatabaseClient(IDatabaseClient databaseClient)\n {\n _databaseClient = databaseClient;\n }\n\n public void Connect(string connectionString)\n {\n try {\n _databaseClient.Connect(connectionString);\n }\n catch (Exception e) {\n Console.WriteLine(e);\n }\n }\n public void Disconnect()\n {\n try\n {\n _databaseClient.Disconnect();\n }\n catch (Exception e)\n {\n Console.WriteLine(e);\n }\n }\n }<\/code><\/pre><\/div>\n\n\n\n
Let’s create a class of our things we want to add to our mongo database, let’s go with chat messages! <\/p>\n\n\n\n
\n
Create and add ChatMessage.cs <\/strong>to the Models <\/li>\n<\/ul>\n\n\n\n
using MongoDB.Bson;\nusing MongoDB.Bson.Serialization.Attributes;\n\nnamespace ClassLibrary.Models\n{\n public class ChatMessage\n {\n [BsonId]\n [BsonRepresentation(BsonType.ObjectId)]\n public string Id { get; set; }\n [BsonElement]\n public string Chat { get; set; }\n }\n}\n<\/code><\/pre><\/div>\n\n\n\n
As you can see, we use the Bson tags to make it database friendly and ready to be used!<\/p>\n\n\n\n
Now, create a ChatRepository.cs<\/strong><\/p>\n\n\n\n
using ClassLibrary.Constants;\nusing MongoDB.Driver;\nusing System;\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Text;\nusing System.Threading.Tasks;\nusing Tet.Models;\n\nnamespace ClassLibrary.Repository\n{\n public interface IDatabaseRepostitory\n {\n public void Insert<T>(T document);\n }\n public class ChatRepository : IDatabaseRepostitory\n {\n readonly IDatabaseClient _client;\n public ChatRepository(IDatabaseClient databaseClient)\n {\n _client = databaseClient;\n _client.Connect(MongoDatabaseConstants.ConnectionString);\n }\n public void Insert<T>(T document)\n {\n _client.Insert(document);\n }\n }\n}\n<\/code><\/pre><\/div>\n\n\n\n
This is the layer that is communicating directly with our database client. As you can see, as soon as the Repository is initalized, we connect to the client, and we have a Insert <\/strong>function.<\/p>\n\n\n\n
Next up, create a ChatService.cs<\/strong> in the Services folder.<\/p>\n\n\n\n
using ClassLibrary.Models;\nusing ClassLibrary.Repository;\n\nnamespace ClassLibrary.Services\n{\n public interface IChatService\n {\n public void SendMessage<T>(ChatMessage repo);\n }\n public class ChatService : IChatService\n {\n readonly IDatabaseRepostitory _repository;\n public ChatService(IDatabaseRepostitory repo) {\n _repository = repo;\n }\n\n public void SendMessage<T>(ChatMessage message)\n {\n message.Chat = Guid.NewGuid().ToString();\n _repository.Insert(message);\n }\n }\n}\n<\/code><\/pre><\/div>\n\n\n\n
With our service, close to our front-end, we are now using dependency injection to take in our IDatabaseRepostitory<\/strong>.<\/p>\n\n\n\n
Next we can now go into any controller and depency inject our ChatService, so for example our HomeController.cs can take use of the Service.<\/p>\n\n\n\n
Now everytime we go to the HomeController, we will send a message and thus we add a message to the mongo collection! Be sure to alter everything as you want, I didn’t add delete or update, but it’s pretty much the same thing. <\/p>\n\n\n\n
Program.cs looks like this with depency injection:<\/p>\n\n\n\n
using ClassLibrary.Repository;\nusing ClassLibrary.Services;\nusing Tet.Models;\n\nvar builder = WebApplication.CreateBuilder(args);\n\n\/\/ Add services to the container.\nbuilder.Services.AddControllersWithViews();\nbuilder.Services.AddSingleton<IDatabaseClient, MongoDatabaseClient>();\nbuilder.Services.AddSingleton<IDatabaseRepostitory, ChatRepository>();\nbuilder.Services.AddSingleton<IChatService, ChatService>();\nvar app = builder.Build();\n\n\/\/ Configure the HTTP request pipeline.\nif (!app.Environment.IsDevelopment())\n{\n app.UseExceptionHandler("\/Home\/Error");\n \/\/ The default HSTS value is 30 days. You may want to change this for production scenarios, see https:\/\/aka.ms\/aspnetcore-hsts.\n app.UseHsts();\n}\n\napp.UseHttpsRedirection();\napp.UseStaticFiles();\n\napp.UseRouting();\n\napp.UseAuthorization();\n\napp.MapControllerRoute(\n name: "default",\n pattern: "{controller=Home}\/{action=Index}\/{id?}");\n\napp.Run();\n<\/code><\/pre><\/div>\n\n\n\nProject structure<\/figcaption><\/figure>\n\n\n\n
Hope you enjoyed this tutorial. To make everything more loosely coupled we could great a ClientDatabase factory, but that’s for another time! <\/p>\n","protected":false},"excerpt":{"rendered":"
I thought I would practice on creating a loosly coupled database model in .NET. Here is in my opinion, a good way to implement mongodb. Nothing else included than the connect part. This is what all our clients can do which is Connect and Disconnect. Seems reasonble enough. Then let’s make a client utulizing this … <\/p>\n
![\"\"](\"https:\/\/fileidea.com\/wp-content\/uploads\/2023\/05\/Skarmbild-2023-05-25-150938.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/fileidea.com\/wp-content\/uploads\/2023\/05\/image.png\")