Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Sholtee/ProxyGen
.NET proxy generator powered by Roslyn
https://github.com/Sholtee/ProxyGen
Last synced: about 1 month ago
JSON representation
.NET proxy generator powered by Roslyn
- Host: GitHub
- URL: https://github.com/Sholtee/ProxyGen
- Owner: Sholtee
- License: mit
- Created: 2020-01-06T12:38:59.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-24T04:28:17.000Z (5 months ago)
- Last Synced: 2024-08-01T22:43:37.035Z (4 months ago)
- Language: C#
- Size: 2.4 MB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.MD
- Changelog: history.md
- License: LICENSE
Awesome Lists containing this project
- RSCG_Examples - https://github.com/Sholtee/ProxyGen
README
# ProxyGen.NET [](https://ci.appveyor.com/project/Sholtee/proxygen/branch/master)  [](https://coveralls.io/github/Sholtee/proxygen?branch=master) [](https://www.nuget.org/packages/proxygen.net) 
> .NET proxy generator powered by [Roslyn](https://github.com/dotnet/roslyn )
**This documentation refers the version 9.X of the library**
## Purposes
This library currently supports generating [proxies](https://en.wikipedia.org/wiki/Proxy_pattern ) for interface interception and [duck typing](https://en.wikipedia.org/wiki/Duck_typing ).
### To hook into interface method calls:
1. Create the interceptor class (which is an [InterfaceInterceptor](https://sholtee.github.io/proxygen/doc/Solti.Utils.Proxy.InterfaceInterceptor-1.html ) descendant):
```csharp
using Solti.Utils.Proxy;
...
public class MyInterceptor: InterfaceInterceptor
{
public MyInterceptor(IMyInterface target) : base(target) {}
public MyInterceptor(IMyInterface target, MyParam myParam) : base(target) {} // overloaded constructor
public override object? Invoke(InvocationContext context) // Invoking the generated proxy instance will trigger this method
{
if (suppressOriginalMethod)
{
return something;
// ref|out parameters can be assigned by setting the corresponding "context.Args[]" item
}
context.Args[0] = someNewVal; // "someNewVal" will be forwarded to the original method
return base.Invoke(context); // Let the original method do its work
}
}
// OR
public class MyInterceptorTargetingTheImplementation: InterfaceInterceptor
{
public MyInterceptor(MyInterfaceImplementation target) : base(target) {}
public override object? Invoke(InvocationContext context)
{
MemberInfo
ifaceMember = context.InterfaceMember, // Will point to the invoked IMyInterface member (e.g.: IMyInterface.Foo())
targetMember = context.TargetMember; // Will point to the underlying MyInterfaceImplementation member (e.g. MyInterfaceImplementation.Foo())
return base.Invoke(context);
}
}
```
2. Generate a proxy instance invoking the desired constructor:
```csharp
using System;
...
IMyInterface target = new MyClass();
...
IMyInterface proxy;
proxy = ProxyGenerator.Activate(Tuple.Create(target)); // or ActivateAsync()
proxy = ProxyGenerator.Activate(Tuple.Create(target, new MyParam()));
```
3. Enjoy
Remarks:
- The *target* can access its most outer enclosing proxy. To achieve this it just has to implement the `IProxyAccess` interface:
```csharp
using Solti.Utils.Proxy;
public class MyClass : IMyInterface, IProxyAccess
{
...
public IMyInterface Proxy { get; set; }
}
```
- Starting from v9.1 partial interface implementations are also supported:
```csharp
using Solti.Utils.Proxy;
public interface IMyInterface
{
void Intercepted();
void NotInterceptred();
}
public class MyInterceptor: InterfaceInterceptor
{
public void NotInterceptred() {...}
// will be triggered by Intercepted() only as NotInterceptred() has its own implementation
public override object Invoke(InvocationContext context) {...}
...
}
```
For further usage examples see [this](https://github.com/Sholtee/proxygen/blob/master/TEST/ProxyGen.Tests/Generators/ProxyGenerator.cs ) or [that](https://github.com/Sholtee/injector#decorating-services ).
### To create ducks:
1. Declare an interface that covers all the desired members of the target class:
```csharp
public class TargetClass // does not implement IDuck
{
public void Foo() {...}
}
...
public interface IDuck
{
void Foo();
}
```
2. Generate the duck instance:
```csharp
using Solti.Utils.Proxy.Generators;
...
TargetClass target = ...;
IDuck duck = DuckGenerator.Activate(Tuple.Create(target)); // or ActivateAsync()
```
3. Quack
Related tests can be seen [here](https://github.com/Sholtee/proxygen/blob/master/TEST/ProxyGen.Tests/Generators/DuckGenerator.cs ).
## Caching the generated assembly
By setting the `ProxyGen.AssemblyCacheDir` property in [YourApp.runtimeconfig.json](https://docs.microsoft.com/en-us/dotnet/core/run-time-config/ ) you can make the system cache the generated assembly, so next time your app starts and requests the proxy there won't be time consuming emitting operation.
You can do it easily by creating a template file named `runtimeconfig.template.json` in your project folder:
```json
{
"configProperties": {
"ProxyGen.AssemblyCacheDir": "GeneratedAssemblies"
}
}
```
## Embedding the generated type
This library can be used as a [source generator](https://devblogs.microsoft.com/dotnet/introducing-c-source-generators/ ) so you can embed the generated proxy type into the assembly that uses it. This is simply done by the `Solti.Utils.Proxy.Attributes.EmbedGeneratedTypeAttribute`:
```csharp
[assembly: EmbedGeneratedType(typeof(ProxyGenerator>))]
[assembly: EmbedGeneratedType(typeof(DuckGenerator))]
```
The `xXxGenerator.GetGeneratedType()` method returns the embedded type if it is present in the assembly in which the `GetGeneratedType()` was called. Since all the time consumig operations already happened in compile time, requesting embedded types can singificantly improve the performance.
Note that:
- Open generics are not supported.
- [coveralls.io](https://www.nuget.org/packages/coveralls.io/ ) (and other coverage reporters) may crash if your project was augmented by a source generator. To work this issue around:
- Ignore the generated sources in your coverage app (e.g.: in [OpenCover](https://www.nuget.org/packages/OpenCover/ ) use the `-filter:-[*]Proxies.GeneratedClass_*` switch)
- Create an empty file for each generated class (e.g.: `YourProject\Solti.Utils.Proxy\Solti.Utils.Proxy.Internals.ProxyEmbedder\Proxies.GeneratedClass_XxX.cs`)
- Exclude these files from your project:
```xml
```
## Inspecting the generated code
*ProxyGen* is able to dump the generated sources. Due to performance considerations it is disabled by default. To enable
- In runtime:
Set the `ProxyGen.SourceDump` property (in the same way you could see [above](#caching-the-generated-assembly)) to the desired directory (note that environment variables are supported):
```json
{
"configProperties": {
"ProxyGen.SourceDump": "%TEMP%"
}
}
```
- In compile time (source generator):
Extend your `.csproj` with the following:
```xml
$(OutputPath)Logs
```
The output should look like [this](https://github.com/Sholtee/proxygen/blob/master/TEST/ProxyGen.Tests/ClsSrcUnit.txt ).
## Migrating from version
- 2.X
- Delete all the cached assemblies (if the `[Proxy|Duck]Generator.CacheDirectory` is set somewhere)
- `InterfaceInterceptor.Invoke()` returns the result of the original method (instead of `CALL_TARGET`) so in the override you may never need to invoke the `method` parameter directly.
- 3.X
- `[Proxy|Duck]Generator.GeneratedType[Async]` property has been removed. To get the generated proxy type call the `[Proxy|Duck]Generator.GetGeneratedType[Async]()` method.
- `[Proxy|Duck]Generator.CacheDirectory` property has been removed. To set the cache directory tweak the [runtimeconfig.json](#caching-the-generated-assembly) file.
- 4.X
- The layout of the `InterfaceInterceptor<>.Invoke()` has been changed. Invocation parameters can be grabbed from the `InvocationContext` passed to the `Invoke()` method.
- The `ConcurrentInterfaceInterceptor<>` class has been dropped since the `InterfaceInterceptor<>` class was rewritten in a thread safe manner.
- 5.X
- You don't need to manually activate the generated proxy type, instead you may use the built-in `Generator.Activate()` method.
- 6.X
- The `InvocationContext.InvokeTarget` property has been removed but you should not be affected by it
- As proxy embedder has been reimplemented using the [v2](https://github.com/dotnet/roslyn/blob/main/docs/features/incremental-generators.md ) Source Generator API, this feature now requires VS 2022
- 7.X
- `InterfaceInterceptor.Member|Method` has been renamed to `InterfaceMember|InterfaceMethod`
- 8.X
- `Generator`s have been demoted to `class`. To compare `Generator` instances use their `Id` property.
## Resources
- [API Docs](https://sholtee.github.io/proxygen )
- [Benchmark Results](https://sholtee.github.io/proxygen/perf )
- [Version History](https://github.com/Sholtee/proxygen/blob/master/history.md )
## Supported frameworks
This project currently targets `netstandard2.0` as well as `netstandard2.1` and had been tested against `net472`, `netcoreapp3.1`, `net5.0`, `net6.0`, `net7.0` and `net8.0`.