Nine MVP's Blog

07/03/2014

JavaScript ECMAScript 6

Filed under: javascript, W3C — Tags: , — Nine MVP @ 10:37 am

รวบรวมหัวข้อน่าสนใจของ JavaScript ECMAScript 6 ที่กำลังจะมา 

== New Syntax ==

  • Creating Variables with Block Scope
  • Constants
  • Default Parameters
  • Rest and Spread
  • Destructuring
  • The for … of Loop
  • Iterators
  • Generators
  • Comprehensions
  • Syntax Refinements

== Organizational ==

  • Classes
  • Modules

== New stamdard types ==

  • Set
  • Map
  • WeakMap
  • Promises
  • Proxies

เรียนรู้ ES6 เบื้องต้น
https://github.com/lukehoban/es6features

ตรวจสอบ browser ของท่าน ECMAScript 6 compatibility table
http://kangax.github.io/es5-compat-table/es6/

ความก้าวหน้าในการรองรับของแต่ละ browser
FireFox
https://developer.mozilla.org/en/docs/Web/JavaScript/ECMAScript_6_support_in_Mozilla

Advertisements

03/11/2013

ASP.NET MVC Series : Photo Upload Tool (PLUpload, Bootstrap)

Filed under: ASP.NET, ASP.NET MVC, C#, html5, javascript — Tags: , , , , — Nine MVP @ 7:55 pm

ตอนนี้จะเป็นบทความสุุดท้ายที่จะโพสใน wordpress นี้ซึ่งผมจะย้ายไป blog ส่วนตัวซึ่งจะจัดการรายละเอียดต่างๆได้สะดวกกว่านี้

ตอนนี้จะมาแนะนำการสร้างเครื่องมือในการทำ Photo Upload สำหรับ MVC และเช่นเคยไม่เกริ่นมากมาย ก็เข้าเรื่องกันเลย

มาดู library ที่จะใช้งาน

plupload  library ตัวนี้มีดีที่รองรับ multi browser สามารถสลับ engine ไปใช้ html4, html5, flash, siverlight, etc. ตามที่ browser จะรองรับหรือมีติดตั้งไว้ และสามารถทำงานแบบ multiple file selection, file filter (GPLv2 License) ซึ่งใครไม่เข้าใจ plupload ให้อ่านที่นี่ก่อน เพราะผมจะไม่อธิบายการทำงานในบทความนี้
http://www.plupload.com

ตอนนี้จะแนะนำการใช้งานโดยสร้าง UI ขึ้นมาใช้งานเองโดยเพิ่มเติมความสามารถเรื่อง thumbnail, image dimension และตรวจสอบว่า browser รองรับการทำงานของฟังชั่นที่เราเพิ่มเติมเข้าไปหรือไม่

หน้าตาและตัวอย่างการทำงาน

สำหรับ Browser ที่รองรับ HTML5

สำหรับ browser ที่ไม่รองรับ HTML5

ตัวอย่าง code ใน Razor View

10-31-2013 3-02-37 PM

Line 3: เป็นการเรียกใช้ _layout.cshtml ซึ่งจะมี javascript พื้นฐานพวก jquery, css ต่างๆไว้ใช้งาน
Line 9: เรียกใช้ css สำหรับ xPhotoUpload
Line 11-17: ประกาศ tag สำหรับ เรียกใช้ตัว xphotoupload และกำหนดค่าต่าง ๆ ผ่าน data-* property

  • data-multiple-upload = true/ false ต้องการใช้งานโหมด single/multiple upload
  • data-upload-url = action for upload url
  • data-flash-url = กำหนด url path สำหรับ flash engine ของ plupload
  • data-filter-extension =  นามสกุลไฟล์ที่ต้องการมองเห็น
  • data-size-limit = ขนาดของไฟล์ที่อนุญาตให้ upload
  • data-chunk-size = ขนาดชิ้นงานที่จะทำการอัพโหลดต่อครั้ง
  • data-show-console = แสดงคอนโซลการทำงานของ upload tool

โค้ดส่วน Controller

10-31-2013 6-42-22 PM

Line 16-19: เป็นการนำวิว Index.cshtml ส่งกลับไปให้ client เพื่อแสดงผล
Line 22: รับเข้าเป็น HttpPostedFileBase parameter เพื่อง่ายในการเรียกใช้  หรือเปลี่ยนไปอ่านจาก Request.File
Line 25-30: เป็นการสร้าง Upload Directory ตามวันที่
Line 33: สั่งให้บันทึก File ที่ upload มาลงตาม path ดังกล่าว
Line 35: ส่งค่ากลับ

ส่วนของ script/style bundle

11-1-2013 2-24-17 PM

Line 28: kendo core เอาไว้ใช้ทำ template
Line 29: plupload script ใช้เป็น engine สำหรัย upload
Line 30: XPhotoUpload script ที่เราเขียนไว้เพิ่มเติมใช้ในงานนี้
Line 33-35: เป็น css ที่ใช้งานทั้งหมด

โครงสร้างไฟล์ในโปรเจคที่เดโม

ใน Content จะมีสองส่วนคือ plupload folder กับ xphotoupload.css ส่วน bootstrap ถือว่าต้องใช้เป็นพื้นในงานนี้อยู่แล้ว
11-3-2013 4-16-56 PM

ต่อมา Scripts จะมี plupload, kendo.core.min.2013.319.js, XPhotoUpload.js ซึ่งใช้ในการทำงานส่วน javascript
11-3-2013 4-17-15 PM

แนะนำ code ใน XPhotoUpload.js บางบรรทัดที่น่าสนใจ

