stevedunn / vogen.serialization

Source Generators in Vogen

Source generators are a powerful feature introduced in .NET 5 that allow code to be generated at compile time. This can significantly improve performance, reduce code duplication, and simplify development.

Vogen leverages source generators for the following reasons:

  • Improved Performance: By generating serialization code at compile time, Vogen avoids the runtime overhead of reflection, leading to faster serialization and deserialization.
  • Reduced Code Duplication: Vogen eliminates the need for manual implementation of serialization logic, reducing code complexity and the potential for errors.
  • Enhanced Type Safety: Vogen uses compile-time code generation to enforce type safety, ensuring that serialization and deserialization operations are performed correctly.

How Source Generators Work in Vogen:

Vogen uses the System.Text.Json library for serialization and deserialization. However, instead of relying on reflection, it generates specialized code for each type that needs to be serialized. This generated code is tailored to the specific structure of the type, resulting in optimal performance and reduced code size.

Options for Source Generation in Vogen:

Vogen provides the following options for controlling source generation:

  • [Vogen.Generate] Attribute: This attribute is applied to classes or structs that you want to enable source generation for. By default, this attribute generates all the necessary serialization code.
  • [Vogen.JsonSerializable] Attribute: This attribute applies if you want to skip the generation of serialization code. This allows for manual customization of the serialization process.

Example Usage:

// Apply the [Vogen.Generate] attribute to enable source generation
          [Vogen.Generate]
          public class MyData
          {
              public string Name { get; set; }
              public int Age { get; set; }
          }
          
// Skip source generation by using the [Vogen.JsonSerializable] attribute
          [Vogen.JsonSerializable]
          public class MyData
          {
              public string Name { get; set; }
              public int Age { get; set; }
          }

Benefits of Using Vogen’s Source Generators:

  • Improved Performance: By generating code at compile time, Vogen eliminates the performance overhead associated with reflection.
  • Reduced Boilerplate Code: Vogen automatically generates serialization logic, reducing the amount of code you need to write.
  • Enhanced Type Safety: Vogen’s source generators ensure that serialization and deserialization operations are performed correctly, reducing the risk of errors.
  • Customization: Vogen allows you to customize the serialization process through custom code generation, giving you full control over how your data is serialized and deserialized.

For more information: