Stef Heyenrath
96 lines
2.8 KiB
Markdown
96 lines
2.8 KiB
Markdown
# ProxyInterfaceGenerator
|
||
|
||
This project uses Source Generation to generate an interface and a Proxy class for classes.
|
||
This makes it possible to wrap external classes which do not have an interface, in a Proxy class which makes it easier to Mock and use DI.
|
||
|
||
## Install
|
||
[](https://www.nuget.org/packages/ProxyInterfaceGenerator)
|
||
|
||
You can install from NuGet using the following command in the package manager window:
|
||
|
||
`Install-Package ProxyInterfaceGenerator`
|
||
|
||
Or via the Visual Studio NuGet package manager or if you use the `dotnet` command:
|
||
|
||
`dotnet add package ProxyInterfaceGenerator`
|
||
|
||
#### :pencil2: Using in a Library project
|
||
When you use this Source Generator as a package reference in your library project, make sure that you define this NuGet package as a Private Asset (`<PrivateAssets>`) and define the correct `<IncludeAssets>`. This is needed to indicate that this dependency is purely used as a development dependency and that you don’t want to expose that to projects that will consume your package.
|
||
|
||
``` xml
|
||
<PackageReference Include="ProxyInterfaceGenerator" Version="0.0.10">
|
||
<!-- 👇 -->
|
||
<PrivateAssets>all</PrivateAssets>
|
||
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
|
||
</PackageReference>
|
||
```
|
||
|
||
## Usage
|
||
|
||
### Given: an external existing class which does not implement an interface
|
||
``` c#
|
||
public sealed class Person
|
||
{
|
||
public string Name { get; set; }
|
||
|
||
public string HelloWorld(string name)
|
||
{
|
||
return $"Hello {name} !";
|
||
}
|
||
}
|
||
```
|
||
|
||
### Create a partial interface
|
||
And annotate this with `ProxyInterfaceGenerator.Proxy[...]` and with the Type which needs to be wrapped:
|
||
|
||
``` c#
|
||
[ProxyInterfaceGenerator.Proxy(typeof(ProxyInterfaceConsumer.Person))]
|
||
public partial interface IPerson
|
||
{
|
||
}
|
||
```
|
||
|
||
### When the code is compiled, this source generator creates the following
|
||
|
||
#### :one: An additional partial interface
|
||
Which defines the same properties and methods as in the external class.
|
||
``` c#
|
||
public partial interface IPerson
|
||
{
|
||
string Name { get; set; }
|
||
|
||
string HelloWorld(string name);
|
||
}
|
||
```
|
||
|
||
#### :two: A Proxy class
|
||
Which takes the external class in the constructor and wraps all properties and methods.
|
||
|
||
``` c#
|
||
public class PersonProxy : IPerson
|
||
{
|
||
public Person _Instance { get; }
|
||
|
||
public PersonProxy(Person instance)
|
||
{
|
||
_Instance = instance;
|
||
}
|
||
|
||
public string Name { get => _Instance.Name; set => _Instance.Name = value; }
|
||
|
||
public string HelloWorld(string name)
|
||
{
|
||
string name_ = name;
|
||
var result_19479959 = _Instance.HelloWorld(name_);
|
||
return result_19479959;
|
||
}
|
||
}
|
||
```
|
||
|
||
### Use it
|
||
``` c#
|
||
IPerson p = new PersonProxy(new Person());
|
||
p.Name = "test";
|
||
p.HelloWorld("stef");
|
||
```
|