MVC Music Store 在线音乐商店示例分析（6）ShoppingCart

在Models文件夹中，ShoppingCart.cs文件中的类是购物车类。

该类定义了购物车的一些属性。该类相对来说稍微复杂点。

添加注释后具体代码如下：

    /// <summary>
    /// 购物车
    /// 分布类
    /// </summary>
     public partial class ShoppingCart
    {
        /// <summary>
        /// 音乐商店实体
        /// 用于操作购物车时，对应数据库的具体数据操作。
        /// （提取商品信息、保存订单等）
        /// </summary>
         MusicStoreEntities storeDB = new MusicStoreEntities();

        /// <summary>
        /// 购物车编号
        /// </summary>
         string ShoppingCartId { get; set; }

        /// <summary>
        /// 购物车会话编号
        /// </summary>
         public const string CartSessionKey = "CartId";

        /// <summary>
        /// 获取购物车
        /// 静态方法
        /// 从请求的上下文的Cookies中保存的购物车编号获取对应的购物车信息
        /// </summary>
        /// <param name="context">HTTP 请求上下文</param>
        /// <returns>返回购物车</returns>
         public static ShoppingCart GetCart(HttpContextBase context)
        {
            var cart = new ShoppingCart();
            cart.ShoppingCartId = cart.GetCartId(context);
            return cart;
        }

        
        // Helper method to simplify shopping cart calls
         /// <summary>
        /// 获取购物车
        /// 静态方法
        /// 从ASP.NET MVC的控制器的请求上下文中获取购物车信息
        /// </summary>
        /// <param name="controller">控制器</param>
        /// <returns>返回购物车</returns>
         public static ShoppingCart GetCart(Controller controller)
        {
            return GetCart(controller.HttpContext);
        }

        /// <summary>
        /// 购物车添加内容
        /// </summary>
        /// <param name="album">相册</param>
        public void AddToCart(Album album)
        {
            // Get the matching cart and album instances
            //从音乐商店实体中获取匹配车和专辑实例
            var cartItem = storeDB.Carts.SingleOrDefault(c => c.CartId == ShoppingCartId && c.AlbumId == album.AlbumId);

            if (cartItem == null)
            {
                // Create a new cart item if no cart item exists
                //当购物车项不存在的情况下，创建一个新的购物车项
                cartItem = new Cart
                {
                    AlbumId = album.AlbumId,
                    CartId = ShoppingCartId,
                    Count = 1,
                    DateCreated = DateTime.Now
                };

                storeDB.Carts.Add(cartItem);
            }
            else
            {
                // If the item does exist in the cart, then add one to the quantity
                //如果该项内容在购物车中存在，则该项数量增加1
                cartItem.Count++;
            }

            // Save changes
            //通过音乐商店实体保存所做的修改
            storeDB.SaveChanges();
        }

        /// <summary>
        /// 移除购物车指定内容
        /// </summary>
        /// <param name="id">记录编号</param>
        /// <returns>剩余数量</returns>
        public int RemoveFromCart(int id)
        {
            // Get the cart
            // 通过音乐商店实体获取购物车中指定的购物项目
            var cartItem = storeDB.Carts.Single(
                cart => cart.CartId == ShoppingCartId 
                && cart.RecordId == id);

            //当前购物项剩余数量默认为0
            int itemCount = 0;

            if (cartItem != null)
            {
                if (cartItem.Count > 1)
                {
                    //当该购物项数量大于1时，则将该项内容减1
                    cartItem.Count--;
                    //设置当前购物项剩余数量
                    itemCount = cartItem.Count;
                }
                else
                {
                    //否则通过音乐商店实体，在购物车中移除该购物项
                    storeDB.Carts.Remove(cartItem);
                }

                // Save changes
                //通过音乐商店实体保存所做的修改
                storeDB.SaveChanges();
            }
            //当该购物项还有剩余项时，返回当前剩余数量，否则将返回0
            return itemCount;
        }

        /// <summary>
        /// 清空购物车
        /// </summary>
        public void EmptyCart()
        {
            //获取当前购物车编号下购物车中所有项
            var cartItems = storeDB.Carts.Where(cart => cart.CartId == ShoppingCartId);

            //移除所有项
            foreach (var cartItem in cartItems)
            {
                storeDB.Carts.Remove(cartItem);
            }

            // Save changes
            //通过音乐商店实体保存所做的修改
            storeDB.SaveChanges();
        }

        /// <summary>
        /// 获取购物车中项目
        /// </summary>
        /// <returns>返回购物车中项目列表</returns>
        public List<Cart> GetCartItems()
        {
            //获取当前购物车编号下购物车中所有项
            return storeDB.Carts.Where(cart => cart.CartId == ShoppingCartId).ToList();
        }

        /// <summary>
        /// 获取购物车中商品数量
        /// </summary>
        /// <returns>购物车中商品数量</returns>
        public int GetCount()
        {
            // Get the count of each item in the cart and sum them up
            // 获取购物车中每项的数量，并计算总数。
            // int? 如果有值则返回实际值，没有值则返回null
            int? count = (from cartItems in storeDB.Carts
                          where cartItems.CartId == ShoppingCartId
                          select (int?)cartItems.Count).Sum();

            // Return 0 if all entries are null
            // 如果所有项都为空则返回0
            //?? 运算符称为 null 合并运算符，用于定义可以为 null 值的类型和引用类型的默认值。 
            // 如果此运算符的左操作数不为 null，则此运算符将返回左操作数；否则返回右操作数。
            return count ?? 0;
        }

        /// <summary>
        /// 获取总价
        /// </summary>
        /// <returns>购物车总价</returns>
        public decimal GetTotal()
        {
            // Multiply album price by count of that album to get the current price for each of those albums in the cart
            //sum all album price totals to get the cart total
            // 每个购物项的数量*单价得到该项总价之后再计算所有项的总价。
            decimal? total = (from cartItems in storeDB.Carts
                              where cartItems.CartId == ShoppingCartId
                              select (int?)cartItems.Count * cartItems.Album.Price).Sum();
            // total总价有数据则返回实际值，否则返回0
            return total ?? decimal.Zero;
        }

        /// <summary>
        /// 创建订单
        /// </summary>
        /// <param name="order">订单</param>
        /// <returns>返回数据库中订单编号</returns>
        public int CreateOrder(Order order)
        {
            //订单总价
            decimal orderTotal = 0;

            //获取购物车中所有商品项目
            var cartItems = GetCartItems();

            // Iterate over the items in the cart, adding the order details for each
            // 遍历购物车中所有项，用于添加订单的每条详情
            foreach (var item in cartItems)
            {
                var orderDetails = new OrderDetail
                {
                    AlbumId = item.AlbumId,
                    OrderId = order.OrderId,
                    UnitPrice = item.Album.Price,
                    Quantity = item.Count
                };

                // Set the order total of the shopping cart
                //累加每项总价以便计算购物车的总价
                orderTotal += (item.Count * item.Album.Price);
            }

            // Set the order's total to the orderTotal count
            // 赋值订单总价
            order.Total = orderTotal;

            // Save the order
            //通过音乐商店实体保存订单
            storeDB.SaveChanges();

            // Empty the shopping cart
            // 清空购物车，以便下次使用
            EmptyCart();

            // Return the OrderId as the confirmation number
            // 返回订单编号，用于订单确认号
            return order.OrderId;
        }

        
        // We're using HttpContextBase to allow access to cookies.
        /// <summary>
        /// 获取购物车编号
        /// 我们使用HTTPContextBase来允许访问cookies来得到编号
        /// </summary>
        /// <param name="context">HTTP请求上下文</param>
        /// <returns></returns>
        public string GetCartId(HttpContextBase context)
        {
            
            if (context.Session[CartSessionKey] == null)
            {
                // 请求上下文的当前会话中没有购物车编号的情况下
                if (!string.IsNullOrWhiteSpace(context.User.Identity.Name))
                {
                    //当前用户登录的情况下
                    //设置购物车编号为当前用户名
                    context.Session[CartSessionKey] = context.User.Identity.Name;
                }
                else
                {
                    // 用户没有登录的情况下
                    // Generate a new random GUID using System.Guid class
                    // 生成一个全局唯一标识符
                    Guid tempCartId = Guid.NewGuid();

                    // Send tempCartId back to client as a cookie
                    // 将该改标识符作为临时购物车编号保存到当前会话当中，
                    // 该会话会将该编号保存到客户端的Cookie中。
                    context.Session[CartSessionKey] = tempCartId.ToString();
                }
            }

            return context.Session[CartSessionKey].ToString();
        }

        // When a user has logged in, migrate their shopping cart to
        // be associated with their username
        /// <summary>
        /// 迁移购物车
        /// 当用户登录时，将用户登录之前的购物车信息，迁移到登录后的购物车中。
        /// </summary>
        /// <param name="userName">用户名</param>
        public void MigrateCart(string userName)
        {
            // 提取购物车中的购买项
            var shoppingCart = storeDB.Carts.Where(c => c.CartId == ShoppingCartId);

            // 将所有购买项的购物车编号更换为用户名。
            foreach (Cart item in shoppingCart)
            {
                item.CartId = userName;
            }
            //保存数据
            storeDB.SaveChanges();
        }
    }

