手把手教你在.NET中创建Web服务实现方法

简介

本攻略将介绍如何在.NET中创建Web服务及其实现方法。在本文中，我们将会学习使用C#编写Web服务，并且在客户端调用此服务。同时，我们还将会探讨如何使用不同类型的服务。

步骤

第一步：创建Web服务

首先，打开Visual Studio并创建新项目。在“新建项目”对话框中，选择“ASP.NET Web应用程序(.NET框架)”模板。

在下一步中，选择Web应用程序的类型，我们选择API。在下一步中，我们可以选择要包含的组件。但是这里我们保持默认。

接下来，在创建的Solution中，我们可以看到一个名为“WebApplication”的项目。打开此项目，右键单击“Controllers”文件夹，并选择“添加” -> “控制器”。

在“添加新项”对话框中，选择“Web API控制器 - 空”，并将其命名为“WebAPIController”。

现在，我们已经创建了一个Web服务基础结构。

第二步：实现Web服务方法

我们已经创建了Web服务，现在让我们在其中新增一个方法。在WebAPIController文件中编写以下代码：

public class WebAPIController : ApiController
{
    [HttpGet]
    public string Greeting(string name)
    {
        return "Hello, " + name + "!";
    }
}

代码中的Greeting方法将会输入一个名字，并返回一个包含该名字的问候信息的字符串。

第三步：启动Web服务

在Visual Studio中，按下F5键启动Web服务。然后，浏览器将启动并打开Swagger UI页面。在Swagger UI页面中，我们可以查看API中所有可用的方法以及它们的相关信息，包括输入和输出参数，HTTP方法，路由等。

此时，我们可以在Swagger UI页面中找到Greeting方法。单击该方法，然后系统将会提示您为该方法提供所需参数。在此示例中，根据我们的编写，该方法需要一个字符串参数：“name”。

输入您的姓名，然后单击“Try it out!”，该方法将向我们返回一个问候信息。

第四步：在客户端调用Web服务

我们已经实现了Web服务，并对其进行了测试。现在，我们将在客户端中调用该服务。

在Visual Studio中，创建一个新的ASP.NET Web 项目。现在，打开该项目并添加一个新的页面。

从Solution中的Web服务项目中复制服务的URL地址，然后在代码中使用以下代码编辑器引用该URL：

HttpClient client = new HttpClient();

client.BaseAddress = new Uri("http://localhost:port/");

client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

HttpResponseMessage response = client.GetAsync("api/WebAPI/Greeting?name=YourName").Result;

if (response.IsSuccessStatusCode)
{
    var greeting = response.Content.ReadAsStringAsync().Result;
}

我们已经通过HttpClient类向Web服务发送请求，并成功获取了响应。现在，让我们运行我们的应用程序，它将运行我们的客户端并向Web服务发送请求。为此，我们可以使用浏览器或者Visual Studio内置的调试器。

第五步：使用不同类型的服务

我们通常可以使用三种不同类型的Web服务：SOAP，RESTful和WCF。

SOAP是一种基于XML的协议，它使Web服务和应用程序之间的交互非常规范化。SOAP的最大优势是可以跨平台交互。SOAP的缺点包括速度较慢，对开发者工具的依赖性较强。

RESTful是另一种类型的Web服务。RESTful是一种基于HTTP的协议，可以使用JSON格式进行数据传输。RESTful的最大优势是非常高效，缺点包括缺少标准化，不兼容enterprise级别应用程序。

WCF是一种灵活的“中间人”模型，可以使用不同类型的协议（如SOAP, HTTP, TCP等）。WCF的优势在于其灵活性和维护性，缺点在于其复杂性。

在此示例中，我们已经实现了一个RESTful的Web服务。

示例说明

下面给出两条示例说明。

示例1

在第三步中使用的Greeting方法是一个简单的示例。它输入一个字符串类型的参数，并输出一个字符串类型的问候信息。这个方法非常简单，但是它使我们在Web服务中实现了一个基本功能，并允许我们在客户端调用它。

示例2

我们还可以实现一个稍微复杂的方法。例如，我们可以实现一个需要请求API的方法，该API返回一个JSON对象。我们可以使用以下代码：

public class WebAPIController : ApiController
{
    [HttpGet]
    public async Task<ActionResult> GetWeather(string city)
    {
        using (HttpClient client = new HttpClient())
        {
            client.BaseAddress = new Uri("http://api.openweathermap.org");
            client.DefaultRequestHeaders.Accept.Clear();
            client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

            HttpResponseMessage response = await client.GetAsync($"/data/2.5/weather?q={city}&appid=YourApiKey");

            if (response.IsSuccessStatusCode)
            {
                Weather weather = await response.Content.ReadAsAsync<Weather>();
                return Ok(weather);
            }

            return NotFound();
        }
    }
}

public class Weather
{
    public string Name { get; set; }
    public Main Main { get; set; }
    public Wind Wind { get; set; }
}

public class Main
{
    public double Temp { get; set; }
    public double Pressure { get; set; }
    public double Humidity { get; set; }
}

public class Wind
{
    public double Speed { get; set; }
}

此方法需要一个字符串类型的参数city，然后向开放天气API发送GET请求。如果API响应成功，返回一个名为Weather的对象，包含了表示天气的信息。

结论

在本文中，我们详细讲解了如何在.NET中创建Web服务及其实现方法。我们通过示例说明了基本的Web服务实现方法，展示了如何在Web服务中使用不同类型的服务。我们希望这篇文章能帮助您更好的了解和使用.NET平台上Web服务的知识。