(株)アイジュピタ情報ライブラリ

EntityFrameworkにおけるSystem.ArgumentException。

ある日、あるプロジェクトでのことです。

EntityFrameworkで何らかの項目をSelectしている箇所で、以下のような例外が発生することを報告されました。

System.ArgumentException: 指定された値は型 'Edm.Int32' のインスタンスではありません

しかし筆者の環境では発生せず。

どうしてだろうと首を傾げつつ調査すると、まさかの事実が発覚しました。

例外の原因自体は「.NET Framework4.0ではEnumが使えないから」という単純なものなのですが、実はそれはプロジェクトで使用するバージョンではなく、

.Net Frameworkのインストールバージョンに依存するものだったのです。

筆者のマシンにインストールされている.NET Frameworkのバージョンは4.5。
例外が発生したマシンにインストールされているのは4.0。

プロジェクト自体は4.0で作成されていますが、それぞれのマシンにインストールされているFrameworkのバージョンが違うため、例外の発生状況が違ってしまっていたもようです。

以下に挙げた参考ページでも、回答の1つに「.NET Frameworkを4.5にしたらコード変えなくてもエラーでなくなったよ(意訳)」というのがありました。


結局この例外はEnumをintに置換することで回避しましたが(コードについては参考ページをご覧ください)、チーム内の環境が違うとこういうこともあるんだなーと考えさせられました。

C# 静的コードチェックツール StyleCop

C# 静的コードチェックツール StyleCopについて

http://stylecop.codeplex.com/

はじめに

http://msdn.microsoft.com/ja-jp/library/vstudio/ff926074.aspx

C#にはMSで使用しているコーディング規約があり、VisualStudioのコード整形のデフォルト動作なんかも、その規約に従って整形するようになっています。

特に問題なければ、こちらに合わせて記述した方がよいのですが、なかなか記述漏れなどを目視でチェックするのは難しいです。

そこで静的解析ツールなるものを使用すると違反をチェックできるのですが、C#の場合はMicrosoftからリリースされています。

それがStyleCopです。

インストール

※StyleCopは Visual Studio 2008、2010、2012 に対応しているツールです。これらの環境がインストールされていることを確認してください。

http://stylecop.codeplex.com/

以上のURLからmsiファイルをダウンロードし、インストールを実行します。

使い方

では、さっそく使ってみましょう。

StyleCopをインストール後、Visual Studioを起動して、C#のプロジェクトを選択してコンテキストメニューを開くとStyleCopの項目が追加されています。



作成されたばかりのWindows Formアプリケーションでさっそく実行してみると…。



おおぉ。いきなり36個も警告が出ています。

英語ベースですのでわかりにくいですが、書いてある内容は簡単なので以下のページを参考にしながら考えていきます。

http://www.stylecop.com/docs/
(なぜかアクセスできないときがある)
http://stylecop.soyuz5.com/StyleCop%20Rules.html
(4.5なのでちょっと古いけど、こちらの方がアクセスできる)


SA1101

フォームデザイナが吐き出すDisposeメソッドで、まず次のように怒られています。


SA1101 : CSharp.Readability : The call to components must begin with the 'this.' prefix to indicate that the item is a member of the class.

メンバーアクセスにはthisプレフィックスをつけなさい。って言われてますね。

最初からつけとけよーーていう突っ込みはさておき、つけてみましょう。



もう一度 Run StyleCopを実行すると、見事消えたのが確認できます。


SA1126

さて次です。


SA1126 : CSharp.Readability : The call to InitializeComponent must begin with the 'this.', 'base.', object.' or 'Form1.' or 'Form.' prefix to indicate the intended method call.

InitializeComponentメソッドのコールにプレフィックスがないから、何かつけなさないって怒られます。

InitializeComponentはForm1のプライベートメソッドの為、thisを付けます。




SA1200

じゃんじゃん行きましょう。


SA1200 : CSharp.Ordering : All using directives must be placed inside of the namespace.

・・・・・・・・・?
using句をnamespaceの中に入れなさい。