การเข้าถึง File จาก browser

image
การเข้าถึง file upload โดยใช้ HTML5 API ทุก browser จะมี object สองตัวนี้ให้เรียกใช้งานซึ่งจะมี standard function ในการใช้ทำงานกับ file ได้

หารายละเอียดของรูปที่จะอัพโหลดเพื่อตรวจสอบ dimension

image
Line 98: สร้าง image object ขึ้น
Line 108: เรียกใช้ _URL object โดยให้สร้าง url address ของไฟล์ที่เลือกเขามาใน plupload และส่งให้ img object
Line 99-102: เป็นการผูก function ให้กับ img เพื่อให้ทำงานเมื่อมีการโหลดภาพเข้ามา ซึ่งจะเกิดทันทีที่กำหนดค่าให้ img.src ที่บรรทัด 108

การทำ progress bar

image
เป็น event ที่เกิดขึ้นโดย plupload และแสดงผลโดยใช้ css class ของ bootstrap  โดยการขยายความกว้างไปพร้อมๆ กำหนด % ของไฟล์ที่ plupload ส่งค่ามาให้ใน event นี้

การใช้ Kendo Template ในการทำ html template binding

image
Line 19: table template สำหรับแสดงผลตารางเพื่อสร้างกรอบการทำงานของทูลอัพโหลด
Line 20: table row แบบไม่แสดงผล thumbnail ในกรณีที่ browser ไม่รองรับการทำงานของ HTML5
Line 21: table row แบบแสดงผล thumbnail หาก browser รองรับการทำงาน

ใน table row ทั้งสองแบบจะมี tag ลักษณะ  #= property name # เพื่อบอกให้ kendo มองหา property ของ object นั้นมาแทนค่าลงไปโดยใช้ code ชุดข้างล่างนี้ซึ่งมี 2 แบบ
แบบสั่ง bind โดยไม่มี object
image
และแบบมี object
image

ส่งท้าย

หากเรามีความรู้ในส่วนของ client script อย่าง javascript ให้ลึกพอ เราก็จะสามารถสร้างสรรค์งานขึ้นตามที่เราต้องการได้ ซึ่งก็เป็นเรื่องที่สมควรจะต้องมีสำหรับ web developer ทุกท่าน Smile

สำหรับ project demo สามารถ download ได้ที่ https://bitbucket.org/NineMvp/mvc-upload #Git
สำหรับ zip file https://bitbucket.org/NineMvp/mvc-upload/get/b68e85296709.zip

02/02/2013

ASP.NET MVC Series: High Performance JSON Parser for ASP.NET MVC

Filed under: ASP.NET, ASP.NET MVC, C#, javascript — Nine MVP @ 9:17 pm

กลับมาอีกครั้งกับบทความตอนใหม่ จากที่ผมได้พูดเปรยไว้ในโพสนึงในกลุ่ม ASP.NET & MVC Developers Thailand Group ว่าอย่าทนใช้ Serializer ของเดิมๆ จึงขอขยายความด้วยบทความตอนนี้

ในปัจจุบัน JSON ได้ถูกใช้งานกันอย่างกว้างขวางจากหลาย application ซึ่งเป็นที่นิยมบน HTTP ใช้ในการส่งข้อมูลกันไปมา Request/Response

โดยปกติใครที่เขียน MVC/JQuery บ่อยๆก็มักจะได้ใช้งาน JSON และแม้ว่าปกติก็ทำงานได้อยู่แล้ว #ทำงานได้ไม่ได้หมายความว่าทำได้ดีที่สุด#

ดังนั้นสำหรับตอนนี้เราจะมาแนะนำให้รู้จักเจ้า JavaScriptSerializer Class ที่มีอยุ่ใน .NET Framework และก็ถูกเรียกใช้เยอะหลายจุดเลยทีเดียวใน MVC โดยบทความตอนนี้จะนำ Serializer ที่ดีกว่าจะหาของที่ดีกว่ามาแทนที่ของเดิมโดยทำงานเร็วกว่าหลายเท่าตัว

Performance Issue:

ก่อนอื่นทำความรุ้จักกับ JavaScriptSerializer Class เป็นคลาสที่เอาไว้ช่วยทำการแปลงจาก .NET Object ไปเป็น JSON (Serialization) และใช้แปลง JSON ไปเป็น .NET Object (Deserialization) นั่นเอง

การใช้งานก็เรียกใช้แบบนี้

string jsonIn = "{ \"Name\" : \"Nine\", \"Salary\" : 500.00 }";
var serializer = new System.Web.Script.Serialization.JavaScriptSerializer();

//Call Deserialize to .NET object
Person person = serializer.Deserialize<Person>(jsonIn);

//modify object value
person.Name = "ASP.NET MVC";
person.Salary = 10000;

//Call Serialize to JSON string
string jsonOut = serializer.Serialize(person);

ซึ่งหากไม่คิดอะไรมากก็ใช้งานได้แล้วครับ เพียงแต่อยากให้ดูผลการทดสอบของเว็บไซต์ที่ผมนำมาอ้างอิงกันก่อน J

The results (in milliseconds) as well as the average payload size (for each of the 100K objects serialized) are as follows.

Graphically this is how they look:



ref: http://theburningmonk.com/2012/08/performance-test-json-serializers-part-iii/

จากกราฟด้านบนจะเห็นได้ว่า JavaScripSerializer นั้นทำงานได้ช้ามาก (แต่ JayRock แย่สุด) เมื่อเทียบกับ library อื่นๆแล้ว แต่นี่ก็ยังไม่ใช่ผลการทดสอบของเรา

