Skip to main content

Blazor WebAssembly File Upload

In this article, we are going to explore file uploading in the Blazor WebAssembly application. From .Net5 onwards Blazor Assembly comes with an inbuilt file rendering blazor component like 'InputFile' Component.

Overview On InputFile Component:

  • InputFile blazor component renders an input field of type 'file' which by default supports single file upload. To support multiple file selection we need to add an attribute 'multiple' to the Html tag of the InputFile blazor component.
  • InputFile blazor component provides an event called 'OnChange'. This event gets invoked on every file selection. This 'OnChange' event has to be configured with a callback method in our blazor code block.
  • The callback method receives an argument of type 'InputFileChangeEventsArgs'. This 'InputFileChangeEventsArgs' captures all images and it information. This argument helps to read the stream of files.

Create A Sample Blazor WebAssembly:

Let's understand the file uploading steps by writing some sample code, so let's get started with the sample Blazor Assembly Application. Remember this InputFile component introduced from .Net5, so make sure your sample application created with .Net5. The IDE's for development can be chosen on your personal preference but most recommended are Visual Studio 2019 and Visual Studio Code.

Uploaded File Read And Render:

Let's understand reading the stream of the file and render the image for preview. Since our application is Blazor WebAssembly where all dotnet code runs inside of the browser sandbox.
Pages/Index.razor:(Html Part)
<div>
    <InputFile OnChange="@OnFileSelection"></InputFile>
    <div class="row">
        <img src="@imgUrl">
    </div>
</div>
  • (Line: 2) Rendered InputFile blazor component for file upload. The 'OnChange' event of the InputFile component configured with an 'OnFileSelection' call back method(.net method)
  • (Line: 4) The selected file is rendered to show the preview.
Pages/Index.razor:(Code Part)
@code{
    string imgUrl = string.Empty;
    private async Task OnFileSelection(InputFileChangeEventArgs e)
    {
        IBrowserFile imgFile = e.File;
        var buffers = new byte[imgFile.Size];
        await imgFile.OpenReadStream().ReadAsync(buffers);
        string imageType = imgFile.ContentType;
        imgUrl =$"data:{imageType};base64,{Convert.ToBase64String(buffers)}";
    }
}
  • (Line: 3) The 'OnFileSelection' method is the callback method registered with the 'OnChange' event of the InputFile blazor component. The 'InputFileChangeEventArgs' type passed parameter for 'OnChange' event.
  • (Line: 5) The 'InputFileChangeEventArgs' contains a property 'File' which returns the first image of the selection by the InputFile blazor Component. The 'File' property is of type 'Microsoft.AspNetCore.Components.Form.IBrowserFile'.
  • (Line: 6) Byte array was initialized to capture the byte data of the image stream in later steps. So the size of the byte array needs to be declared as the size of the uploaded file. The 'IBrowserFile' provides a property called 'Size' to determine the file size, this 'Size' value will be used for the byte array variable.
  • (Line: 7) The 'IBrowserFile' provides the method 'OpenReadStream' that gives the file as 'Stream' of data. Using the 'Stream' extension of ReadAsync to populate the byte data.
  • (Line: 8) The 'IBrowserFile' provides the 'ContentType' property to determine the upload file is jpg or png.
  • (Line: 9) The preview URL assigned with a base64 string image format.

Multiple Uploaded Files Read And Render:

Pages/Index.razor:(Html Part)
<div>
    <InputFile OnChange="@OnFileSelection" multiple></InputFile>
    <div class="row">
        @foreach (var imgUrl in imgUrls)
        {
            <img src="@imgUrl">
        }
    </div>
</div>
  • (Line: 2) The InputFile blazor component decorated with a 'multiple' attribute for multi-selection. of files to upload.
  • (Line: 4) The list images loop to show the preview.
Pages/Index.razor:(Code Part)
@code{
    List<string> imgUrls = new List<string>();
    private async Task OnFileSelection(InputFileChangeEventArgs e)
    {
        foreach (IBrowserFile imgFile in e.GetMultipleFiles(5))
        {
            var buffers = new byte[imgFile.Size];
            await imgFile.OpenReadStream().ReadAsync(buffers);
            string imageType = imgFile.ContentType;
            string imgUrl = $"data:{imageType};base64,{Convert.ToBase64String(buffers)}";
            imgUrls.Add(imgUrl);
        }
    }
}
  • (Line: 2) The images list container that will loop to show the preview.
  • (Line: 5) The 'InputFileChangeEventArgs' contains a method called 'GetMultipleFiles' which returns the collection of 'IBrowserFile'. The 'GetMultipleFiles' method has an optional parameter to fetch the number of files. By default, it returns the max number of 10 'IBrowserFile', here in our sample we are setting max to '5' files to read.