・・・・すみません。自分この警告を見るまで、namespaceの中にusingを書ける事すら知りませんでした。^^;

この規約はうち的には無しってことで、警告から除外しましょう。

コンテキストメニューから「StyleCop settings」を選択します。



今回除外したいのはOrderingの SA1200なので、それを探してチェックをOFFにします。




SA1400

まだ、21個も残っています。頑張ります。


SA1400 : CSharp.Maintainability : The class must have an access modifier.

アクセス修飾子をつけなさいって怒られます。

Programクラスなんてアセンブリの外に出る必要がないので、ここではinetrnalを付けておきます。
もちろんクラスによって必要な修飾子は違うので注意です。



Form1.Designerクラス内のpartialクラスでも怒られます。

この場合もう片割れをみるんじゃねーの?と思わんでもないですが、まぁ省略しちゃダメっていうのもわかるのでここは、Form1.cs側でpublicと指定されているのを確認して、同じようにpublic指定します。




SA1507

SA1507 : CSharp.Layout : The code must not contain multiple blank lines in a row.

空行が複数続いているぜ。

…厳しい…が、確かに無駄な空行はコードの見た目を崩す…ということで、ここも直します。


SA1513


SA1513 : CSharp.Layout : Statements or elements wrapped in curly brackets must be followed by a blank line.

これちょっと悩みました。

http://stylecop.soyuz5.com/SA1513.html
を見てもこんな書き方してないし。

よく読みなおすと、}の次にステートメントをを書く場合、改行を入れなさい…ってことで、このように直します。




SA1600


SA1600 : CSharp.Documentation : The class must have a documentation header.

クラスヘッダ書いてないよってことですね。ちゃんとサマリーつけましょう。




SA1601


SA1601 : CSharp.Documentation : The partial class element must have a documentation header containing either a summary tag or a content tag.

partialクラスの場合は、summaryかcontentタグを持ったヘッダが必要ってことで、こちらもsummaryを追加します。




SA1630

SA1630 : CSharp.Documentation : The documentation text within the summary tag does not contain any whitespace between words, indicating that it most likely does not follow a proper grammatical structure
required for documentation text.

要約すると、コメントにスペース含まれてないから文章おかしくないか?ということですが、英語前提なので、これはルールから外します。


同様に、SA1642,SA1643,SA1650も英語のお話なので、ルールから外します。


SA1633

ついに最後になりました。

SA1633 : CSharp.Documentation : The file has no header, the header Xml is invalid, or the header is not located at the top of the file.
ファイルヘッダが無い事ことで、ファイルヘッダを付けますが、ここで注意。

クラスのコメントなどは、ほぼXMLコメントで記載している方が大半だと思いますが、ファイルのヘッダは割と会社毎に独自フォーマットがあるように思われます。

Microsoft的なファイルヘッダは次の形になるようです。
http://stylecop.soyuz5.com/SA1633.html



もしファイルヘッダの記述方法を独自にする場合は、SA1634~SA1649までは無効化します。

変えることが可能な場合は、この際なので、Microsoft形式に合わせておいた方がファイル名の一致などもStyleCopがチェックしてくれるため、便利です。


さいごに

やっときえたーーーーーーー!!!!!!!

この作業、コーディングの最後にまとめて…なんてとてもできません。
こまめに実行して、修正していくことをお勧めします。

では、よいC#ライフを!

フルカラービットマップからグレースケールビットマップへの変換(5)--BitmapData.Strideプロパティ

前項までの記事の初出時、コメント欄にて情報を頂きましたので追記しておきます。
1行のバイト数を取得するBitmapData.Strideプロパティという便利なものがあるということで、早速使ってみました。

フルカラービットマップからグレースケールビットマップへの変換(4)--処理時間の短縮

前項で描画時間の計測が可能になったので、処理の高速化が図れないかを検証します。
注意点
本節での処理時間計測は、Releaseビルドのデバッグなしで実行しています。

現状の把握
まずは現状のソースファイルですが、以下のようになっているかと思います。

