c# JSON返回格式的WEB SERVICE

下面是详细讲解“c# JSON返回格式的WEB SERVICE”的攻略。

简介

在使用web service进行跨语言通信时，由于各种语言对数据格式的要求不同，我们需要一种通用的数据格式来实现通信，而 JSON 就是一种通用的数据格式。C# JSON返回格式的WEB SERVICE可以将数据以 JSON 格式返回，方便与其他编程语言进行数据交互。下面我们来看具体实现过程。

步骤

1. 创建一个 C# WEB SERVICE

首先，需要创建一个 C# WEB SERVICE。可以使用 Visual Studio 创建，具体步骤如下：

• 打开 Visual Studio，新建一个“ASP.NET Web 服务应用程序”项目。
• 右键点击项目，选择“添加”->“新建项”->“Web 服务”。
• 在新建的 WEB 服务中添加自己的代码，实现相应的功能。

2. 引用 Newtonsoft.Json 库

由于C#中没有内置支持JSON的序列化和反序列化的类库，需要使用第三方的类库。这里我们使用 Newtonsoft.Json 库，新版本的 Visual Studio 会自动下载相关的 NuGet 包。如果未自动下载，则可以手动通过 NuGet 下载。

可以打开 NuGet 控制台，输入以下命令：

Install-Package Newtonsoft.Json

3. 定义要返回的数据结构

在 WEB SERVICE 中，需要定义要返回的数据结构。可以按照自己的需求定义类、结构体等。这里以返回一个学生信息列表为例，定义如下：

public class Student
{
    public int Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
}

public class StudentList
{
    public List<Student> Students { get; set; }
}

4. 实现返回 JSON 数据的方法

在 WEB SERVICE 中，需要实现一个方法，将自定义的数据结构转换为 JSON 格式并返回。可以使用 Newtonsoft.Json 中的 JsonSerializer。

using Newtonsoft.Json;

[WebMethod]
public string GetStudentList()
{
    StudentList studentList = new StudentList();
    studentList.Students = new List<Student>();

    //添加学生数据
    studentList.Students.Add(new Student() { Id = 1, Name = "Jack", Age = 20 });
    studentList.Students.Add(new Student() { Id = 2, Name = "Rose", Age = 21 });

    //将数据转换为 JSON 格式并返回
    return JsonConvert.SerializeObject(studentList);
}

5. 调用 WEB SERVICE 并获取 JSON 数据

最后，可以通过相应的方法来调用 WEB SERVICE 并获取 JSON 数据。例如在 JavaScript 中可以使用 jQuery 的 AJAX 方法：

$.ajax({
    type: "POST",
    url: "WebService.asmx/GetStudentList",
    data: "{}",
    contentType: "application/json; charset=utf-8",
    dataType: "json",
    success: function (data) {
        //处理返回的 JSON 数据
    },
    error: function (xhr, err) {
        console.log("Error: " + err);
    }
});

示例

示例1：返回一个简单的 JSON 对象

首先定义一个简单的对象：

public class MyObject
{
    public string Name { get; set; }
    public int Age { get; set; }
}

然后实现一个 WEB SERVICE 方法，返回这个对象的 JSON：

[WebMethod]
public string GetMyObject()
{
    MyObject myObject = new MyObject()
    {
        Name = "Jack",
        Age = 20
    };

    return JsonConvert.SerializeObject(myObject);
}

最后在 JavaScript 中调用这个 WEB SERVICE：

$.ajax({
    type: "POST",
    url: "WebService.asmx/GetMyObject",
    data: "{}",
    contentType: "application/json; charset=utf-8",
    dataType: "json",
    success: function (data) {
        console.log(data.d.Name); //输出 Jack
        console.log(data.d.Age); //输出 20
    },
    error: function (xhr, err) {
        console.log("Error: " + err);
    }
});

示例2：返回带有子对象的 JSON 数据

定义一个包含子对象的数据结构：

public class MyObjectWithChild
{
    public string Name { get; set; }
    public int Age { get; set; }
    public MyChildObject Child { get; set; }
}

public class MyChildObject
{
    public string Name { get; set; }
    public int Age { get; set; }
}

通过实现一个 WEB SERVICE 的方法，来返回这个数据结构的 JSON 数据：

[WebMethod]
public string GetMyObjectWithChild()
{
    MyObjectWithChild myObjectWithChild = new MyObjectWithChild()
    {
        Name = "Jack",
        Age = 20,
        Child = new MyChildObject()
        {
            Name = "Rose",
            Age = 19
        }
    };

    return JsonConvert.SerializeObject(myObjectWithChild);
}

最后在 JavaScript 中将这个 JSON 数据解析：

$.ajax({
    type: "POST",
    url: "WebService.asmx/GetMyObjectWithChild",
    data: "{}",
    contentType: "application/json; charset=utf-8",
    dataType: "json",
    success: function (data) {
        console.log(data.d.Name); //输出 Jack
        console.log(data.d.Age); //输出 20
        console.log(data.d.Child.Name); //输出 Rose
        console.log(data.d.Child.Age); //输出 19
    },
    error: function (xhr, err) {
        console.log("Error: " + err);
    }
});

结论

C# JSON返回格式的 WEB SERVICE 可以将数据以 JSON 格式返回，方便与其他编程语言进行数据交互。通过引用 Newtonsoft.Json 库，并实现一个将数据结构转换为 JSON 格式的方法，即可轻松实现。