C#的类库中怎么添加Web Service引用

发布时间：2021-08-25 17:52:15 作者：chen
来源：亿速云阅读：144

# C#的类库中怎么添加Web Service引用

在现代软件开发中，Web Service是实现跨平台、跨语言系统集成的重要技术。对于C#开发者而言，在类库项目中引用Web Service是常见的需求。本文将详细介绍在C#类库中添加Web Service引用的完整流程，包括传统ASMX服务和现代WCF服务的不同处理方式。

## 一、准备工作

在开始之前，请确保：
1. 已安装Visual Studio（2017或更高版本）
2. 已创建C#类库项目（.NET Framework或.NET Core/.NET 5+）
3. 拥有目标Web Service的URL地址（如`http://example.com/service.asmx`）

## 二、添加ASMX Web Service引用（传统方式）

### 1. 通过"添加服务引用"方式

对于.NET Framework类库项目：
```csharp
// 步骤：
1. 右键项目 → "添加" → "服务引用"
2. 在弹出的对话框中输入WSDL地址（如http://example.com/service.asmx?wsdl）
3. 指定命名空间（如"MyWebService"）
4. 点击"高级"可配置高级选项
5. 点击"确定"生成代理类

生成的代理类将出现在”Service References”文件夹下，使用时：

var client = new MyWebService.ServiceSoapClient();
var result = client.SomeMethod();

2. 使用wsdl.exe工具（备用方案）

当Visual Studio集成方式不可用时：

# 命令行操作：
wsdl /language:CS /out:MyServiceProxy.cs http://example.com/service.asmx?wsdl

然后将生成的.cs文件添加到项目中。

三、添加WCF服务引用

对于较新的WCF服务：

1. 标准添加方式

// 步骤：
1. 右键项目 → "添加" → "服务引用"
2. 输入服务地址（如http://example.com/Service.svc）
3. 点击"前往"按钮加载服务元数据
4. 指定命名空间后点击"确定"

2. 配置注意事项

在app.config/web.config中会自动生成绑定配置：

<system.serviceModel>
  <bindings>
    <basicHttpBinding>
      <binding name="BasicHttpBinding_IService" />
    </basicHttpBinding>
  </bindings>
  <client>
    <endpoint address="http://example.com/Service.svc"
      binding="basicHttpBinding" 
      contract="MyServiceReference.IService" />
  </client>
</system.serviceModel>

四、.NET Core/.NET 5+的特殊处理

现代.NET项目需要使用Connected Services：

1. 添加WCF Web Service引用

// 步骤：
1. 右键项目 → "添加" → "Connected Service"
2. 选择"Microsoft WCF Web Service Reference Provider"
3. 输入服务地址并配置选项
4. 点击"完成"生成客户端代码

2. 使用HttpClient替代（推荐REST方案）

对于现代开发，建议考虑：

// 示例：使用HttpClient调用REST API
var client = new HttpClient();
var response = await client.GetAsync("https://api.example.com/data");
var content = await response.Content.ReadAsStringAsync();

五、常见问题解决方案

1. 证书验证问题

// 绕过证书验证（仅开发环境）
ServicePointManager.ServerCertificateValidationCallback += 
    (sender, cert, chain, errors) => true;

2. 命名冲突处理

在添加引用时指定不同的命名空间避免冲突

3. 异步方法调用

现代服务引用默认生成异步方法：

var result = await client.SomeMethodAsync();

六、最佳实践建议

接口抽象：不要直接使用生成的客户端，应创建接口包装

public interface IMyServiceProxy {
    Task<SomeResult> GetDataAsync();
}

public class MyServiceProxy : IMyServiceProxy {
    private readonly ServiceClient _client;
    
    public async Task<SomeResult> GetDataAsync() {
        return await _client.GetDataAsync();
    }
}

依赖注入：在ASP.NET Core中注册服务

services.AddTransient<IMyServiceProxy, MyServiceProxy>();

配置管理：将服务地址放在配置文件中

{
  "ServiceConfig": {
    "BaseUrl": "https://api.example.com"
  }
}

结语

在C#类库中添加Web Service引用是集成分布式系统的基础操作。根据项目类型（.NET Framework/.NET Core）和服务类型（ASMX/WCF/REST）选择适当的方式，并遵循最佳实践，可以构建出健壮、可维护的服务集成层。随着技术的发展，建议新项目优先考虑基于HTTP/REST的通信方式，但传统Web Service集成技能在维护现有系统时仍然非常重要。 “`

本文共计约950字，涵盖了从传统到现代的Web Service集成方案，提供了详细的步骤说明和实用代码示例，并包含了常见问题解决方案和最佳实践建议。