This module is a part of the Pip.Services polyglot microservices toolkit. It provides a set of basic patterns used in microservices or backend services. Also the module implemenets a reasonably thin abstraction layer over most fundamental functions across all languages supported by the toolkit to facilitate symmetric implementation.
The module contains the following packages:
- Commands - commanding and eventing patterns
- Config - configuration framework
- Convert - soft value converters
- Data - data patterns
- Errors - application errors
- Random - random data generators
- Refer - locator (IoC) pattern
- Reflect - reflection framework
- Run - execution framework
- Validate - validation framework
- Configuration Pattern
- Locator Pattern
- Component Lifecycle
- Components with Active Logic
- Data Patterns
- API Reference
- Change Log
- Get Help
- Contribute
Install the dotnet package as
dotnet add package PipServices3.CommonsThen you are ready to start using the Pip.Services patterns to augment your backend code.
For instance, here is how you can implement a component, that receives configuration, get assigned references, can be opened and closed using the patterns from this module.
using PipServices3.Commons;
using PipServices3.Commons.Config;
using PipServices3.Commons.Refer;
using PipServices3.Commons.Run;
public class MyComponentA : IConfigurable, IReferenceable, IOpenable
{
private string _param1 = "ABC";
private int _param2 = 123;
private MyComponentB _anotherComponent;
private bool _opened = true;
public void Configure(ConfigParams config)
{
this._param1 = config.GetAsStringWithDefault("param1", this._param1);
this._param2 = config.GetAsIntegerWithDefault("param2", this._param2);
}
public void SetReferences(IReferences references)
{
this._anotherComponent = references.GetOneRequired<MyComponentB>(
new Descriptor("myservice", "mycomponent-b", "*", "*", "1.0")
);
}
public bool IsOpen()
{
return this._opened;
}
public Task OpenAsync(string correlationId)
{
Task task = Task.Factory.StartNew(() =>
{
this._opened = true;
Console.WriteLine("MyComponentA has been opened .");
});
return task;
}
public Task CloseAsync(string correlationId)
{
Task task = Task.Factory.StartNew(() =>
{
this._opened = true;
Console.WriteLine("MyComponentA has been closed.");
});
return task;
}
}Then here is how the component can be used in the code
using PipServices3.Commons.Config;
using PipServices3.Commons.Refer;
MyComponentA myComponentA = new MyComponentA();
// Configure the component
myComponentA.Configure(ConfigParams.FromTuples(
"param1", "XYZ",
"param2", "987"
));
// Set references to the component
myComponentA.SetReferences(References.FromTuples(
new Descriptor("myservice", "mycomponent-b", "default", "default", "1.0"), myComponentB
));
// Open the component
myComponentA.OpenAsync("123");For development you shall install the following prerequisites:
- Core .NET SDK 3.1+
- Visual Studio Code or another IDE of your choice
- Docker
Restore dependencies:
dotnet restore src/src.csprojCompile the code:
dotnet build src/src.csprojRun automated tests:
dotnet restore test/test.csproj
dotnet test test/test.csprojGenerate API documentation:
./docgen.ps1Before committing changes run dockerized build and test as:
./build.ps1
./test.ps1
./clear.ps1The .NET version of Pip.Services is created and maintained by:
- Sergey Seroukhov
- Alex Mazur
- Andrew Harrington
- Volodymyr Tkachenko
- Mark Zontak
Many thanks to contibutors, who put their time and talant into making this project better:
- Nick Jimenez, BootBarn Inc.