postsharp / postsharp.samples

PostSharp Samples

PostSharp.Samples

Welcome to this collection of PostSharp example projects.

You can browse these samples online and navigate the code just by clicking on code references, or you can download them on GitHub.

Project	Description
Aspect Framework
PostSharp.Samples.CustomLogging	Logs method calls including parameter values.
PostSharp.Samples.CustomCaching	Caches the results of methods calls
PostSharp.Samples.ExceptionHandling	Add parameter values to call stack in exception details. Report and then swallow exceptions in entry points.
PostSharp.Samples.AutoRetry	Automatically retries a method call when it fails.
PostSharp.Samples.WeakEvent	Prevents memory leaks due to events.
PostSharp.Samples.ValidateResourceString	Prints a build-time warning when incorrect resource string name is passed to parameter.
PostSharp.Samples.SessionState	Stores a field or property in the session state or page view state.
PostSharp.Samples.Transactions	Automatically executes a method inside a transaction.
PostSharp.Samples.Profiling	Measure different execution times of methods, including async methods.
PostSharp.Samples.Encryption	Automatically encrypts and decrypts parameter and fields/properties
PostSharp.Samples.MiniProfiler	Measures method execution time with MiniProfiler of StackExchange.
PostSharp.Samples.Persistence	Persists fields or properties into the Windows registry or app.config.
PostSharp.Samples.AutoDataContract	Automatically adds [DataContract] and [DataMember] attributes to derived classes and all properties
PostSharp.Samples.Authorization	Requires permissions before getting or setting fields or executing methods.
PostSharp.Samples.NormalizeString	Trims and lowercases strings before they are assigned to a field or property.
PostSharp.Samples.StoredProcedure	Implements something like P-Invoke, but for database stored procedures.
Diagnostics
PostSharp.Samples.Logging.Console	Demonstrates how to configure PostSharp Logging so that it directs its output to the system console.
PostSharp.Samples.Logging.PerRequest	Shows how to have different verbosity for each request,
PostSharp.Samples.Logging.Customization	Shows how to customize PostSharp Logging.
PostSharp.Samples.Logging.Etw	Demonstrates how to configure PostSharp Logging so that it directs its output to ETW.
PostSharp.Samples.Logging.Etw.CustomSource	Demonstrates how use PostSharp Logging with a custom ETW source (instead of the predefined one).
PostSharp.Samples.Logging.Log4Net	Demonstrates how to configure PostSharp Logging so that it directs its output to log4net.
PostSharp.Samples.Logging.NLog	Demonstrates how to configure PostSharp Logging so that it directs its output to NLog.
PostSharp.Samples.Logging.Serilog	Demonstrates how to configure PostSharp Logging so that it directs its output to Serilog.
PostSharp.Samples.Logging.Loupe	Demonstrates how to configure PostSharp Logging so that it directs its output to Loupe.
PostSharp.Samples.Logging.CommonLogging	Demonstrates how to configure PostSharp Logging so that it directs its output to Common.Logging.
PostSharp.Samples.Logging.CustomBackend.ServiceStack	Demonstrates how to implement a PostSharp Logging adapter for your custom logging framework.
PostSharp.Samples.Logging.Audit	Shows how to append an audit record to a database when a method is invoked.
Distributed Diagnostics with Elastic Search
PostSharp.Samples.Logging.ElasticStack/MicroserviceExample	The server-side service demonstrating correlation of logs of a distributed application with Elastic Search.
PostSharp.Samples.Logging.ElasticStack/ClientExample	The server-side service demonstrating correlation of logs of a distributed application with Elastic Search.
XAML
PostSharp.Samples.Xaml	Demonstrates a few ready-made aspects that are useful for XAML
Caching
PostSharp.Samples.Caching	Caching method results with Redis and different ways to remove things from the cache.
Threading
PostSharp.Samples.Threading.PingPong	The classic educational ping-pong example.
PostSharp.Samples.Threading.ThreadDispatching	A simple WPF progress bar updated from a background thread.
Platform Support
PostSharp.Samples.Blazor.AutoRetry	Demonstrates a custom aspect used in a Blazor application.

postsharp.samples's Issues

Suggestion: Add Blazor support

This may be late, but since I didn't find samples of PostSharp in Blazor I assume that there isn't support at all. I recently read about MVVM Support in Blazor and noticed that with PostSharp we can have (finally) a stable version after a long waiting. Here is the link I read https://blog.jeremylikness.com/blog/2019-01-04_mvvm-support-in-blazor/.

PostSharp No Longer Works with Blazor Web Assembly in .NET 8

Hi there

You've got a sample project at, "Blazor/PostSharp.Samples.Blazor.AutoRetry/PostSharp.Samples.Blazor.AutoRetry.csproj".

This project was originally running .NET 6 and was working with no issues - I could see the output of the Aspect in the browser developer tool console window.

I then updated the .NET version to 8.0, the "Microsoft.AspNetCore.Components.WebAssembly" and "Microsoft.AspNetCore.Components.WebAssembly.DevServer" NuGet package refs to version 8.0.2 the PostSharp package ref version to 2024.0.5. After the upgrades, PostSharp no longer seems to inject the aspect behaviour - I see no Aspect output in the console window anymore.

I want to use PostSharp in my Web Assembly project but I have no intention of rolling back to a previous version of .NET just to support your (commercial) product.

Am I missing something in the upgrade? Everything else within the Blazor app seems to be working as expected.

Missing Advanced Code Samples For Dependency Injection

The code samples for explaining, "Consuming Dependencies from an Aspect", are all missing from the "PostSharp.Samples" solution. All of these are great examples to follow in real practical projects for something as simple as creating a detailed physical log file within PostSharp Aspects.

This section presents several ways to consume dependencies from an aspect:

• Using a Global Composition Container
• Using a Global Service Locator
• Using Dynamic Dependency Resolution
• Using Contextual Dependency Resolution
• Importing Dependencies from the Target Object

How to catch the initialization exception?

I want to tell user a friendly message to replace not catched excetpion.

Missing postsharp developer license

The documentation on this subject is incomplete, and while looking for a solution or hint in this sample, one can discover that it does not compile for the same reason:

Severity Code Description Project File Line Suppression State
Error License error. No valid license key has been installed. To register a license key, see https://doc.postsharp.net/deploying-keys. PostSharp.Samples.Authorization