C# Source Generator to create Value object pattern, also inspired by units of measure to support all arithmetic operators and serialization.
NuGet: UnitGenerator
Install-Package UnitGenerator
For example, Identifier, UserId is comparable only to UserId, and cannot be assigned to any other type. Also, arithmetic operations are not allowed.
usingUnitGenerator;[UnitOf(typeof(int))]publicreadonlypartialstructUserId{}will generates
[System.ComponentModel.TypeConverter(typeof(UserIdTypeConverter))]publicreadonlypartialstructUserId:IEquatable<UserId>{readonlyintvalue;publicUserId(intvalue){this.value=value;}publicreadonlyintAsPrimitive()=>value;publicstaticexplicitoperatorint(UserIdvalue)=>value.value;publicstaticexplicitoperatorUserId(intvalue)=>newUserId(value);publicboolEquals(UserIdother)=>value.Equals(other.value);publicoverrideboolEquals(object?obj)=>// snip...publicoverride int GetHashCode()=>value.GetHashCode();publicoverridestringToString()=>value.ToString();publicstaticbooloperator==(inUserIdx,inUserIdy)=>x.value.Equals(y.value);publicstaticbooloperator!=(inUserIdx,inUserIdy)=>!x.value.Equals(y.value);privateclassUserIdTypeConverter:System.ComponentModel.TypeConverter{// snip...}}However, Hp in games, should not be allowed to be assigned to other types, but should support arithmetic operations with int. For example double heal = target.Hp = Hp.Min(target.Hp * 2, target.MaxHp).
[UnitOf(typeof(int),UnitGenerateOptions.ArithmeticOperator|UnitGenerateOptions.ValueArithmeticOperator|UnitGenerateOptions.Comparable|UnitGenerateOptions.MinMaxMethod)]publicreadonlypartialstructHp{}// -- generates[System.ComponentModel.TypeConverter(typeof(HpTypeConverter))]publicreadonlypartialstructHp:IEquatable<Hp>,IComparable<Hp>{readonlyintvalue;publicHp(intvalue){this.value=value;}publicintAsPrimitive()=>value;publicstaticexplicitoperatorint(Hpvalue)=>value.value;publicstaticexplicitoperatorHp(intvalue)=>newHp(value);publicboolEquals(Hpother)=>value.Equals(other.value);publicoverrideboolEquals(object?obj)=>// snip...publicoverride int GetHashCode()=>value.GetHashCode();publicoverridestringToString()=>value.ToString();publicstaticbooloperator==(inHpx,inHpy)=>x.value.Equals(y.value);publicstaticbooloperator!=(inHpx,inHpy)=>!x.value.Equals(y.value);privateclassHpTypeConverter:System.ComponentModel.TypeConverter{/* snip... */}// UnitGenerateOptions.ArithmeticOperatorpublicstaticHpoperator+(inHpx,inHpy)=>newHp(checked((int)(x.value+y.value)));publicstaticHpoperator-(inHpx,inHpy)=>newHp(checked((int)(x.value-y.value)));publicstaticHpoperator*(inHpx,inHpy)=>newHp(checked((int)(x.value*y.value)));publicstaticHpoperator/(inHpx,inHpy)=>newHp(checked((int)(x.value/y.value)));// UnitGenerateOptions.ValueArithmeticOperatorpublicstaticHpoperator++(inHpx)=>newHp(checked((int)(x.value+1)));publicstaticHpoperator--(inHpx)=>newHp(checked((int)(x.value-1)));publicstaticHpoperator+(inHpx,ininty)=>newHp(checked((int)(x.value+y)));publicstaticHpoperator-(inHpx,ininty)=>newHp(checked((int)(x.value-y)));publicstaticHpoperator*(inHpx,ininty)=>newHp(checked((int)(x.value*y)));publicstaticHpoperator/(inHpx,ininty)=>newHp(checked((int)(x.value/y)));// UnitGenerateOptions.ComparablepublicintCompareTo(Hpother)=>value.CompareTo(other.value);publicstaticbooloperator>(inHpx,inHpy)=>x.value>y.value;publicstaticbooloperator<(inHpx,inHpy)=>x.value<y.value;publicstaticbooloperator>=(inHpx,inHpy)=>x.value>=y.value;publicstaticbooloperator<=(inHpx,inHpy)=>x.value<=y.value;// UnitGenerateOptions.MinMaxMethodpublicstaticHpMin(Hpx,Hpy)=>newHp(Math.Min(x.value,y.value));publicstaticHpMax(Hpx,Hpy)=>newHp(Math.Max(x.value,y.value));}You can configure with UnitGenerateOptions, which method to implement.
[Flags]enumUnitGenerateOptions{None=0,ImplicitOperator=1,ParseMethod=2,MinMaxMethod=4,ArithmeticOperator=8,ValueArithmeticOperator=16,Comparable=32,Validate=64,JsonConverter=128,MessagePackFormatter=256,DapperTypeHandler=512,EntityFrameworkValueConverter=1024,WithoutComparisonOperator=2048,JsonConverterDictionaryKeySupport=4096}UnitGenerateOptions has some serializer support. For example, a result like Serialize(userId) => { Value = 1111 } is awful. The value-object should be serialized natively, i.e. Serialize(useId) => 1111, and should be able to be added directly to a database, etc.
Currently UnitGenerator supports MessagePack for C#, System.Text.Json(JsonSerializer), Dapper and EntityFrameworkCore.
[UnitOf(typeof(int),UnitGenerateOptions.MessagePackFormatter)]publicreadonlypartialstructUserId{}// -- generates[MessagePackFormatter(typeof(UserIdMessagePackFormatter))]publicreadonlypartialstructUserId{classUserIdMessagePackFormatter:IMessagePackFormatter<UserId>{publicvoidSerialize(refMessagePackWriterwriter,UserIdvalue,MessagePackSerializerOptionsoptions){options.Resolver.GetFormatterWithVerify<int>().Serialize(refwriter,value.value,options);}publicUserIdDeserialize(refMessagePackReaderreader,MessagePackSerializerOptionsoptions){returnnewUserId(options.Resolver.GetFormatterWithVerify<int>().Deserialize(refreader,options));}}}When referring to the UnitGenerator, it generates a internal UnitOfAttribute.
namespaceUnitGenerator{[AttributeUsage(AttributeTargets.Struct,AllowMultiple=false)]internalclassUnitOfAttribute:Attribute{publicUnitOfAttribute(Typetype,UnitGenerateOptionsoptions=UnitGenerateOptions.None,stringtoStringFormat=null)}}You can attach this attribute with any specified underlying type to readonly partial struct.
[UnitOf(typeof(Guid))]publicreadonlypartialstructGroupId{}[UnitOf(typeof(string))]publicreadonlypartialstructMessage{}[UnitOf(typeof(long))]publicreadonlypartialstructPower{}[UnitOf(typeof(byte[]))]publicreadonlypartialstructImage{}[UnitOf(typeof(DateTime))]publicreadonlypartialstructStartDate{}[UnitOf(typeof((stringstreet,stringcity)))]publicreadonlypartialstructStreetAddress{}Standard UnitOf(UnitGenerateOptions.None) generates value constructor, explicit operator, implement IEquatable<T>, override GetHashCode, override ToString, == and != operator, TypeConverter for ASP.NET Core binding, AsPrimitive method.
If you want to retrieve primitive value, use AsPrimitive() instead of .Value. This is intended to avoid casual getting of primitive values (using the arithmetic operator option if available).
When type is bool, also implements
true,false,!operators.
publicstaticbooloperator true(Foox)=>x.value;publicstaticbooloperator false(Foox)=>!x.value;publicstaticbooloperator!(Foox)=>!x.value;When type is Guid or Ulid, also implements
New()andNew***()static operator.
publicstaticGroupIdNew();publicstaticGroupIdNewGroupId();Second parameter UnitGenerateOptions options can configure which method to implement, default is None.
Third parameter strign toStringFormat can configure ToString format. Default is null and output as ${0}.
When referring to the UnitGenerator, it generates a internal UnitGenerateOptions that is bit flag of which method to implement.
[Flags]internalenumUnitGenerateOptions{None=0,ImplicitOperator=1,ParseMethod=2,MinMaxMethod=4,ArithmeticOperator=8,ValueArithmeticOperator=16,Comparable=32,Validate=64,JsonConverter=128,MessagePackFormatter=256,DapperTypeHandler=512,EntityFrameworkValueConverter=1024,}You can use this with [UnitOf].
[UnitOf(typeof(int),UnitGenerateOptions.ArithmeticOperator|UnitGenerateOptions.ValueArithmeticOperator|UnitGenerateOptions.Comparable|UnitGenerateOptions.MinMaxMethod)]publicreadonlypartialstructStrength{}[UnitOf(typeof(DateTime),UnitGenerateOptions.Validate|UnitGenerateOptions.ParseMethod|UnitGenerateOptions.Comparable)]publicreadonlypartialstructEndDate{}[UnitOf(typeof(double),UnitGenerateOptions.ParseMethod|UnitGenerateOptions.MinMaxMethod|UnitGenerateOptions.ArithmeticOperator|UnitGenerateOptions.ValueArithmeticOperator|UnitGenerateOptions.Comparable|UnitGenerateOptions.Validate|UnitGenerateOptions.JsonConverter|UnitGenerateOptions.MessagePackFormatter|UnitGenerateOptions.DapperTypeHandler|UnitGenerateOptions.EntityFrameworkValueConverter)]publicreadonlypartialstructAllOptionsStruct{}You can setup project default options like this.
internalstaticclassUnitOfOptions{publicconstUnitGenerateOptionsDefault=UnitGenerateOptions.ArithmeticOperator|UnitGenerateOptions.ValueArithmeticOperator|UnitGenerateOptions.Comparable|UnitGenerateOptions.MinMaxMethod;}[UnitOf(typeof(int),UnitOfOptions.Default)]publicreadonlypartialstructHp{}// Defaultpublicstaticexplicitoperator U(Tvalue)=>value.value;publicstaticexplicitoperator T(Uvalue)=>newT(value);// UnitGenerateOptions.ImplicitOperatorpublicstaticimplicitoperator U(Tvalue)=>value.value;publicstaticimplicitoperator T(Uvalue)=>newT(value);publicstaticTParse(strings)publicstaticboolTryParse(strings,outTresult)publicstaticTMin(Tx,Ty)publicstaticTMax(Tx,Ty)publicstaticToperator+(inTx,inTy)=>newT(checked((U)(x.value+y.value)));publicstaticToperator-(inTx,inTy)=>newT(checked((U)(x.value-y.value)));publicstaticToperator*(inTx,inTy)=>newT(checked((U)(x.value*y.value)));publicstaticToperator/(inTx,inTy)=>newT(checked((U)(x.value/y.value)));publicstaticToperator++(inTx)=>newT(checked((U)(x.value+1)));publicstaticToperator--(inTx)=>newT(checked((U)(x.value-1)));publicstaticToperator+(inTx,inUy)=>newT(checked((U)(x.value+y)));publicstaticToperator-(inTx,inUy)=>newT(checked((U)(x.value-y)));publicstaticToperator*(inTx,inUy)=>newT(checked((U)(x.value*y)));publicstaticToperator/(inTx,inUy)=>newT(checked((U)(x.value/y)));Implements IComparable<T> and >, <, >=, <= operators.
publicUCompareTo(Tother)=>value.CompareTo(other.value);publicstaticbooloperator>(inTx,inTy)=>x.value>y.value;publicstaticbooloperator<(inTx,inTy)=>x.value<y.value;publicstaticbooloperator>=(inTx,inTy)=>x.value>=y.value;publicstaticbooloperator<=(inTx,inTy)=>x.value<=y.value;Without implements >, <, >=, <= operators. For example, useful for Guid.
[UnitOf(typeof(Guid),UnitGenerateOptions.Comparable|UnitGenerateOptions.WithoutComparisonOperator)]publicreadonlypartialstructFooId{}Implements partial void Validate() method that is called on constructor.
// You can implement this custom validate method.[UnitOf(typeof(int),UnitGenerateOptions.Validate)]publicreadonlypartialstructSampleValidate{// impl here.privatepartialvoidValidate(){if(value>9999)thrownewException("Invalid value range: "+value);}}// Source generator generate this codes.publicT(int value){this.value=value;this.Validate();}privatepartialvoidValidate();Implements System.Text.Json's JsonConverter. It will be used JsonSerializer automatically.
[JsonConverter(typeof(UserIdJsonConverter))]publicreadonlypartialstructUserId{classUserIdJsonConverter:JsonConverter<UserId>}Implements JsonConverter's WriteAsPropertyName/ReadAsPropertyName. It supports from .NET 6, supports Dictionary's Key.
vardict=Dictionary<UserId,int>JsonSerializer.Serialize(dict);Implements MessagePack for C#'s MessagePackFormatter. It will be used MessagePackSerializer automatically.
[MessagePackFormatter(typeof(UserIdMessagePackFormatter))]publicreadonlypartialstructUserId{classUserIdMessagePackFormatter:IMessagePackFormatter<UserId>}Implements Dapper's TypeHandler by public accessibility. TypeHandler is automatically registered at the time of Module initialization.
publicreadonlypartialstructUserId{publicclassUserIdTypeHandler:Dapper.SqlMapper.TypeHandler<UserId>}[ModuleInitializer]
public staticvoid AddTypeHandler(){Dapper.SqlMapper.AddTypeHandler(new A.ATypeHandler());}Implements EntityFrameworkCore's ValueConverter by public accessibility. It is not registered automatically so you need to register manually.
publicreadonlypartialstructUserId{publicclassUserIdValueConverter:ValueConverter<UserId,int>}// setup handler manuallybuilder.HasConversion(newUserId.UserIdValueConverter());C# Source Generator feature is rely on C# 9.0. If you are using Unity 2021.2, that supports Source Generators. Add the UnitGenerator.dll from the releases page, disable Any Platform, disable Include all platforms and set label as RoslynAnalyzer.
It works in Unity Editor however does not work on IDE because Unity does not generate analyzer reference to .csproj. We provides CsprojModifer to analyzer support, uses Add analyzer references to generated .csproj supports both IDE and Unity Editor.
Unity(2020) does not support C# 9.0 so can not use directly. However, C# Source Genertor supports output source as file.
- Create
UnitSourceGen.csproj.
<ProjectSdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net5.0</TargetFramework>
<!-- add this two lines and configure output path -->
<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
<CompilerGeneratedFilesOutputPath>$(ProjectDir)..\Generated</CompilerGeneratedFilesOutputPath>
</PropertyGroup>
<ItemGroup>
<!-- reference UnitGenerator -->
<PackageReferenceInclude="UnitGenerator"Version="1.0.0" />
<!-- add target sources path from Unity -->
<CompileInclude="..\MyUnity\Assets\Scripts\Models\**\*.cs" />
</ItemGroup>
</Project>- install .NET SDK and run this command.
dotnet build UnitSourceGen.csproj
File will be generated under UnitGenerator\UnitGenerator.SourceGenerator\*.Generated.cs. UnitOfAttribute is also included in generated folder, so at first, run build command and get attribute to configure.
This library is under the MIT License.