ผมจึงหยิบเอาตัวที่ใกล้ชิดกับเรามากที่สุดมาทำการทดสอบคือ JavaScriptSerializer, JSON.NET (มีอยู่ใน MVC project) และ ServiceStack.Text (ผลการทดสอบดีที่สุด

และจะนำมาใช้งานในบทความนี้)

JSON.NET : http://json.codeplex.com/

ServiceStack.Text : https://github.com/ServiceStack/ServiceStack.Text

 

TEST CASE:

การทดสอบจะใช้ Stopwatch ในการจับเวลาการทำงานโดย for loop 1,000,000 ครั้ง

โดยทดสอบทั้งการ Serialize และ Deserialize ดังนี้

int times = 1000000;
string output = "";


//JavaScriptSerializer Class
var startMSJson = Stopwatch.StartNew();
var msjs = new System.Web.Script.Serialization.JavaScriptSerializer();
for (int i = 0; i < times; i++)
{
var testObject = new { Name = "Nine" + i.ToString(), Salary = 500.00 };
var temp = msjs.Serialize(testObject);
}
startMSJson.Stop();
output += "Javascript Serializer : " + startMSJson.ElapsedMilliseconds.ToString() + " ms" +
Environment.NewLine;

startMSJson = Stopwatch.StartNew();
for (int i = 0; i < times; i++)
{
var jsonIn = "{ \"Name\" : \"Nine\", \"Salary\" : 500.00 }";
var temp = msjs.Deserialize<Person>(jsonIn);
}
startMSJson.Stop();
output += "Javascript Deserializer : " + startMSJson.ElapsedMilliseconds.ToString() + " ms" +
Environment.NewLine;



//JSON.NET
var startJSONNET = Stopwatch.StartNew();
for (int i = 0; i < times; i++)
{
var testObject = new { Name = "Nine" + i.ToString(), Salary = 500.00 };
var temp = Newtonsoft.Json.JsonConvert.SerializeObject(testObject);
}
startJSONNET.Stop();
output += "JSON.NET Serializer : " + startJSONNET.ElapsedMilliseconds.ToString() + " ms" +
Environment.NewLine;

startJSONNET = Stopwatch.StartNew();
for (int i = 0; i < times; i++)
{
var jsonIn = "{ \"Name\" : \"Nine\", \"Salary\" : 500.00 }";
var temp = Newtonsoft.Json.JsonConvert.DeserializeObject<Person>(jsonIn);
}
startJSONNET.Stop();
output += "JSON.NET Deserializer : " + startJSONNET.ElapsedMilliseconds.ToString() + " ms" +
Environment.NewLine;



//ServiceStack.Text
var startSSTJson = Stopwatch.StartNew();
for (int i = 0; i < times; i++)
{
var testObject = new { Name = "Nine" + i.ToString(), Salary = 500.00 };
var temp = ServiceStack.Text.JsonSerializer.SerializeToString(testObject);
}
startSSTJson.Stop();
output += "ServiceStack.Text Serializer : " + startSSTJson.ElapsedMilliseconds.ToString() + " ms" +
Environment.NewLine;

startSSTJson = Stopwatch.StartNew();
for (int i = 0; i < times; i++)
{
var jsonIn = "{ \"Name\" : \"Nine\", \"Salary\" : 500.00 }";
var temp = ServiceStack.Text.JsonSerializer.DeserializeFromString<Person>(jsonIn);
}
startSSTJson.Stop();
output += "ServiceStack.Text Deserializer : " + startSSTJson.ElapsedMilliseconds.ToString() + " ms" +
Environment.NewLine;

 

Output

  • Javascript Serializer : 11589 ms
  • Javascript Deserializer : 7769 ms
  • JSON.NET Serializer : 3783 ms
  • JSON.NET Deserializer : 6641 ms
  • ServiceStack.Text Serializer : 2069 ms
  • ServiceStack.Text Deserializer : 1211 ms

หลังทดสอบพบว่าผลการทำงานของ JavaScriptSerializer นั้นแย่มากจริงๆ รองลงมา JSON.NET ก็ทำได้ดี แต่ ServiceStack.Text ทำได้ดีที่สุด ซึ่งวัตถุประสงค์หลักของบทความนี้ต้องการจะบอกว่าใน ASP.NET MVC มีการใช้งาน Serializer ตัวที่แย่ที่สุดนั้นเอง

และเราจะนำตัว ServiceStack.Text มาใช้งานทดแทนเจ้า JavaScriptSerializer กัน แต่ว่าถูกใช้งานอยู่ที่ไหนบ้างหละ?

 

Where is JavaScriptSerializer used in ASP.NET MVC?

ต่อไปจะพากันไปหาจุดที่มีการเรียกใช้เจ้า JavaScriptSerializer ซึ่งมีอยู่หลายจุด แต่ขอนำจุดที่สำคัญของระบบจริงๆ มาแก้ไขกันในบทความนี้ ซึ่งจะเน้นไปที่ Input และ Output ซึ่งมีอยู่ 2 จุดคือ

Model Binder (INPUT)

จุดแรก model binder จะทำหน้าที่จับเอา request โดยตรวจดู content type ว่าเป็นชนิด json จากนั้นก็นำค่าไปทำการ deserialize ไปเป็น .net object ตามคลาสที่ประกาศไว้ใน Action นั้นๆ เช่น

public JsonResult NewPerson(Person person)
{
return Json(new Person());
}

