ASP.NET MVCでバーコードを動的に生成および表示する方法

IronBarcode

IronBarcodeは、.NETアプリケーションでバーコード画像を作成、読み取り、操作するための幅広い機能を提供する人気の.NETバーコードライブラリです。 このライブラリは、.NETコンポーネントとライブラリを専門とするソフトウェア開発会社であるIron Softwareによって開発およびメンテナンスされています。 IronBarcodeは、Code 128、Code 39、QRコード、Data Matrix、PDF417など、幅広いバーコード形式をサポートしています。また、ライブラリにはカスタム寸法、色、フォントでバーコードを生成したり、バーコード画像にテキストやロゴを追加したりする機能も備えています。

バーコード生成に加えて、IronBarcodeにはバーコード画像の読み取りとデコード機能も含まれています。 このライブラリは、画像、PDFドキュメント、ライブカメラフィードからのバーコードの読み取りとデコードが可能です。 1Dと2Dの両方のバーコード形式をサポートしており、部分的に隠れたまたは破損したバーコードでも認識できます。

前提条件

.NETアプリケーションでIronBarcodeを使用する前に、満たす必要のあるいくつかの前提条件があります。

1. .NET Frameworkまたは.NET Core: IronBarcodeは、.NET Frameworkと.NET Coreの両方で動作するように設計されています。 開発環境に適切な.NETバージョンがインストールされていることを確認してください。
2. Visual Studio: IronBarcodeは、簡単に開発およびテストできるようにVisual Studioに統合できます。 Visual Studio Community、Professional、またはEnterpriseエディションを使用できます。 Visual Studioのウェブサイトからダウンロードできます。
3. IronBarcodeライブラリ: Iron SoftwareのウェブサイトまたはNuGetパッケージマネージャー経由でIronBarcodeライブラリをダウンロードしてインストールします。 NuGetパッケージマネージャーコンソールを使用して次のコマンドを実行することで、ライブラリをインストールできます：Install-Package BarCode。

IronBarcodeは開発用には無料ですが、商用および配布目的で使用するにはライセンスが必要です。 そのすべての機能をテストするために無料トライアルを試すことができます。

新しいASP.NET MVCプロジェクトを作成する

Visual Studioを開き、新しいプロジェクトを作成をクリックします。

新しいウィンドウで「ASP.NET MVC（Webアプリ） モデルビュコントローラ」を選択し、次へボタンをクリックします。

新しいプロジェクトの名前とその場所を入力して、次へをクリックします。

使用したい.NETバージョンを選択し、他のオプションはそのままにして作成をクリックします。

.NETプロジェクトが作成されます。

IronBarcodeのインストール

IronBarcodeを使用してバーコード画像を生成し表示する

環境が整ったら、ASP.NET MVCでバーコード画像を動的に生成するためのコードの書き方を始められます。

まず、モデルフォルダ内にGenerateBarcodeModel.csという名前のクラスを作成します。

using System.ComponentModel.DataAnnotations;

namespace GenerateBarcodeMVCCore6_Demo.Models
{
    public class GenerateBarcodeModel
    {
        [Display(Name = "Enter Barcode Text")]
        public string Barcode { get; set; }
    }
}

using System.ComponentModel.DataAnnotations;

namespace GenerateBarcodeMVCCore6_Demo.Models
{
    public class GenerateBarcodeModel
    {
        [Display(Name = "Enter Barcode Text")]
        public string Barcode { get; set; }
    }
}

Imports System.ComponentModel.DataAnnotations

Namespace GenerateBarcodeMVCCore6_Demo.Models
	Public Class GenerateBarcodeModel
		<Display(Name := "Enter Barcode Text")>
		Public Property Barcode() As String
	End Class
End Namespace

生成されたバーコード画像を保存するために、wwwrootフォルダ内に「GeneratedBarcode」という名前のフォルダを作成します。

「controllers」フォルダ内のHomeController.csクラスに以下のアクションメソッドを追加します。

