Merge pull request aspnet#90 from JialinXin/serversideblazor

Add serversideblazor sample
fengjihua · Apr 26, 2019 · f96fe4b · f96fe4b
2 parents 8e13755 + f221d16
commit f96fe4b
Show file tree

Hide file tree

Showing 31 changed files with 1,317 additions and 0 deletions.
diff --git a/docs/images/serversideblazor.png b/docs/images/serversideblazor.png
diff --git a/samples/ServerSideBlazor/App.razor b/samples/ServerSideBlazor/App.razor
@@ -0,0 +1,5 @@
+@*
+    The Router component displays whichever component has a @page
+    directive matching the current URI.
+*@
+<Router AppAssembly="typeof(Startup).Assembly" />
diff --git a/samples/ServerSideBlazor/Data/WeatherForecast.cs b/samples/ServerSideBlazor/Data/WeatherForecast.cs
@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System;
+
+namespace ServerSideBlazor.Data
+{
+    public class WeatherForecast
+    {
+        public DateTime Date { get; set; }
+
+        public int TemperatureC { get; set; }
+
+        public int TemperatureF { get; set; }
+
+        public string Summary { get; set; }
+    }
+}
diff --git a/samples/ServerSideBlazor/Data/WeatherForecastService.cs b/samples/ServerSideBlazor/Data/WeatherForecastService.cs
@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace ServerSideBlazor.Data
+{
+    public class WeatherForecastService
+    {
+        private static string[] Summaries = new[]
+        {
+            "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
+        };
+
+        public Task<WeatherForecast[]> GetForecastAsync(DateTime startDate)
+        {
+            var rng = new Random();
+            return Task.FromResult(Enumerable.Range(1, 5).Select(index => new WeatherForecast
+            {
+                Date = startDate.AddDays(index),
+                TemperatureC = rng.Next(-20, 55),
+                Summary = Summaries[rng.Next(Summaries.Length)]
+            }).ToArray());
+        }
+    }
+}
diff --git a/samples/ServerSideBlazor/Pages/Counter.razor b/samples/ServerSideBlazor/Pages/Counter.razor
@@ -0,0 +1,16 @@
+@page "/counter"
+
+<h1>Counter</h1>
+
+<p>Current count: @currentCount</p>
+
+<button class="btn btn-primary" onclick="@IncrementCount">Click me</button>
+
+@functions {
+    int currentCount = 0;
+
+    void IncrementCount()
+    {
+        currentCount++;
+    }
+}
diff --git a/samples/ServerSideBlazor/Pages/FetchData.razor b/samples/ServerSideBlazor/Pages/FetchData.razor
@@ -0,0 +1,45 @@
+@page "/fetchdata"
+@using ServerSideBlazor.Data
+@inject WeatherForecastService ForecastService
+
+<h1>Weather forecast</h1>
+
+<p>This component demonstrates fetching data from a service.</p>
+
+@if (forecasts == null)
+{
+    <p><em>Loading...</em></p>
+}
+else
+{
+    <table class="table">
+        <thead>
+            <tr>
+                <th>Date</th>
+                <th>Temp. (C)</th>
+                <th>Temp. (F)</th>
+                <th>Summary</th>
+            </tr>
+        </thead>
+        <tbody>
+            @foreach (var forecast in forecasts)
+            {
+                <tr>
+                    <td>@forecast.Date.ToShortDateString()</td>
+                    <td>@forecast.TemperatureC</td>
+                    <td>@forecast.TemperatureF</td>
+                    <td>@forecast.Summary</td>
+                </tr>
+            }
+        </tbody>
+    </table>
+}
+
+@functions {
+    WeatherForecast[] forecasts;
+
+    protected override async Task OnInitAsync()
+    {
+        forecasts = await ForecastService.GetForecastAsync(DateTime.Now);
+    }
+}
diff --git a/samples/ServerSideBlazor/Pages/Index.razor b/samples/ServerSideBlazor/Pages/Index.razor
@@ -0,0 +1,5 @@
+@page "/"
+
+<h1>Hello, world!</h1>
+
+Welcome to your new app.
diff --git a/samples/ServerSideBlazor/Pages/_Host.cshtml b/samples/ServerSideBlazor/Pages/_Host.cshtml
@@ -0,0 +1,29 @@
+@page "/"
+@namespace ServerSideBlazor.Pages
+@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
+
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>ServerSideBlazor</title>
+    <base href="~/" />
+    <environment include="Development">
+        <link rel="stylesheet" href="css/bootstrap/bootstrap.min.css" />
+    </environment>
+    <environment exclude="Development">
+        <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css"
+              asp-fallback-href="css/bootstrap/bootstrap.min.css"
+              asp-fallback-test-class="sr-only" asp-fallback-test-property="position" asp-fallback-test-value="absolute"
+              crossorigin="anonymous"
+              integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T"/>
+    </environment>
+    <link href="css/site.css" rel="stylesheet" />
+</head>
+<body>
+    <app>@(await Html.RenderComponentAsync<App>())</app>
+
+    <script src="_framework/blazor.server.js"></script>
+</body>
+</html>
diff --git a/samples/ServerSideBlazor/Pages/_Imports.razor b/samples/ServerSideBlazor/Pages/_Imports.razor
@@ -0,0 +1 @@
+@layout MainLayout
diff --git a/samples/ServerSideBlazor/Program.cs b/samples/ServerSideBlazor/Program.cs
@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+
+namespace ServerSideBlazor
+{
+    public class Program
+    {
+        public static void Main(string[] args)
+        {
+            CreateHostBuilder(args).Build().Run();
+        }
+
+        public static IHostBuilder CreateHostBuilder(string[] args) =>
+            Host.CreateDefaultBuilder(args)
+                .ConfigureWebHostDefaults(webBuilder =>
+                {
+                    webBuilder.UseStartup<Startup>();
+                });
+    }
+}
diff --git a/samples/ServerSideBlazor/Properties/launchSettings.json b/samples/ServerSideBlazor/Properties/launchSettings.json
@@ -0,0 +1,28 @@
+{
+  "iisSettings": {
+    "windowsAuthentication": false,
+    "anonymousAuthentication": true,
+    "iisExpress": {
+      "applicationUrl": "http://localhost:62025",
+      "sslPort": 44340
+    }
+  },
+  "profiles": {
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "ServerSideBlazor": {
+      "commandName": "Project",
+      "launchBrowser": true,
+      "applicationUrl": "https://localhost:5001;http://localhost:5000",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "ASPNETCORE_HOSTINGSTARTUPASSEMBLIES": "Microsoft.Azure.SignalR"
+      }
+    }
+  }
+}
diff --git a/samples/ServerSideBlazor/README.md b/samples/ServerSideBlazor/README.md
@@ -0,0 +1,62 @@
+# Server-side Blazor with Azure SignalR Service
+
+This sample is to show how to make Server-side Blazor work with Azure SignalR Service.
+
+## Prerequisites
+* Install .NET Core 3.0 SDK (Version >= 3.0.100-preview4-011136)
+* Provision an Azure SignalR Service instance
+
+Set the connection string in the [Secret Manager](https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-2.1&tabs=visual-studio#secret-manager) tool for .NET Core, and run this app.
+
+```
+dotnet restore
+dotnet user-secrets set Azure:SignalR:ConnectionString "<your connection string>"
+dotnet run
+```
+
+After running, you will see that the web server starts, makes connections to the Azure SignalR Service instance and creates an endpoint at `http://localhost:5001/`. Browser the page and click F12, you can find the connection to Azure SignalR Service is created. See snapshot 
+
+![serversideblazor](../../docs/images/serversideblazor.png)
+
+## Steps one by one
+1. Create Server-side Blazor project.
+
+```
+dotnet new blazorserverside 
+```
+
+2. Add reference to Azure SignalR SDK
+```
+dotnet add package Microsoft.Azure.SignalR --version 1.1.0-preview1-10384
+```
+
+3. Add configuration to turn on Azure SignalR Service in [appsetting.json](appsettings.json)
+```
+  "Azure": {
+    "SignalR": {
+      "Enabled": true
+    }
+  }
+```
+
+4. Assign hosted startup assembly to use Azure SignalR. Edit [launchSettings.json](Properties\launchSettings.json) and add a configuration like below inside `environmentVariables`.
+```
+"environmentVariables": {
+    ...,
+    "ASPNETCORE_HOSTINGSTARTUPASSEMBLIES": "Microsoft.Azure.SignalR"
+  }
+```
+
+5. Configure Azure SignalR Service `ConnectionString` either in [appsetting.json](appsettings.json) or use [Secret Manager](https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-2.1&tabs=visual-studio#secret-manager) tool.
+
+> Notes: Step 3 and 4 can be replaced by directly calling `AddAzureSignalR()`. Update `ConfigureServices()` in [StartUp.cs](Startup.cs) like below.
+> 
+> ```
+> public void ConfigureServices(IServiceCollection services)
+> {
+>     ...
+>     services.AddServerSideBlazor().AddSignalR().AddAzureSignalR();
+>     ...
+> }
+> ```
+
diff --git a/samples/ServerSideBlazor/ServerSideBlazor.csproj b/samples/ServerSideBlazor/ServerSideBlazor.csproj
@@ -0,0 +1,12 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp3.0</TargetFramework>
+    <LangVersion>7.3</LangVersion>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Azure.SignalR" Version="1.1.0-preview1-10384" />
+  </ItemGroup>
+
+</Project>
diff --git a/samples/ServerSideBlazor/Shared/MainLayout.razor b/samples/ServerSideBlazor/Shared/MainLayout.razor
@@ -0,0 +1,15 @@
+@inherits LayoutComponentBase
+
+<div class="sidebar">
+    <NavMenu />
+</div>
+
+<div class="main">
+    <div class="top-row px-4">
+        <a href="https://docs.microsoft.com/en-us/aspnet/" target="_blank" class="ml-md-auto">About</a>
+    </div>
+
+    <div class="content px-4">
+        @Body
+    </div>
+</div>
diff --git a/samples/ServerSideBlazor/Shared/NavMenu.razor b/samples/ServerSideBlazor/Shared/NavMenu.razor
@@ -0,0 +1,37 @@
+<div class="top-row pl-4 navbar navbar-dark">
+    <a class="navbar-brand" href="">ServerSideBlazor</a>
+    <button class="navbar-toggler" onclick="@ToggleNavMenu">
+        <span class="navbar-toggler-icon"></span>
+    </button>
+</div>
+
+<div class="@NavMenuCssClass" onclick="@ToggleNavMenu">
+    <ul class="nav flex-column">
+        <li class="nav-item px-3">
+            <NavLink class="nav-link" href="" Match="NavLinkMatch.All">
+                <span class="oi oi-home" aria-hidden="true"></span> Home
+            </NavLink>
+        </li>
+        <li class="nav-item px-3">
+            <NavLink class="nav-link" href="counter">
+                <span class="oi oi-plus" aria-hidden="true"></span> Counter
+            </NavLink>
+        </li>
+        <li class="nav-item px-3">
+            <NavLink class="nav-link" href="fetchdata">
+                <span class="oi oi-list-rich" aria-hidden="true"></span> Fetch data
+            </NavLink>
+        </li>
+    </ul>
+</div>
+
+@functions {
+    bool collapseNavMenu = true;
+
+    string NavMenuCssClass => collapseNavMenu ? "collapse" : null;
+
+    void ToggleNavMenu()
+    {
+        collapseNavMenu = !collapseNavMenu;
+    }
+}