0 と 1 の世界の見習い探検家

タグ:dotnet

WordPress の API.NET のプログラムでつついていたところ、記事の投稿操作を行った際に下記のエラーが発生。
すぐに気付けたけど沼る方もいそうだなと思ったため、念のための備忘録です。
StreamWriter 使って Stream に JSON を書いてる方に当てはまるかも。

WordPress から返ってきたエラーの内容↓
rest_invalid_json: 無効な JSON ボディが渡されました。

結論
.NET の StreamWriter を使う際は、BOM に気をつけよう


無効な JSON というので、どんな壊れた内容で API をコールしてしまったのかとデバッガを覗いたところ、
見た目上はきれいな JSON が渡されているようでした。
見た目上は。

20240125-03_json


問題は、リクエスト時に送信する JSON を StreamWriter を使って Stream に書いていた時に起こっていました。
まずシリアライズ ツールを使って生成した JSON を String 型の文字列に格納し、その後送信用の Stream に StreamWriter を使って書いていました。

こんな感じ
var json = JsonSerializer.Serialize(obj, this._serializerOptions);
var ms = new MemoryStream();
using (var sw = new StreamWriter(ms, Encoding.UTF8, 512, true))
{
    await sw.WriteAsync(json);
}

良くなかったのがここで StreamWriter の Encoding 指定に Encoding.UTF8 を使っていたこと。
書き込み先の Stream の頭に BOM が付与されてしまい、それで受け取った側の WordPress が壊れた JSON として認識したようです。

雑なサンプルコードですが、UTF8 を使いたい場合は Encoding.UTF8 を使わずに、UTF8Encoding を new して、コンストラクタの第一引数に false を与えてあげましょう。BOM が付与されなくなります。

var json = JsonSerializer.Serialize(obj, this._serializerOptions);
var ms = new MemoryStream();
using (var sw = new StreamWriter(ms, new UTF8Encoding(false), 512, true))
{
    await sw.WriteAsync(json);
}


まぁそもそも、使っているシリアライザが System.Text.Json 名前空間のものなのですが、
デバッガで見た内容からして、ASCII で送信可能な状態にエンコーディングしてくれているので、UTF8 を使う必要がないと言えば無いのですが、ちょっとデバッグ目的で使いたて……ですね…… (もごもご)

20240125-01_netsdk1054errormsg

.NET Standard で NuGet 用のパッケージ (*.nupkg) を出力しようとした際、下記エラーが発生して出力できなかったときの備忘録。

.NET Standard で「パック」を行おうとしたところ、下記エラーメッセージが表示され出力に失敗しました。
NETSDK1054: .NET Core のみがサポートされています。

対象の .NET Standard プロジェクトのプロパティを開き、[パッケージ] > [全般] > 「.NET ツールとしてパック」の項目を探す。
間違えてチェックをオンにしてしまったようだが、下記は .NET Standard のプロジェクトでは非対応のようなので、チェックを外してください。

20240125-02_check

エラーの言っている .NET Core のみのサポートの話を参照している外部の NuGet パッケージのバージョンの問題だと誤解して、一生懸命バージョンを下げたりしていたが、なんのこともなかった……。

どうもこんにちは、青砥です。
最近発見して便利だと思ったナレッジを共有します。

アセンブリのバージョンなどでビルド時の日時を使用する方法について書き遺しておきます。


awpioetvj4tj-02
図 1 ビルド結果

Visual Studio のプロジェクトのプロパティで、アセンブリや NuGet Package (*.nupkg) のバージョンを指定するかと思いますが、ここで「ビルド時の日時」を使用した動的なバージョン番号の生成を可能にする方法を見つけました。

まずは結論から。
$([System.DateTime]::Now.ToString('0.yy.M.dHH'))

qad34vtuwm04t
図 2 プロジェクト プロパティでの指定


DateTime オブジェクトを ToString しているイメージです。
yy.M.dHH なので下記のようになります。

図 3 例の書式指定の場合のバージョン番号生成結果


上記は .NET Standard 2.0 ライブラリのプロジェクトのプロパティですが、おそらく Visual Studio 2022 上であれば他の .NET Framework 向けプロジェクトなどでも利用可能かと思います。


仕組み
Visual Studio ではプロジェクト プロパティで利用可能な変数のような仕組みが存在します。

(参考)
MSBuild の予約済みおよび既知のプロパティ - MSBuild | Microsoft Learn
https://learn.microsoft.com/ja-jp/visualstudio/msbuild/msbuild-reserved-and-well-known-properties?view=vs-2022

例えば、プロジェクト プロパティでは出力アセンブリ名がデフォルトではプロジェクトと同名になるよう下記のような指定になっております。

図 4 出力するアセンブリ名の指定


上記の例ではプロジェクトに関する各種値を提供する機能からプロジェクト名を値として利用しています。このような変数機能の他に「プロパティ関数」と呼ばれる動的な値の呼び出しも一部提供されているようです。

(参考)
プロパティ関数 - MSBuild | Microsoft Learn
https://learn.microsoft.com/ja-jp/visualstudio/msbuild/property-functions?view=vs-2022

上記のページで紹介されている例を見てみるとなんとなく分かる通り、どうも PowerShell をワンライナーで実行しているようなイメージのようです。
そのため、結論に記載した通り、System.Date の Now プロパティで現在 (実行はビルド時なのでビルド時現在) の日時情報を DateTime オブジェクトで取得し、ToString メソッドで好きな形式に書式調整してあげれば、日時から動的にバージョン番号を生成することができるようになります。

DateTime の文字列化時の書式設定については下記ページをご参照ください。
(参考)
DateTime.ToString メソッド (System) | Microsoft Learn
https://learn.microsoft.com/ja-jp/dotnet/api/system.datetime.tostring?view=net-7.0

もっとわかりやすい MS 以外が公開しているドキュメントも参考になるかとは思いますがw


開発中途版などで中間成果物を短いスパンでリリースするなどの利用目的にハマると思います。

ご参考までに。

どうもご無沙汰しております、青砥です。
この度初めて NuGet でパッケージを公開してみました。

その名も「MisskeySharp」、、






最近 Twitter の代替 SNS が再び勢い付いており、そのうちの一つが Misskey です。
Misskey は個人により開発されているようですが、そのシュールで豊富なリアクション スタンプの種類、また 1 投稿でかなりの長文が打てるところが特長です。

さて、そんな Misskey でこの度とある bot を公開したいと思い、.NET で開発いたしました。
もともとは Twitter の bot として動かしていたものなのですが、イロマス政権の重大製作の 1 つ「Twitter API 有償化」などの影響を受け、Twitter では運用できなくなってしまったものです。

Misskey は .NET 用のクライアントとして Misq という高機能なライブラリがすでに提供されているようでしたが、ターゲット フレームワークが .NET Framework 4.x で止まっており、.NET 6 のプロジェクトから利用を試みたところ、.NET 5 以降ではどうもうまく動かなくなってしまっているようでした。

そこで、私自身の Misskey API の勉強も兼ね、.NET Standard で新たにライブラリを開発することにいたしました。


現状のバージョンは開発中途版という扱いで、標準機能で利用できるものも主にノートの投稿、検索、フォロワー / フォロイーの一覧取得程度です。
今後、機能をどんどん増やしていきたいと思います。

Misskey の API はとても単純明快で、叩きやすい造りになっているところが面白いなと思いました。
みなさんもいかがでしょうか。

このページのトップヘ