REST WCF数据服务的简单示例

时间:2014-10-20 13:51:26

标签: c# asp.net visual-studio-2010 wcf-data-services

我需要开发两个站点之间的数据传输,并相信在我们的.Net环境中,RESTful实现比使用FTP(ugh)的实现要好得多。但是,很难找到简单的例子,并且ADO.NET掩盖了REST基础知识或许多聪明的细节,所以我试图让自己变得非常简单。不过,我需要一些原则和实施方面的帮助才能让它发挥作用。

在VisualStudio Web项目中,我创建了一个新项WCF Data Service和一个数据类。这是App_Code \ WidgetRecord.cs:

//using System;
using System.Collections.Generic;//List
using System.Linq;//Where
//using System.Web;
using System.ServiceModel;//ServiceContract, OperationContract
using System.Runtime.Serialization;//DataContract
using System.Diagnostics;//Debug.WriteLine()

/// <summary>
/// Declare operations for a service
/// </summary>
[ServiceContract]
public interface IScandataService
{
    [OperationContract]
    List<WidgetRecord> List();

    [OperationContract]
    WidgetRecord Get(string Id);

    [OperationContract]
    int Put(string Id, string Desc);
}//end interface

/// <summary>
/// Fake database storage for testing the WCF Data Service
/// </summary>
public static class Database
{
    /// <summary>
    /// Fake database table
    /// </summary>
    public static List<WidgetRecord> WidgetTable = new List<WidgetRecord>() { 
    new WidgetRecord("0001", "red"), 
    new WidgetRecord("0002", "blue") };
}

/// <summary>
/// Implement operations for a service.
/// Representation of a table of widgets identified by scanned barcodes
/// </summary>
[DataContract]
public class WidgetRecord : IScandataService
{
    /// <summary>
    /// Row column: the id which could be a scanned barcode
    /// </summary>
    public string Id { get; set; }

    /// <summary>
    /// Row column: widget description.
    /// (Other columns could be a timestamp, location etc)
    /// </summary>
    public string Desc { get; set; }

    /// <summary>
    /// Dummy initializer, needed for ....(??)
    /// </summary>
    public WidgetRecord()
    {
    return;
    }

    /// <summary>
    /// Initializer to populate the fake database storage.
    /// Creates a new widget record.
    /// </summary>
    /// <param name="Id"></param>
    public WidgetRecord(string Id, string Desc)
    {
    this.Id = Id;
    this.Desc = Desc;
    return;
    }

    /// <summary>
    /// List all stored widgets
    /// </summary>
    /// <returns></returns>
    [OperationContract]
    public List<WidgetRecord> List()
    {
    return Database.WidgetTable;
    }

    /// <summary>
    /// Get info on an existing widget
    /// </summary>
    /// <param name="Id"></param>
    /// <returns></returns>
    [OperationContract]
    public WidgetRecord Get(string Id)
    {
    WidgetRecord sd = Database.WidgetTable.Where(n => n.Id == Id).FirstOrDefault();
    if (sd == null)
        Debug.WriteLine(string.Format("Found: {0} - {1}", sd.Id, sd.Desc));
    else
        Debug.WriteLine(string.Format("Not found: id={0}", Id));
    return sd;
    }

    /// <summary>
    /// Add a new widget to the database
    /// </summary>
    /// <param name="Id"></param>
    /// <param name="Desc"></param>
    /// <returns></returns>
    [OperationContract]
    public int Put(string Id, string Desc)
    {
    Database.WidgetTable.Add(new WidgetRecord(Id, Desc));
    Debug.WriteLine(string.Format("Put: {0} - {1}", Id, Desc));
    return 0;
    }
}//end class

在其他来源中,我经常看到partial class[DataContract]字段成员,另一个类有方法。我不明白为什么这应该分开。我只是尝试使用ServiceContract接口作为我的数据类的基类。无论如何,我的带有字段和方法的类构建正常。

我在code-behind的{​​{1}}中引用上述课程,即WcfDataService.svc