この状態で、1280×1024の画像をグレースケール化すると、(私の環境では)概ね1156ms程度かかります。計測点を、ネストしているfor文の前後に移動しても、さほど違いが見られなかったため、このネストしているfor文の処理時間が短縮できれば、全体の処理速度も速くなるはずです。

記述こそ単純ですが、無駄な計算を何度も行っており、非常に遅いです。これから順にチューンアップしていきます。
まず、インデックスの算出を何度も繰り返しているため、その部分に手を入れます。


これで、400msほど高速化できました。


次に、インデックスのY成分を算出している部分は、Xのループの外に出せますので、修正します。


これで、300msほど高速化できました。


インデックス記述ではなく、ポインタの参照外しに修正します。


若干ではありますが高速化しているようです。


最終的には、以下となりました。


処理速度も、申し分ないレベルです。

フルカラービットマップからグレースケールビットマップへの変換(3)--処理時間の計測

前項で使用したコードを用いて、実際にどの程度の処理時間を要するかを知るための方法を示します。
下準備

計測結果を表示するために、フォーム上にラベルを作成しておいてください。





フルカラービットマップからグレースケールビットマップへの変換(2)--ビットマップのデータ構造

前エントリの最後に書いたバグの話です。
(1)に示したコードのバグ

前エントリで示したコードでは、壁紙サイズ等の無難なサイズの画像ではうまく動きますが、半端な画像サイズでは、以下のように、出力結果が不正となります。




実際にどのような画像で不具合が出るのかを知るためには、ビットマップのピクセルデータの構造を知る必要があります。
実際の構造は、
ビットマップデータ
このブロックは、イメージを各ピクセルごとに記述する。ピクセルは通常左から右へ、下から上に向かって保存されている。各ピクセルは1バイト以上で記述されている。もし水平方向のバイト数が4の倍数ではないときは、ヌル (0x00)で埋めて4の倍数にする。
Windows bitmap - Wikipedia
となっており、1行あたりのバイト数が4の倍数にならない場合、バグが発現することになります。

上記で示した画像のサイズは、222×628となっており、入力画像(24bitカラー)の1行あたりのバイト数は222×3=666バイトとなります。これを4で割ると、144余り2となるため、入力画像が、1行あたり2バイトずつずれてしまうことになります。また、出力画像(8bitグレースケール)の1行あたりのバイト数は222×1=222バイトとなり、これを4で割ると、55余り2となるため、出力画像も、1行あたり2バイトずつずれてしまうことになります。

これを改善するためには、1行あたりのずれを考慮し、ピクセルデータのインデックスにオフセット値を加える必要があります。
以下にコードを示します。


これにより、冒頭で示したバグが改善されます。

フルカラービットマップからグレースケールビットマップへの変換(1)

C#によるフルカラービットマップからグレースケールビットマップへの変換処理について、まとめてみました。
下準備(プロジェクトの作成)

Winfowsフォームアプリケーションを新規作成します。プロジェクト名は、ImageFiltersとしておきます。
以下のようなフォームを作成します。

ボタンを2つ、パネルを1つ、(パネル内に)ピクチャボックスを1つ配置します。

2つのボタンのAnchorプロパティをbottom,leftに設定します。
パネルのAutoScrollプロパティをtrueに、Anchorプロパティをtop,bottom,left,rightに設定します。
ピクチャボックスのSizeModeプロパティをAutoScrollに設定します。
2つのボタンをダブルクリックし、イベントハンドラのコードを生成します。

下準備(ビットマップの表示)

次に、ボタン1をクリックすると、ファイル選択ダイアログが開き、選択された画像がパネル内に表示されるようにします。
ここで、button1という名前は不適切なので、NameプロパティをbuttonLoadに変更します。また、Textプロパティを「読み込み」に変更します。
イベントハンドラの名前(button1_Click)も適切な名前に変更する必要があります。イベントハンドラ名の上にマウスカーソルを持っていき、[リファクタ]→[名前の変更]を選択します。

新しい名前にbuttonLoad_Clickを選択し、OKを押します。


