ZayniFramework.Common 2.2.1

Common used .NET libraries such as extensions API, dynamic API, Reflection API, Paging API, TaskQueue and Result entities.

There is a newer version of this package available.
See the version list below for details.
Install-Package ZayniFramework.Common -Version 2.2.1
dotnet add package ZayniFramework.Common --version 2.2.1
<PackageReference Include="ZayniFramework.Common" Version="2.2.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ZayniFramework.Common --version 2.2.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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 place in different path with your entry assembly in runtime. You need to set the app.config file path to ConfigManagement.ConfigFullPath property. 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.
// 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=104.199.141.666,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 );

Extensions API example.

ObjectExtension

Convert an object to a Dictionary. Use the Object.ConvertToDictionary() extension method.

public void ConvertToDictionary_Example()
{
    var model = new UserModel
    {
        Name = "Amber",
        Age  = 23,
        Sex  = "female"
    };

    IDictionary dict = model.ConvertToDictionary();

    string name = dict[ "Name" ] + "";
    string sex  = dict[ "Sex" ]  + "";
    int    age  = int.Parse( dict[ "Age" ] + "" );
}

Convert List<T> to DataTable. Use List<T>.ConvertToDataTable() extension method.

var list = new List<UserModel>() 
{
    new UserModel() 
    {
        Name = "Sylvia",
        Age  = 35,
        Sex  = "Female"
    },
    new UserModel() 
    {
        Name = "Kate",
        Age  = 20,
        Sex  = "Female"
    },
    new UserModel() 
    {
        Name = "John",
        Age  = 23,
        Sex  = "Male"
    }
};

DataTable dt = list.ConvertToDataTable( "SomeTableName" );
Assert.IsNotNull( dt );          

Deep Clone Object. Use Object.CloneObject() or Object.Clone() extension method.

UserModel clone = obj.CloneObject<UserModel>();
UserModel copy  = obj.Clone<UserModel>();

Invoke the object's method. Use the Object.MethodInvoke() extension method.

public class MemberModel
{
    public string Name { get; set; }

    public string SayHello( string message ) => $"Hello, my name is {Name}. {message}";
}

public void MethodInvoke_Example()
{
    var model  = new MemberModel() { Name = "Sylvia" };
    var result = model.MethodInvoke( "SayHello", "This is a test." );
    Assert.AreEqual( "Hello, my name is Sylvia. This is a test.", result );
}

Get the property value. Use the Object.GetPropertyValue() extension method.

public void GetPropertyValueTest()
{
    var model = new MemberModel()
    {
        Name = "Kate"
    };

    object obj = model.GetPropertyValue( "Name" );
    Assert.IsNotNull( obj );

    string name = obj + "";
    Assert.AreEqual( model.Name, name );

    name = model.GetPropertyValue<string>( "Name" );
    Assert.AreEqual( model.Name, name );
}

Dynamic API example.

Add using.

using ZayniFramework.Common;
using ZayniFramework.Common.Dynamic;

Bind a property to dynamic object in runtime.

Use DynamicBroker.CreateDynamicObject() and DynamicBroker.BindProperty() static method.

public void BindPropertyTest()
{
    dynamic obj = DynamicBroker.CreateDynamicObject();
    Assert.IsNotNull( obj );

    bool isOk = DynamicBroker.BindProperty( obj, "UserName", "Sylvia" ); 
    Assert.IsTrue( isOk );

    string name = obj.UserName;
    Assert.AreEqual( "Sylvia", name );

    bool isOk2 = DynamicBroker.BindProperty( obj, "UserName", "Vivian" );
    Assert.IsTrue( isOk2 );

    string name2 = obj.UserName;
    Assert.AreEqual( "Vivian", name2 );
}

Bind a delegate to dynamic object in runtime.

Use DynamicBroker.BindMethod() static method.
Also demo Object.IsNotNull() extension method.

public void BindMethod_Example() 
{
    dynamic obj = DynamicBroker.CreateDynamicObject();
    Assert.IsNotNull( obj );

    bool isOk = DynamicBroker.BindProperty( obj, "UserName", "Sylvia" );
    Assert.IsTrue( isOk );

    string name = obj.UserName;
    Assert.AreEqual( "Sylvia", name );

    SaySomething handler = ( m ) => {
        return string.Format( "Hi, my name is {0}. {1}", obj.UserName, m );
    };

    bool isOk2 = DynamicBroker.BindMethod<SaySomething>( obj, "IntroduceYourself", handler );
    Assert.IsTrue( isOk2 );

    string message = obj.IntroduceYourself( "Nice to meet you." );
    Assert.IsTrue( message.IsNotNullOrEmpty() );
    Assert.AreEqual( "Hi, my name is Sylvia. Nice to meet you.", message );
}

