开包即食的教程带你浅尝最新开源的C# Web引擎Blazor

在今年年初，恰逢新春佳节临近的时候。微软给全球的C#开发者们，着实的送上了一分惊喜。微软正式开源Blazor，将.NET带回到浏览器。
这个小惊喜，迅速的在dotnet开发者中间传开了。2018年3月22日Blazor发布了它的第一次Release Blazor到底是个什么样的东西呢？我们是否真的可以携着C#语言进入前端的市场中? 不如现在就跟我一起体验dotnet blazor吧。

一、前言

获取最新版的dotnet core 并安装Blazor模板：

安装最新的.Net Core（版本需要高于2.1.101）；
对于简单的尝试来说，VS code 已经足够。所以笔者并没有亲自安装Visual Studio；

使用命令行初始化项目：

dotnet new -i Microsoft.AspNetCore.Blazor.Templates

dotnet new blazor -o BlazorApp1

cd BlazorApp1

dotnet run

如果你需要使用Visual Studio：
- 安装最新的Visual Studio 2017；
- 安装 ASP.NET Core Blazor Language Services extension；

在Visual Studio中创建新的测试项目；
选择 File -> New Project -> Web -> ASP.NET Core Web Application；
确定在Target Framework里选择了 .NET Core and ASP.NET Core 2.0；
选择 Blazor 模板；

开包即食的教程带你浅尝最新开源的C# Web引擎Blazor

二、如何在前端渲染cshtml

当我们运行起项目之后，就可以看到如下提示：

开包即食的教程带你浅尝最新开源的C# Web引擎Blazor

这个时候我们在浏览器里打开监听的端口 http://localhost:17477，就可以看到我们这个项目的网页了。

这个简单的示例项目带了3个页面：

开包即食的教程带你浅尝最新开源的C# Web引擎Blazor

第一个页面比较简单，但先别急,让我们打开浏览器工具，先看看页面在加载页面过程中都加载了什么：

开包即食的教程带你浅尝最新开源的C# Web引擎Blazor

在初次打开页面的时候，我们看到的是这样一个Loading..的页面，这个页面的代码是这样的：

<!DOCTYPE html>

<html>

<head>

    <meta charset="utf-8" />

    <title>BlazorDemo</title>

    <base href="/" />

    <link href="css/bootstrap/bootstrap.min.css" rel="stylesheet" />

    <link href="css/site.css" rel="stylesheet" />

</head>

<body>

    <app>Loading...</app>

    <script src="css/bootstrap/bootstrap-native.min.js"></script>

    <script src="_framework/blazor.js" main="BlazorDemo.dll" entrypoint="BlazorDemo.Program::Main" references="Microsoft.AspNetCore.Blazor.Browser.dll,Microsoft.AspNetCore.Blazor.dll,Microsoft.Extensions.DependencyInjection.Abstractions.dll,Microsoft.Extensions.DependencyInjection.dll,mscorlib.dll,netstandard.dll,System.Core.dll,System.Diagnostics.StackTrace.dll,System.dll,System.Globalization.Extensions.dll,System.Net.Http.dll,System.Runtime.Serialization.Primitives.dll,System.Security.Cryptography.Algorithms.dll" linker-enabled="true"></script></body>

</html>

可以看到这个页面加载了两个js，第一个是bootstrap的，第二个叫做blazor.js。只不过这个js有非常多的参数，有 main、entrypoint和references。看看References里写的是不是很熟悉? 一看就是.net的dll。

blazor.js加载了mono.js，mono.js加载了mono.wasm。这个是个什么文件?

开包即食的教程带你浅尝最新开源的C# Web引擎Blazor

wasm代表的就是Web Assembly，简单地说它就是编译好的二进制文件，可以由浏览器直接运行，源语言可以是C/C++或者任何可以编译到Web Assembly的文件，而这里我们加载的就是mono编译好的Web Assembly文件，它被加载之后，相当于浏览器中启动了一个mono 运行环境。

