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
  4. great article, clear and usefull.

    ReplyDelete
  5. This method should be avoided. The use of "PostAsJsonAsync" will serialize the byte[] as base64 (and will be deserialized automatically when reaching the controller) adding 30% to the request length

    ReplyDelete

Post a Comment

Popular posts from this blog

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

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

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

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

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo