Skip to main content

Use the power of Source Generators with Lombok.NET

Since the introduction of source generators in .NET 5, I always wondered what the cool use cases would be that this feature makes possible. Today I want to introduce to you Lombok.NET, as an example of what Source Generators make possible.

Lombok.NET

If you are a Java developer, the name ‘Lombok’ maybe rings a bell. Lombok.NET is inspired by Project Lombok, a Java library with as main goal to help you minimize the amount of boilerplate code you need to write. I have no clue how this exactly works in Java, but Lombok.NET has the same goal using Source Generators.

Here are the list of features that Lombok.NET supports today:

Let’s have a look at 2 of them that I use the most.

Installation

Before we can use Lombok.NET, we need to install it first. this is quite easy because it is just a NuGet package:

dotnet add package Lombok.NET

Usage

Now we start using Lombok.NET. The way that it works is by annotating our classes, structs, interfaces, … with some attributes.

ToString

The first one I want to show you is the [ToString] attribute.  This will generate a ToString implementation that will print out all the private fields(can be configured) from your class.

We start with a Person class with 2 properties. Notice that I made the class partial. This is required so that Lombok.NET can extend the class definition without having to update the original file.

Now we introduce the [ToString] attribute. I set the MemberType to MemberType.Property and  AccessTypes to AccessTypes.Public because I want to include the public properties in the generated ToString implementation:

If we now build our code, a partial class is generated:

Let’s have a look at what is inside:

Nice!

Async Overloads

Let’s have a look at another example. With Async Overloads Lombok.NET will generate an async overload for every method in your interface(it also works for abstract classes and methods).

Here is an example of a small IRepository interface. Notice that here as well I need to make the interface partial:

We add an [AsyncOverloads] attribute to annotate our interface:

If we build our code, a partial interface is generated . Here is what is inside:

Certainly have a look at the other possibilities that Lombok.NET has to offer.

And if you are looking at some other use cases where Source Generators are useful, here are some examples:

Popular posts from this blog

XUnit - Assert.Collection

A colleague asked me to take a look at the following code inside a test project: My first guess would be that this code checks that the specified condition(the contains) is true for every element in the list.  This turns out not to be the case. The Assert.Collection expects a list of element inspectors, one for every item in the list. The first inspector is used to check the first item, the second inspector the second item and so on. The number of inspectors should match the number of elements in the list. An example: The behavior I expected could be achieved using the Assert.All method:

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.

Angular --deploy-url and --base-href

As long you are running your Angular application at a root URL (e.g. www.myangularapp.com ) you don’t need to worry that much about either the ‘--deploy-url’ and ‘--base-href’ parameters. But once you want to serve your Angular application from a server sub folder(e.g. www.mywebsite.com/angularapp ) these parameters become important. --base-href If you deploy your Angular app to a subfolder, the ‘--base-href’ is important to generate the correct routes. This parameter will update the <base href> tag inside the index.html. For example, if the index.html is on the server at /angularapp/index.html , the base href should be set to <base href="/angularapp/"> . More information: https://angular.io/guide/deployment --deploy-url A second parameter that is important is ‘--deploy-url’. This parameter will update the generated url’s for our assets(scripts, css) inside the index.html. To make your assets available at /angularapp/, the deploy url should