随后的两个js是笔者chrome浏览器插入的js，在这里不要被他们干扰了。那么mono 运行时加载完成之后，就需要加载dotnet 的Dll了，首先是入口库，接着就是需要的引用库。

开包即食的教程带你浅尝最新开源的C# Web引擎Blazor

好家伙 1.9MB！当所有的Dll被下载完毕之后，这个时候我们的浏览器就可以运行我们这个dotnet的网页了。于是就回到了我们最开始看到的那个应用程序。

所以，总结一下blazor.js调用mono.js，mono.js加载mono.wsam，然后根据写在script标签里的内容继续的加载dotnet的库文件。如果浏览器不支持wsam，就会尝试使用asm.js加载mono.asm.js。

三、Blazor的模板究竟是怎样的？

我们已经知道，经过前面的步骤，浏览器里已经运行了一个.Net 运行时了。而且加载了项目必须的dll。那么这样一个简单的程序，它的代码究竟是怎么样的呢？

打开项目代码，映入眼帘的是一个标准的.net Project：

开包即食的教程带你浅尝最新开源的C# Web引擎Blazor

_ViewImports.cshtml包含了项目一些其他页面中最常使用的namespace：

@using System.Net.Http

@using Microsoft.AspNetCore.Blazor

@using Microsoft.AspNetCore.Blazor.Components

@using Microsoft.AspNetCore.Blazor.Layouts

@using Microsoft.AspNetCore.Blazor.Routing

@using BlazorDemo

@using BlazorDemo.Shared

Program.cs是程序的入口点：

using Microsoft.AspNetCore.Blazor.Browser.Rendering;

using Microsoft.AspNetCore.Blazor.Browser.Services;

using System;

namespace BlazorDemo

{

    class Program

    {

        static void Main(string[] args)

        {

            var serviceProvider = new BrowserServiceProvider(configure =>

            {

                // Add any custom services here

            });

            new BrowserRenderer(serviceProvider).AddComponent<App>("app");

        }

    }

}

在入口点中，我们注册了一个浏览器渲染服务 BrowserRender，让他渲染App。

App.cshmtl是这样的：

<Router AppAssembly=typeof(Program).Assembly />

这里的Router对应的是Microsoft.AspNetCore.Blazor.Routing.Router。当给它一个AppAssembly时，他就会自动的把当前的Url 和 AppAssembly的其他Pages对应起来。

所以，当我们在浏览器里输入 /Counter时，他就会加载Pages/Couter.cshtml。

Shared文件夹里分别是布局文件、导航栏，还有一个我们自定义的控件 SurveyPrompt。

熟悉Razor引擎的小伙伴们一定很轻车熟路了。那么当我们打开网站时，默认显示给我们的就是Index，这个时候我们会加载Pages/Index.cshtml。

Index.cshtml的代码是这个样子的：

@page "/"

<h1>Hello, world!</h1>

Welcome to your new app.

<SurveyPrompt Title="How is Blazor working for you?" />

@page 可以告诉Router，当前页面注册到 "/"。

除了显示hello world以外，我们在这里还看到了刚刚说到的第三方控件：SurveyPrompt，果然不简单嘛，一个看似简单的页面，居然还告诉了我们如何使用自定义控件。

从声明上看，我们知道SunveyPrompt是一个控件，并且有一个属性Title。现在我们打开它的代码：

<div class="alert alert-survey" role="alert">

    <span class="glyphicon glyphicon-ok-circle" aria-hidden="true"></span>

    <strong>@Title</strong>

    Please take our

    <a target="_blank" class="alert-link" href="https://go.microsoft.com/fwlink/?linkid=870381">

        brief survey

    </a>

    and tell us what you think.

</div>

@functions

{

    // This is to demonstrate how a parent component can supply parameters

    public string Title { get; set; }

}

