mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-21 17:16:16 +08:00
Marc Schier
f3928db05b
Introduces a consistent `Microsoft.Extensions.DependencyInjection`
surface across the OPC UA libraries. Every consumer starts from a single
root entry point and chains feature-specific extension methods on a
unified builder. PubSub is intentionally excluded per the original
scope.
```csharp
services
.AddOpcUa() // Stack/Opc.Ua.Core
.AddServer(o => { /* … */ }) // Libraries/Opc.Ua.Server
.AddNodeManager<MyNodeManagerFactory>()
.Services
.AddOpcUa()
.AddClient(o => { /* … */ }); // Libraries/Opc.Ua.Client
```
Manual non-DI constructors (`new ApplicationInstance(...)`, `new
StandardServer(...)`, `new LdsServer(...)`, `new ManagedSession(...)`,
etc.) remain unchanged — DI is purely additive for users who want the
.NET Generic Host to own application lifetime, logging, and
configuration.
### What ships
| Feature library | Method on `IOpcUaBuilder` | Returns |
|----------------------------------------------|-------------------------------------------|--------------------------|
| `Opc.Ua.Core` (root) | `services.AddOpcUa()` | `IOpcUaBuilder` |
| `Opc.Ua.Configuration` | `builder.AddApplicationInstance()` |
`IOpcUaBuilder` |
| `Opc.Ua.Client` | `builder.AddClient(opt => …)` |
`IOpcUaClientBuilder` |
| `Opc.Ua.Client.ComplexTypes` | `builder.AddComplexTypes()` |
`IOpcUaBuilder` |
| `Opc.Ua.Server` | `builder.AddServer(opt => …)` |
`IOpcUaServerBuilder` |
| `Opc.Ua.Gds.Client.Common` | `builder.AddGdsClient(opt => …)` |
`IGdsClientBuilder` |
| `Opc.Ua.Gds.Server.Common` | `builder.AddGdsServer(opt => …)` |
`IGdsServerBuilder` |
| `Opc.Ua.Lds.Server` | `builder.AddLdsServer(opt => …)` |
`ILdsServerBuilder` |
| `Opc.Ua.WotCon.Server` | `builder.AddWotConServer(opt => …)` |
`IWotConServerBuilder` |
| `Opc.Ua.WotCon.Client` | `builder.AddWotConClient(opt => …)` |
`IOpcUaBuilder` |
### Design highlights
- **Binary-safe inheritance** — `IOpcUaBuilder :
IDependencyInjectionBuilder` so any existing `AddLogging(this
IDependencyInjectionBuilder)` callers keep compiling unchanged.
- **Three options overloads** per feature: `Action<TOptions>`
(AOT-safe), `IConfiguration`, `IConfigurationSection`. The two binding
overloads are annotated `[RequiresUnreferencedCode]` /
`[RequiresDynamicCode]`. Section names follow the `OpcUa:<Feature>`
convention (`OpcUa:Server`, `OpcUa:Client`, `OpcUa:Gds:Server`,
`OpcUa:Lds`, …).
- **Generic Host integration** — each server feature (regular, GDS, LDS)
registers its own `BackgroundService`. Marker singletons throw
`InvalidOperationException` on duplicate `.AddServer()` /
`.AddGdsServer()` / `.AddLdsServer()`. A regular server + GDS + LDS can
coexist in one host; each owns its own `IApplicationInstance` produced
by a shared `IApplicationInstanceFactory` so PKI roots, endpoints, and
certificates don't collide.
- **Registration isolation** — node managers registered under the
regular server via `.AddNodeManager<T>()` are wrapped in
`OpcUaServerNodeManagerRegistration` so they don't bleed into the GDS /
LDS hosted services.
- **WoT Connectivity server** composes on top of the regular server
feature: `.AddServer(...).AddWotConServer(...)` registers
`WotConnectivityNodeManagerFactory` as a server node-manager
registration.
- **Unified telemetry** — `services.AddOpcUa()` registers
`ITelemetryContext` via `TryAddSingleton` using a new
`ServiceProviderTelemetryContext` that resolves the host's
`ILoggerFactory` on first use. User-supplied registrations win.
### Removed pre-release DI surface
The pre-release `services.AddOpcUaServer(...)`,
`services.AddOpcUaClient(...)`, `services.AddOpcUaGdsClient(...)`
extensions are deleted. `IClientBuilder` was renamed to
`IOpcUaClientBuilder`. In-repo callers migrated:
- `Applications/MinimalCalcServer/Program.cs`
- `Applications/MinimalBoilerServer/Program.cs`
- `Tests/Opc.Ua.Client.Tests/ClientBuilder/OpcUaClientBuilderTests.cs`
(renamed from `OpcUaClientServiceCollectionExtensionsTests.cs`)
- Docs (`MigrationGuide.md`, `Sessions.md`,
`SourceGeneratedNodeManagers.md`, README, new
`Docs/DependencyInjection.md`)
### csproj audit
Pruned every redundant `Microsoft.Extensions.*` package reference.
`Opc.Ua.Core` already pulls in `Microsoft.Extensions.Diagnostics` and
`Microsoft.Extensions.Logging`, which transitively expose DI / Options /
Configuration.Abstractions / Options.ConfigurationExtensions to every
downstream library. Only `Microsoft.Extensions.Hosting.Abstractions`
stays explicit on the server libraries (it isn't transitively
available). Also pruned redundant `System.Formats.Asn1` (Bindings.Https)
and `System.Collections.Immutable` (Security.Certificates).
### Tests
50 new tests in eight projects:
| Project | Tests |
|--------------------------------------|-------|
| `Opc.Ua.Core.Tests` | 12 |
| `Opc.Ua.Client.Tests` | 4 |
| `Opc.Ua.Client.ComplexTypes.Tests` | 3 |
| `Opc.Ua.WotCon.Tests` | 6 |
| `Opc.Ua.Lds.Tests` | 5 |
| `Opc.Ua.Gds.Tests` | 6 |
| `Opc.Ua.Server.Tests` (integration) | 10 |
| `Opc.Ua.Aot.Tests` (smoke) | 4 |
| **Total** | **50** |
Combined-host integration tests cover the rubber-duck-driven scenarios:
telemetry-context override across legacy and new entry paths, server +
GDS + LDS coexistence with distinct ports and PKI roots,
duplicate-registration rejection, and node-manager isolation across
features.
### AOT
`dotnet publish Tests/Opc.Ua.Aot.Tests -c Release -r win-x64
--self-contained` reports zero `IL2026` / `IL3050` / `IL2104` warnings
from the new DI surface. All generic registrations carry
`[DynamicallyAccessedMembers(PublicConstructors)]`. AOT consumers stick
to the `Action<TOptions>` overload exclusively; the new
`Tests/Opc.Ua.Aot.Tests/HostingAotTests.cs` smoke fixture exercises this
end-to-end.
108 lines
4.9 KiB
C#
108 lines
4.9 KiB
C#
/* ========================================================================
|
|
* Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
|
|
*
|
|
* OPC Foundation MIT License 1.00
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person
|
|
* obtaining a copy of this software and associated documentation
|
|
* files (the "Software"), to deal in the Software without
|
|
* restriction, including without limitation the rights to use,
|
|
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the
|
|
* Software is furnished to do so, subject to the following
|
|
* conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
* OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
* The complete license agreement can be found here:
|
|
* http://opcfoundation.org/License/MIT/1.00/
|
|
* ======================================================================*/
|
|
|
|
namespace Opc.Ua.Server.Hosting
|
|
{
|
|
/// <summary>
|
|
/// Configurable server operation limits exposed via the unified
|
|
/// dependency-injection surface. Binder-friendly mirror of
|
|
/// <see cref="OperationLimits"/>; copied verbatim into
|
|
/// <see cref="ServerConfiguration.OperationLimits"/> by the hosted
|
|
/// service when <see cref="OpcUaServerOptions.OperationLimits"/> is
|
|
/// non-null.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Any value left at zero is treated as "unlimited" by the OPC UA
|
|
/// server stack — match the underlying
|
|
/// <see cref="OperationLimits"/> semantics.
|
|
/// </remarks>
|
|
public sealed class OperationLimitsOptions
|
|
{
|
|
/// <inheritdoc cref="OperationLimits.MaxNodesPerRead"/>
|
|
public uint MaxNodesPerRead { get; set; }
|
|
|
|
/// <inheritdoc cref="OperationLimits.MaxNodesPerHistoryReadData"/>
|
|
public uint MaxNodesPerHistoryReadData { get; set; }
|
|
|
|
/// <inheritdoc cref="OperationLimits.MaxNodesPerHistoryReadEvents"/>
|
|
public uint MaxNodesPerHistoryReadEvents { get; set; }
|
|
|
|
/// <inheritdoc cref="OperationLimits.MaxNodesPerWrite"/>
|
|
public uint MaxNodesPerWrite { get; set; }
|
|
|
|
/// <inheritdoc cref="OperationLimits.MaxNodesPerHistoryUpdateData"/>
|
|
public uint MaxNodesPerHistoryUpdateData { get; set; }
|
|
|
|
/// <inheritdoc cref="OperationLimits.MaxNodesPerHistoryUpdateEvents"/>
|
|
public uint MaxNodesPerHistoryUpdateEvents { get; set; }
|
|
|
|
/// <inheritdoc cref="OperationLimits.MaxNodesPerMethodCall"/>
|
|
public uint MaxNodesPerMethodCall { get; set; }
|
|
|
|
/// <inheritdoc cref="OperationLimits.MaxNodesPerBrowse"/>
|
|
public uint MaxNodesPerBrowse { get; set; }
|
|
|
|
/// <inheritdoc cref="OperationLimits.MaxNodesPerRegisterNodes"/>
|
|
public uint MaxNodesPerRegisterNodes { get; set; }
|
|
|
|
/// <inheritdoc cref="OperationLimits.MaxNodesPerTranslateBrowsePathsToNodeIds"/>
|
|
public uint MaxNodesPerTranslateBrowsePathsToNodeIds { get; set; }
|
|
|
|
/// <inheritdoc cref="OperationLimits.MaxNodesPerNodeManagement"/>
|
|
public uint MaxNodesPerNodeManagement { get; set; }
|
|
|
|
/// <inheritdoc cref="OperationLimits.MaxMonitoredItemsPerCall"/>
|
|
public uint MaxMonitoredItemsPerCall { get; set; }
|
|
|
|
/// <summary>
|
|
/// Projects this binder-friendly view into the OPC UA
|
|
/// <see cref="OperationLimits"/> structure consumed by
|
|
/// <c>ApplicationConfigurationBuilder.SetOperationLimits</c>.
|
|
/// </summary>
|
|
internal OperationLimits ToOperationLimits()
|
|
{
|
|
return new OperationLimits
|
|
{
|
|
MaxNodesPerRead = MaxNodesPerRead,
|
|
MaxNodesPerHistoryReadData = MaxNodesPerHistoryReadData,
|
|
MaxNodesPerHistoryReadEvents = MaxNodesPerHistoryReadEvents,
|
|
MaxNodesPerWrite = MaxNodesPerWrite,
|
|
MaxNodesPerHistoryUpdateData = MaxNodesPerHistoryUpdateData,
|
|
MaxNodesPerHistoryUpdateEvents = MaxNodesPerHistoryUpdateEvents,
|
|
MaxNodesPerMethodCall = MaxNodesPerMethodCall,
|
|
MaxNodesPerBrowse = MaxNodesPerBrowse,
|
|
MaxNodesPerRegisterNodes = MaxNodesPerRegisterNodes,
|
|
MaxNodesPerTranslateBrowsePathsToNodeIds = MaxNodesPerTranslateBrowsePathsToNodeIds,
|
|
MaxNodesPerNodeManagement = MaxNodesPerNodeManagement,
|
|
MaxMonitoredItemsPerCall = MaxMonitoredItemsPerCall
|
|
};
|
|
}
|
|
}
|
|
}
|