dotnet_common 1.2.0

dotnet_common

Commonly used helpers for dotnet core.

Installation

This package can be installed via nuget using:

Install-Package dotnet_common

Or via the dotnet CLI using:

dotnet add package dotnet_common

Usage

For use with the built in dependency injection framework of a .net core web app / api, install the package (as per above) and then add whichever service you would like to use to your ConfigureServices method in your startup.cs class:

//cache manager class added as a singleton to keep one instance alive in your application
services.AddSingleton<dotnet_common.Interface.ICacheManager, dotnet_common.CacheManager.MemoryCache>();

//file system utility
services.AddScoped<dotnet_common.Interface.IFileSystemUtility, dotnet_common.FileSystemUtility.SystemIO>();

//marshaller that uses the data contract serializer
services.AddScoped<dotnet_common.Interface.IMarshaller, dotnet_common.Marshaller.DataContractSerializer>();

//encyption utility that uses AES
services.AddScoped<dotnet_common.Interface.IEncryptionUtility, dotnet_common.EncryptionUtility.AesEncryptionUtility>();

Next you can use whichever class you want in your controllers by adding them like so:

[Route("api/[controller]")]
public class ValuesController : Controller
{
    private readonly dotnet_common.Interface.ICacheManager _cacheManager;
    private readonly dotnet_common.Interface.IMarshaller _marshaller;
    private readonly dotnet_common.Interface.IFileSystemUtility _fileSystemUtility;
    private readonly dotnet_common.Interface.IEncryptionUtility _encryptionUtility;

    public [ControllerName]Controller(dotnet_common.Interface.ICacheManager cacheManager,
        dotnet_common.Interface.IMarshaller marshaller,
        dotnet_common.Interface.IFileSystemUtility fileSystemUtility,
        dotnet_common.Interface.IEncryptionUtility encryptionUtility)
    {
        _cacheManager = cacheManager;
        _marshaller = marshaller;
        _fileSystemUtility = fileSystemUtility;
        _encryptionUtility = encryptionUtility;
    }
}

You would then be able to use the privately instantiated version of the relevant class in your code.

Samples

There is a sample project included in the code to show usage in a dotnet core web API project.

• Sample Project

• Sample Startup Class

• Cache Manager being used in a controller

• File System Utility being used in a controller

• Marshaller being used in a controller

• Encryption utility being used in a controller