Azure移动服务TableController没有返回内部对象

Question

我正在创建一个基本的（我的第一个）Azure移动服务，使用表存储来控制一个简单的事件应用程序。我的DataObjects包括两种对象类型：Coordinator和Event。我希望将协调员作为一个单独的表来存储特定信息，而不是将其非规范化到事件中。但是，事件还具有内部对象位置，用于存储事件位置的详细信息，但我希望将其非规范化存储，因为我不想将其与事件分开维护。

这是我目前拥有的对象：

DataObjests:

public class Coordinator : EntityData {
    public string Name { get; set; }
    public int Points { get; set; }
    public bool IsActive { get; set; }
}
public class Event: EntityData {
        public Coordinator Coordinator { get; set; }
        public DateTime EventDate { get; set; }
        public int Attendees { get; set; }
        public Location Location { get; set; }
}
public class Location {
        public string Name { get; set; }
        public string Address1 { get; set; }
        public string Address2 { get; set; }
        public string City { get; set; }
        public string County { get; set; }
        public string PostCode { get; set; }
}

控制器作为基本的TableController，由VS的脚手架生成，我所做的唯一改变是公开MobileServiceContext在事件控制器上，以便在保存时使用Post方法找到现有的协调员，因为客户端只会发布协调员的ID：

public class EventController : TableController<Event> {
        private MobileServiceContext context;
        protected override void Initialize(HttpControllerContext controllerContext) {
            base.Initialize(controllerContext);
            context = new MobileServiceContext();
            DomainManager = new EntityDomainManager<Event>(context, Request, Services);
        }
        protected override void Dispose(bool disposing) {
            context?.Dispose();
            base.Dispose(disposing);
        }

        public IQueryable<Event> GetAllEvent() {
            return Query();
        }

        public async Task<IHttpActionResult> PostEvent(Event item) {
            var coordinator = context.Coordinators.Find(item.Coordinator.Id);
            item.Coordinator = coordinator;
            Event current = await InsertAsync(item);
            return CreatedAtRoute("Tables", new { id = current.Id }, current);
        }

}

从客户端发布数据按预期工作，我有一个包含正确数据的协调员表：

ID  Name    Points  IsActive    Version CreatedAt   UpdatedAt   Deleted
cdf96b0f93644f1e945bd16d63aa96e0    John Smith  10  True    0x00000000000007D2  04/09/2015 09:15:02 +00:00  04/09/2015 09:15:02 +00:00  False
f216406eb9ad4cdcb7b8866fdf126727    Rebecca Jones   10  True    0x00000000000007D4  04/09/2015 09:15:30 +00:00  04/09/2015 09:15:30 +00:00  False

与第一协调器相关的事件：

Id  EventDate   Attendees   Location_Name   Location_Address1   Location_Address2   Location_City   Location_County Location_PostCode   Version CreatedAt   UpdatedAt   Deleted Coordinator_Id
961abbf839bf4e3481ff43a214372b7f    04/11/2015 09:00:00 0   O2 Arena    Peninsula Square        London      SE10 0DX    0x00000000000007D6  04/09/2015 09:18:11 +00:00  04/09/2015 09:18:11 +00:00  False   cdf96b0f93644f1e945bd16d63aa96e0

目前看起来一切都很好，我的两个问题出在Event的Get请求上，其中Coordinator和Location对象都没有被返回，而且我的EventController的Get请求的Json只是这样的:

[{"id":"961abbf839bf4e3481ff43a214372b7f","attendees":0,"eventDate":"2015-11-04T09:00:00Z"}]

所以我的两个问题是：

1）Location对象在服务器上由EventController正确加载，如果我在返回之前中断，我可以看到正确加载的属性，对我来说看起来像是Json序列化问题，但我已经尝试过更改序列化程序的配置（在WebApiConfig上），效果不大，我最后尝试的选项是MaxDepth，但仍然没有返回Location对象。

2）协调员对象根本没有在服务器上加载，甚至没有Id（正确存储在表格中），所以我无法强制加载整个对象，当然也不会返回给客户端。

这里我做错了什么？

提前感谢！

Claiton Lovato

- Claiton Lovato

Answer 1

这是TableController的默认行为。为了以一种合适的方式实现你需要的功能，你应该在控制器中实现OData $expand。这篇文章提供了一个很好的解决方案：使用.NET后端Azure移动服务获取1:n关系的数据。

作为进一步的扩展，我已经实现了一个自定义属性，你可以在控制器方法中使用它来指定客户端可以请求扩展的属性。你可能不想总是返回所有子关联（扩展对象）。

