Datasilk.Core.Mvc 1.0.7.6

.NET 5.0 This package targets .NET 5.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Datasilk.Core.Mvc --version 1.0.7.6                

                    
                

            
NuGet\Install-Package Datasilk.Core.Mvc -Version 1.0.7.6
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Datasilk.Core.Mvc" Version="1.0.7.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Datasilk.Core.Mvc --version 1.0.7.6                

                    
                

            
#r "nuget: Datasilk.Core.Mvc, 1.0.7.6"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Datasilk.Core.Mvc as a Cake Addin
#addin nuget:?package=Datasilk.Core.Mvc&version=1.0.7.6

// Install Datasilk.Core.Mvc as a Cake Tool
#tool nuget:?package=Datasilk.Core.Mvc&version=1.0.7.6

Datasilk Logo

Datasilk Core MVC

An MVC Framework for ASP.NET Core

Datasilk Core is an ultra-fast, light-weight alternative to ASP.NET Core MVC, it supports Views using HTML with mustache variables, hierarchical Controller rendering, and RESTful web services.

Installation

From Nuget
  1. Include the Nuget Package Datasilk.Core.Mvc within your ASP.NET Core project.
From Github

  1. Add this repository to your ASP.NET Core project as a submodule:

    git submodule add https://github.com/Datasilk/Core

Startup.cs

Make sure to include the middleware within Startup.cs.

public virtual void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
	app.UseDatasilkMvc(new MvcOptions()
	{
		IgnoreRequestBodySize = true,
		WriteDebugInfoToConsole = true,
		LogRequests = false,
		Routes = new Routes(),
		ServicePaths = new string[] { 'api' },
		DefaultController = 'home',
		DefaultServiceMethod = 'Get',
		InvokeNext = true
	});
}

Page Requests

All page request URLs are mapped to controllers that inherit the Datasilk.Core.Web.IController interface. For example, the URL http://localhost:7770/products would map to the class MyProject.Controllers.Products. Each controller contains one method, Render, which is used to serve a web page to the user's web browser.

/Views/Home/home.html

<div class="hero">
	<h1>{{title}}</h1>
	<h2>{{description}}</h2>
</div>

/Controllers/Home.cs

namespace MyProject.Controllers
{
    public class Home: Datasilk.Core.Web.Controller
    {
        public override string Render(string body = "")
		{
			//render page
			var view = new View("/Views/Home/home.html");
			view["title"] = "Hello.";
			view["description"] = "I like to write software.";
			AddScript("/js/views/home/home.js");
			return view.Render();		
		}
	}
}

In the example above, a user tries to access the URL http://localhost:7770/, which (by default) will render the contents of the MyProject.Controllers.Home class. This class loads /Views/Home/home.html into a View object and replaces the {{title}} & {{description}} variables located within the home.html file with the text, "Hello" & "I like to write software". Then, the page returns the contents of view.Render().

Controller Hierarchy

You could create controllers that inherit other controllers, then return base.Render(view.Render()) to create a cascade of controller rendering. This would be useful to have a base controller that renders the header & footer of a web page, while all other controllers render the body.

/Views/Shared/layout.html

<html>
    <head>...</head>
    <body>{{content}}</body>
</html>

/Controllers/Layout.cs

namespace MyProject.Controllers
{
    public class Layout: Datasilk.Core.Web.Controller
    {
        public override string Render(string body = "")
		{
			//render layout
			var view = new View("/Views/Shared/layout.html");
			view["content"] = body;
			return view.Render();
		}
	}
}

/Controllers/Home.cs

namespace MyProject.Controllers
{
    public class Home: Layout
    {
        public override string Render(string body = "")
		{
			//render page
			var view = new View("/Views/Home/home.html");
			return base.Render(view.Render());		
		}
	}
}

In the example above, the Home controller inherits from the Layout controller class, then calls base.Render, which will allow the Layout controller to inject the home page HTML content into the body of the HTML layout.

NOTE: MyProject.Controllers.Home is the default class that is instantiated if the URL contains a domain name with no path structure.

Controller Routing

To render Controllers based on complex URL paths, the MVC framework relies heavily on the first part of the request path to determine which class to instantiate. For example, if the user accesses the URL http://localhost:7770/blog/2019/11/09/Progress-Report, Datasilk Core MVC initializes the MyProject.Controllers.Blog class.

The request path is split up into an array and passed into the PathParts field within the Datasilk.Core.Web.Controller class. The PathParts array is used to determine what type of content to load for the user. If we're loading a blog post like the above example, we can check the PathParts array to find year, month, and day, followed by the title of the blog post, and determine which blog post to load.

