ZayniFramework.Common 2.3.2

Zayni Framework

• Create By: Lin, Ping-chen
• Create Date: 2016-05-17
• Update Date: 2019-04-04

The Zayni Framework is an application framework developed in C# programming language with .NET Standard 2.0. The Zayni Framework is try to help every .NET developer to build their applications and libraries easier. The concept is make every C# code or .NET libraries reusable, flexible and combinable.

Zayni Framework provide many kinds of common used libraries, extensions and service middleware framework for any .NET application (both .NET Core or .NET Framework application). If you want to know how to use Zayni Framework, you can take a look from the unit test projects or other test projects.

The modules in the Zayni Framework:

• Common module (Configs, interfaces, extensions, AOP interceptors, dynamic, reflections and converters... etc)
• Caching module (Memory, Redis, MySQL Memory Table Engine, ZayniFramework.Remote.ShareData.Service.)
• Caching.RemoteCache module (Out-process remote cache service library.)
• Caching.RedisClient module (The Redis client components.)
• Compression module (Provide GZip compression and extensions.)
• Cryptography module (AES, DES, SHA256, SHA512... etc and KeyMaker SDK tool.)
• Data Access & ORM module (Micro ORM, dynamic ORM for data access. Support the SQL Server and MySQL, SQL logging and database mirgarion CLI tool.)
• Data Access with LightORM module (Provide CRUD ORM DataContext template & SQL Engine.)
• Exception Handling module (Exception handler & exception policies.)
• Formatting module (Numerical data format, DateTime format, masking... etc)
• Logging module (Log event delegate, file log, console log, database log, email log & windows event log.)
• Serialization module (Json.NET, Jil, XML, BinaryFormatter & ZeroFormatter.)
• Validation module (Provide validator and many kinds of validtion attributes.)
• Middle.Service (Self-hosted middleware framework. Support multi-hosted remote host services like: TCP Socket, WebSocket, RabbitMQ and also In-Process service mode.)
• Middle.Service.Client module (The client-side proxy for Middle.Service module. Provide remote client such as the TCPSocket, WebSocket, RabbitMQ and In-Process Proxy to connect and access the Middle.Service remote host service.)
• Middle.Service.Entity module (The entities and DTOs for service middleware.)
• Middle.Service.Grpc module (The extension module for Middle.Service module. It provide the gRPC remote service host which is very fast RPC communication. You don't need to know any details about gRPC or ProtoBuf anymore. Just use the Middle.Service module to write your ServiceAction and you will have the benefit in gRPC and Zayni Framework both! 😃 )
• Middle.Service.Grpc.Client module (The extension module for Middle.Service.Client module. It provide the gRPC remote client.)
• Middle.Service.Grpc.Entity module (The extension module for Middle.Service.Entity module.)
• Middle.Service.HttpCore module (The extension module for Middle.Service module. It provide the ASP.NET Core Kestrel self-hosted http remote service. Using this extension module allow you to have more flexible in your application. You can build the http microservice in you existed console apps or any .NET Core applications, not just only in a ASP.NET Core website application.)
• Middle.Service.HttpCore.Client module (The extension module for Middle.Service.Client module. It provide the http remote client.)
• Middle.TelnetService module (Self-hosted telnet service for any .NET application)
• Remote.ShareData.Service

Here is the overview and main concept about the Zayni Framework.

You are welcome to contact with me if you have any questions or advises. Or create an new issue in this project. My email address is ponylin1985@gmail.com.

How to use Zayni Framework and Sample Code.

Add namespace using in your code.

using ZayniFramework.Common;

Configuration API example.

Read the app.config sample.

If you app.config's location is the same with your entry assembly. You can also use ConfigurationManager to read the configurations.<br/> BUT if your app.config's location is placed in different path with your entry assembly in runtime. You need to set the app.config file path to ConfigManagement.ConfigFullPath property before you using any Zayni Framework's module or libraries. So, the Zayni Framework can load all the configurations correctlly.

// This is the case that you place your app.config in different path with your entry assembly. You need to set the ConfigManagement.ConfigFullPath property before you using any Zayni Framework's module.
// If the app.config's path is the same with your entry assembly. You don't need to set the ConfigManagement.ConfigFullPath property.
// You app.config full path here...
var path = $"{Path.GetDirectoryName( Assembly.GetExecutingAssembly().Location )}/Configs/WebAPI.Test.dll.config";
ConfigManagement.ConfigFullPath = path;

In your app.config.

<connectionStrings>
    <add name="AAA" connectionString="SERVER=XXX.XXX.XXX.XXX;Port=3306;DATABASE=zayni;UID=XXX;PASSWORD=XXX;Allow User Variables=True;Charset=utf8;Convert Zero Datetime=True;"       providerName="MySql.Data.MySqlClient"/>
    <add name="BBB" connectionString="Server=XXX.XXX.XXX.XXX,1433;Database=ZayniFramework;User Id=XXX;Password=XXX;Max Pool Size=20;Min Pool Size=5;Connection Lifetime=30;" providerName="System.Data.SqlClient" />
</connectionStrings>
<appSettings>
    <add key="ABC" value="Hello, Zayni Framework" />
    <add key="DEF" value="Zayni Framework with Docker" />
    <add key="WWW" value="true" />
</appSettings>

Then you can read the configurations like this.

// Read the connection string.
string connectionStringA = ConfigManagement.ConnectionStrings[ "AAA" ].ConnectionString;
string connectionStringB = ConfigManagement.ConnectionStrings[ "BBB" ].ConnectionString;

// Read the appSettings
string a = ConfigManagement.AppSettings[ "ABC" ];
string b = ConfigManagement.AppSettings[ "DEF" ];

// or your can read appSettings like this.
Result r = await AppSettingsLoader.Instance.LoadBooleanConfigSettingAsync( "WWW" );
Assert.IsTrue( r.Success );
Assert.IsTrue( r.Data.Value );  // r.Data.Value is a Boolean type. The value will be true

Read the json config sample.

If you have a JSON file as a configuarion file like xxx.json. You can use ConfigManager.GetConfig( string path ) method to read the json config file.

// The path of your json config file.
string configPath = "./someDir/someConfig.json";

// Load the json configs with dynamic type.
dynamic configs = ConfigManager.GetConfig( configPath );

// Load the json configs with strong C# type. You can define the strong type class if you want.
var cfg = ConfigManager.GetConfig<TheStrongConfigType>( configPath );