YbSoftwareFactory 代碼生成插件【九】：基於JQuery、WebApi的ASP.NET MVC插件的代碼生成項目主要技術解析

    YbSoftwareFactory目前已可快速生成ASP.NET  WebForm、MVC、WinForm和WPF的解決方案源代碼，所生成的源代碼可直接在VS中打開並運行。終端用戶還可自行二次開發自己所需的插件。本章將對ASP.NET MVC代碼生成插件所生成項目的主要特點和技術進行解析，其Demo地址：http://mvcdemo.yellbuy.com/。

主要技術特點：

一、數據字典的排序

    有童鞋問到數據字典的排序是如何實現的，其實數據字典的排序比較簡單。首先，需要定義一個排序字段，並根據這個字段升序排列。如果要優先顯示某個字典項，則需減小該排序字段的值。如果該排序字段再首位，則無需操作，第二位，則為第一位的排序值小1000，其他設置為前面兩項的值的平均數。反之亦然～

    在所生成的解決方案中，使用了通用的Api組件，你只需配置好主代碼即可。

二、數據分頁和動態查詢

    現在很多童鞋使用Linq查詢，確實是非常方便，並且是強類型的，這樣編寫代碼也不容易出錯；但最大的缺點就是靈活性差，例如無法把查詢語法寫到一個統一的基類中。在本解決方案中，設計比較巧妙之處就是把過濾查詢的實現寫到了一個泛型基類中，僅需在具體實現類中定義查詢的方式字符串即可，代碼不僅更加簡潔，而且修改、維護也更加方便。使用動態Linq技術可以在泛型基類中統一以如下的方式進行數據查詢、分頁和排序，而無需在具體類中總是寫重復的代碼：

/// <summary>
        /// 分頁查詢
        /// </summary>
        /// <param name="filter">查詢條件</param>
        /// <param name="page">頁號</param>
        /// <param name="rows">記錄數</param>
        /// <param name="sort">排序字段名稱</param>
        /// <param name="order">排序方式</param>
        /// <returns></returns>
        public ResponseResult<M> Get(string filter, int page, int rows, string sort, string order)
        {

            var table = Table;
            if (!string.IsNullOrWhiteSpace(filter))
            {
                var str = GetFilterFormat();
                //有過濾條件，進行過濾查詢
                if (!string.IsNullOrWhiteSpace(str))
                    table = table.Where(str, filter);
            }
            var total = table.LongCount();
            table = table.OrderBy(string.Format("{0} {1}", sort, order)).Skip((page - 1) * rows).Take(rows);
            var items = table.ToList();
            var models = InjectFrom(items);
            return new ResponseResult<M>(total, models);
        }

    如果感興趣，可以在前一章中下載DynamicLinq的實現源碼。

三、授權和身份認證

    授權和驗證關系到系統的安全，普通的授權驗證方式無法實現本系統所要求的靈活性以及細粒度的權限控制，因此需對授權方式進行擴展，這主要需從AuthorizeAttribute繼承，本解決方案中新增了一個PermissionKey屬性，更據所設置的PermissionKey名稱進行相應的授權處理，通過添加“EveryOne”角色名甚至能設置匿名用戶的操作權限，不可謂不靈活。主要代碼如下：