TaskQueue example.

Add using.

using ZayniFramework.Common;
using ZayniFramework.Common.Tasks;

EnQueue an action to TaskQueue.

private static void ExecuteDirectly()
{
    var queue = new TaskQueue( false );

    for ( int i = 0; i < 50; i++ )
    {
        int j = i + 1;

        dynamic queueAction = new QueueAction( new Work().DoSomething );
        queueAction.Index   = j;
        queueAction.Message = new { Test = "123", NumberNo = 55 };
        queue.EnQueue( queueAction );
    }
}

More TaskQueue detail sample here.

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 place in different path with your entry assembly in runtime. You need to set the app.config file path to ConfigManagement.ConfigFullPath property. 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.
// 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=104.199.141.666,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 );

Extensions API example.

ObjectExtension

Convert an object to a Dictionary. Use the Object.ConvertToDictionary() extension method.

public void ConvertToDictionary_Example()
{
    var model = new UserModel
    {
        Name = "Amber",
        Age  = 23,
        Sex  = "female"
    };

    IDictionary dict = model.ConvertToDictionary();

    string name = dict[ "Name" ] + "";
    string sex  = dict[ "Sex" ]  + "";
    int    age  = int.Parse( dict[ "Age" ] + "" );
}

Convert List<T> to DataTable. Use List<T>.ConvertToDataTable() extension method.

var list = new List<UserModel>() 
{
    new UserModel() 
    {
        Name = "Sylvia",
        Age  = 35,
        Sex  = "Female"
    },
    new UserModel() 
    {
        Name = "Kate",
        Age  = 20,
        Sex  = "Female"
    },
    new UserModel() 
    {
        Name = "John",
        Age  = 23,
        Sex  = "Male"
    }
};

DataTable dt = list.ConvertToDataTable( "SomeTableName" );
Assert.IsNotNull( dt );          

Deep Clone Object. Use Object.CloneObject() or Object.Clone() extension method.

UserModel clone = obj.CloneObject<UserModel>();
UserModel copy  = obj.Clone<UserModel>();

Invoke the object's method. Use the Object.MethodInvoke() extension method.

public class MemberModel
{
    public string Name { get; set; }

    public string SayHello( string message ) => $"Hello, my name is {Name}. {message}";
}

public void MethodInvoke_Example()
{
    var model  = new MemberModel() { Name = "Sylvia" };
    var result = model.MethodInvoke( "SayHello", "This is a test." );
    Assert.AreEqual( "Hello, my name is Sylvia. This is a test.", result );
}

Get the property value. Use the Object.GetPropertyValue() extension method.

public void GetPropertyValueTest()
{
    var model = new MemberModel()
    {
        Name = "Kate"
    };

    object obj = model.GetPropertyValue( "Name" );
    Assert.IsNotNull( obj );

    string name = obj + "";
    Assert.AreEqual( model.Name, name );

    name = model.GetPropertyValue<string>( "Name" );
    Assert.AreEqual( model.Name, name );
}

Dynamic API example.

Add using.

using ZayniFramework.Common;
using ZayniFramework.Common.Dynamic;

Bind a property to dynamic object in runtime.

Use DynamicBroker.CreateDynamicObject() and DynamicBroker.BindProperty() static method.

public void BindPropertyTest()
{
    dynamic obj = DynamicBroker.CreateDynamicObject();
    Assert.IsNotNull( obj );

    bool isOk = DynamicBroker.BindProperty( obj, "UserName", "Sylvia" ); 
    Assert.IsTrue( isOk );

    string name = obj.UserName;
    Assert.AreEqual( "Sylvia", name );

    bool isOk2 = DynamicBroker.BindProperty( obj, "UserName", "Vivian" );
    Assert.IsTrue( isOk2 );

    string name2 = obj.UserName;
    Assert.AreEqual( "Vivian", name2 );
}

Bind a delegate to dynamic object in runtime.

Use DynamicBroker.BindMethod() static method.
Also demo Object.IsNotNull() extension method.

public void BindMethod_Example() 
{
    dynamic obj = DynamicBroker.CreateDynamicObject();
    Assert.IsNotNull( obj );

    bool isOk = DynamicBroker.BindProperty( obj, "UserName", "Sylvia" );
    Assert.IsTrue( isOk );

    string name = obj.UserName;
    Assert.AreEqual( "Sylvia", name );

    SaySomething handler = ( m ) => {
        return string.Format( "Hi, my name is {0}. {1}", obj.UserName, m );
    };

    bool isOk2 = DynamicBroker.BindMethod<SaySomething>( obj, "IntroduceYourself", handler );
    Assert.IsTrue( isOk2 );

    string message = obj.IntroduceYourself( "Nice to meet you." );
    Assert.IsTrue( message.IsNotNullOrEmpty() );
    Assert.AreEqual( "Hi, my name is Sylvia. Nice to meet you.", message );
}