จากตัวอย่างด้านบน Person จะเป็นคลาสที่กำหนดไว้ใน NewPerson Action ของ Controller เมื่อมีการ request กลับมาที่ Controller/NewPerson ด้วยการ json post ตัวอย่างด้านล่างนี้

"{ \"Name\" : \"Nine\", \"Salary\" : 500.00 }"

ก่อนที่จะเข้ามาใน NewPerson Action จะมีการสร้าง Person object จากส่งกลับเข้ามาโดยไปเรียก ModelBinder (หากไม่มี custom binder จะไปเรียก DefaultModelBinder มาทำงาน) โดยดักจับ content-type ว่าเป็น request ประเภทใด

ในกรณีนี้ส่งมาเป็น JSON ก็จะไปเรียกตัว JsonValueProviderFactory (ValueProviderFactory เป็น base class) ซึ่งเจ้านี่เองที่มีการใช้งาน JavaScriptSerializer Class ในการแปลง JSON มาเป็น object เพื่อส่งกลับมาใน Action

แกะดู code เจ้า JsonValueProviderFactory กัน

public sealed class JsonValueProviderFactory : ValueProviderFactory 

{

private static void AddToBackingStore(JsonValueProviderFactory.EntryLimitedDictionary backingStore, string prefix, object value){ … }

private static object GetDeserializedObject(ControllerContext controllerContext)

{

if (!controllerContext.HttpContext.Request.ContentType.StartsWith("application/json", StringComparison.OrdinalIgnoreCase))

return (object) null;


string input = new StreamReader(controllerContext.HttpContext.Request.InputStream).ReadToEnd();



if (string.IsNullOrEmpty(input))

return (object) null;


else

return new JavaScriptSerializer().DeserializeObject(input);

}



public override IValueProvider GetValueProvider(ControllerContext controllerContext){ }


private static string MakeArrayKey(string prefix, int index) { }


private static string MakePropertyKey(string prefix, string propertyName) { }


private class EntryLimitedDictionary


{


………

private static int GetMaximumDepth()


{


NameValueCollection appSettings = ConfigurationManager.AppSettings;


if (appSettings != null)


{


string[] values = appSettings.GetValues("aspnet:MaxJsonDeserializerMembers");


int result;

if (values != null && values.Length > 0 && int.TryParse(values[0], out result))


return result;


}


return 1000;


}


}


}

จะพบว่าถูกเรียกใน GetDesirializedObject() (ซึ่งถูก GetValueProvider() เรียกอีกที) นั่นเอง ทีนี้เราจะมาสร้างของเราใช้งานเองครับ J

ผมสร้าง Class ขึ้นใหม่โดย Inherit เจ้า ValueProviderFactory และใช้เจ้า ServiceStack.Text ใน GetValueProvider() ตรงๆแบบนี้ โดยใช้ AsExpandoObject() Extension Method แทนการทำงานอื่นๆของ JsonValueProviderFactory

public sealed class JsonServiceStackValueProviderFactory : ValueProviderFactory
{
public override IValueProvider GetValueProvider(ControllerContext controllerContext)
{
if (controllerContext == null)
throw new ArgumentNullException("controllerContext");

if (!controllerContext.HttpContext.Request.ContentType.StartsWith("application/json", StringComparison.OrdinalIgnoreCase))
return null;

var reader = new StreamReader(controllerContext.HttpContext.Request.InputStream).BaseStream;

return new DictionaryValueProvider<object>(
ServiceStack.Text.JsonSerializer.DeserializeFromStream<Dictionary<string, object>>(reader).AsExpandoObject(),
CultureInfo.CurrentCulture);
}
}

มาดู Extension Method ตัวที่ว่ากันครับ

public static class CollectionExtensions
{
public static ExpandoObject AsExpandoObject(this IDictionary<string, object> dictionary)
{
var epo = new ExpandoObject();
var epoDic = epo as IDictionary<string, object>;

foreach (var item in dictionary)
{
bool processed = false;

if (item.Value is IDictionary<string, object>)
{
epoDic.Add(item.Key, AsExpandoObject((IDictionary<string, object>)item.Value));
processed = true;
}
else if (item.Value is ICollection)
{
var itemList = new List<object>();
foreach (var item2 in (ICollection)item.Value)
if (item2 is IDictionary<string, object>)
itemList.Add(AsExpandoObject((IDictionary<string, object>)item2));
else
itemList.Add(AsExpandoObject(new Dictionary<string, object> { { "Unknown", item2 } }));

if (itemList.Count > 0)
{
epoDic.Add(item.Key, itemList);
processed = true;
}
}

if (!processed)
epoDic.Add(item);
}

return epo;
}
}

การนำไปใช้งานก็ไปที่ Global.asax.cs วางโค้ดลงไปตาม

protected void Application_Start() 
{
AreaRegistration.RegisterAllAreas();
WebApiConfig.Register(GlobalConfiguration.Configuration);
FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
RouteConfig.RegisterRoutes(RouteTable.Routes);
BundleConfig.RegisterBundles(BundleTable.Bundles);
AuthConfig.RegisterAuth();

ValueProviderFactories.Factories.Remove(ValueProviderFactories.Factories.OfType<JsonValueProviderFactory>().FirstOrDefault());
ValueProviderFactories.Factories.Add(new JsonServiceStackValueProviderFactory());


}

การทำงานคือเราจะไป remove เจ้า JsonValueProviderFactory ออกจาก ValueProviderFactories Class และเพิ่ม JsonServiceStackValueProviderFactory อันใหม่ของเราเข้าไป

JsonResult (Output)

