Koubot.Tool 1.0.5

Koubot.Tool

A toolkit to assist in the development of Koubot related projects, providing a large number of extension methods, as well as some tool classes, can also be used to develop other projects (for lazy people lol), has also been uploaded to Nuget, you can use Nuget search Koubot to reference. The toolkit project does not have and will not have other project dependencies.

bases on .NET Standard 2.0

This is an incomplete version of the document, go to https://github.com/Euynac/Koubot.Plugin for more information

Some of the methods inside use features of VS plug-in ReSharper, and good hints and code checking are available when using ReSharper

  	//Ability to teach ReSharper null judgment (passed in null, returns true)		
  	[ContractAnnotation("null => true")] 
     public static bool IsNullOrEmpty([CanBeNull] this string s)
         => string.IsNullOrEmpty(s);
//https://www.jetbrains.com/help/resharper/Contract_Annotations.html#syntax

General

KouTaskDelayer

Timer that executes a task at particular time. if used it, it will takes a long-running thread to determine whether there is a task in the task list that needs to be executed. Supports same execution times.

KouTaskDelayer.AddTask(executeDate, new Task(() => { ... }));

SortTool

Extension methods in it can help to quickly complete the implementation of Comparison, Compare and other related methods, and it support chaining (to achieve weight sorting) and compare with null.

		public int CompareTo(SystemAliasList? other)
        {
            return this.CompareToObjAsc(IsGlobalAlias, other?.IsGlobalAlias, out int result)
                ?.CompareToObjAsc(IsGroupAlias, other?.IsGroupAlias, out result)
                ?.CompareToObjAsc(Advanced, other?.Advanced, out result)
                ?.CompareToObjAsc(AliasId, other?.AliasId, out result) == null ? result : 0;
        }

For example, to implement a CompareTo method for alias list, the effect is that the list will first sorted by the IsGlobalAlias field in ascending order, then by the IsGroupAlias field ascending, then by the Advanced field ascending , and finally by the AliasID field ascending, and the empty ones will be placed at the end (represent the null comparison support)

KouWatch

Unit test timer/efficiency comparator

When you need to time the execution time, you always need to write：

Stopwatch watch = new Stopwatch();
watch.Start();
...
watch.Stop();
Debug.WriteLine(watch.ElapsedMilliseconds);

Obviously very tedious, if you use KouWatch, you can use the following instead, and it will automatically output the time when the execution is finished.

			KouWatch.Start("testName", () =>
            {
                ...
            });

In addition, if you want to compare the execution time, there are methods for comparing, such as testing the efficiency of GetCustomAttributeCached compared to the system method.

			KouWatch.Start("cache", () =>
            {
                userBlacklist.FieldInfo(p => p.Reason);//二次封装GetCustomAttributeCached
            }, "default", () =>
            {
                property.GetCustomAttribute<KouAutoModelField>(); ;
            }, 100000);

Web

LeakyBucketRateLimiter

A leaky bucket algorithm flow limiter specifically for client-side API calls. The common implementation of the Leaky Bucket algorithm on the web does not calculate the time it takes for a request to reach the server, causing it easily to exceed the QPS specified by the server. This flow limiter implementation takes the request out of the bucket only after it is complete.

QPS support floating point number, such as 0.5, that is, 2 seconds before a call (in addition, if the QPS is very large, the interval call once will be at most 50ms , so the current maximum effective support for QPS for about 20 (later to optimize)) error in 0.5ms - 3ms or so

In addition, the flow limiter supports multiple APIs to limit the flow simultaneously and does not open new threads for automatic bucket leakage, but uses these threads to automatically control the requests in the bucket (but this also creates the disadvantage of poor support for large QPS)

support setting timeout time

Usage example:

using (var limiter = new LeakyBucketRateLimiter("test", TestQPS, TestLimitedSize))
{
    if (!limiter.CanRequest())
    {
        Console.WriteLine($"Request Failed: {limiter.ErrorMsg}");
        return;
    }
    Console.WriteLine($"An API request is sent");
}

The IDisposable feature is utilized so that when the request is out of the using range, the request is automatically considered finished and the request can be removed from the bucket

Encoder/Decoder

Currently provides base64 encryption and decryption (WebTool.EncodeBase64), and MD5 encryption (WebTool.EncryptStringMD5).

Random

RandomTool

Initialize only once and always use the same random number seed.

Those starting with XXX. are extension methods of the corresponding type

Math

ExpressionCalculator

Expression calculator that can be used to calculate expressions like sin(pi/2)^e-1*floor(3.5).

...

String

Format

Use

var result = $"{Reason?.Be($"\nReason:{Reason}")}";

instead of

var result = $"{(Reason == null ? null : $"\nReason:{Reason}" )}";

There are also obj.BeIfNotEmpty，obj.BeIfNotWhiteSpace，obj.BeIfTrue，obj.BeIfNotDefault

...