WCF迁移至WCF Core：帮助菜单样式不一致问题求助

CoreWCF 作为 WCF 的跨平台重构版本，其内置调试帮助页面的样式与传统 WCF 存在差异，默认无法直接切换回旧样式。要实现与原 WCF 一致的帮助菜单样式，可通过自定义帮助页面的方式解决，具体步骤如下：

1. 禁用 CoreWCF 默认帮助页面 #

先修改服务配置，关闭内置的调试帮助页，避免与自定义页面冲突：

public void Configure(IApplicationBuilder app)
{
    app.UseServiceModel(serviceBuilder =>
    {
        serviceBuilder.AddService<Service>(o =>
        {
            // 禁用默认帮助页
            o.DebugBehavior.HttpHelpPageEnabled = false;
            o.DebugBehavior.HttpsHelpPageEnabled = false;
            o.DebugBehavior.IncludeExceptionDetailInFaults = false;
        });
        serviceBuilder.AddServiceEndpoint<Service,IService>(new BasicHttpBinding(CoreWCF.Channels.BasicHttpSecurityMode.None), "/Custom");
    });

    var sMB = app.ApplicationServices.GetRequiredService<ServiceMetadataBehavior>();
    sMB.HttpGetEnabled = true;
    sMB.HttpsGetEnabled = true;
}

2. 实现自定义帮助页面 #

通过添加 MVC 控制器和视图，读取服务元数据并生成与传统 WCF 风格一致的帮助页面：

2.1 添加 MVC 服务依赖 #

在 ConfigureServices 中添加 MVC 支持：

public void ConfigureServices(IServiceCollection services)
{
    services.AddTransient<IService,Service>();
    services.AddServiceModelServices();
    services.AddServiceModelMetadata();
    services.AddSingleton<IServiceBehavior, UseRequestHeadersForMetadataAddressBehavior>();
    // 添加 MVC 支持
    services.AddControllersWithViews();
    SetCacheConnectionString();
    SetAdministratorUser();
}

2.2 配置 MVC 路由 #

在 Configure 中启用 MVC 路由：

public void Configure(IApplicationBuilder app)
{
    // 保留原有 CoreWCF 配置...

    // 启用 MVC 路由
    app.UseRouting();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllerRoute(
            name: "default",
            pattern: "{controller=Help}/{action=Index}");
    });
}

2.3 创建帮助页面控制器 #

编写控制器读取服务契约与操作信息：

using CoreWCF.Description;
using System.Reflection;
using Microsoft.AspNetCore.Mvc;

public class HelpController : Controller
{
    private readonly IServiceProvider _serviceProvider;

    public HelpController(IServiceProvider serviceProvider)
    {
        _serviceProvider = serviceProvider;
    }

    public IActionResult Index()
    {
        var serviceHost = _serviceProvider.GetServices<CoreWCF.ServiceHostBase>().FirstOrDefault();
        if (serviceHost == null) return View();

        // 解析服务操作信息
        var contract = serviceHost.Description.Endpoints.First().Contract;
        var operations = contract.Operations.Select(op => new
        {
            Name = op.Name,
            Description = op.SyncMethod?.GetCustomAttribute<System.ComponentModel.DescriptionAttribute>()?.Description,
            WebInvokeAttr = op.SyncMethod?.GetCustomAttribute<WebInvokeAttribute>(),
            Params = op.SyncMethod?.GetParameters()
        }).ToList();

        return View(operations);
    }
}

2.4 创建 Razor 视图（Views/Help/Index.cshtml） #

编写 HTML 模拟传统 WCF 帮助页样式：

<!DOCTYPE html>
<html>
<head>
    <title>服务帮助页面</title>
    <style>
        body { font-family: Arial, sans-serif; margin: 20px; }
        .operation-block { border: 1px solid #ccc; padding: 15px; margin: 10px 0; border-radius: 4px; }
        .operation-title { margin-top: 0; color: #2d69b2; }
        .detail-info { color: #666; margin-left: 15px; }
        .uri-template { font-family: monospace; color: #1a53ff; }
    </style>
</head>
<body>
    <h1>服务操作帮助</h1>
    @foreach (var op in Model)
    {
        <div class="operation-block">
            <h3 class="operation-title">@op.Name</h3>
            @if (!string.IsNullOrEmpty(op.Description))
            {
                <p>@op.Description</p>
            }
            @if (op.WebInvokeAttr != null)
            {
                <p><strong>请求方法:</strong> @op.WebInvokeAttr.Method</p>
                <p><strong>URI 模板:</strong> <span class="uri-template">@op.WebInvokeAttr.UriTemplate</span></p>
                <p><strong>响应格式:</strong> @op.WebInvokeAttr.ResponseFormat</p>
            }
            @if (op.Params != null && op.Params.Any())
            {
                <p><strong>参数:</strong></p>
                <ul>
                    @foreach (var param in op.Params)
                    {
                        <li class="detail-info">@param.Name (@param.ParameterType.Name)</li>
                    }
                </ul>
            }
        </div>
    }
</body>
</html>

3. 访问自定义帮助页面 #

启动服务后，访问根路径下的 Help 页面（如 http://localhost:5000/Help），即可看到与传统 WCF 风格一致的帮助界面。

内容的提问来源于stack exchange，提问作者Ariel Gallardo