Asp.NetCore之組件寫法

本章內容和大家分享的是Asp.NetCore組件寫法，在netcore中很多東西都以提供組件的方式來使用，比如MVC架構，Session，Cache，數據庫引用等； 這里我也通過調用驗證碼接口來自定義個組件以此說明如何使用，以及使用時需要注意的場景；

Middleware之hello world

對於netcore來說，通常會在UseStartup<Startup>對應的Startup類中引用組件，這個Startup可以換成自己自定義的其實類，不過需要在UseStartup的時候指向她；這里還是以Startup類為例，通過vs自動生成的文件，在這個類中我們能看到Configure方法體里面包含了：app.UseMvc(),app.UseStaticFiles(),app.xxx()等一些列自帶的組件，下面來看下自定義個hello world中組件實例，首先使用靜態擴展方法擴展IApplicationBuilder：

 public static class MiddlewareExtends
    {
        /// <summary>
        /// 測試用例中間件
        /// </summary>
        /// <param name="builder"></param>
        /// <returns></returns>
        public static IApplicationBuilder UseTest(this IApplicationBuilder builder)
        {
            return builder.UseMiddleware<TestMiddleware>();
        }

    }

使用 builder.UseMiddleware<TestMiddleware>() 來添加自定義組件，組件實現代碼如下：

    public class TestMiddleware
    {
        private RequestDelegate _requestDelegate;
        public TestMiddleware(RequestDelegate requestDelegate)
        {
            _requestDelegate = requestDelegate;
        }

        public Task Invoke(HttpContext context)
        {

            context.Items["TestMiddleware"] = "hello world，我是TestMiddleware。";

            return _requestDelegate(context);
        }
    }

以上是最基礎的組件格式；注：

1. 組件必須要有 public Task Invoke(HttpContext context) ，HttpContext是咋們http上下文，Invoke()委托方法，每次程序被訪問時就會進入Invoke；

2. 要有 public delegate Task RequestDelegate(HttpContext context); 委托方法，來響應http請求；

到這里咋們hello world就完成了，為了測試方法，我們直接在action中寫入如下代碼：

 public IActionResult About()
        {

            ViewData["Message"] = HttpContext.Items["TestMiddleware"];
            return View();
        }

運行結果：

 

組件異步寫法

 public class TestMiddleware
    {
        private RequestDelegate _requestDelegate;
        public TestMiddleware(RequestDelegate requestDelegate)
        {
            _requestDelegate = requestDelegate;
        }

        public async Task Invoke(HttpContext context)
        {

            context.Items["TestMiddleware"] = "hello world，我是asyncTestMiddleware。";

            await _requestDelegate(context);
        }
    }

僅僅需要async 和 await 組合修飾就行了；

 

.netcore自定義驗證碼組件

 /// <summary>
    /// 文字驗證碼
    /// </summary>
    public class WenZiCodeMiddleware
    {
        private RequestDelegate _requestDelegate;
        public WenZiCodeMiddleware(RequestDelegate requestDelegate)
        {
            _requestDelegate = requestDelegate;
        }

        public async Task Invoke(HttpContext context)
        {

            var url = "http://localhost:1001/shenniuapi/WenZiValidateCode";
            using (HttpClient client = new HttpClient())
            {
                client.Timeout = TimeSpan.FromSeconds(60);

                var str = "{\"UserName\": \"神牛步行3\",\"UserPwd\": \"4297f44b13955235245b2497399d7a93\",\"Token\": \"008我是測試\"}";
                var content = new StringContent(str, Encoding.UTF8, "application/x-www-form-urlencoded");
                content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
                var result01 = client.PostAsync(url, content).Result;
                var stream = await result01.Content.ReadAsStreamAsync();
                using (var reader = new StreamReader(stream))
                {
                    var result02 = await reader.ReadToEndAsync();
                    context.Items["codedata"] = result02;
                }
            }

            await _requestDelegate(context);
        }
    }

我們同樣需要再靜態擴展方法里面添加如下代碼，來加入組件：

/// <summary>
        /// 文字驗證碼中間件
        /// </summary>
        /// <param name="builder"></param>
        /// <returns></returns>
        public static IApplicationBuilder UseWenZiValidateCode(this IApplicationBuilder builder)
        {
            return builder.UseMiddleware<WenZiCodeMiddleware>();
        }

在Configure方法中，引用組件： app.UseWenZiValidateCode(); ;Action中，使用組件：

 public FileResult GetCode()
        {
            var data = HttpContext.Items["codedata"].ToString();
            var code = JsonConvert.DeserializeObject<MoValidateCodeResponse>(data);
            return File(code.CodeStream, "image/jpeg");
        }

