Blazor でUSPS データにリアルタイムで連携するアプリを構築

詳細情報をご希望ですか?

製品の詳細情報:

USPS 連携ソリューション


ASP.NET Core Blazor C# でUSPS にSQL でクエリ。



Blazor は、.NET を使って対話型のクライアント側Web UI を構築するためのフレームワークです。JavaScript の代わりにC# を使って、UI を作れるところが魅力です。また、既存の.NET ライブラリや.NET エコシステムを使うことができる利点があります。

CData ADO.NET Provider for USPS は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってUSPS を操作可能にします。Blazor が.NET Core 対応をしているため、Server Side Blazor からADO.NET Provider を使うことができます。この記事では、Server Side Blazor からUSPS に接続して直接SQL クエリを実行する方法を説明します。

CData ADO.NET Provider for USPS のインストール

CData ADO.NET Provider は、通常であればRDB に接続するフレームワークである ADO.NET DataAdapter やLinqToSQL(もしくはDapper などのORM を挟んでもいいです)であり、USPS のデータへもRDB と同感覚でアクセスが可能になります。

CData のWebsite からProvider をダウンロードして、マシンにインストールします。NuGet からインストールすることも可能です。USPS ADO.NET Data Provider で検索してください。

Blazor でUSPS にデータ連携するアプリを構築

Blazor にADO.NET Provider for USPS を接続

  • Visual Studio を立ち上げて、Blazor アプリのプロジェクトを作成します。
  • ソリューションエクスプローラーで「依存関係」から右クリックで「プロジェクト参照の追加」をクリック。
  • 参照マネージャーが開くので、「参照」ボタンをクリックして、先ほどインストールしたADO.NET Provider の.dll を選択します。「C:\Program Files\CData\CData ADO.NET Provider for USPS 2019J\lib etstandard2.0」内のSystem.Data.CData.USPS.dll」を参照に選びます。

Blazor でUSPS データをSELECT

サンプルプロジェクトの「Page」→「Index.razor」を開きます。

以下のコードを書きます。使っているクエリはおなじみの標準SQL です。USPS 固有のAPI を書かなくてもRDB と同感覚でSQL が書けるところがADO.NET Prover for USPS の強味です。

    
      @page "/"
      @using System.Data;
      @using System.Data.CData.USPS;
      
      

Hello, world!

Welcome to your Data app.
@using (USPSConnection connection = new USPSConnection( "PostageProvider=ENDICIA; RequestId=12345; Password='abcdefghijklmnopqr'; AccountNumber='12A3B4C'")) { var sql = "SELECT FirstName, Phone FROM Senders WHERE SenderID = '25'"; var results = new DataTable(); USPSDataAdapter dataAdapter = new USPSDataAdapter(sql, connection); dataAdapter.Fill(results); @foreach (DataColumn item in results.Rows[0].Table.Columns) { } @foreach (DataRow row in results.Rows) { @foreach (var column in row.ItemArray) { } }
@item.ColumnName
@column.ToString()
}

USPS に認証するには、次の接続プロパティを設定してください。

  • PostageProvider:リクエストの処理に使用するポステージプロバイダです。利用可能なオプションはENDICIA とSTAMPS です。指定されていない場合、 デフォルトはENDICIA です。
  • UseSandbox:ライブまたはテストリクエストを、運用サーバーに送るかサンドボックスサーバーに送るかを制御します。 true に設定した場合、Password、AccountNumber、StampsUserId プロパティは無視されます。
  • StampsUserId:この値はStamps サーバーに認証してログインするために使用されます。この値は Endicia には使用されず、UseSandbox がtrue の場合はオプションです。
  • Password:この値はEndicia とStamps サーバーへのログインに使用されます。ポステージプロバイダがEndicia の場合、この値はポステージアカウントに紐づけられたパスフレーズになります。 UseSandbox がtrue の場合にはオプションです。
  • AccountNumber:郵送者のアカウント番号です。UseSandbox がtrue の場合にはオプションです。
  • PrintLabelLocation:このプロパティは、GenerateLabels またはGenerateReturnLabels ストアドプロシージャを使用する場合には必須です。 生成されたラベルが格納されているフォルダの場所を指定してください。

キャッシュデータベース

USPS から利用可能な有用なタスクには多くのデータを要求します。データの入力を簡単にして後日思い出せるようにするには、 キャッシュデータベースを使用してリクエストを行ってください。キャッシュの使用にはキャッシュ用の接続プロパティを設定してください。

  • CacheLocation:デフォルトのキャッシュプロバイダーで接続が設定される、キャッシュの場所へのパスです。例えば、C:/users/username/documents/uspscache

CacheLocation の代わりに、CacheConnectionCacheProvider を設定して デフォルト以外のプロバイダーを使用してキャッシュ接続を設定することもできます。

プロジェクトをリビルドして実行します。このようにUSPS からデータを直接取得し、HTML テーブル形式にレンダリングしています。

もちろんSaaS データソースへの接続の場合には、RDB 向けのドライバーと違い最終的にはHTTP リクエストが行われるので、サーバーサイド Blazor としてサーバーサイドから実行されるのか、クライアントサイド Blazor として、実行中のブラウザからHTTPリクエストが行われるのかの違いはあります。そのあたりはネットワークやプロキシの設定として注意が必要でしょう。設定はコード内の接続プロパティで可能です。

まとめ

このようにサーバーサイドBlazor アプリから簡単にADO.NET Provider を使ってUSPS にリアルタイムでデータ取得を行うアプリを作ることができました。Blazor が.NET Core、フレームワークのツール群を使えるというメリットを活かすことができます。今回はSELECT * でしたが、フィルタリングやJOIN も可能です。INSERT、UPDATE、DELETE も標準SQL で書くことができます。是非、30 日の無償トライアル でシンプルかつパワフルなADO.NET Provider でのサーバーサイドBlazor 連携をお試しください。