Azure 移动服务 TableController 不返回内部对象
Azure Mobile Service TableController not returning inner objects
我正在创建一个带有 Table 存储的基本(我的第一个)Azure 移动服务来控制一个简单的事件应用程序。我的 DataObjects 由 2 种对象类型组成:Coordinator
和 Event
,我希望协调器是一个单独的 table 来存储我不希望它在事件中非规范化的特定信息,但是事件还有一个内部对象 Location 来存储事件位置的详细信息,但我想存储非规范化的,因为我不想与事件分开维护这些详细信息。
这里是我目前拥有的对象:
数据对象:
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 方法来查找现有的保存为客户端时的协调器只会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);
}
}
Post来自客户端的数据按预期工作,我有一个具有正确数据的协调器 table:
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
此时一切看起来都很好,我的 2 个问题是事件的获取,其中 Coordinator
和 Location
对象都没有返回,而我的 EventController 的 Json get就是这样:
[{"id":"961abbf839bf4e3481ff43a214372b7f","attendees":0,"eventDate":"2015-11-04T09:00:00Z"}]
所以我的两个问题是:
1) Location 对象由服务器上的 EventController
正确加载,如果我在返回前中断,我可以看到正确加载的属性,对我来说看起来像 Json 序列化问题,但我已经尝试更改序列化程序的配置(在 WebApiConfig
上)但没有太大效果,我尝试的最后一个选项是 MaxDepth
但仍然没有返回 Location 对象。
2) 我根本没有在服务器上加载 Coordinator 对象,甚至没有 Id(正确存储在 table 上)所以我不能强制加载整个对象,当然它不会返回给客户端。
关于我在这里做错了什么有什么想法吗?
提前致谢
克莱顿洛瓦托
这是 TableController 的默认行为。
为了以时尚的方式实现您正在寻找的东西,您应该在控制器中实现 OData $expand。
本文提供了一个很好的解决方案演练
Retrieving data from 1:n relationship using .NET backend Azure Mobile Services
作为进一步的扩展,我实现了一个自定义属性,您可以在控制器方法中使用该属性来指定客户端可以请求扩展的属性。您可能不想总是返回所有子关系(扩展对象)
[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();
}
我已经设法将复杂属性序列化并发送回客户端。也许解决方案不是最干净的,但它适用于我的情况。希望其他人也会发现它有用。
首先,创建一个继承自 EnableQueryAttribute
的 class 并覆盖 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);
}
我正在创建一个带有 Table 存储的基本(我的第一个)Azure 移动服务来控制一个简单的事件应用程序。我的 DataObjects 由 2 种对象类型组成:Coordinator
和 Event
,我希望协调器是一个单独的 table 来存储我不希望它在事件中非规范化的特定信息,但是事件还有一个内部对象 Location 来存储事件位置的详细信息,但我想存储非规范化的,因为我不想与事件分开维护这些详细信息。
这里是我目前拥有的对象: 数据对象:
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 方法来查找现有的保存为客户端时的协调器只会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);
}
}
Post来自客户端的数据按预期工作,我有一个具有正确数据的协调器 table:
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
此时一切看起来都很好,我的 2 个问题是事件的获取,其中 Coordinator
和 Location
对象都没有返回,而我的 EventController 的 Json get就是这样:
[{"id":"961abbf839bf4e3481ff43a214372b7f","attendees":0,"eventDate":"2015-11-04T09:00:00Z"}]
所以我的两个问题是:
1) Location 对象由服务器上的 EventController
正确加载,如果我在返回前中断,我可以看到正确加载的属性,对我来说看起来像 Json 序列化问题,但我已经尝试更改序列化程序的配置(在 WebApiConfig
上)但没有太大效果,我尝试的最后一个选项是 MaxDepth
但仍然没有返回 Location 对象。
2) 我根本没有在服务器上加载 Coordinator 对象,甚至没有 Id(正确存储在 table 上)所以我不能强制加载整个对象,当然它不会返回给客户端。
关于我在这里做错了什么有什么想法吗?
提前致谢
克莱顿洛瓦托
这是 TableController 的默认行为。 为了以时尚的方式实现您正在寻找的东西,您应该在控制器中实现 OData $expand。
本文提供了一个很好的解决方案演练
Retrieving data from 1:n relationship using .NET backend Azure Mobile Services
作为进一步的扩展,我实现了一个自定义属性,您可以在控制器方法中使用该属性来指定客户端可以请求扩展的属性。您可能不想总是返回所有子关系(扩展对象)
[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();
}
我已经设法将复杂属性序列化并发送回客户端。也许解决方案不是最干净的,但它适用于我的情况。希望其他人也会发现它有用。
首先,创建一个继承自 EnableQueryAttribute
的 class 并覆盖 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);
}