CslaGeneratorSerialization 0.1.0

GeneratorSerialization

A custom CSLA serializer using C# source generators.

Getting Started

Reference the CslaGeneratorSerialization NuGet package. You also need to reference CSLA as well, though if you're using this generator, you are probably already referencing CSLA.

Prerequisites

The CslaGeneratorSerialization package targets .NET Standard 2.0, though the code it emits is not limited to .NET Standard 2.0.

Usage

To enable custom serialization, simply make your BO partial:

[Serializable]
public sealed partial class Person
	: BusinessBase<Person>
{
	[Create]
	private void Create() =>
		this.Id = Guid.NewGuid();

	public static readonly PropertyInfo<uint> AgeProperty =
		RegisterProperty<uint>(_ => _.Age);
	[Required]
	public uint Age
	{
		get => this.GetProperty(Person.AgeProperty);
		set => this.SetProperty(Person.AgeProperty, value);
	}

	public static readonly PropertyInfo<Guid> IdProperty =
		RegisterProperty<Guid>(_ => _.Id);
	[Required]
	public Guid Id
	{
		get => this.GetProperty(Person.IdProperty);
		set => this.SetProperty(Person.IdProperty, value);
	}

	public static readonly PropertyInfo<string> NameProperty =
		RegisterProperty<string>(_ => _.Name);
	[Required]
	public string Name
	{
		get => this.GetProperty(Person.NameProperty);
		set => this.SetProperty(Person.NameProperty, value);
	}
}

The generator will create a custom implementation of IGeneratorSerializable. Note that you must do this for all of your BOs, even ones in other libraries. The generator assumes that this interface will be implemented and attempt to cast all BOs to this type.

You will also need to register the custom serializer during application configuration:

var services = new ServiceCollection();
services.AddCsla(o =>
  o.Serialization(so => so.SerializationFormatter(typeof(GeneratorFormatter))));
var provider = services.BuildServiceProvider();

That should do it to get your application to start using this custom serialization formatter.

Additional Documentation

• Changelog
• CSLA

Feedback

If you run into any issues, please add them here.