BaseHost.Web
1.2.7
dotnet add package BaseHost.Web --version 1.2.7
NuGet\Install-Package BaseHost.Web -Version 1.2.7
<PackageReference Include="BaseHost.Web" Version="1.2.7" />
paket add BaseHost.Web --version 1.2.7
#r "nuget: BaseHost.Web, 1.2.7"
// Install BaseHost.Web as a Cake Addin
#addin nuget:?package=BaseHost.Web&version=1.2.7
// Install BaseHost.Web as a Cake Tool
#tool nuget:?package=BaseHost.Web&version=1.2.7
Purpose
This is used as the foundation of my other C# projects. It provides some common bits of setup with are often needed. It sets up a configured host which uses my config module, my console module, Autofac and NLog. There is also a code generator which will create builders for any class [BuilderPattern].
How to use
Host
This is how a host can be setup, you'll need to add your own nlog config
public class Host : ConsoleHost{
public static void Main(string[] args) => new Host().Start(args);
protected override void Setup(ContainerBuilder builder){
builder.AutoActivateWith<Controller>(i => i.Start());
}
public class Controller{
public Controller(ILogger logger){...}
public void Start(){...}
}
}
Builder Generator
The generator will create a builder class, also add methods for each public property with a private mutator, With(value), Update(Func<value,value>). It will also make special use of ImmutableArray, ImmutableDictionary and ImmutableHashSet
Example model class
[BuilderPattern]
public partial class Model
{
public string Value { get; private set; }
}
generated class
public partial class Model
{
private Model () { }
public Builder AsBuilder() => Builder.BasedOn(this);
public static Builder CreateBuilder() => Builder.Instance();
public Mutable AsMutable() => new Mutable(){
Value = this.Value,
};
public Model WithValue(string value) => AsBuilder().WithValue(value).Build();
public Model UpdateValue(Func<string,string> valueFunc) => AsBuilder().UpdateValue(valueFunc).Build();
public sealed partial class Builder {
private Model _instance = new Model();
private Builder() { }
internal static Builder Instance () => new Builder();
internal static Builder BasedOn(Model reference) => Instance ()
.WithValue(reference.Value);
public Builder WithValue(string value){
_instance.Value = value;
return this;
}
public Builder UpdateValue(Func<string,string> valueFunc){
_instance.Value = valueFunc(_instance.Value);
return this;
}
public Model Build() {
var local = _instance;
_instance = null;
local = local.GetValidatedInstance();
return local;
}
}
public sealed class Mutable {
public string Value {get; set; }
public Model AsImmutable() => Model.CreateBuilder()
.WithValue(this.Value)
.Build();
}}}
Console
There are shells, console and commands. shells run on a console, and have access to commands. new commands can be registered and them will be accessable from all the consoles. There are some commands included, for shutdown/get-starting-args/config and more commands can be registered in ICommandManager
There is also a websocket interface for this.
var shutdown = new Shutdown();
_commandManager.Register("get-starting-args",args);
Config
A config can be given in the form of a json file (Host.config.json), if no json file is provied one will be generated and saved in output at runtime. Config is specified as below:
[ConfigValue(Name = "ws_pokemon_server_path", DefaultString = "ws:bhah.blah.blah:12")]
private static string ConnectionString => Config.ws_pokemon_server_path; //Config is generated at build time
Extention Methods
Lots of extention methods, covering a variety of functionality, ienumerable/observables/funcs ..., not really much structure, just whaterver I've found useful
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net8.0
- Autofac (>= 8.0.0)
- Autofac.Extensions.DependencyInjection (>= 9.0.0)
- BaseHost (>= 1.2.7)
- CommandLineParser (>= 2.9.1)
- GraphQL.Server.Ui.Playground (>= 7.7.1)
- GraphQL.Server.Ui.Voyager (>= 7.7.1)
- HotChocolate.AspNetCore (>= 13.9.6)
- Microsoft.AspNetCore.Mvc.NewtonsoftJson (>= 8.0.6)
- Microsoft.OpenApi (>= 1.6.14)
- Newtonsoft.Json (>= 13.0.3)
- NLog (>= 5.3.2)
- NLog.Web.AspNetCore (>= 5.3.11)
- Swashbuckle.AspNetCore (>= 6.6.2)
- Swashbuckle.AspNetCore.Newtonsoft (>= 6.6.2)
- System.Collections.Immutable (>= 8.0.0)
- System.ComponentModel.Annotations (>= 5.0.0)
- System.Reactive (>= 6.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.