5

<TL;DR>

至少，我正在寻找一种方法来有条件地排除资源上的某些属性，使其不包含在每次调用的响应中（见fields下文）。

理想情况下，我想使用支持以下所有要点的 ServiceStack 实现 REST 服务。

更新
虽然我真的很喜欢 ServiceStack 的方法，并且如果可能的话更愿意使用它，但如果它不是特别适合这些想法，我宁愿不弯腰把它搞砸以使其工作。如果是这样的话，任何人都可以指出另一个可能更合适的 c# 框架吗？当然，我自己也在积极探索其他选择。

</TD;DR>

在这次题为“设计 REST + JSON API ”的演讲中，演讲者描述了他在 JSON 中的资源引用（通过href资源的属性）的策略。除此之外，他还描述了两个查询参数 (fields和expand)，用于控制对 REST 服务的调用响应中包含哪些数据。我一直在尝试深入研究 ServiceStack 框架以实现对fields特别的支持，但到目前为止还没有成功。这目前在 ServiceStack 中可行吗？理想情况下，该解决方案与格式无关，因此适用于所有 ServiceStack 支持的输出格式。我想expand会遵循同样的策略。

我将在这里描述这些功能，但我认为链接上的谈话可以更好地解释它们。

假设我们有一个具有以下属性的 Profiles 资源：givenName、surname、gender和favColor。socialNetworksProfiles 资源还包括用户在属性中所属的社交网络列表。

href-（视频中的 42:22）每个资源都在 REST 服务上包含指向它的完整链接。一个电话GET /profiles/123会返回 

{
    "href":"https://host/profiles/123",
    "givenName":"Bob",
    "surname":"Smith",
    "gender":"male",
    "favColor":"red",
    "socialNetworks": {
        "href":"https://host/socialNetworkMemberships?profileId=123"
    }
}

请注意，该socialNetworks属性返回一个仅填充了 href 值的对象。这使响应保持简短和集中，同时还为最终用户提供了足够的信息，以便在需要时提出进一步的请求。href在这个庄园中全面使用的属性使得将资源数据结构作为其他资源的子级重用（从概念上无论如何）变得容易。

fields-（视频中的 55:44）查询字符串参数，指示服务器仅在 REST 响应中包含所需资源的指定属性。

GET /profiles/123如上所示，来自的正常响应将包括资源的所有属性。当fields请求中包含查询参数时，仅返回指定的字段。'GET /propfiles/123?fields=surname,favColor' 将返回

{
    "href":"https://host/profiles/123",
    "surname":"Smith",
    "favColor":"red"
}

expand- （视频中的 45:53）查询字符串参数，指示服务器在结果中充实指定的子资源。使用我们的示例，如果您要打电话GET /profiles/123?expand=socialNetworks，您可能会收到类似

{
    "href":"https://host/profiles/123",
    "givenName":"Bob",
    "surname":"Smith",
    "gender":"male",
    "favColor":"red",
    "socialNetworks": {
        "href":"https://host/socialNetworkMemberships?profileId=123",
        "items": [
            { 
                "href":"https://host/socialNetworkMemberships/abcde",
                "siteName":"Facebook",
                "profileUrl":"http://www.facebook.com/..."
            },
            ...
        ]
    }
}
4

2 回答 2

6

所以...在我看来，ServiceStack 的最佳特性是它使通过 HTTP 发送、接收和处理 POCO 变得超级容易。如何设置 POCO 以及在两者之间（在“服务”内）做什么取决于您。SS有意见吗？是的。你必须同意他们的观点吗？不。（但你可能应该:)）

我认为扩展类似下面的内容会让你接近你想要如何处理你的 api。可能不是 ServiceStack 的最佳示例，但 ServiceStack 代码/要求几乎不引人注意，并且不会妨碍您（未显示 AppHost 配置）。您可能可以在其他 .NET 框架（MVC/Web API/等）中执行类似的操作，但在我看来，它看起来不像使用 ServiceStack 的直接 C#/.NET 代码。

请求课程 

[Route("/Profiles/{Id}")]
public class Profiles
{
    public int? Id { get; set; }
}

[Route("/SocialNetworks/{Id}")]
public class SocialNetworks
{
    public int? Id { get; set; }
}