Create A .NetCore Web API To Save Files To Physical Location:

Create another sample .NetCore Web API application. Then we will create an endpoint to save the files to a physical location on the server. This endpoint will be consumed by our Blazor Assembly application.

Now create a payload object for our endpoint as below.
Models/SaveFile.cs:
using System.Collections.Generic;

namespace FileUploadSample.Api.Models
{
    public class SaveFile
    {
        public List<FileData> Files { get; set; }
    }

    public class FileData
    {
        public byte[] Data { get; set; }
        public string FileType { get; set; }
        public long Size { get; set; }
    }
}
  • (Line: 12) 'Data' property of type byte[] which holds the file as byte data.
  • (Line: 13) 'FileType' property holds the file info like 'png', 'jpeg', etc.
  • (Line: 14) 'Size' property holds the size of the file uploading.
Now write an endpoint that has an implementation of saving the file to the physical folder location.
Controllers/FileUploadController.cs:
using FileUploadSample.Api.Models;
using Microsoft.AspNetCore.Mvc;
using System;
using System.Threading.Tasks;

namespace FileUploadSample.Api.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class FileUploadController : ControllerBase
    {
        [HttpPost]
        [Route("save-file-to-physicallocation")]
        public async Task<IActionResult> SaveToPhysicalLocation([FromBody] SaveFile saveFile)
        {
            foreach (var file in saveFile.Files)
            {
                string fileExtenstion = file.FileType.ToLower().Contains("png") ? "png" : "jpg";
                string fileName = $@"D:\MyTest\{Guid.NewGuid()}.{fileExtenstion}";
                using(var fileStream = System.IO.File.Create(fileName))
                {
                    await fileStream.WriteAsync(file.Data);
                }
            }
            return Ok();
        }
    }
}
  • (Line: 16) looping the collection of file information.
  • (Line: 19) the full path of the file name. It is always recommended to save the files in non-application folders on the server.
  • (Line: 20) The 'System.IO.File.Create("image_path")'  generates the file stream at the specified path.
  • (Line: 22) Saving the files array of byte data to the specified physical path.
To consume this endpoint by our Blazor Application enable cors.
Startup.cs:
namespace FileUploadSample.Api
{
// existing code hidden for display purpose
    public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
            services.AddCors(options =>
            {
                options.AddPolicy(name: "MyAllowSpecificOrigins",
                                  builder =>
                                  {
                                      builder.AllowAnyOrigin();
                                      builder.AllowAnyHeader();
                                      builder.AllowAnyMethod();
                                  });
            });
        }
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {

            app.UseRouting();

            app.UseCors("MyAllowSpecificOrigins");
        }
    }
}
  • (Line: 11) registered cors policy.
  • (Line: 25) configure the cors middleware bypassing the registered cors policy name.

Integrate HttpClient Call In Our Blazor WebAssembly Application:

Add our web API domain to HttpClient configuration in Program.cs file.
Program.cs:
builder.Services.AddScoped(sp => new HttpClient { BaseAddress = new Uri("https://localhost:5002/") });
  • Replace the Url with our web API domain in HttpClient configurations
Add a model class in our Blazor WebAssembly application for API payload this class will be the exact match of our API model we have created in prior steps
Models/SaveFile.cs:
using System.Collections.Generic;
namespace BlazorWasmFileUpload.Models
{
    public class SaveFile
    {
        public List<FileData> Files { get; set; }
    }

    public class FileData
    {
        public byte[] Data { get; set; }
        public string FileType { get; set; }
        public long Size { get; set; }
    }
}
Pages/index.razor:(Html Part)
@page "/"
@using BlazorWasmFileUpload.Models;
@inject HttpClient Http

<div>
    <InputFile OnChange="@OnFileSelection" multiple></InputFile>
    <div class="row">
        @foreach (var imgUrl in imgUrls)
        {
            <img src="@imgUrl">
        }
    </div>
    <div>
        <button type="button" class="btn btn-primary" @onclick="SaveToServer" >Upload To Server</button>
    </div>
</div>
  • (Line: 3) Injected the HttpClient
  • (Line: 14) Added a new button trigger web API to post the file data. The 'SaveToServer' is a call back method of the button click