TaskQueue example.

Add using.

using ZayniFramework.Common;
using ZayniFramework.Common.Tasks;

EnQueue an action to TaskQueue.

private static void ExecuteDirectly()
{
    var queue = new TaskQueue( false );

    for ( int i = 0; i < 50; i++ )
    {
        int j = i + 1;

        dynamic queueAction = new QueueAction( new Work().DoSomething );
        queueAction.Index   = j;
        queueAction.Message = new { Test = "123", NumberNo = 55 };
        queue.EnQueue( queueAction );
    }
}

More TaskQueue detail sample here.

NuGet packages (21)

Showing the top 5 NuGet packages that depend on ZayniFramework.Common:

Package Downloads
ZayniFramework.Logging
Support file log, database log, email log, windows event log and console log. Also you can define log event, then you can pipe your log message to anywhere you want.
ZayniFramework.Serialization
The serialization module support JSON (System.Text.Json or Newtonsoft.Json) or XML serialization. You can also define your own serialization component and register it into SerializerFactory.
ZayniFramework.Middle.Service.Entity
The Middle.ServiceHost.Entity define the entities and DTOs for Middle.ServiceHost and Middle.ServiceHost.Client module.
ZayniFramework.Validation
The Validation module provide many kinds of validation attributes and Validator for .NET applications.
ZayniFramework.DataAccess
This is a lightweight ORM framework like Dapper but also provider DbCommand SQL log. And support Microsoft SQL Server, MySQL and PostgreSQL database. Also support dynamic ORM.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
2.19.1 87 1/6/2021
2.19.0 104 1/1/2021
2.18.3 123 12/27/2020
2.18.2 922 8/29/2020
2.18.1 3,693 8/26/2020
2.18.0 463 8/20/2020
2.17.135 159 8/19/2020
2.17.134 1,023 7/28/2020
2.17.133 239 7/27/2020
2.17.132 254 7/18/2020
2.17.131 514 7/11/2020
2.16.130 604 6/13/2020
2.15.128 407 6/3/2020
2.15.127 539 5/31/2020
2.15.126 1,310 4/30/2020
2.14.122 446 4/13/2020
2.13.100 570 3/12/2020
2.12.51 593 2/18/2020
2.11.50 398 2/10/2020
2.10.44 629 1/30/2020
2.9.43 775 1/11/2020
2.8.42 629 1/10/2020
2.8.41 488 1/5/2020
2.7.40 552 1/2/2020
2.7.39 458 1/2/2020
2.7.38 618 1/1/2020
2.6.37 543 12/23/2019
2.6.35 786 12/4/2019
2.6.1 449 12/2/2019
2.6.0 458 11/28/2019
2.5.2 653 11/26/2019
2.5.1 569 11/12/2019
2.5.0 451 11/9/2019
2.4.3 595 10/16/2019
2.4.2 410 10/16/2019
2.4.1 574 9/20/2019
2.3.28 522 9/19/2019
2.3.27 613 8/30/2019
2.3.26 615 8/20/2019
2.3.25 562 8/12/2019
2.3.22 457 7/31/2019
2.3.21 668 7/20/2019
2.3.20 603 6/22/2019
2.3.19 516 6/14/2019
2.3.18 541 6/13/2019
2.3.17 588 6/13/2019
2.3.15 594 6/8/2019
2.3.14 572 6/8/2019
2.3.13 617 5/30/2019
2.3.12 563 5/24/2019
2.3.11 589 5/24/2019
2.3.10 616 5/21/2019
2.3.9 563 5/9/2019
2.3.8 590 5/8/2019
2.3.7 631 4/30/2019
2.3.6 604 4/23/2019
2.3.5 640 4/19/2019
2.3.4 550 4/18/2019
2.3.3 578 4/17/2019
2.3.2 594 4/6/2019
2.3.1 599 12/15/2018
2.3.0 607 12/7/2018
2.2.6 730 11/25/2018
2.2.3 396 11/23/2018
2.2.2 517 11/20/2018
2.2.1 717 11/17/2018
2.2.0 538 11/16/2018
2.1.0 559 11/15/2018
2.0.1 524 11/6/2018
2.0.0 534 11/4/2018
Show less