namespace MyProject.Controllers
{
    public class Blog: Datasilk.Core.Web.Controller
    {
        public override string Render(string body = "")
		{
			if(PathParts.length > 3){
				//get blog entry
				var date = new Date(PathParts[1] + "/" + PathParts[2] + "/" + PathParts[3]);
				var title = PathParts[3] || "";
				var view = new View("/Views/Blog/entry.html");
				//get blog entry from database using date & title
				var entry = Blog.GetEntry(date, title);
				view.Bind(entry);
				return view.Render();
			}
			else
			{
				//get blog home page
				var view = new View("/Views/Blog/blog.html");
				return view.Render();
			}           
		}
	}

Access Denied

If your web page is protected behind security and must display an Access Denied page, you can use:

return AccessDenied<Login>(this)

from within your Datasilk.Core.Web.Controller class Render method, which will render a controller of your choosing with a response status code of 403. The above example renders the Login controller.

500 Error

If your controller experiences an error, you can show another controller:

return Error<BrokenPage>(this)

from within your Datasilk.Core.Web.Controller class Render method, which will render a controller of your choosing with a response status code of 500. The above example renders the BrokenPage controller.

404 Error

If your controller processes an unknown request path, you could show a 404 not found error:

return Error404<NotFound>(this)

from within your Datasilk.Core.Web.Controller class Render method, which will render a controller of your choosing with a response status code of 404. The above example renders the NotFound controller.

Web Services

The Datasilk Core MVC framework comes with the ability to call RESTful web APIs. All web API calls are executed from Datasilk.Core.Web.IService interfaces.

Example
namespace MyProject.Services
{
    public class User: Datasilk.Core.Web.Service
    {
		[POST]
		public string Authenticate(string email, string password)
		{
			//authenticate user
			//...
			if(authenticated)
			{
				return Success();
			}
			else
			{
				return AccessDenied("Incorrect email or password");
			}
		}
	}
}

In the example above, the user would send an AJAX POST via JavaScript to the Uri /api/User/Authenticate to authenticate their email & password. The data sent to the server over HTTPS would be formatted using the JavaScript function, JSON.stringify({email:myemail, password:mypass}), and the data properties would be mapped to C# method arguments.

Web Service Response

All Datasilk.Core.Web.Service methods should return a string. You can easily return a JSON object as well. Use the built-in method JsonResponse(dynamic) to ensure that the ContentType for your response is set to text/json.

return JsonResponse(new {id = user.Id, firstname, lastname});

Routes.cs

If you would like to map requests to controllers & services directly, create a new class that inherits Datasilk.Core.Web.Routes. For example:

using Microsoft.AspNetCore.Http;
using Datasilk.Core.Web;

public class Routes : Datasilk.Core.Web.Routes
{
    public override IController FromControllerRoutes(HttpContext context, Parameters parameters, string name)
    {
        switch (name)
        {
            case "": case "home": return new Controllers.Home();
            case "login": return new Controllers.Login();
            case "dashboard": return new Controllers.Dashboard();
        }
        return null;
    }

    public override IService FromServiceRoutes(HttpContext context, Parameters parameters, string name)
    {
        switch (name)
        {
            case "": case "user": return new Services.User();
            case "dashboard": return new Services.Dashboard();
        }
        return null;
    }
}
Why Routing?

By routing new class instances using the new keyword, you bypass the last resort for Datasilk Core MVC, which is to create an instance of your Controller or Service class using Activator.CreateInstance, taking 10 times the amount of CPU ticks to instatiate. You don't have to use routing, but it does speed up performance slightly.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net5.0

    • No dependencies.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Datasilk.Core.Mvc:

Package Downloads
Saber.Core

Core MVC classes & interfaces used in the Saber website builder.
Kandu.Core

The core interfaces, classes, and middleware for Kandu, used by plugin developers.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.8.2 614 3/26/2023
1.0.8.1 207 3/20/2023
1.0.8 807 11/18/2022
1.0.7.9 410 7/21/2022
1.0.7.8 444 3/4/2022
1.0.7.7 415 2/23/2022
1.0.7.6 445 11/28/2021
1.0.7.5 466 11/3/2021
1.0.7.4 355 11/3/2021
1.0.7.3 275 11/2/2021
1.0.7.2 278 11/2/2021
1.0.7.1 340 10/17/2021
1.0.7 1,116 3/14/2021
1.0.6.5 387 12/10/2020
1.0.6.4 386 12/10/2020
1.0.6.3 484 11/24/2020
1.0.6.2 593 11/14/2020
1.0.6 508 11/12/2020
1.0.5.2 472 11/12/2020
1.0.5 603 11/10/2020
1.0.4.2 1,219 11/6/2020
1.0.4.1 405 11/6/2020
1.0.4 400 11/6/2020
1.0.3 425 9/29/2020
1.0.2 507 11/9/2019
1.0.1 476 11/9/2019
1.0.0 485 11/9/2019

Added GetBlock method for retrieving entire block of text across multiple Elements