Pages/Index.razor:(Code Part)
@code{
    List<string> imgUrls = new List<string>();
    List<FileData> fileData = new List<FileData>();
    private async Task OnFileSelection(InputFileChangeEventArgs e)
    {
        foreach (IBrowserFile imgFile in e.GetMultipleFiles(5))
        {
            var buffers = new byte[imgFile.Size];
            await imgFile.OpenReadStream().ReadAsync(buffers);
            string imageType = imgFile.ContentType;
            string imgUrl = $"data:{imageType};base64,{Convert.ToBase64String(buffers)}";
            imgUrls.Add(imgUrl);
            fileData.Add(new FileData
            {
                Data = buffers,
                FileType = imageType,
                Size = imgFile.Size
            });
        }
    }

    private async Task SaveToServer()
    {
        if (fileData.Count > 0)
        {
            var payload = new SaveFile { Files = fileData };
            await Http.PostAsJsonAsync("/api/FileUpload/save-file-to-physicallocation", payload);
        }
    }
}
  • (Line: 3) Initialized collection of 'FileData' object to hold the selected files.
  • (Line: 13) Selected files info dumped into the collection of the 'FileData' object.
  • (Line: 22) The 'SaveToServer' is the callback method of the button we created above.
  • (Line: 26) Preparing the final payload to post.
  • (Line: 27) Invoked the HttpClient post method.



Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on the Blazor WebAssembly File Upload. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

  1. Hi Naveen, can you read the file header info from IBrowserFile to check whether it is a image file? Thank you :)

    ReplyDelete
    Replies
    1. Hi,
      IBrowserFile.ContentType gives the file format png, jpg, etc we can check these file extensions to identify the file is image or not

      Delete
    2. You can get the extension of file using System.IO.Path.GetExtension(imgFile.Name)

      Delete
  2. Great work on this! Really helped me understand the Controller portion of this process! Thanks again!

    ReplyDelete
  3. Hi Naveen, IBrowserFile is not recognised with a CS0426 error. What am I missing?
    Thank you.

    ReplyDelete
    Replies
    1. Hi
      Microsoft.AspNetCore.Components.Forms.IBrowserFile

      Your project created target framework .Net5?

      Delete
    2. Hi Naveen, Newbie mistake it was core3.1. Is there a limit on file size? I can see small files but not large taken with the camera. I presume I will have to thumbnail them to show but can save the full file to the server?

      Thanks
      Francis

      Delete
    3. Hi Naveen,
      Thanks, yes the limit is 512,000 bytes. Using the RequestImageFileAsync allows the creation of a thumbnail.

      IBrowserFile imgFile = e.File;
      string imageType = imgFile.ContentType;
      var resizedImageFile = await imgFile.RequestImageFileAsync(imageType, 100, 100);
      var buffers = new byte[resizedImageFile.Size];
      await resizedImageFile.OpenReadStream().ReadAsync(buffers);
      imgUrl = $"data:{imageType};base64,{Convert.ToBase64String(buffers)}";
      Thanks again and let me by you a coffee :)

      Delete
    4. I'm glad that you have fixed your issue on your own.
      Thank you so much for supporting by a coffee

      Delete

Post a Comment

Popular posts from this blog

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http

GraphQL API Integration In Asp.Net Core Application

Introduction: GraphQL is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data. How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions. HTTP-POST is the only Http verb recommended by the GraphQL. The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API: The main building blocks of GraphQL API is Schemas and Types.  A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc. T

ASP.NET Core Web API Versioning

Introduction: An iteration and evolutionary changes of an ASP.NET Core Web API is handled by Versioning. Versioning of an API gives confidence to the clients which consumes API for a long time. Any changes or development of an API will be accessible using the new version and it won't cause issues to the clients consuming the old version of API. When To Use Versioning: Any API response changes. Developing an API by implementing testing levels like 'Alpha', 'Beta', and 'RC' versions before releasing Production. Deprecating an API which means API going to be removed or upgraded by a version within a short period. Versioning Types: Query String Versioning Url Path Versioning Media Type Versioning API Version Nuget: To Configure versioning to AspNet Core Web API Microsoft provided a library(Microsoft.AspNetCore.Mvc.Versioning). So to use the versioning library please install NuGet below.              Install-Package Microsoft.A

Blazor Server CRUD Operations

Introduction: Blazor Server is a web framework to develop server-side single-page applications. Blazor is made up of components with the combinations on C#, Html, CSS.  Blazor Server is production-ready from the .Net Core 3.0.  Blazor Server Working Mechanism: Blazor Server is a very light-weight web development framework.  In Blazor Server, not all code gets downloaded to the client browsers. Blazor Server made of components these components can be a block of code or page with respective navigation.  Blazor server application communicates with the server with a SignalR background connection which is inbuilt functionality. Application click,  form submission, change events, application page navigation every operation is carried out by the SignalR connection by communicating with the server.  Blazor updates the Html DOM very gently on every data update without any overhead. Blazor Server application maintains a nice intelligent tree structure to update the required inform