Question 1

How do I serialize a simple class with JsonSrcGen?

Accepted Answer

Add the `[Json]` attribute to your class and use properties with supported types, then create a `JsonConverter` instance and call `ToJson` or `ToJsonUtf8`. For example, `[Json] public class MyType { public string MyProperty { get; set; } }`.

Question 2

JsonSrcGen vs System.Text.Json: which is better for performance?

Accepted Answer

JsonSrcGen typically offers better performance due to compile-time code generation that avoids reflection, while System.Text.Json uses runtime reflection but has broader built-in support and easier setup. Choose JsonSrcGen for high-performance needs, but expect more configuration work.

Question 3

Can JsonSrcGen handle custom data types like enums or complex objects?

Accepted Answer

Yes, via custom converters by implementing `ICustomConverter<T>` and adding the `[CustomConverter]` attribute. This allows you to define serialization logic for any type, though it requires extra code compared to built-in support.

Question 4

Is JsonSrcGen compatible with .NET Framework projects?

Accepted Answer

No, JsonSrcGen requires .NET 5 or later because it relies on C# source generators, which aren't available in .NET Framework or older .NET Core versions. You'll need to upgrade your project to use it.

Question 5

How to ignore null properties when serializing with JsonSrcGen?

Accepted Answer

Add the `[JsonIgnoreNull]` attribute to your class, and JsonSrcGen will skip serializing any properties with null values, reducing JSON size and improving efficiency for sparse data.

Question 6

What's the setup process for arrays and lists in JsonSrcGen?

Accepted Answer

Define assembly-level attributes like `[assembly: JsonArray(typeof(bool))]` or `[assembly: JsonList(typeof(bool))]` in your code, which generates serializers at compile time but adds boilerplate to your project configuration.

JsonSrcGen

What is JsonSrcGen?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions