如何从Web服务返回多个值?

时间:2012-08-20 13:45:53

标签: c# visual-studio-2010 web-services asmx webmethod

我对网络服务世界很陌生,所以请耐心等待。 我正在使用.asmx文件在Visual Studio 2010中创建一个非常简单的Web服务。

以下是我正在使用的代码:

namespace MyWebService
{
    [WebService(Namespace = "http://www.somedomain.com/webservices")]
    [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
    [System.ComponentModel.ToolboxItem(false)]

    public class Service1 : System.Web.Services.WebService
    {
        [WebMethod]
        public string simpleMethod(String str)
        {
            return "Hello " + str;
        }   
    }
}

当我调用它并为str参数输入值“John Smith”时,它返回:

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://www.somedomain.com/webservices">Hello John Smith</string>

我的问题是,为Web服务方法返回超过1个值的最佳做法是什么?如果值都是相同的数据类型,我应该使用数组吗?如果值包含不同的数据类型,我是否需要创建自定义类?

1 个答案:

答案 0 :(得分:37)

我认为最好的设计是编写一个类并将其包含在您的WSDL 中。这将使类签名与您的服务描述一起提供。这意味着客户端,尽管它的语言,将能够使用该类型的对象。

创建此类时,尽量不要使用.Net内置自定义类型,例如DataSet或其他任何类型。尽可能尝试使用基本类型。这将确保您的对象可以轻松地序列化和反序列化,以及客户开发的.Net以外的框架使用。

请检查此问题:How to Declare Complex Nested C# Type for Web Service 它确实显示了一些代码和一些小建议。

如果您需要任何进一步的支持,请告诉我。


<强>更新

假设您想要为给定的webmethod返回以下数据集:

  • 学生姓名
  • 学生的出生日期
  • 学生当前被分配到的课程列表(由他们的名字代表)

查看服务的签名方式:

public class WebService1 : System.Web.Services.WebService
{
    public class Course
    {
        public string Name { get; set; }
    }

    public class Student
    {
        public string Name { get; set; }
        public DateTime BirthDate { get; set; }
        public List<Course> CurrentCourses { get; set; }
    }

    [WebMethod]
    public Student HelloWorld()
    {
        Student Baxter = new Student();

        Baxter.Name = "Baxter";
        Baxter.BirthDate = new DateTime(1986, 04, 22);
        Baxter.CurrentCourses = new List<Course>();
        Baxter.CurrentCourses.Add(new Course() { Name = "SOAP Webservices 101" });
        Baxter.CurrentCourses.Add(new Course() { Name = "Mastering C#" });
        Baxter.CurrentCourses.Add(new Course() { Name = "Why you (and I) suck at Javascript" });

        return Baxter;
    }
}

调用之后,结果如下:

<Student xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://tempuri.org/">
    <Name>Baxter</Name>
    <BirthDate>1986-04-22T00:00:00</BirthDate>
    <CurrentCourses>
        <Course>
            <Name>SOAP Webservices 101</Name>
        </Course>
        <Course>
            <Name>Mastering C#</Name>
        </Course>
        <Course>
            <Name>Why you (and I) suck at Javascript</Name>
        </Course>
    </CurrentCourses>
</Student>

最好的是,因为这个类签名是公共的(包含在WSDL中),所以你可以通过简单地处理WSDL来在不同的项目中执行以下

        ServiceReference1.WebService1SoapClient SoapClient = new ServiceReference1.WebService1SoapClient();
        ServiceReference1.Student IsThisBaxter = SoapClient.HelloWorld();
相关问题