จุดที่สองจะเป็นการ render JSON string กลับออกไปยัง Client เรามาดูโค้ดของ JsonResult Class ที่ ASP.NET MVC ใช้อยู่ในปัจจุบัน

public class JsonResult : ActionResult
{

public override void ExecuteResult(ControllerContext context)
{

if (context == null)

throw new ArgumentNullException("context");

if (this.JsonRequestBehavior == JsonRequestBehavior.DenyGet && String.Equals(context.HttpContext.Request.HttpMethod, "GET", StringComparison.OrdinalIgnoreCase))

throw new InvalidOperationException(MvcResources.JsonRequest_GetNotAllowed);

HttpResponseBase response = context.HttpContext.Response;

response.ContentType = string.IsNullOrEmpty(this.ContentType) ? "application/json" : this.ContentType;

if (this.ContentEncoding != null) response.ContentEncoding = this.ContentEncoding;

if (this.Data == null) return;

JavaScriptSerializer scriptSerializer = new JavaScriptSerializer();

if (this.MaxJsonLength.HasValue)


scriptSerializer.MaxJsonLength = this.MaxJsonLength.Value;

if (this.RecursionLimit.HasValue)


scriptSerializer.RecursionLimit = this.RecursionLimit.Value;


response.Write(scriptSerializer.Serialize(this.Data));

}

}

ต่อไปเราจะสร้าง JsonResult ของเราเอง โดยสร้างคลาสใหม่ขึ้นมา แล้ว Inherit เจ้า JsonResult ให้กับคลาส

แล้วก็ทำการ override ExecuteResult() ใหม่ตามนี้


public class JsonServiceStackResult : JsonResult
{

public override void ExecuteResult(ControllerContext context)
{


HttpResponseBase response = context.HttpContext.Response;


response.ContentType = !String.IsNullOrEmpty(ContentType) ? ContentType : "application/json";



if (ContentEncoding != null)
{


response.ContentEncoding = ContentEncoding;


}

if (Data != null)
{


response.Write(ServiceStack.Text.JsonSerializer.SerializeToString(Data));


}


}


}

ตั้งชื่อซะยาวเรียกใช้คงลำบาก งั้นเราก็ไปสร้าง Base Controller ของเราไว้ใช้งานแทนเจ้า return Json(); แบบนี้


public abstract class MyBaseController : Controller
{


protected new JsonResult Json(object data, JsonRequestBehavior behavior)


{ return Json(data, "application/json", Encoding.UTF8, behavior); }


protected new JsonResult Json(object data)
{

return Json(data, "application/json", Encoding.UTF8, JsonRequestBehavior.DenyGet);


}



protected override JsonResult Json(object data, string contentType, Encoding contentEncoding, JsonRequestBehavior behavior)
{

return new JsonServiceStackResult
{

Data = data,


ContentType = contentType,


ContentEncoding = contentEncoding


};


}


}

ตอนจะใช้งานก็แค่นำ MyBaseController ไป inherit แทนที่ Controller Class แล้วค่อยเรียก Json() เหมือนปกติเดิม J

public class HomeController : MyBaseController
{


public JsonResult NewPerson(Person person)
{

return Json(new Person());

}

}

 
 
 

Conclusion

ในบทความนี้หวังว่าจะมีประโยชน์สำหรับผู้ที่ต้องการเพิ่มประสิทธิภาพให้กับตัว MVC App โดยบางท่านอาจจะยังไม่ทราบส่วนนี้ จนกว่าจะต้องทำ Performance tuning กันเพื่อเพิ่มประสิทธิภาพในการทำงานในจุดที่ช้าและทำงานได้ไม่ดี

และจากบทความตอนนี้ท่านสามารถนำสิ่งเหล่านี้ไปใช้งานได้ทั้ง ASP.NET MVC และ ASP.NET WEB API (ตัวนี้เหมาะที่จะเปลี่ยนใหม่เพราะทำงานกับ Data จำนวนมาก)

สำหรับตอนนี้ขอจบไว้เพียงเท่านี้ เจอกันใหม่ตอนหน้าครับ

 


SONY DSC

About Me:

Chalermpon Areepong : Nine (นาย)

Microsoft MVP Thailand ASP.NET

ASP.NET & MVC Developers Thailand Group :http://www.facebook.com/groups/MVCTHAIDEV/

Greatfriends.biz Community Leader : http://greatfriends.biz

Email : nine_biz-talk.net at hotmail dot com

Blog : https://nine69.wordpress.com

24/10/2012

ASP.NET MVC Series : Web Push Technology II.2

Filed under: ASP.NET, ASP.NET MVC, C#, html5, javascript, knockout, WEB, websockets — Tags: , , , , , , , — Nine MVP @ 4:10 pm

จาก ตอนที่ I ผมได้แนะนำการทำงานพื้นฐานของคำสั่งทั้ง javascript และ protocol กันไปแล้ว และเมื่อที่ผ่านมา ตอนที่ II.1 ได้พูดถึงการทำ Push Mail Service ด้วย SSE

สำหรับตอนนี้เราจะมาทดสอบตัว websockets โดยใช้โจทย์เดิมกัน  ซึ่งสำหรับตอนนี้จะเป็นการเปลี่ยนการทำงานจากการใช้ SSE มาเป็น WebSockets Engine ในการสื่อสารกับ Push Mail Service    ซึ่งจะมีการปรับเปลี่ยนทั้ง client javascript  และ Web API Service มาดูกัน

การทำงานและ output จะเหมือนกับโปรเจ็ค SSE ก่อนนี้ทุกอย่าง ดังนั้นผมจะอธิบายเพียงส่วนที่แตกต่างกันครับ

 