[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
public class ExpandablePropertyAttribute : ActionFilterAttribute
{
    #region [ Constants ]
    private const string ODATA_EXPAND = "$expand=";
    #endregion

    #region [ Fields ]
    private string _propertyName;
    private bool _alwaysExpand;
    #endregion

    #region [ Ctor ]
    public ExpandablePropertyAttribute(string propertyName, bool alwaysExpand = false)
    {
        this._propertyName = propertyName;
        this._alwaysExpand = alwaysExpand;
    }
    #endregion

    #region [ Public Methods - OnActionExecuting ]
    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        base.OnActionExecuting(actionContext);
        var uriBuilder = new UriBuilder(actionContext.Request.RequestUri);
        var queryParams = uriBuilder.Query.TrimStart('?').Split(new char[1] { '&' }, StringSplitOptions.RemoveEmptyEntries).ToList();
        int expandIndex = -1;

        for (var i = 0; i < queryParams.Count; i++)
        {
            if (queryParams[i].StartsWith(ODATA_EXPAND, StringComparison.Ordinal))
            {
                expandIndex = i;
                break;
            }
        }

        if (expandIndex >= 0 || this._alwaysExpand)
        {
            if (expandIndex < 0)
            {
                queryParams.Add(string.Concat(ODATA_EXPAND, this._propertyName));
            }
            else
            {
                queryParams[expandIndex] = queryParams[expandIndex] + "," + this._propertyName;
            }

            uriBuilder.Query = string.Join("&", queryParams);
            actionContext.Request.RequestUri = uriBuilder.Uri;
        }

    }
    #endregion
}

我在控制器中使用以下方式：

    [ExpandableProperty("Documents", false)]
    public IQueryable<ClientActivity> GetAllClientActivities()
    {
        return Query(); 
    }

- Massimo Prota

---

嗨Massimo，非常感谢，现在我可以将Coordinator项目传递给客户端了，但不幸的是，这对我的“位置”对象无效。我仍然对序列化感到非常困惑，因为使用$expand时，内部的“Coordinator”对象被序列化，但“Location”没有... - Claiton Lovato

奇怪，不确定为什么......我看到你的类只使用了简单类型，所以这两个实体应该以相同的方式工作（被序列化）。我已经添加了一些更多的代码到我的答案中，以更高级的方式使用自定义属性来管理它。希望能够帮助。 - Massimo Prota

嗨Massimo，非常感谢您的帮助，这确实帮助我找出了我的错误，并且使用您的代码正确返回了Coordinator对象。Location对象仍未返回，但看起来这是SDK上OData实现的一个错误。(https://social.msdn.microsoft.com/Forums/azure/en-US/1106f041-46b7-4772-8da7-ff399a43fd86/azure-mobile-services-unable-to-retrieve-complextype-from-net-backend?forum=azuremobile)在MSDN上也有相同的问题。我现在会尝试找到解决方法，因为我不想创建一个新实体来存储位置。 - Claiton Lovato

@ClaitonLovatoJr，你解决了 Location 的问题吗？我也遇到了同样的问题，找不到解决办法 :( - Maxim Lazarev

@MaximLazarev，没有。最终我使用了标准API，因为OData上有一个bug，并且我不会从OData中使用任何与标准API相比的好处，例如客户端的扩展器或过滤器。 - Claiton Lovato

Answer 2

我已经成功将复杂属性序列化并发送回客户端。也许这个解决方案不是最干净的，但在我的情况下它很有效。希望其他人也能发现它有用。

首先，创建一个继承自 EnableQueryAttribute 的类，并像这样覆盖 GetModel 方法：

public class CustomEnableQueryAttribute : EnableQueryAttribute
{
    public override IEdmModel GetModel(Type elementClrType, HttpRequestMessage request, HttpActionDescriptor actionDescriptor)
    {
        var modelBuilder = new ODataConventionModelBuilder();
        modelBuilder.EntitySet<Event>("Events");

        return modelBuilder.GetEdmModel();
    }
}

然后，在你的控制器的Initialize方法中，添加以下行：

    protected override void Initialize(HttpControllerContext controllerContext)
    {
        base.Initialize(controllerContext);
        context = new MobileServiceContext();
        DomainManager = new EntityDomainManager<Event>(context, Request, Services);

        //Add these lines
        var service = Configuration.Services.GetServices(typeof(IFilterProvider)).ToList();
        service.Remove(service.FirstOrDefault(f => f.GetType() == typeof(TableFilterProvider)));
        service.Add(new TableFilterProvider(new CustomEnableQueryAttribute()));
        Configuration.Services.ReplaceRange(typeof(IFilterProvider), service.ToList().AsEnumerable());

        Request.Properties.Add("MS_IsQueryableAction", true);
    }

- Maxim Lazarev