App_Code\WcfDataService.cs

这一切都构建并运行,但基本上什么也没做。

//using System;
using System.Data.Services;//IDataServiceConfiguration, EntitySetRights, ServiceOperationRights, DataServiceProtocolVersion
//using System.Data.Services.Common;
//using System.Collections.Generic;
//using System.Linq;
//using System.ServiceModel.Web;

public class WcfDataService : DataService<WidgetRecord>
{
    // This method is called only once to initialize service-wide policies.
    public static void InitializeService(IDataServiceConfiguration config)
    {
    // TODO: set rules to indicate which entity sets and service operations are visible, updatable, etc.
    // Examples:
    config.SetEntitySetAccessRule("*", EntitySetRights.AllRead);
    config.SetServiceOperationAccessRule("*", ServiceOperationRights.All);
    //config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V2;
    return;
    }
}//end class

我无法向网址添加命令:

http://localhost:56794/website_for_rest/wcfDataService.svc/
-->
<?xml version="1.0" encoding="UTF-8" standalone="true"?>
<service xmlns="http://www.w3.org/2007/app" 
    xmlns:app="http://www.w3.org/2007/app" 
    xmlns:atom="http://www.w3.org/2005/Atom" 
    xml:base="http://localhost:56794/website_for_rest/WcfDataService.svc/">
    <workspace>
        <atom:title>Default</atom:title>
    </workspace>
</service>

我是否需要向http://localhost:56794/website_for_rest/wcfDataService.svc/List --> page not found 添加内容? VS给了我一个126行web.config,我不知道在哪里添加什么。

感谢任何帮助。

1 个答案:

答案 0 :(得分:1)

至少对我来说,答案是最简单的REST示例不使用WCF数据服务,这是一个简化REST的框架。但是,如果您有大量数据和许多要执行的操作,则只需要简化REST。对于启动器和简单的数据传输,您可以在没有框架的情况下执行REST。当你需要一个框架时,有很多选择,参见例如this list of a few dozen frameworks。首先,SOAP是较旧的之一,由于过于复杂而失宠。与Web服务相同。显然,用于接替WS的WCF数据服务又被Web API取代。

此类框架的问题在于它们可能会产生新问题。对我来说,我必须升级我的工具是一个缺点,因为带有.Net3.5的VS2010不支持Web API。升级是一件好事,但如果它干扰了我正在进行的大型项目,那就不是了。或者WCF数据服务对我来说并不清楚,有各种我不懂的智能绑定,请看我的问题。 WCF DS存在许多示例,但与ADO.NET结合使用可帮助您处理大量表。

坚持使用Microsoft环境(VS,.Net,Asp),很容易从简单的REST开始。只需创建一个空网页,例如Default.aspx,然后在其Page_Load()中开始编写REST功能。

要查看GET,PUT,POST等请求是否已到达,请查看Request.RequestType

获取HTTP正文中的数据:Request.BinaryRead(Request.ContentLength)

如果您需要处理授权,请从Authentication Http标题行获取用户名和密码:Request.Params["HTTP_AUTHORIZATION"],这是base64编码的。然后,您将需要与HTTPS的安全连接,HTTPS在传输(TCP)级别对整个HTTP数据包(包括HTTP标头)进行加密。

要返回HTTP状态代码和/或错误消息,只需在页面中添加常规的asp文本控件即可。如果您想RESTful返回数据结构,也可以用Response对象替换整个http响应。

使用Telerik fiddler工具,可以轻松制作HTTP数据包来测试简单的REST服务器页面。

要让客户使用更好的网址访问您的网页,您需要使用一些网址重写。这涉及下载和安装重写模块,以及向web.config添加规则。 This seems to be a good source with detailed explanations and examples

当然使用一个漂亮的框架会很棒,但是准确的实现是学习REST的好方法,并且已经比旧的FTP交换数据方法有了很大的改进,这在我的行业中经常出现。

感谢Mason,他帮助我意识到WCF DS只是众多框架中的一个。