using Microsoft.AspNetCore.Mvc;
using IronBarCode;
using System;
using System.Drawing;
using System.IO;

namespace YourNamespace.Controllers
{
    public class HomeController : Controller
    {
        private readonly IWebHostEnvironment _environment;

        public HomeController(IWebHostEnvironment environment)
        {
            _environment = environment;
        }

        public IActionResult CreateBarcode()
        {
            return View();
        }

        // Handling POST operation inside this Action method
        [HttpPost]
        public IActionResult CreateBarcode(GenerateBarcodeModel generateBarcode)
        {
            try
            {
                // Create a barcode using the input text
                GeneratedBarcode barcode = BarcodeWriter.CreateBarcode(generateBarcode.Barcode, BarcodeWriterEncoding.Code128);

                // Adding annotation text to barcode
                barcode.AddBarcodeValueTextBelowBarcode();

                // Styling the Barcode
                barcode.ResizeTo(400, 120);
                barcode.ChangeBarCodeColor(Color.Red);
                barcode.SetMargins(10);

                // Define path to save the barcode image
                string path = Path.Combine(_environment.WebRootPath, "GeneratedBarcode");
                if (!Directory.Exists(path))
                {
                    Directory.CreateDirectory(path);
                }

                // Save the generated barcode as a PNG file
                string filePath = Path.Combine(_environment.WebRootPath, "GeneratedBarcode/barcode.png");
                barcode.SaveAsPng(filePath);

                // Get the file name and URL for the generated barcode image
                string fileName = Path.GetFileName(filePath);
                string imageUrl = $"{this.Request.Scheme}://{this.Request.Host}{this.Request.PathBase}/GeneratedBarcode/{fileName}";
                ViewBag.QrCodeUri = imageUrl;
            }
            catch (Exception)
            {
                throw;
            }
            return View();
        }
    }
}

using Microsoft.AspNetCore.Mvc;
using IronBarCode;
using System;
using System.Drawing;
using System.IO;

namespace YourNamespace.Controllers
{
    public class HomeController : Controller
    {
        private readonly IWebHostEnvironment _environment;

        public HomeController(IWebHostEnvironment environment)
        {
            _environment = environment;
        }

        public IActionResult CreateBarcode()
        {
            return View();
        }

        // Handling POST operation inside this Action method
        [HttpPost]
        public IActionResult CreateBarcode(GenerateBarcodeModel generateBarcode)
        {
            try
            {
                // Create a barcode using the input text
                GeneratedBarcode barcode = BarcodeWriter.CreateBarcode(generateBarcode.Barcode, BarcodeWriterEncoding.Code128);

                // Adding annotation text to barcode
                barcode.AddBarcodeValueTextBelowBarcode();

                // Styling the Barcode
                barcode.ResizeTo(400, 120);
                barcode.ChangeBarCodeColor(Color.Red);
                barcode.SetMargins(10);

                // Define path to save the barcode image
                string path = Path.Combine(_environment.WebRootPath, "GeneratedBarcode");
                if (!Directory.Exists(path))
                {
                    Directory.CreateDirectory(path);
                }

                // Save the generated barcode as a PNG file
                string filePath = Path.Combine(_environment.WebRootPath, "GeneratedBarcode/barcode.png");
                barcode.SaveAsPng(filePath);

                // Get the file name and URL for the generated barcode image
                string fileName = Path.GetFileName(filePath);
                string imageUrl = $"{this.Request.Scheme}://{this.Request.Host}{this.Request.PathBase}/GeneratedBarcode/{fileName}";
                ViewBag.QrCodeUri = imageUrl;
            }
            catch (Exception)
            {
                throw;
            }
            return View();
        }
    }
}

Imports Microsoft.AspNetCore.Mvc
Imports IronBarCode
Imports System
Imports System.Drawing
Imports System.IO