変更箇所のプレビューが表示されます。ここでは、メソッド名と同様に、イベントハンドラの登録部分が変更されることを確認します。
Form1というクラス名等も不適切ですので、同様に変更しておくと良いでしょう。

buttonLoadがクリックされた際に行う処理は、以下となります。
  • ファイルオープンダイアログを開き、画像を選択する
  • 選択した画像を元にしてBitmapクラスのオブジェクトを作成する
  • 作成したBitmapクラスのオブジェクトをピクチャボックスに設定する
上記を実装したコードを以下に示します。なお、フォームの名前をImageFiltersFormに、ピクチャボックスの名前をpictureBoxに、パネルの名前をpanelに変更しています。さらに、Bitmapクラスのオブジェクトを保持するため、bitmapというメンバ変数を追加しています。


ここまでの作業で、以下のように、ビットマップ画像をパネルに表示することが可能になりました。


グレースケール化

次に、ボタン2をクリックすると、パネル上にグレースケール化された画像が表示されるようにします。
button2についても、(button1と同様に)不適切な名前のため、buttonExecに変更します。イベントハンドラ名も同様に変更します。
buttonExecがクリックされた際に行う処理は、以下となります。ここでは、簡単のため、24bitフルカラー画像から8bitグレースケール画像への変換のみを考慮します。
  • 出力ビットマップの領域確保
  • 入出力ビットマップをシステムメモリにロック
  • ポインタを介して、pixcel毎にグレースケール化
  • グレースケールのパレット情報の設定
  • 入出力ビットマップのロックを解除
以下のような疑似コードを元に、順次実装していきます。System.Drawing.Imagingにあるクラスを使用するため、事前にusing指定しておくと良いかと思います。また、ポインタを使用するunsafeブロックが存在するため、プロジェクトの設定を変更し、unsafeコードを許可する必要があります。


出力ビットマップを保持するために、事前に、grayscaleというメンバ変数を追加します。
出力ビットマップの領域は、以下のように確保します。別途、パレット情報を与える必要がありますが、それについては後述します。


次に、ビットマップをシステムメモリ上の特定の位置にロックすることで、ポインタを介したデータ操作を可能にします。入力ビットマップはリードオンリー、出力ビットマップはライトオンリーとしています。


上記の処理により、入力ビットマップと出力ビットマップのピクセルデータの先頭アドレスが取得できたので、ピクセル毎にグレースケール化を行います。グレースケール化の方法は、RGB値の平均値を使用しています。


8ビットインデックスカラーのビットマップをグレースケールにするために、パレット情報を生成します。具体的には、0x00から0xffまでの値を、順番に、RGB全てに与えています。


最後に、入出力ビットマップのロックを解除します。


ここまでの手順で、以下のように、24ビットフルカラー画像を8ビットグレースケール画像に変換できます。


おわりに

ここまでの手順で作成したグレースケール変換処理には、実は、バグがあります。次回はその辺りの所を書こうと思っています。

任意の形のウィンドウを作る

デスクトップアクセサリや、ガジェットを作成する場合は、ウインドウを任意の形に変更したいと考えることが多いと思います。ここでは、2通りの方法を説明します。
System.Windows.Forms.Form.TransparencyKeyプロパティを使う

おそらく最も簡単な方法だと思います。
背景画像を指定し、透過させる色を指定すると、透過色の部分が描画されなくなります。


この画像の黒い部分を透明化します。
実コードは以下となります。



実際に動かしてみると、背景色部分が大きいせいもありますが、若干のちらつきがあります。
また、描画速度は、概ね80ms程度でした。


System.Windows.Forms.Control.Regionプロパティを使う

描画領域をあらかじめ指定しておくと、指定領域の中のみが描画されます。

実行結果は左のようになります(背景はデスクトップの壁紙です)。
ここでは、描画する領域を、100×100の矩形に収まる円にしています。


実コードは以下となります。

実際に動かしてみると、背景部分の再描画が無いせいか、特にちらつきはありませんでした。
描画速度は、概ね70ms程度でした。