我们可以看到代码分为两部分，@functions上面是类似html的东西，下面是类似C#的东西。熟悉React或者Vue的伙伴们恐怕不会对这种混写感到陌生。这个就是Blazor的语法，Html部分很像使Razor的模板方式，而最后整个页面都会被编译成一个类，这个类派生自 Component。如果你编译过项目，你会在Debug下面的Shared目录找到一个叫SurveyPrompt.g.cs的东西：

#pragma checksum "/Users/pzhi/SCM/gitHub/zhipu123/BlazorDemo/Shared/SurveyPrompt.cshtml" "{ff1816ec-aa5e-4d10-87f7-6f4963833460}" "a2a2ea88635b799343bc6d9647bbb818c8a20c9d"

// <auto-generated/>

#pragma warning disable 1591

namespace BlazorDemo.Shared

{

    #line hidden

    using System;

    using System.Collections.Generic;

    using System.Linq;

    using System.Threading.Tasks;

    using System.Net.Http;

    using Microsoft.AspNetCore.Blazor;

    using Microsoft.AspNetCore.Blazor.Components;

    using Microsoft.AspNetCore.Blazor.Layouts;

    using Microsoft.AspNetCore.Blazor.Routing;

    using BlazorDemo;

    using BlazorDemo.Shared;

    public class SurveyPrompt : Microsoft.AspNetCore.Blazor.Components.BlazorComponent

    {

        #pragma warning disable 1998

        protected override void BuildRenderTree(Microsoft.AspNetCore.Blazor.RenderTree.RenderTreeBuilder builder)

        {

            base.BuildRenderTree(builder);

            builder.OpenElement(, "div");

            builder.AddAttribute(, "class", "alert alert-survey");

            builder.AddAttribute(, "role", "alert");

            builder.AddContent(, "\n    ");

            builder.OpenElement(, "span");

            builder.AddAttribute(, "class", "glyphicon glyphicon-ok-circle");

            builder.AddAttribute(, "aria-hidden", "true");

            builder.CloseElement();

            builder.AddContent(, "\n    ");

            builder.OpenElement(, "strong");

            builder.AddContent(, Title);

            builder.CloseElement();

            builder.AddContent(, "\n\n    Please take our\n    ");

            builder.OpenElement(, "a");

            builder.AddAttribute(, "target", "_blank");

            builder.AddAttribute(, "class", "alert-link");

            builder.AddAttribute(, "href", "https://go.microsoft.com/fwlink/?linkid=870381");

            builder.AddContent(, "\n        brief survey\n    ");

            builder.CloseElement();

            builder.AddContent(, "\n    and tell us what you think.\n");

            builder.CloseElement();

            builder.AddContent(, "\n\n");

        }

        #pragma warning restore 1998

    // This is to demonstrate how a parent component can supply parameters

    public string Title { get; set; }

    }

}

#pragma warning restore 1591

我们发现@functions里面的内容会作为这个类的成员变量和成员方法，而上面的内容则被编译到了BuildRenderTree方法中。

那么到了这里我们大概知道了这个简单的HomePage都有什么玄机了。我们也大概知道了Blazor的语法，也知道其实我们所有的页面最终都会是一个Componet。

那么什么是Componet呢? 在这里并不想用过多的笔墨介绍这个概念。如果你是一个Vue或者React的开发，你应该对这个模块化开发不陌生。一个Componet，就是满足一定的功能，有自己的属性、状态，可以展示特定数据的元素。

就如同我们这里的SurveyPrompt，接受一个Title属性，并且负责把它展示成这样子：

开包即食的教程带你浅尝最新开源的C# Web引擎Blazor

四、Blazor的刷新和绑定机制初探

现在我们知道了一个简单的页面是如何渲染出来的，那么让我们打开Counter这个配置来看一看数据是如何交互的。

我们第二个page是这样子：

开包即食的教程带你浅尝最新开源的C# Web引擎Blazor

有一个button，当我们点击的时候，上面的current count 变成了 1：