基本响应类

public class BaseResponse
{
    protected virtual string hrefPath
    {
        get { return ""; }
    }

    public string Id { get; set; }
    public string href { get { return hrefPath + Id; } }
}

示例中的类 

public class Profile : BaseResponse
{
    protected override string hrefPath { get { return "https://host/profiles/"; } }

    public string GivenName { get; set; }
    public string SurName { get; set; }
    public string Gender { get; set; }
    public string FavColor { get; set; }

    public List<BaseResponse> SocialNetworks { get; set; }
}

public class SocialNetwork: BaseResponse
{
    protected override string hrefPath { get { return "https://host/socialNetworkMemberships?profileId="; }}

    public string SiteName { get; set; }
    public string ProfileUrl { get; set; }
}

服务

public class ProfileService : Service
{
    public object Get(Profiles request)
    {
        var testProfile = new Profile { Id= "123", GivenName = "Bob", SurName = "Smith", Gender = "Male", FavColor = "Red", 
                SocialNetworks = new List<BaseResponse>
                    {
                        new SocialNetwork { Id = "abcde", SiteName = "Facebook", ProfileUrl = "http://www.facebook.com/"}
                    }
        };

        if (!String.IsNullOrEmpty(this.Request.QueryString.Get("fields")) || !String.IsNullOrEmpty(this.Request.QueryString.Get("expand")))
            return ServiceHelper.BuildResponseObject<Profile>(testProfile, this.Request.QueryString);

        return testProfile;
    }
}

public class SocialNetworkService : Service
{
    public object Get(SocialNetworks request)
    {
        var testSocialNetwork = new SocialNetwork
            {
                Id = "abcde",
                SiteName = "Facebook",
                ProfileUrl = "http://www.facebook.com/"
            };

        if (!String.IsNullOrEmpty(this.Request.QueryString.Get("fields")) || !String.IsNullOrEmpty(this.Request.QueryString.Get("expand")))
            return ServiceHelper.BuildResponseObject<SocialNetwork>(testSocialNetwork, this.Request.QueryString);

        return testSocialNetwork;
    }
}

反射助手类

public static class ServiceHelper
{
    public static object BuildResponseObject<T>(T typedObject, NameValueCollection queryString) where T: BaseResponse
    {
        var newObject = new ExpandoObject() as IDictionary<string, object>;
        newObject.Add("href", typedObject.href);

        if (!String.IsNullOrEmpty(queryString.Get("fields")))
        {
            foreach (var propertyName in queryString.Get("fields").Split(',').ToList())
            {
                //could check for 'socialNetwork' and exclude if you wanted
                newObject.Add(propertyName, typedObject.GetType().GetProperty(propertyName, BindingFlags.IgnoreCase | BindingFlags.Public | BindingFlags.Instance).GetValue(typedObject, null));
            }
        }

        if (!String.IsNullOrEmpty(queryString.Get("expand")))
        {
            foreach (var propertyName in queryString.Get("expand").Split(',').ToList())
            {
                newObject.Add(propertyName, typedObject.GetType().GetProperty(propertyName, BindingFlags.IgnoreCase | BindingFlags.Public | BindingFlags.Instance).GetValue(typedObject, null));
            }
        }

        return newObject;
    }
}
于 2013-09-24T22:24:24.660 回答
0

通常，您可以通过设置 DataMember 属性来控制 DTO 的序列化。使用这些属性，您可以控制属性是否应该具有默认值。这意味着如果您只是不定义要返回的对象的属性，则它不应被序列化，因此不会显示在生成的 Json 中。

ServiceStack 内部使用标准的 DataContract...Serializer，所以应该支持这个

否则，您也可以使用动态对象并在运行时简单地组合您的对象，将其序列化并将其发送回。这是一个非常非常基本的例子：

        var seri = JsonSerializer.Create(new JsonSerializerSettings() { });

        using (var textWriter = new StringWriter())
        {
            var writer = new JsonTextWriter(textWriter);

            dynamic item = new { Id = id };

            seri.Serialize(writer, item);

            return textWriter.ToString();
        }
于 2013-09-23T15:20:31.283 回答