Namespace YourNamespace.Controllers
	Public Class HomeController
		Inherits Controller

		Private ReadOnly _environment As IWebHostEnvironment

		Public Sub New(ByVal environment As IWebHostEnvironment)
			_environment = environment
		End Sub

		Public Function CreateBarcode() As IActionResult
			Return View()
		End Function

		' Handling POST operation inside this Action method
		<HttpPost>
		Public Function CreateBarcode(ByVal generateBarcode As GenerateBarcodeModel) As IActionResult
			Try
				' Create a barcode using the input text
				Dim barcode As GeneratedBarcode = BarcodeWriter.CreateBarcode(generateBarcode.Barcode, BarcodeWriterEncoding.Code128)

				' Adding annotation text to barcode
				barcode.AddBarcodeValueTextBelowBarcode()

				' Styling the Barcode
				barcode.ResizeTo(400, 120)
				barcode.ChangeBarCodeColor(Color.Red)
				barcode.SetMargins(10)

				' Define path to save the barcode image
				Dim path As String = System.IO.Path.Combine(_environment.WebRootPath, "GeneratedBarcode")
				If Not Directory.Exists(path) Then
					Directory.CreateDirectory(path)
				End If

				' Save the generated barcode as a PNG file
				Dim filePath As String = System.IO.Path.Combine(_environment.WebRootPath, "GeneratedBarcode/barcode.png")
				barcode.SaveAsPng(filePath)

				' Get the file name and URL for the generated barcode image
				Dim fileName As String = System.IO.Path.GetFileName(filePath)
				Dim imageUrl As String = $"{Me.Request.Scheme}://{Me.Request.Host}{Me.Request.PathBase}/GeneratedBarcode/{fileName}"
				ViewBag.QrCodeUri = imageUrl
			Catch e1 As Exception
				Throw
			End Try
			Return View()
		End Function
	End Class
End Namespace

上記のコード内のアクションメソッドは、後で作成するビューから生成される送信要求を処理します。 IronBarcodeを使用すると、バーコード形式、画像要素、バーコードフォント、HTML画像要素をカスタマイズできます。 さらにカスタマイズするためには、バーコードフォントのインストール用にIron Drawingなどの追加ライブラリが必要な場合もあります。 より詳細なAPIドキュメントはこちらで見つけることができます。

バーコードジェネレーターのメソッド用にビューを作成できます。

HomeController.csファイル内でCreateBarcodeメソッドを右クリックし、ビューの追加をクリックします。

Razorビューを選択し、追加をクリックします。

以下の画像に示すようにパラメーターを選択し、追加をクリックします。 そのメソッド用のビューが自動的に追加されます。

生成されたコードを変更して、インターフェースを望む形に変更できます。

@model GenerateBarcodeMVCCore6_Demo.Models.GenerateBarcodeModel

@{
    ViewData["Title"] = "CreateBarcode";
}

<h1>CreateBarcode</h1>

<form asp-action="CreateBarcode" method="post">
    <div>
        <label asp-for="Barcode"></label>
        <input asp-for="Barcode" />
        <span asp-validation-for="Barcode"></span>
    </div>
    <button type="submit">Generate Barcode</button>
</form>

@if (ViewBag.QrCodeUri != null)
{
    <div>
        <img src="@ViewBag.QrCodeUri" alt="Barcode Image" />
    </div>
}

@section Scripts {
    @{await Html.RenderPartialAsync("_ValidationScriptsPartial");}
}

すべてのセットアップが完了したら、_Layout.cshtmlファイルを開き、navbarにCreateBarcodeオプションを追加するためのコードを追加します。

<li class="nav-item">
    <a class="nav-link text-dark" asp-controller="Home" asp-action="CreateBarcode">CreateBarcode</a>
</li>

<li class="nav-item">
    <a class="nav-link text-dark" asp-controller="Home" asp-action="CreateBarcode">CreateBarcode</a>
</li>

アプリケーションを実行し、テキストフィールドにテキストを書き、バーコード生成ボタンをクリックすると、バーコード画像が動的に生成され表示されます。