View試圖中代碼：

GetCode：<img src="/home/GetCode" data-src="/home/GetCode" />

效果展示：

這里需要考慮場景是，我們上面提及到的Invoke方法是任意請求都會進入，那驗證碼這種功能做成組件是否不是很合理，因為驗證碼也只有在登陸界面或驗證的界面需要用到而已，如我們上面寫的驗證碼組件，每次都會被程序執行這顯然不合理，因此個人認為如果你需要自定義組件，那么需要考量：是否每次請求都需要進入您的組件服務，如果不需要的話，那其實沒必要弄一個組件，當然感覺很高大上；因此這里我不得不使用靜態擴展方法(當然還有其他方式)來重寫獲取驗證碼的方法；

 

靜態擴展方法重寫驗證碼組件

由於上面我們在添加組件時有一個靜態類了，那么我們直接在上面補充擴展方法：

/// <summary>
        /// 文字驗證碼
        /// </summary>
        /// <param name="context"></param>
        /// <returns></returns>
        public static async Task<MoValidateCodeResponse> WenZiCode(this HttpContext context)
        {
            var code = default(MoValidateCodeResponse);
            try
            {
                var url = "http://localhost:1001/shenniuapi/WenZiValidateCode";
                using (HttpClient client = new HttpClient())
                {
                    client.Timeout = TimeSpan.FromSeconds(60);

                    var str = "{\"UserName\": \"神牛步行3\",\"UserPwd\": \"4297f44b13955235245b2497399d7a93\",\"Token\": \"008我是測試\"}";
                    var content = new StringContent(str, Encoding.UTF8, "application/x-www-form-urlencoded");
                    content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
                    var result01 = client.PostAsync(url, content).Result;
                    var stream = await result01.Content.ReadAsStreamAsync();
                    using (var reader = new StreamReader(stream))
                    {
                        var result02 = await reader.ReadToEndAsync();
                        code = await JsonConvert.DeserializeObjectAsync<MoValidateCodeResponse>(result02);
                    }
                }
            }
            catch (Exception ex)
            {
            }
            return code;
        }

對應的驗證碼實體類：

 /// <summary>
    /// 神牛接口返回基類
    /// </summary>
    public class MoShenNiuBaseResponse
    {
        /// <summary>
        /// 返回狀態： 0：失敗 1：成功
        /// </summary>
        public int Status { get; set; }

        /// <summary>
        /// 錯誤信息
        /// </summary>
        public string Msg { get; set; }
    }

    /// <summary>
    /// 驗證碼返回類
    /// </summary>
    public class MoValidateCodeResponse : MoShenNiuBaseResponse
    {

        public MoValidateCodeResponse()
        {
            this.ImgCode = new List<MoImgCode>();
        }

        /// <summary>
        /// 驗證碼類型
        /// </summary>
        public string Code { get; set; }

        /// <summary>
        /// 驗證碼圖片流
        /// </summary>
        public byte[] CodeStream { get; set; }

        /// <summary>
        /// 圖片驗證坐標
        /// </summary>
        public List<MoImgCode> ImgCode;
    }

    /// <summary>
    /// 圖片驗證碼坐標
    /// </summary>
    public class MoImgCode
    {
        public string Index { get; set; }

        public string IndexType { get; set; }

        public string ImgUrl { get; set; }

        public Point Point_A { get; set; }

        public Point Point_B { get; set; }

        public bool IsChoice { get; set; }
    }

    public class Point
    {
        public int X { get; set; }
        public int Y { get; set; }
    }

這個時候同樣來到Action中：

 public async Task<FileResult> GetCodeAsync()
        {
            var code = await HttpContext.WenZiCode();

            return File(code.CodeStream, "image/jpeg");
        }

修改view試圖代碼，增加點擊驗證碼圖片重新獲取新的驗證碼：

<style type="text/css">
    img{cursor:pointer}
</style>
<h3>@ViewData["Message"]</h3>
<h3>@ViewData["codedata"]</h3>
GetCode：<img src="/home/GetCode" data-src="/home/GetCode" />
GetCodeAsync：<img src="/home/GetCodeAsync" data-src="/home/GetCodeAsync" />

<script src="~/lib/jquery/dist/jquery.js"></script>
<script>
    $(function () {
        $("img").on("click", function () {
            var img = this;
            var nowTime = new Date().getTime();
            var src = $(img).attr("data-src") + "?t=" + nowTime;
            $(img).attr("src", src);
        });
    })
</script>

效果圖：

以上就是本篇的所有內容，旨在分享怎么寫一個組件和什么時候用組件合適，謝謝大家支持和點贊。