画像からリージョンを生成する(System.Windows.Forms.Control.Regionプロパティを使う)

System.Windows.Forms.Form.TransparencyKeyプロパティを使う場合、描画領域が自動的に認識されるため、任意の画像で透過処理が可能ですが、背景色部分の描き直しが発生するせいか、若干のちらつきが出てしまいます。

System.Windows.Forms.Control.Regionプロパティを使う場合、ちらつきは発生しませんが、描画領域を、リージョンのデータとして渡してやる必要があります。これを手で作るのは困難です。
そこで、元画像を解析し、リージョンのデータを自動的に生成するコードを追加しました。

実コードは以下となります。

Regionクラス(System.Drawing)は、GraphicsPathクラス(System.Drawing.Drawing2D)で定義された、接続された一連の図形からなる領域です。GraphicsPathクラスは、任意の数の図形の集合で、複雑な図形を表現します。ここでは、描画するピクセルを1つずつ、GraphicsPathクラスに追加していくことで、描画領域を定義しています。


実行結果は左のようになります(背景はデスクトップの壁紙です)。
描画に要する時間は、概ね99ms程度でした。


ちらつきの解消(System.Windows.Forms.Form.TransparencyKeyプロパティを使う)

Form.FormBoderStyleにNoneを指定すると、ベースとなるフォームの描画を行わないので、ちらつきが無くなります。
描画速度は、ちらつき対策を行う前と同様に、概ね80ms程度でした。

まとめ

今回の試行では、System.Windows.Forms.Form.TransparencyKeyプロパティを使う方が若干速い、という結果になりましたが、複数の画像を切り替えて表示させる場合などでは、一度生成したリージョンを使いまわすことが出来るSystem.Windows.Forms.Control.Regionプロパティを使用した方が速くなるケースもあるかと思います。

SplitContainerの自動生成コード不具合について

※この現象はVisualStudio2005(.NET Framework 2.0),2008(.NET Framework 3.5)で発生、2010(.NET Framework 4.0)で発生しないことを確認しました。
SplitContainer(パネルの中身を2分割して境界線を自由に移動できるやつです)でデザイナの不具合を発見したので、その回避方法を記述します。

SplitContainerには以下のプロパティが存在します。
「Panel1MinSize」――パネル1の最小幅(縦分割の場合は最低高)
「Panel2MinSize」
――パネル2の最小幅(縦分割の場合は最低高)
「SplitterDistance」
――2つのパネルの分割位置。Panel1MinSizeとPanel2MinSizeの間の値である必要がある。
しかし、各パネルのMinSize値をデフォルトから変更すると、SplitterDistanceの値がPanel1MinSizeとPanel2MinSizeの間の値であるにも関わらずデザイナでエラーが発生します。

この件についてネットで調べたところ、以下のURLに記述がありました。
http://www.microsoft.com/japan/msdn/community/gdn/ShowPost-36298.htm

SplitContainer自体の初期設定サイズは(150,150)なのですが、デザイナが自動生成するソースにて、実際のコントロールサイズを設定する前に各パネルのMinSizeを設定してしまい、その値が初期設定サイズを超えてしまうことで発生するようです。

とりあえず手っ取り早くエラーを発生させなくする方法として以下の処置をとりましたので、SplitContainerをお使いになる際の参考になればと思います。 (ここからデザイナをいじって再ビルドするとまた発生するので、根本的な解決にはなってないのですが…)

該当するフォームのDesigner.csを見ると、以下のような記述になっています。

この、「Panel2の設定の後に親パネルのサイズ設定が行われている」というのが原因のようです。
ということで、上記ソースの下3行を移動しました。

これでとりあえずエラーは発生しなくなりました。

なお、この不具合はMicrosoftのフィードバックで挙げられていますが、解決策は延期としてクローズされています。
https://connect.microsoft.com/VisualStudio/feedback/details/93991/splitcontainer
VS2010(.NET4.0)では発生しないですが、旧バージョンを使用する際にはご注意ください。