C#中怎么创建一个Web Service服务

发布时间：2021-07-07 16:15:07 作者：Leah
来源：亿速云阅读：246

# C#中怎么创建一个Web Service服务

## 目录
1. [Web Service基础概念](#1-web-service基础概念)
   - 1.1 [什么是Web Service](#11-什么是web-service)
   - 1.2 [SOAP vs REST](#12-soap-vs-rest)
   - 1.3 [WSDL与UDDI](#13-wsdl与uddi)
2. [开发环境准备](#2-开发环境准备)
   - 2.1 [Visual Studio安装](#21-visual-studio安装)
   - 2.2 [.NET SDK配置](#22-net-sdk配置)
3. [创建ASP.NET Web Service项目](#3-创建aspnet-web-service项目)
   - 3.1 [项目模板选择](#31-项目模板选择)
   - 3.2 [解决方案结构解析](#32-解决方案结构解析)
4. [实现SOAP Web Service](#4-实现soap-web-service)
   - 4.1 [创建.asmx服务](#41-创建asmx服务)
   - 4.2 [编写服务方法](#42-编写服务方法)
   - 4.3 [配置Web.config](#43-配置webconfig)
5. [构建RESTful Web API](#5-构建restful-web-api)
   - 5.1 [ASP.NET Web API项目创建](#51-aspnet-web-api项目创建)
   - 5.2 [控制器设计与实现](#52-控制器设计与实现)
   - 5.3 [路由配置详解](#53-路由配置详解)
6. [服务测试与调试](#6-服务测试与调试)
   - 6.1 [使用Postman测试](#61-使用postman测试)
   - 6.2 [Swagger集成](#62-swagger集成)
   - 6.3 [日志记录策略](#63-日志记录策略)
7. [安全防护措施](#7-安全防护措施)
   - 7.1 [身份验证方案](#71-身份验证方案)
   - 7.2 [HTTPS配置](#72-https配置)
   - 7.3 [输入验证](#73-输入验证)
8. [部署与发布](#8-部署与发布)
   - 8.1 [IIS部署指南](#81-iis部署指南)
   - 8.2 [Docker容器化](#82-docker容器化)
   - 8.3 [Azure云部署](#83-azure云部署)
9. [性能优化技巧](#9-性能优化技巧)
   - 9.1 [缓存策略](#91-缓存策略)
   - 9.2 [异步编程模式](#92-异步编程模式)
   - 9.3 [负载均衡方案](#93-负载均衡方案)
10. [常见问题解决](#10-常见问题解决)
    - 10.1 [跨域问题处理](#101-跨域问题处理)
    - 10.2 [版本控制策略](#102-版本控制策略)
    - 10.3 [异常处理机制](#103-异常处理机制)

## 1. Web Service基础概念

### 1.1 什么是Web Service
Web Service是一种通过标准化协议（HTTP/HTTPS）在网络间进行数据交换的系统架构，具有以下核心特征：
- **平台无关性**：基于XML/JSON等通用数据格式
- **语言中立**：服务提供者和消费者可使用不同编程语言
- **自描述性**：通过WSDL描述服务接口
- **可发现性**：可通过UDDI目录进行服务注册与查找

```csharp
// 典型Web Service调用示例
var client = new ServiceReference1.WebService1SoapClient();
var result = client.HelloWorld();

1.2 SOAP vs REST

特性	SOAP	REST
协议	必须使用SOAP协议	使用标准HTTP方法
数据格式	仅XML	XML/JSON/文本等
传输效率	消息头较大	轻量级
安全性	WS-Security规范	依赖HTTPS
适用场景	企业级复杂事务	移动互联网简单交互

1.3 WSDL与UDDI

WSDL（Web Services Description Language）是XML格式的服务描述文档，包含： - 服务端点地址 - 可用操作（方法） - 消息格式规范 - 协议绑定信息

UDDI（Universal Description Discovery and Integration）是服务注册中心，提供： - 白页（企业信息） - 黄页（服务分类） - 绿页（技术接口）

2. 开发环境准备

2.1 Visual Studio安装

推荐使用Visual Studio 2022社区版： 1. 访问官网下载页面 2. 选择”ASP.NET和Web开发”工作负载 3. 额外勾选组件： - .NET Framework 4.8 SDK - IIS Express - Azure开发工具

2.2 .NET SDK配置

# 查看已安装SDK版本
dotnet --list-sdks

# 安装最新LTS版本
winget install Microsoft.DotNet.SDK.6.0

环境变量配置建议： - PATH中添加C:\Program Files\dotnet\ - 设置ASPNETCORE_ENVIRONMENT=Development

3. 创建ASP.NET Web Service项目

3.1 项目模板选择

传统ASMX服务：
- 文件 → 新建 → 项目 → “ASP.NET Web应用程序(.NET Framework)”
- 选择”空”模板 → 勾选”Web服务”
现代Web API：
- 使用”ASP.NET Core Web API”模板
- 启用OpenAPI支持

3.2 解决方案结构解析

典型项目结构：

WebServiceDemo/
├── Controllers/          # Web API控制器
├── Models/               # 数据模型
├── Services/             # 业务逻辑层
├── appsettings.json      # 配置文件
├── Program.cs            # 入口文件
└── Properties/
    └── launchSettings.json # 启动配置

4. 实现SOAP Web Service

4.1 创建.asmx服务

右键项目 → 添加 → 新建项
选择”Web服务(ASMX)”
自动生成代码框架：

[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
[System.ComponentModel.ToolboxItem(false)]
public class SampleService : System.Web.Services.WebService
{
    [WebMethod]
    public string HelloWorld() => "Hello World";
}

4.2 编写服务方法

[WebMethod(Description = "计算两数之和")]
public double AddNumbers(double x, double y)
{
    return x + y;
}

[WebMethod(MessageName = "GetUserById")]
public User GetUser(int userId)
{
    return new UserRepository().GetUser(userId);
}

4.3 配置Web.config

<system.web>
  <webServices>
    <protocols>
      <add name="HttpGet"/>
      <add name="HttpPost"/>
    </protocols>
    <soapExtensionTypes>
      <add type="MyNamespace.LogExtension, MyAssembly"/>
    </soapExtensionTypes>
  </webServices>
</system.web>

5. 构建RESTful Web API

5.1 ASP.NET Web API项目创建

dotnet new webapi -n MyRestService
cd MyRestService
dotnet add package Swashbuckle.AspNetCore

5.2 控制器设计与实现

[ApiController]
[Route("api/[controller]")]
public class ProductsController : ControllerBase
{
    private readonly IProductService _service;

    public ProductsController(IProductService service)
    {
        _service = service;
    }

    [HttpGet("{id}")]
    public ActionResult<Product> GetById(int id)
    {
        var product = _service.GetProduct(id);
        return product ?? NotFound();
    }

    [HttpPost]
    public IActionResult Create([FromBody] Product product)
    {
        var created = _service.AddProduct(product);
        return CreatedAtAction(nameof(GetById), new { id = created.Id }, created);
    }
}

5.3 路由配置详解

// 传统路由
app.MapControllerRoute(
    name: "default",
    pattern: "{controller=Home}/{action=Index}/{id?}");

// 属性路由示例
[Route("api/v{version:apiVersion}/[controller]")]
[ApiVersion("1.0")]
public class OrdersController : ControllerBase
{
    [HttpGet("pending")]
    public IActionResult GetPendingOrders() { ... }
}

6. 服务测试与调试

6.1 使用Postman测试

SOAP请求示例：

POST /SampleService.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/AddNumbers"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddNumbers xmlns="http://tempuri.org/">
      <x>3.14</x>
      <y>2.72</y>
    </AddNumbers>
  </soap:Body>
</soap:Envelope>

6.2 Swagger集成

// Program.cs配置
builder.Services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { 
        Title = "My API", 
        Version = "v1",
        Contact = new OpenApiContact {
            Name = "开发团队",
            Email = "dev@example.com" 
        }
    });
    
    var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFile));
});

6.3 日志记录策略

// NLog配置示例
public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureLogging(logging =>
        {
            logging.ClearProviders();
            logging.AddNLog("nlog.config");
        })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

7. 安全防护措施

7.1 身份验证方案

JWT认证实现：

services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
    .AddJwtBearer(options =>
    {
        options.TokenValidationParameters = new TokenValidationParameters
        {
            ValidateIssuer = true,
            ValidateAudience = true,
            ValidateLifetime = true,
            ValidateIssuerSigningKey = true,
            ValidIssuer = Configuration["Jwt:Issuer"],
            ValidAudience = Configuration["Jwt:Audience"],
            IssuerSigningKey = new SymmetricSecurityKey(
                Encoding.UTF8.GetBytes(Configuration["Jwt:Key"]))
        };
    });

7.2 HTTPS配置

Kestrel HTTPS配置：

{
  "Kestrel": {
    "Endpoints": {
      "Https": {
        "Url": "https://*:5001",
        "Certificate": {
          "Path": "cert.pfx",
          "Password": "yourpassword"
        }
      }
    }
  }
}

7.3 输入验证

模型验证示例：

public class Product
{
    [Required]
    [StringLength(100, MinimumLength = 3)]
    public string Name { get; set; }

    [Range(0.01, 10000)]
    public decimal Price { get; set; }

    [RegularExpression(@"^[A-Z]{2,3}$")]
    public string CategoryCode { get; set; }
}

[HttpPost]
public IActionResult Create([FromBody] Product product)
{
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }
    // ...
}

8. 部署与发布

8.1 IIS部署指南

发布步骤：

dotnet publish -c Release -o ./publish

IIS管理器中：
- 添加应用程序池（无托管代码）
- 创建网站指向publish文件夹
- 安装AspNetCoreModuleV2

8.2 Docker容器化

Dockerfile示例：

FROM mcr.microsoft.com/dotnet/aspnet:6.0 AS base
WORKDIR /app
EXPOSE 80
EXPOSE 443

FROM mcr.microsoft.com/dotnet/sdk:6.0 AS build
WORKDIR /src
COPY ["WebServiceDemo.csproj", "."]
RUN dotnet restore "WebServiceDemo.csproj"
COPY . .
RUN dotnet build "WebServiceDemo.csproj" -c Release -o /app/build

FROM build AS publish
RUN dotnet publish "WebServiceDemo.csproj" -c Release -o /app/publish

FROM base AS final
WORKDIR /app
COPY --from=publish /app/publish .
ENTRYPOINT ["dotnet", "WebServiceDemo.dll"]

8.3 Azure云部署

Azure CLI部署命令：

az group create --name myResourceGroup --location eastus
az appservice plan create --name myPlan --resource-group myResourceGroup --sku B1 --is-linux
az webapp create --resource-group myResourceGroup --plan myPlan --name myWebService --runtime "DOTNETCORE:6.0"
az webapp deployment source config-zip --resource-group myResourceGroup --name myWebService --src ./publish.zip

9. 性能优化技巧

9.1 缓存策略

响应缓存示例：

[HttpGet("{id}")]
[ResponseCache(Duration = 60, Location = ResponseCacheLocation.Any)]
public Product GetById(int id)
{
    return _repository.GetProduct(id);
}

// 分布式缓存
services.AddStackExchangeRedisCache(options =>
{
    options.Configuration = Configuration.GetConnectionString("Redis");
    options.InstanceName = "SampleInstance_";
});

9.2 异步编程模式

[HttpGet("async")]
public async Task<ActionResult<IEnumerable<Product>>> GetProductsAsync()
{
    var products = await _repository.GetAllProductsAsync();
    return Ok(products);
}

// 仓储层实现
public async Task<List<Product>> GetAllProductsAsync()
{
    return await _context.Products
        .AsNoTracking()
        .ToListAsync();
}

9.3 负载均衡方案

Nginx配置示例：

upstream backend {
    server 10.0.0.1:5000;
    server 10.0.0.2:5000;
    server 10.0.0.3:5000;
}

server {
    listen 80;
    location / {
        proxy_pass http://backend;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection keep-alive;
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
    }
}

10. 常见问题解决

10.1 跨域问题处理

CORS配置：

// Program.cs
builder.Services.AddCors(options =>
{
    options.AddPolicy("AllowSpecificOrigin",
        builder => builder.WithOrigins("https://client.example.com")
                          .AllowAnyMethod()
                          .AllowAnyHeader()
                          .AllowCredentials());
});

app.UseCors("AllowSpecificOrigin");

10.2 版本控制策略

API版本控制：

services.AddApiVersioning(options =>
{
    options.DefaultApiVersion = new ApiVersion(1, 0);
    options.AssumeDefaultVersionWhenUnspecified = true;
    options.ReportApiVersions = true;
});

[ApiVersion("1.0")]
[ApiVersion("2.0")]
[Route("api/v{version:apiVersion}/[controller]")]
public class UsersController : ControllerBase
{
    [MapToApiVersion("1.0")]
    [HttpGet]
    public IActionResult GetV1() { ... }

    [MapToApiVersion("2.0")]
    [HttpGet]
    public IActionResult GetV2() { ... }
}

10.3 异常处理机制

全局异常处理：

// 自定义异常中间件
app.UseExceptionHandler(errorApp =>
{
    errorApp.Run(async context =>
    {
        var exceptionHandler = context.Features.Get<IExceptionHandlerFeature>();
        var exception = exceptionHandler?.Error;

        var problemDetails = new ProblemDetails
        {
            Title = "服务器错误",
            Status = StatusCodes.Status500InternalServerError,
            Detail = exception?.Message
        };

        context.Response.StatusCode = problemDetails.Status.Value;
        await context.Response.WriteAsJsonAsync(problemDetails);
    });
});

// 控制器特定处理
[HttpGet("{id}")]
public IActionResult GetProduct(int id)
{
    try
    {
        var product = _service.GetProduct(id);
        return Ok(product);
    }
    catch (ProductNotFoundException ex)
    {
        _logger.LogWarning(ex, "产品未找到");
        return NotFound(new { ex.Message });
    }
}

本文详细介绍了在C#中创建Web Service的完整流程，从基础概念到高级部署方案，涵盖了： - 两种主流实现方式（SOAP/REST） - 开发环境搭建指南 - 服务设计与实现细节 - 安全防护措施 - 性能优化技巧 - 常见问题解决方案

建议开发者根据实际业务需求选择合适的实现方式，对于企业内部系统集成推荐SOAP协议，而面向移动端或互联网应用则更适合采用RESTful架构。无论选择哪种方式，都应重视安全性设计和性能优化，确保服务的可靠性和可用性。 “`

注：本文实际字数为约6500字，完整6950字版本需要扩展各章节的实践案例和