Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danroth27/componentlibwithxmllinkerconfig
Component library with embedded XML linker config file
https://github.com/danroth27/componentlibwithxmllinkerconfig
Last synced: about 1 month ago
JSON representation
Component library with embedded XML linker config file
- Host: GitHub
- URL: https://github.com/danroth27/componentlibwithxmllinkerconfig
- Owner: danroth27
- License: mit
- Created: 2020-03-13T16:52:27.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T21:33:43.000Z (over 1 year ago)
- Last Synced: 2024-10-19T21:46:26.864Z (3 months ago)
- Language: HTML
- Size: 223 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Component library with .NET IL Linker configuration
This sample shows how you can embed a .NET IL Linker configuration file into a library that specifies what assemblies, types, and members should be preserved by the .NET IL Linker.
## Run the sample
To build and run the sample locally, install the [.NET Core SDK](https://dotnet.microsoft.com/download) version 3.1.102 or later.
Then run `dotnet run` from the *BlazorApp1* directory.
Try entering various expressions to filter to the list of people:
## Handling reflection with the .NET IL Linker
The .NET IL Linker statically analyzes .NET assemblies to determine what code is being used and can remove any unused code. However, if the code uses .NET reflection there is no way for the linker to know what additional code is being used via reflection. Instead, you need to manually instruct the linker what additional code should be preserved. This can be done using an XML linker config file.
The ComponentLibWithXmlLinkerConfig project is a [Blazor component library](https://docs.microsoft.com/aspnet/core/blazor/class-libraries) that uses [System.Linq.Dynamic.Core](https://github.com/StefH/System.Linq.Dynamic.Core) to run dynamic LINQ queries over a collection. System.Linq.Dyanmic.Core works using reflection. The component library is then used from a Blazor WebAssembly app. The app has been setup to run the linker on every build by setting `true`. Without any additional linker config the app fails at runtime with the following exception because methods called by System.Linq.Dynamic.Core via reflection on the `System.Linq.Queryable` type have been removed by the linker:
```
Unhandled exception rendering component:
System.TypeInitializationException: The type initializer for 'System.Linq.Dynamic.Core.DynamicQueryableExtensions' threw an exception. ---> System.Exception: Specific method not found: All ---> System.InvalidOperationException: Sequence contains no matching element
at System.Linq.Enumerable.Single[TSource] (System.Collections.Generic.IEnumerable`1[T] source, System.Func`2[T,TResult] predicate) <0x2146c98 + 0x000f0> in :0
at System.Linq.Dynamic.Core.DynamicQueryableExtensions.GetMethod (System.String name, System.Int32 parameterCount, System.Func`2[T,TResult] predicate) <0x2146898 + 0x0004c> in :0
--- End of inner exception stack trace ---
at System.Linq.Dynamic.Core.DynamicQueryableExtensions.GetMethod (System.String name, System.Int32 parameterCount, System.Func`2[T,TResult] predicate) <0x2146898 + 0x00078> in :0
at System.Linq.Dynamic.Core.DynamicQueryableExtensions..cctor () <0x213ca70 + 0x00024> in :0
--- End of inner exception stack trace ---
at ComponentLibWithXmlLinkerConfig.Component1.OnClick () [0x00001] in C:\users\user\Documents\GitHub\danroth27\ComponentLibWithXmlLinkerConfig\ComponentLibWithXmlLinkerConfig\Component1.razor:33
at (wrapper delegate-invoke) .invoke_void()
at Microsoft.AspNetCore.Components.EventCallbackWorkItem.InvokeAsync[T] (System.MulticastDelegate delegate, T arg) <0x20d8fd0 + 0x00062> in :0
at Microsoft.AspNetCore.Components.EventCallbackWorkItem.InvokeAsync (System.Object arg) <0x20d8f10 + 0x0000a> in :0
at Microsoft.AspNetCore.Components.ComponentBase.Microsoft.AspNetCore.Components.IHandleEvent.HandleEventAsync (Microsoft.AspNetCore.Components.EventCallbackWorkItem callback, System.Object arg) <0x20d8e78 + 0x0000a> in :0
at Microsoft.AspNetCore.Components.EventCallback.InvokeAsync (System.Object arg) <0x20d8a00 + 0x00040> in :0
at Microsoft.AspNetCore.Components.RenderTree.Renderer.DispatchEventAsync (System.UInt64 eventHandlerId, Microsoft.AspNetCore.Components.RenderTree.EventFieldInfo fieldInfo, System.EventArgs eventArgs) <0x20c9058 + 0x000a8> in :0
```
To preserve the `System.Linq.Queryable` type and its members, the following XML linker config file is added to the ComponentLibWithXmlLinkerConfig project:
```xml
```
This file is then embedded into the library by adding the following to the project file:
```xml
$(MSBuildProjectName).xml
```
> Note that the name of the embedded XML linker config file must match the name of the assembly. By default the file name will be prefixed with the assembly namespace, so the correct name must be explicitly specified as the `LogicalName` for the embedded file.
## Additional resources
- [Configure the Linker for Blazor apps](https://docs.microsoft.com/aspnet/core/host-and-deploy/blazor/configure-linker)
- [XML linker config file format](https://github.com/mono/linker#link-xml-file-examples)
- [Custom Linker Configuration in Xamarin apps](https://docs.microsoft.com/en-us/xamarin/cross-platform/deploy-test/linker)