开包即食的教程带你浅尝最新开源的C# Web引擎Blazor

这一切是怎么发生的呢? 以下是Counter.cshtml的代码：

@page "/counter"

<h1>Counter</h1>

<p>Current count: @currentCount</p>

<button @onclick(IncrementCount)>Click me</button>

@functions {

    int currentCount = 0;

    void IncrementCount()

    {

        currentCount++;

    }

}

我们看到这个页面非常简单，我们定义了一个CurrentCount的Field，然后在IncreaseCount方法里给它加一，一个叫Click me的button标签里有一个@onclick方法，将IncreaseCount作为参数。

Counter.cshtml编译后的代码是这样的：

#pragma checksum "/Users/pzhi/SCM/gitHub/zhipu123/BlazorDemo/Pages/Counter.cshtml" "{ff1816ec-aa5e-4d10-87f7-6f4963833460}" "05ad2dd449cbc9f09f8b759e1f06e7eb5e9583b4"

// <auto-generated/>

#pragma warning disable 1591

namespace BlazorDemo.Pages

{

    #line hidden

    using System;

    using System.Collections.Generic;

    using System.Linq;

    using System.Threading.Tasks;

    using System.Net.Http;

    using Microsoft.AspNetCore.Blazor;

    using Microsoft.AspNetCore.Blazor.Components;

    using Microsoft.AspNetCore.Blazor.Layouts;

    using Microsoft.AspNetCore.Blazor.Routing;

    using BlazorDemo;

    using BlazorDemo.Shared;

    [Microsoft.AspNetCore.Blazor.Layouts.LayoutAttribute(typeof(MainLayout))]

    [Microsoft.AspNetCore.Blazor.Components.RouteAttribute("/counter")]

    public class Counter : Microsoft.AspNetCore.Blazor.Components.BlazorComponent

    {

        #pragma warning disable 1998

        protected override void BuildRenderTree(Microsoft.AspNetCore.Blazor.RenderTree.RenderTreeBuilder builder)

        {

            base.BuildRenderTree(builder);

            builder.OpenElement(, "h1");

            builder.AddContent(, "Counter");

            builder.CloseElement();

            builder.AddContent(, "\n\n");

            builder.OpenElement(, "p");

            builder.AddContent(, "Current count: ");

            builder.AddContent(, currentCount);

            builder.CloseElement();

            builder.AddContent(, "\n\n");

            builder.OpenElement(, "button");

            builder.AddAttribute(, onclick(IncrementCount));

            builder.AddContent(, "Click me");

            builder.CloseElement();

            builder.AddContent(, "\n\n");

        }

        #pragma warning restore 1998

    int currentCount = ;

    void IncrementCount()

    {

        currentCount++;

    }

    }

}

#pragma warning restore 1591

我们看到@onclick其实在这里就是执行了一个Component的一个方法onclick，顾名思义，当这个Component被点击的时候就被调用。我们的IncreaseCount被作为参数传给了它，可见onclick会在被点击的时候执行IncreaseCount。

那么问题来了，当我们执行了IncreaseCount方法时，页面怎么会知道要不要刷新? 是刷新整个页面还是刷新所有?

熟悉WPF的同学可能知道，在WPF中如果我们需要让一个ViewModel可以被监听变化，它就需要实现INotifyChanged事件。那么同样道理，我们的这个IncreaseCount可能也是类似的吗?

然而基于编译后的代码我们可以发现 CurrentCount作为我们Counter这个类的Field，并没有任何机会高速Page自己变化了。而且这个Field非常普通，也不是什么WPF中的DP（依赖属性），所以到目前为止变化是怎么通知的。并没有一个合理的解释。后面的时间里我会尝试阅读Blazor的代码搞清楚这件事情。

第一个问题画个问号，那么第二个问题呢?

打开浏览器工具，定位到button，再次点击button观察dom的反应。

开包即食的教程带你浅尝最新开源的C# Web引擎Blazor