public class YbApiAuthorizeAttribute : System.Web.Http.AuthorizeAttribute
    {
        private const string BasicAuthResponseHeader = "WWW-Authenticate";
        private const string BasicAuthResponseHeaderValue = "Basic";
        public string PermissionKey { get; set; }
        public override void OnAuthorization(HttpActionContext actionContext)
        {
            if (actionContext == null)
                throw new ArgumentNullException("actionContext");
            if (AuthorizationDisabled(actionContext) || AuthorizeRequest(actionContext.ControllerContext.Request))
                return;
            this.HandleUnauthorizedRequest(actionContext);
        }

        protected override void HandleUnauthorizedRequest(HttpActionContext actionContext)
        {
            if (actionContext == null)
                throw new ArgumentNullException("actionContext");
            actionContext.Response = CreateUnauthorizedResponse(actionContext.ControllerContext.Request);
        }

        private HttpResponseMessage CreateUnauthorizedResponse(HttpRequestMessage request)
        {
            var result = new HttpResponseMessage()
                {
                    StatusCode = HttpStatusCode.Unauthorized,
                    RequestMessage = request
                };
            //we need to include WWW-Authenticate header in our response,        
            //so our client knows we are using HTTP authentication        
            result.Headers.Add(BasicAuthResponseHeader, BasicAuthResponseHeaderValue);
            return result;
        }

        private static bool AuthorizationDisabled(HttpActionContext actionContext)
        {
            //support new AllowAnonymousAttribute        
            if (!actionContext.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute>().Any())
                return actionContext.ControllerContext.ControllerDescriptor.GetCustomAttributes<AllowAnonymousAttribute>().Any();
            return true;
        }

        private bool AuthorizeRequest(HttpRequestMessage request)
        {
            //匿名用戶的權限驗證
            if (!HttpContext.Current.User.Identity.IsAuthenticated)
            {
                var permissionsOfEveryOne = Permissions.GetPermissionsInRole("EveryOne");
                return CheckPermission(request, permissionsOfEveryOne);
            }
            //未設置權限Key，則任何用戶均可訪問
            if (string.IsNullOrWhiteSpace(PermissionKey)) return true;

            //登錄用戶的權限驗證
            var allowPermissions = Permissions.GetPermissionsForUser();
            return CheckPermission(request, allowPermissions);
        }

        private bool CheckPermission(HttpRequestMessage request, Permission[] permissionsOfEveryOne)
        {
            if (permissionsOfEveryOne == null || permissionsOfEveryOne.Length == 0)
                return false;
            var permissionKeys = permissionsOfEveryOne.Select(c => c.PermissionKey);
            if (request.Method.Method.Equals("GET", StringComparison.OrdinalIgnoreCase))
                return permissionKeys.Contains(PermissionKey.ToLower());
            if (request.Method.Method.Equals("PUT", StringComparison.OrdinalIgnoreCase))
                return permissionKeys.Contains(string.Format("{0}.add", PermissionKey.ToLower()));
            if (request.Method.Method.Equals("POST", StringComparison.OrdinalIgnoreCase))
                return permissionKeys.Contains(string.Format("{0}.edit", PermissionKey.ToLower()));
            if (request.Method.Method.Equals("DELETE", StringComparison.OrdinalIgnoreCase))
                return permissionKeys.Contains(string.Format("{0}.delete", PermissionKey.ToLower()));
            return false;
        }

        protected string[] RolesSplit
        {
            get { return SplitStrings(Roles); }
        }

        protected string[] UsersSplit
        {
            get { return SplitStrings(Users); }
        }

        protected static string[] SplitStrings(string input)
        {
            if (string.IsNullOrWhiteSpace(input)) return new string[0];
            var result = input.Split(',').Where(s => !String.IsNullOrWhiteSpace(s.Trim()));
            return result.Select(s => s.Trim()).ToArray();
        }

       /// <summary>
        /// Implement to include authentication logic and create IPrincipal    
       /// </summary>
        protected bool TryCreatePrincipal(string user, string password, out IPrincipal principal)
        {
            principal = null;
            if (!Membership.ValidateUser(user, password))
                return false;
            string[] roles = System.Web.Security.Roles.Provider.GetRolesForUser(user);
            principal = new GenericPrincipal(new GenericIdentity(user), roles);
            return true;
        }
    }

     當然，你也需要在具體的Controller上添加相應的Attribute標記，例如：[YbApiAuthorize(PermissionKey = "Categories")]

四、實體對象的驗證

    實體對象的驗證使用Fluent Validator組件進行驗證，YbSoftWareFactory自動生成基本的客戶端和服務器端的驗證代碼（如非空檢查，字符串長度檢查等），所生成的服務器端的驗證代碼示例如下：

public class CustomersValidator : AbstractValidator<Customers>
    {
        public CustomersValidator()
        {
            //此處添加驗證邏輯
            RuleFor(x => x.CustomerID).NotEmpty().WithMessage("必須輸入標識");
            RuleFor(x => x.CompanyName).NotEmpty().WithMessage("必須輸入公司名");
            RuleFor(x => x.ContactName).Length(30).WithMessage("聯系人最多只能輸入30個字符");
            RuleFor(x => x.ContactTitle).Length(30).WithMessage("職務最多只能輸入30個字符");
            RuleFor(x => x.Address).Length(60).WithMessage("地址最多只能輸入60個字符");
            RuleFor(x => x.City).Length(15).WithMessage("市最多只能輸入15個字符");
            RuleFor(x => x.Region).Length(15).WithMessage("省/自治區最多只能輸入15個字符");
            RuleFor(x => x.PostalCode).Length(10).WithMessage("郵編最多只能輸入10個字符");
            RuleFor(x => x.Country).Length(15).WithMessage("國家最多只能輸入15個字符");
            RuleFor(x => x.Phone).Length(24).WithMessage("電話最多只能輸入24個字符");
            RuleFor(x => x.Fax).Length(24).WithMessage("傳真最多只能輸入24個字符");
        }
    }

五、日志

    為方便調試和錯誤診斷，系統集成long4net日志組件，所有異常信息均輸出至相應的日志文件中。

有童鞋問YbSoftwareFactory怎么使用，好用不？（見過很多人是一根筋，自己把自己搞得太累～）其實使用YbSoftwareFactory生成ASP.NET MVC項目的源代碼超級簡單，僅需三步：

    第一步：運行YbSoftwareFactory並連接數據庫

    第二步：編輯元數據信息，以便生成的界面更加友好

    第三步：點擊“解決方案”按鈕生成源代碼

    短暫的等待后，在VS中打開所生成的源碼解決方案，然后就是運行它....

注：本插件已正式發布，需要插件和代碼的請和我聯系。