แนะนำ MvcPushWS Project

ส่วนทีต้องติดตั้งเพิ่มเติมสำหรับ MvcPushWS Project ก็คือ

Microsoft.WebSockets โดยหาได้จาก nuget windows ตามภาพด้านล่าง

image

 

สำหรับ Flow โปรแกรมมีจำนวน step มี 9 จุดที่น่าสนใจ

ลำดับที่ 0.-3. ผมจะข้ามไปโดยหากสนใจจะอ่านให้กลับไปดู ตอนที่ II.1 ครับ

image

 

4. เมื่อ user มี email รีเทิร์นค่ากลับมาก็ให้ทำการ connect to Push Service

ใน javascript function InitialWS(); จะเป็นการสร้างและกำหนดค่าการทำงานของ WebSockets  ให้ชี้ไปยัง EmailServiceController (WebAPI) ซึ่งเป็น push service ที่เราสร้างขึ้นมาสำหรับส่ง email ใหม่ที่ส่งเข้ามาจากผู้ใช้อื่นๆ โดยจะมีการ add event ไว้ 1 คือ onmessage

   1: //WS Setup

   2:     function InitialWS() {

   3:         if ("WebSocket" in window) {

   4:             var uri = 'ws://' + window.location.host + '/api/EmailService/?email=' + viewModel.email();

   5:             socket = new WebSocket(uri);

   6:             socket.onmessage = function(e) {

   7:                 console.log(e.data); // log 

   8:                 var mails = JSON.parse(e.data);

   9:                 //alert from email

  10:                 showNewMessageAlert(mails[0].From);

  11:                 //binding array object to viewmodel(template binding)

  12:                 viewModel.messages.valueWillMutate();

  13:                 ko.utils.arrayPushAll(viewModel.messages(), mails);

  14:                 viewModel.messages.valueHasMutated();

  15:                 //sort inbox item

  16:                 SortMessageDesc();

  17:             };

  18:         } else {

  19:             // the browser doesn't support WebSockets

  20:             alert("WebSockets NOT supported here!\r\n\r\nBrowser: " + navigator.userAgent + "\r\n\r\n");

  21:         }

  22:     }

  1. line3: ทำการตรวจสอบว่า user browser รองรับการทำงานของ websockets หรือไม่
  2. line4: สร้าง url ปลายทางไปยัง push mail service และส่ง email pameter ไปด้วย
  3. line5: สร้างตัวแปร WebSocket และส่ง url ให้เพื่อทำการติดต่อกับ service
  4. line6-8: ทำการกำหนดการทำงานให้กับ onmessage event โดยให้เอาข้อมูลที่ส่งมาจากทางฝั่ง service ทำการ log และแปลงค่าเป็น json object
  5. line10-16: ทำการแสดงผล popup, โยนเข้า knockout model แล้วจัดลำดับ email ใน inbox ให้ DESC ReceivedDate

เมื่อมีการทำการ new WebSocket(url) ตรงนี้จะทำงานทันที โดยติดต่อไปยัง EmailServiceController.Get() Action โดยมี request header หน้าตาแบบนี้

           WebSockets Request Header

image

มีพารามิเตอร์ที่เกี่ยวข้องกับ websocket ดังนี้

  • Upgrade: websocket
  • Connection: xxx, Upgrade

เป็นค่าเพื่อบอก push email service ว่านี่เป็นการติดต่อมาจาก websocket  ให้ทำการสลับการทำงานจาก HTTP Protocol ไปเป็น WebSocket Protocol

  • Sec-WebSocket-Key: kmDqIkNBFU0iWMWb5fNiPQ==

จะอยู่ในรูปของ base64 encode  ทาง push email service จะเอาค่านี้ไปใช้งานเพื่อสร้าง handshake สำหรับคุยกันระหว่าง websocket client/server

ส่วนของ origin url จะถูกสร้างโดย browser

  • Sec-WebSocket-Version: 13

เป็นการบอก websocket client ว่าทางฝั่ง Client Browser นั้นใช้ protocol version ไหน ซึ่ง version 13 นั้นเป็น final spec ที่ทาง IEFT กำหนดให้เป็น standard

 

5. Create PushEmailHandler for new subscriber (EmailServiceController)

เมื่อ websocket มีการทำ connect มาที่ EmailService มีการสั่งยิงมาด้วย GET (WebSocket ทำงานโดยใช้ GET) มาเข้า HttpGet Action ซึ่งมีอยู่ตัวเดียวใน EmailServiceController ก็คือ

Get(HttpRequestMessage request)  ซึ่งจะมีการสร้าง WebSocketHandler class (มีใน Microsoft.Websockets จาก Nuget) ขี้นใหม่สำหรับ PushMailWSHandler เอาไว้ช่วยจัดการกับ ws request

   1: public class EmailServiceController : ApiController

   2: {

   3:     //Get

   4:     public HttpResponseMessage Get(HttpRequestMessage request)

   5:     {

   6:         //accept only websockets request

   7:         if (!HttpContext.Current.IsWebSocketRequest)

   8:             return request.CreateErrorResponse(HttpStatusCode.Forbidden, "the service support only websocket client");

   9:  

  10:         //get user's email

  11:         var email = request.QueryString("email");

  12:  

  13:         //user's email is required parameter

  14:         if (string.IsNullOrEmpty(email.Trim()))

  15:             return request.CreateErrorResponse(HttpStatusCode.BadRequest, "the service required users email parameter.");

  16:  

  17:         //register websockets handler to context

  18:         HttpContext.Current.AcceptWebSocketRequest(new PushMailWSHandler(email));

  19:         return Request.CreateResponse(HttpStatusCode.SwitchingProtocols);

  20:     }

  21: }

  1. line7-8: ตรวจสอบว่าเป็นการส่งค่าสั่งมาจาก websocket หรือไม่ถ้าไม่ก็ส่ง error response แบบ forbidden พร้อม error message กลับไป
  2. line11: อ่าน email parameter มาจาก QueryString
  3. line14-15: หากไม่พบ email parameter ก็ส่ง error response แบบ badrequest พร้อม error message กลับไป
  4. line18-19: กำหนดให้ HttpContext ทำการรับ websocket handler ตัวใหม่สำหรับ pushmail ที่สร้างไว้ (เล่าตอนหลัง) และสร้าง response ตาม handler ที่เพิ่งกำหนดเข้าไปใหม่ ก็คือ switch to websocket protocol

  อธิบายตัว PushMailHandler class

