使用 ScriptIgnore 时的 JavaScriptSerializer 循环引用

Question

我将我的实体框架实体从我的 Web 项目和数据访问层拆分为一个单独的类库。在我的控制器中，我调用我的存储库以获取IEnumerable<RobotDog.Entities.Movie>，然后尝试使用JavaScriptSerializer 序列化为json，但即使我使用的是[ScriptIgnore] 属性，我也会得到循环引用。

重要提示：最初我在一个项目中拥有我的实体、数据访问和网络，并且我能够在没有循环引用的情况下成功序列化我的实体。当我创建单独的图层时，我开始遇到问题。我没有更改任何实体。

RobotDog.Entities 命名空间中我的一个实体的示例：

namespace RobotDog.Entities {
    public class Character {
        [Key]
        [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
        public int Id { get; set; }

        [MaxLength(200)]
        public string Name { get; set; }

        public virtual Person Person { get; set; }

        [ScriptIgnore]
        public virtual Movie Movie { get; set; }
    }
}

我的控制器：

namespace RobotDog.Web.Controllers {
    public class MoviesController : Controller {
        private UnitOfWork _unitOfWork = new UnitOfWork();

        [HttpGet]
        public ActionResult Index() {
            var user = Membership.GetUser(User.Identity.Name);
            if(user != null) {
                var movies = _unitOfWork.UserMovieRepository.Get(u => u.UserId == (Guid) user.ProviderUserKey).Select(m => m.Movie);
                var serializer = new JavaScriptSerializer();
                var json = serializer.Serialize(movies);
                return View(json);
            }
            return View();
        }

    }
}

我的仓库：

namespace RobotDog.DataAccess.Movies {
    public class Repository<TEntity> : IRepository<TEntity> where TEntity : class {
        internal MovieContext Context;
        internal DbSet<TEntity> DbSet;

        public Repository(MovieContext context) {
            if (context == null)
                throw new ArgumentNullException("context");

            Context = context;
            DbSet = Context.Set<TEntity>();
        }

        public virtual IEnumerable<TEntity> Get(Expression<Func<TEntity, bool>> predicate = null, Func<IQueryable<TEntity>, IOrderedQueryable<TEntity>> orderBy = null ) {
            IQueryable<TEntity> query = DbSet;

            if (predicate != null)
                query = query.Where(predicate);

            return orderBy != null ? orderBy(query).ToList() : query.ToList();
        }
    }
}

Answer 1

也许响应有点晚，但我在 POCO Classes for Entity Framework Code-Firts 上遇到了类似的问题。问题是可能的属性被声明为虚拟的。在这种情况下，EF 创建了覆盖虚拟属性的代理类。似乎 ScriptIgnore 属性默认情况下不会应用于覆盖的属性，除非您像这样使用它：

[ScriptIgnore(ApplyToOverrides=true)]

Answer 2

圆形对象图不能被 JSON 序列化。当你重新考虑它时，它实际上是有道理的。处理这个问题的正确方法是使用视图模型。您永远不应该将您的域实体直接传递给您的视图。始终定义一个仅包含您想要公开的必要属性的视图模型。

我确信使用这个 JSON 的客户端并不关心这个圆形对象图。因此，只需定义一个视图模型，打破这种循环依赖并仅包含您需要的属性。

然后您所要做的就是将您的域模型映射到视图模型并将此视图模型传递给 JsonResult（是的，这是您代码中的另一个问题 - 您在控制器操作中手动进行 JSON 序列化和编写管道代码，而不是将此委托给框架）。

所以：

[HttpGet]
public ActionResult Index() 
{
    var user = Membership.GetUser(User.Identity.Name);
    if(user != null) 
    {
        IEnumerable<Movie> movies = _unitOfWork
            .UserMovieRepository.Get(u => u.UserId == (Guid) user.ProviderUserKey)
            .Select(m => m.Movie);
        IEnumerable<MovieViewModel> moviesVm = ... map the domain model to your view model
        return Json(moviesVm, JsonRequestBehavior.AllowGet);
    }

    // return an empty movies array
    var empty = Enumerable.Empty<MovieViewModel>();
    return Json(empty, JsonRequestBehavior.AllowGet);
}

您现在应该关注的重要事情是定义 MovieViewModel 类，该类将仅包含您希望以 JSON 形式向客户端公开的信息。打破所有循环引用。随意拥有此主视图模型引用的其他视图模型，以便映射其他实体。

最重要的是：永远不要将你的领域模型传递给视图。始终定义视图模型。这样，您的应用程序就完全独立于您正在使用的底层数据访问技术。您可以在不影响 UI 部分的情况下随意修改 DAL 层，因为此 UI 由视图模型表示。