　　其中获取购物车方法GetCart重载了两个，一个使用HttpContextBase来获取购物车信息，一个使用Controller来调用上面使用HttpContextBase重载方法来获取购物车信息。这种做法可以通用将来使用HTTPContext和使用控制器的情况，非常方便。

　　AddToCart方法用于将来添加新项目到购物车中。该方法中做了判断，可以添加重复项目，每次可以多加一个。但没有可以添加指定数量的方式。如果将来在购物车中要添加指定数量时，这里要使用这个类的话，就比较麻烦了，就需要重复调用AddToCart方法，这样每次都要先查出该购买项，然后判断，然后再增1，再保存，依次循环。如果出现意外的话，那么就不好处理了。这里要提供将来在界面中可以添加指定数量的功能的话，就应该再重构一下该方法。

　　RemoveFromCart方法用于在购物车中移除项，同样的每次也只操作一项。如果我要移除这个购物内容话，而当前数量为10的话，岂不是要调用10次这个方法，界面点击10次？我认为这里应该重构一个移除项方法。

　　EmptyCart方法是清空购物车、GetCartItems是获取购物车中的购买项列表，这两个方法都简单，没什么好说的。除此之外还提供了GetCount获取购物车商品数量、GetTotal获取购物车总价、CreateOrder创建订单（将购物车的购买项添加到订单以及订单详细中去）这几个方法。

　　

　　GetCartId获取购物车编号，这里考虑了用户登录与没有登录的情况下处理。登录了就使用用户名作为购物车的标识符，匿名用户的话创建了一个临时的全局唯一标识符来作为购物车标识符。同时还提供了MigrateCart方法用来将匿名用户的购物车迁移到登录用户中去的方法。这个方法非常简单，就是将购物车的标识符修改为用户名作为标识符。