ได้ทำการสืบทอดจาก WebSocketHandler Class ที่มีมากับ Microsoft.WebSockets โดยเมื่อมีการเรียก constructor ให้ทำงานโดย remove old pushmail handler ตัวเก่าออกไปก่อน แล้วค่อย add ตัวใหม่ที่เพิ่งสร้างเข้าไป (ทำตามแนวคิด *มาทีหลังดังกว่า)

   1: using MvcPushWS.Models;

   2: using Newtonsoft.Json;

   3: using Microsoft.Web.WebSockets;

   4:  

   5: namespace MvcPushWS.Controllers

   6: {

   7:     public class PushMailWSHandler : WebSocketHandler

   8:     {

   9:         //EFcontext

  10:         private MailBoxDBContext mbctx = new MailBoxDBContext();

  11:         //message pool

  12:         private static List<MailMessageView> _newMails = new List<MailMessageView>();

  13:         //subscriber pools

  14:         private static ConcurrentDictionary<string, SubscriberPushMail> _subscribers = 

  15:             new ConcurrentDictionary<string, SubscriberPushMail>();

  16:  

  17:         //constructor

  18:         public PushMailWSHandler(string email)

  19:         {

  20:             // add subscriber to pool

  21:             if (!string.IsNullOrEmpty(email.Trim()))

  22:             {

  23:                 if (_subscribers.ContainsKey(email))

  24:                 {

  25:                     SubscriberPushMail dead;

  26:                     if (_subscribers.TryRemove(email, out dead))

  27:                     {

  28:                         dead.client.Close();

  29:                         dead = null;

  30:                     }

  31:                 }

  32:                 _subscribers.TryAdd(email, new SubscriberPushMail

  33:                 {

  34:                     Email = email,

  35:                     client = this

  36:                 });

  37:  

  38:             }

  39:         }

  40:  

  41: ...............

*ไม่ขออธิบาย code เพราะการทำงานจะคล้ายกับตอนที่แล้ว

 

6. เมื่อตอบกลับการทำงานไปยัง WebSocket Client

ตัว WebSocketHandler จะเพิ่มตัวแปะลงใน Response Header เพื่อตอบกลับการทำงานไปยัง client

          WebSocket Response Header

image

  • Upgrade: Websocket
  • Connection: Upgrade
  • Sec-WebSocket-Accept: teTd3/I5X/xGOf2RHcLCvf49Jb4=

เมื่อมี response ตอบกลับมาตัว HTTP Code เราจะมองเห็นเป็น 101 Switching Protocols โดยการทำงานต่อจากนี้เราจะไม่สามารถดูได้จาก browser dev tool อีกเนื่องจากทำงานจะมีการส่งข้อมูลกันเป็น frame ไปมาตามรูปด้านล่างนี้

image

image

 

 

7. เมื่อ User2 ทำการส่งอีเมลไปหา User1

ต่อไปเมื่อมี user2 เปิด browser เข้ามา load mailbox ของตัวเอง และทำการส่งอีเมลถึง user1 หลังจากกดปุ่ม Send จะเข้ามาทำงานใน click ของ jquery ที่เราได้ hook event เอาไว้

โดยใช้ตัว websocket object โดยให้ส่ง viewModel.newEmail ไปด้วยในรูปแบบของ json string และให้ทำการล้างค่าของ newEmail หลังจากทำงานเสร็จแล้ว

   1: $(document).ready(function () {

   2:     

   3:     //binding mapping to viewModel

   4:     ko.applyBindings(viewModel);

   5:  

   6:     $("#sendMail").click(function () {

   7:         

   8:         if (socket.readyState != WebSocket.OPEN)

   9:             return;

  10:  

  11:         var data = JSON.stringify(ko.mapping.toJS(viewModel.newEmail));

  12:  

  13:         //use websocket send json string to pushmail service

  14:         socket.send(data);

  15:        

  16:         //clear value

  17:         viewModel.newEmail.To('');

  18:         viewModel.newEmail.Title('');

  19:         viewModel.newEmail.Message('');

  20:     });

  21:  

  22: });

  1. line14: เป็นการใช้ websocket ส่งข้อมูลกลับไปที่ push mail service ของเรา

หลังจากที่ websocket client ได้ส่ง json string เข้ามาจะไปทำงานที่ PushMailHandler ตัวที่เราได้เก็บเอาไว้ก่อนหน้านี้ โดยจะเกิด Event OnMessage(string data) ขึ้น

   1: public class PushMailWSHandler : WebSocketHandler

   2: {

   3:     .........................

   4:     .....................

   5:  

   6:     //User send a email message to service

   7:     public override void OnMessage(string message)

   8:     {

   9:         var dtomail = JsonConvert.DeserializeObject<MailMessageView>(message);

  10:         try

  11:         {

  12:             var user = mbctx.Users.SingleOrDefault(o => o.UserName == dtomail.Username);

  13:             if (user == null)

  14:                 this.Send(JsonConvert.SerializeObject(new {success = false, msg = "not found user"}));

  15:  

  16:             var dt = DateTime.Now;

  17:  

  18:             dtomail.ReceivedDate = dt.ToString("dd/MM/yyyy HH:mm:ss");

  19:             var mail = new MailMessage

  20:             {

  21:                 Id = dtomail.Id = Guid.NewGuid(),

  22:                 From = dtomail.From,

  23:                 To = dtomail.To,

  24:                 Title = dtomail.Title,

  25:                 Message = dtomail.Message,

  26:                 IsRead = false,

  27:                 ReceivedDate = dt,

  28:                 User_Id = user.Id

  29:             };

  30:             mbctx.MailMessages.Add(mail);

  31:             mbctx.SaveChanges();

  32:             //add alert email if the target subscriber is online

  33:             if (_subscribers.ContainsKey(mail.To))

  34:             {

  35:                 _newMails.Add(dtomail);

  36:                 //push email to subscriber

  37:                 PushMessageToClient(mail.To);

  38:             }

  39:         }

  40:         catch (Exception ex)

  41:         {

  42:             //this.Send(JsonConvert.SerializeObject(new { success = false, msg = ex.Message }));

  43:         }

  44:  

  45:     }

  46:  

  47:     //push email to target subscriber

  48:     private void PushMessageToClient(string toEmail)

  49:     {

  50:         var subscribers = _subscribers.Where(o => o.Key.ToLower() == toEmail.ToLower().Trim());

  51:         foreach (var subscriber in subscribers)

  52:         {

  53:             var mails = _newMails.Where(o => o.To.ToLower().Trim() == toEmail.Trim().ToLower()).ToList();

  54:             if (mails.Count > 0)

  55:             {

  56:                 subscriber.Value.client.Send(JsonConvert.SerializeObject(mails));

  57:                 _newMails.RemoveAll(o => o.To == toEmail);

  58:             }

  59:         }

  60:  

  61:  

  62:     }

  63: }

  1. line7: คือ method ที่เราได้ override ไว้เมื่อมี client ได้ส่งข้อมูลกลับมาที่ service
  2. line9-31: ทำการ convert json string กลับมาเป็น object เพื่อใช้บันทึกลง database
  3. line37: เรียก pushmessagetoClient ไปยัง client ตามอีเมลที่ส่งเข้ามา
  4. line56: เมื่อหา client ปลายทางเจอแล้วก็เรียกใช้ PushMailWSHandler ที่เราเก็บไว้ตอนแรกใน flow ที่ 5.  ทำการเรียก Send(json string); ส่งไป

 

ถ้าอยากเขียน WebSocket Server เองไม่ต้องการใช้ Microsoft.WebSocket ?

ก็เขียนแบบ TCP Server ปกติได้เลยครับ เพียงแต่ตอน response กลับก็เขียน header กลับไปให้ครบตามนี้

   1: var listener = new TcpListener(IPAddress.Loopback, 8181);

   2: listener.Start();

   3: using (var client = listener.AcceptTcpClient())

   4: using (var stream = client.GetStream())

   5: using (var reader = new StreamReader(stream))

   6: using (var writer = new StreamWriter(stream))

   7: {

   8:     writer.WriteLine("HTTP/1.1 101 Web Socket Protocol Handshake");

   9:     writer.WriteLine("Upgrade: WebSocket");

  10:     writer.WriteLine("Connection: Upgrade");

  11:     writer.WriteLine("WebSocket-Origin: http://localhost:8080");

  12:     writer.WriteLine("WebSocket-Location: ws://localhost:8181/websession");

  13:     writer.WriteLine("");

  14: }

  15: listener.Stop();

 

ทิ้งท้ายก่อนจบ

สำหรับตอนนี้เป็นการทดสอบการใช้งานตัว WebSocket และ WebSocket Server ขึ้นใช้งานเอง เพื่อสร้างความเข้าใจในการทำงาน  แต่ตัวอย่างข้างต้นที่ได้หยิบยกมายังไม่เหมาะจะนำไปใช้งานจริง ดังนั้นอาจจะต้องแก้ไขและปรับแต่งหรืออาจจะไปมองหา WebSocket Server ที่มีอยู่มากมายตอนนี้ ซึ่งน่าสนใจอยู่หลายตัวครับ SuperWebSocket.Net, XSockets.NET หรืออีกมากมายที่ http://en.wikipedia.org/wiki/Comparison_of_WebSocket_implementations 

ปล. ก่อนจะเอาโปรเจ็ค demo ไปรันทดสอบรบกวนตรวจสอบ browser ของคูณกันก่อนนะครับ Smile  http://websocketstest.com/

image

 

Download Demo Project

*มี database script อยู่ใน project folder เอาไปสร้าง database และอย่าลืมเปลี่ยน connectionstring ใหม่


SONY DSC

About Me:

Chalermpon Areepong : Nine (นาย)

Microsoft MVP Thailand ASP.NET

ASP.NET & MVC Developers Thailand Group :http://www.facebook.com/groups/MVCTHAIDEV/

Greatfriends.biz Community Leader : http://greatfriends.biz

Email : nine_biz-talk.net at hotmail dot com

Blog : https://nine69.wordpress.com

Create a free website or blog at WordPress.com.