求人の応募フォームを作ってよ、という依頼があって、そのときにごにょごにょと作ったのがあるので、それの簡易版を基にいくつかjQueryのプラグインを紹介する。
今回使用するJavascriptファイルは以下の5つ。
jquery-1.4.2.min.js
http://jquery.com/
言わずと知れたjQueryライブラリ。
jquery.validate.min.js
http://bassistance.de/jquery-plugins/jquery-plugin-validation/
検証(バリデーション、Validation)を行うプラグイン。
jquery.scrollTo-1.4.2-min.js
http://flesler.blogspot.com/2007/10/jqueryscrollto.html
滑らかなスクロールを行うプラグイン。今回のサンプルでは縦方向に短かいけれど、現物は項目数がもっと多かったため、入力エラーがあった場合はその項目までスクロールさせたかったので使用している。
hint.js
http://remysharp.com/2007/01/25/jquery-tutorial-text-box-hints/
Watermark(未入力時にヒントテキストがテキストボックス内に表示される)を行うプラグイン。
mailform.js
今回のサンプルを実装している外部ファイル。
上2つのライブラリはMSのCDN(Content Delivery Network)から参照可能なのでそれぞれ下記のURLを参照すると良い。
http://ajax.microsoft.com/ajax/jquery/jquery-1.4.2.min.js
http://ajax.microsoft.com/ajax/jquery.validate/1.7/jquery.validate.min.js
フォームの外観は下図。ヒントとして入力例テキストボックスに表示されている。
何も入力しない状態で確認画面へをクリックすると下図になる。必須項目の検証が行われている。
年齢、メールアドレス、確認用メールアドレスはそれぞれ、数値の検証、メールアドレスの検証、メールアドレスと同じ値かの検証が行われている。
すべてを入力した状態が下図。
上図の状態で確認画面へをクリックすると下図になり、入力された内容の確認が行える。
同意するにチェックをいれると送信ボタンが有効になり、メール送信なりが行えるようになる。
ここから簡単にいくつかポイントを解説する。
mailform.htm
formタグのactionの値はでたらめなので適当な値に修正してもらいたい。formタグ内にsubmitボタンを配置するとクリック時に入力エラーがあっても勝手に飛んでいってしまうのでformの外側に配置している。入力項目はclassにinput_modeが設定されている。また確認時に表示する項目にはconfirm_modeが設定されている。
mailform.css
input.errorで検証時にエラーだった入力項目の表示を設定できる。今回のサンプルでは入力項目のテキストを赤に変え、周りを赤の線で囲っている。errorは検証エラーのメッセージの表示設定だ。
mailform.js
$form.validateで入力項目の検証を行っている。rulesでどの要素にどのようなルールを適用するかを指定している。messagesはルールに対応するメッセージを指定している。今回使用しているrequired, digits, emailなどのほかにも、range, url, dateなど色々と用意されているので、詳細はこちらを参照して欲しい。
Javascriptをオフにしている人をばっさりと斬って捨てる漢な決断が必要だが、こんな感じで入力内容の検証をすべてクライアントで行い、入力内容をポストすることも可能だ。
今回のサンプルは下記からダウンロードできる。
2010年11月17日水曜日
2010年10月24日日曜日
NuGet(以前はNuPack)で簡単インストール
※NuPackはNuGetという名称に変更されました。リンク修正済み
オープンソースライブラリを簡単に開発環境にインストールできるNuGetがリリースされた。いわゆるパッケージ管理システムだ。Visual Studioに統合されていて、どのバージョンでも使用できるようだ(ちなみに今回はVisual Studio 2010 Ultimateを使用している)。NuGetのインストール方法は簡単だ。下記のリンクからNuGet.Tools.vsixをダウンロードしてダブルクリックするだけだ。
NuGet
サイト右側のDownloadリンクから取得しよう。
※NuGetはいくつか問題が報告されていて私もはじめは使用できなかったので対処法を後述する。
Known Issues With NuGet CTP 1NuGetを使うと何が便利かというと、ライブラリのインストール(設定を含む)をすべて自動で行ってくれることだ。以前当ブログでも解説したElmahの設定なども自動で設定してくれて、すぐに使用できるようになる。また、複雑な依存関係があるようなNHibernate.Linqなどもすべて自動で設定してくれる。さらにNuGetの素晴らしいところはシステムレベルでは何もインストールしないので環境が汚染されることを心配しなくてよい。
では実際にNuGetを使用してみよう。NuGetの説明ではElmahが引っ張りだこなので同じ内容をやるのは気が引けるが、以前マニュアルでの導入方法を解説したこともあるのでここでもElmahの設定方法を解説する。
インストール後にVisual Studioを起動して適当にASP.NET MVCのプロジェクトを作成し、View → Other Windowを開くとPackage Manager Consoleがあるので選択しよう。ちなみに下図でPackage Manager Consoleの項目が二つあるのも既知のバグだ。ここではASP.NET MVCのプロジェクトを使用しているが、もちろんASP.NETのプロジェクトでも問題ないし、WPF、Silverlightなど、どのようなプロジェクトでもNuGetは使用可能だ。
Package Manager ConsoleでList-Packageと入力すると下図のリストが一覧できる。これはNuGetを使用して自動でインストールできるライブラリの一覧だ。
ついでAdd-Package elmahと入力する。これでインストール完了だ。いたって簡単。ReferencesにElmahが追加されているのが分かると思う。
またWeb.configにも必要な設定が追加されている。以前解説したのとは違い、ここではIn-Memoryにエラーをログするようになっている。
http://localhost:2430/elmah.axdにアクセスすると下図のElmahのエラーログページが表示されるはずだ。
以上コマンドラインでのインストール方法を解説したが、GUIで行う方法もある。Referencesを右クリックしてAdd Package Referenceを選択しよう。
Visual Studio 2010で馴染み深い下図のダイアログがポップアップするので、目当てのライブラリを検索する。
ライブラリが見つかったらInstallボタンをクリックしよう。
と、簡単にライブラリがインストールできるのが分かったと思うので、気になるライブラリがあったらガンガン導入して評価してみると良いだろう。
ここから既知のバグの対処法をいくつか紹介する。
・NuGetがアンインストールできない
管理者権限でVisual Studioを実行しないとTools → Extension Managerで表示されるダイアログのNuGetの項目にあるUninstallボタンが無効化されているので注意しよう。
・View → Other WindowsにPackage Manager Consoleがない
・Package Manager Consoleを実行するとSystem.Security.AccessControl.ObjectSecurityExceptionが表示される
どうやらReflectorのAddinをインストールしてあるとこれらの現象が発生するようだ。下記リンクを参考にReflectorのアドインを削除しよう。
方法: アドインを非アクティブにして削除する
・View → Other WindowsにPackage Manager Consoleが2つある
NuGetをインストールする以前にPower Shellをインストールしてあるとこうなってしまうようだ。ちなみにこれの解決方法はないそうだ。
2010年10月3日日曜日
MVVMパターンでSilverlightアプリを開発する その2
前回MVVMパターンと、それを実装するためのライブラリのMVVM Light Toolkitを紹介した。今回はソースコードを交えつつ解説したいと思う。
今回使用するソースコードは次の場所に公開している。
実行後の画面は下図の通りだ。
リストがあって、詳細ボタンをクリックすると詳細が表示されるといういたって単純な構成にしてある。
プロジェクトの構成は下図の通り。
MainView.xaml
MainView.xamlにFrameが定義してあり、状況によってViewsフォルダ配下のDetailsPage.xamlとListPage.xamlを表示する。MainPage.xamlで注目してほしい箇所は2箇所ある。まずUserControlタグのDataContext属性にキー名LocatorというオブジェクトのMainというプロパティがBindingされている。LocatorはViewModelのインスタンスを管理するViewModelLocatorクラスで、App.xamlでインスタンス化されている。
ViewModelLocator.csは下記の通り。
ViewModelごとに上記の記述が連なっていく。
ついで、MainPage.xamlで定義したFrameのSourceにCurrentPageがBindingされている。CurrentPageプロパティが定義されているのはMainViewModelクラスになる。MainViewModel.csのコードは下記になる。
MainViewModelはCurrentPageを変更することによりページの遷移の制御を行っている。MessengerはMVVM Light Toolkitが提供してくれる通信用のクラスだ。Messengerはデフォルトで1つのインスタンスを提供してくれるので、ViewModelのBroadCastのテスト用途などで指定のMessengerを使いたい場合など以外はMessenger.Defaultプロパティを使えば良いだろう。Register関数でライブラリ標準のNotificationMessageを受け取るように指定している。今回はNotificationMessageに遷移先を渡すようにしているので、Registerを呼び出した際のコールバック内でNotificationを参照してCurrentPageを変更する。
NotificationMessage.Notificationは文字列だが、NotificationMessageにはSenderとTargetも渡せるようになっているので、Registerハンドラーの中でNotificationの文字列比較だけでなく、Sender, Targetも使用してどこに対してのメッセージなのかを識別するようにしたほうが良いだろう。というのも、MessengerのSendとRegisterはGenericを使用してNotificationMessage以外にも任意の型を指定して簡単にメッセージを発信、受信することも可能だが、実際、データ型を指定してしまうとコードからどこの誰に対するメッセージなのかまったく識別できなくなってしまうし、また、メッセージ毎にメッセージ用のクラスを用意すると、それはそれで作りすぎるとかなりカオスな状態を引き起こしてしまう。そのため、Messengerの利用はプロジェクトの規模が大きくなればなるほど計画的に使用するべきだろう。
標準のメッセージクラスは以下の通り。
MessageBase
GenericMessage<T>
NotificationMessage
NotificationMessage<T>
NotificationMessageAction
NotificationMessageAction<T>
DialogMessage
PropertyChangedMessage<T>
ListPage.xaml
ListPage.xamlもMainPage.xamlと同様にDataContextへViewModelLocatorを介してListPageViewModelクラスのBindingを行っている。リストの表示に選択機能は必要ないのでItemsControlでListPageViewModelのBushiListプロパティを単純に表示している。
ListPage.xamlは下記の通り。
ListPage.xaml.csは下記の通り。
BushiListは名前の通りBushiクラスのリストだ。それをItemsControlのItemsSourceとしている。注目して欲しいのはDataTemplate内のButtonの定義だ。実はSilverlight4からButtonBaseクラスはCommandを実装するようになったので、ButtonBaseから派生しているButtonは本来ならばCommand="{Binding ShowDetailsCommand}"といったような記述が可能なのだが、今回はItensControlのDataTemplate内ということで、個々のアイテムのDataContextはBushiになってしまう。そのため単純に前述の定義を行ってもListPageViewModel内で定義されたShowDetailsCommandプロパティは見つからない。SL4ではRelativeSourceがWPFほど強力ではないので、それを補うため今回は下記のブログポストで見つけたBindingHelperクラスを使用している。
RelativeSource Binding with FindAncestor mode in Silverlight
CommandParameterにBindingのみを指定することで個々のアイテムのDataContextであるBushiを渡している。これを受けるのはPateListViewModelのShowDetailsCommandだ。ShowDetailsCommandはRelayCommandのGenericを使用してBushiクラスを受け取るようになっている。ShowDetailsCommand内で、BushiをMessengerでDetailsPageViewModelクラスへと発信している(実際にはTargetを設定していないのでBushiをRegisterしている対象へとばらまいている)。ついでNotificationMessageも発信して詳細ページへの遷移を促している。
一点注目して欲しいのがIsInDesignModeだ。このフラグを使用してデザインモード時に仮のデータを渡してやることにより、アプリケーションを実際に動作させてWCF経由などでデータを取得、画面に表示させなくともExpression BlendやVisual StudioのXamlビューで実際に動作させた場合と同等の画面確認が行えるようになっている。これを容易に可能にするのがMVVMパターンを使うことによってもたらされる恩恵の一つでもあり、Expression Blendとの親和性が高いことからBlendabilityが高いとも表現される。
DetailsPage.xaml
DetailsPage.xamlはGridタグでListPage.xamlで選択されたBushiの詳細を受け取り表示するだけである。また戻るボタン押下時にListPage.xamlへの遷移をNotificationMessageを発信することによりMainViewModelへと通知している。DetailsPage.xaml, DetailsPageViewModel.csの詳細はここまで説明してきたこととほぼ同じなので省略する。
まとめ
前回と今回で、MVVMパターン開発手法のMVVM Light Toolkit版を解説してきた。MVVM Light Toolkitは大きなライブラリではないけれど、MVVMパターンに必要な要素はすべて盛り込まれているので、MVVM Light Toolkitを使えばすぐにでもMVVMパターンで開発を行えるのが理解できたと思うし、容易に使える実感を持てたのではないだろうか。
この解説を通して、MVVMパターンを使用してUIとビジネスロジックの切り離しを明確にすることにより、ビジネスロジックの単体テストが容易になり、それにあわせてアプリケーション全体の保守性もあがり、またデザイナとの共同作業を行う上で重要なExpression Blendとの親和性も高まる、ということが伝わったら幸いだ。
今回使用するソースコードは次の場所に公開している。
実行後の画面は下図の通りだ。
リストがあって、詳細ボタンをクリックすると詳細が表示されるといういたって単純な構成にしてある。
プロジェクトの構成は下図の通り。
MainView.xaml
MainView.xamlにFrameが定義してあり、状況によってViewsフォルダ配下のDetailsPage.xamlとListPage.xamlを表示する。MainPage.xamlで注目してほしい箇所は2箇所ある。まずUserControlタグのDataContext属性にキー名LocatorというオブジェクトのMainというプロパティがBindingされている。LocatorはViewModelのインスタンスを管理するViewModelLocatorクラスで、App.xamlでインスタンス化されている。
ViewModelLocator.csは下記の通り。
public class ViewModelLocator{
public static MainViewModel MainStatic
{
get
{
if (_main == null)
{
CreateMain();
}
return _main;
}
}
public MainViewModel Main
{
get
{
return MainStatic;
}
}
public static void ClearMain()
{
_main.Cleanup();
_main = null;
}
public static void CreateMain()
{
if (_main == null)
{
_main = new MainViewModel();
}
}
// 以下、他のViewModel用のPropertyが続く
}
ViewModelごとに上記の記述が連なっていく。
ついで、MainPage.xamlで定義したFrameのSourceにCurrentPageがBindingされている。CurrentPageプロパティが定義されているのはMainViewModelクラスになる。MainViewModel.csのコードは下記になる。
public class MainViewModel : ViewModelBase
{
public MainViewModel()
{
CurrentPage = new Uri("/Views/ListPage.xaml", UriKind.Relative);
Messenger.Default.Register(this, x =>
{
switch(x.Notification)
{
case Notifications.ToList:
CurrentPage = new Uri("/Views/ListPage.xaml", UriKind.Relative);
break;
case Notifications.ToDetails:
CurrentPage = new Uri("/Views/DetailsPage.xaml", UriKind.Relative);
break;
}
});
}
Uri _currentPage;
public Uri CurrentPage {
get { return _currentPage; }
set
{
_currentPage = value;
base.RaisePropertyChanged("CurrentPage");
}
}
}
MainViewModelはCurrentPageを変更することによりページの遷移の制御を行っている。MessengerはMVVM Light Toolkitが提供してくれる通信用のクラスだ。Messengerはデフォルトで1つのインスタンスを提供してくれるので、ViewModelのBroadCastのテスト用途などで指定のMessengerを使いたい場合など以外はMessenger.Defaultプロパティを使えば良いだろう。Register関数でライブラリ標準のNotificationMessageを受け取るように指定している。今回はNotificationMessageに遷移先を渡すようにしているので、Registerを呼び出した際のコールバック内でNotificationを参照してCurrentPageを変更する。
NotificationMessage.Notificationは文字列だが、NotificationMessageにはSenderとTargetも渡せるようになっているので、Registerハンドラーの中でNotificationの文字列比較だけでなく、Sender, Targetも使用してどこに対してのメッセージなのかを識別するようにしたほうが良いだろう。というのも、MessengerのSendとRegisterはGenericを使用してNotificationMessage以外にも任意の型を指定して簡単にメッセージを発信、受信することも可能だが、実際、データ型を指定してしまうとコードからどこの誰に対するメッセージなのかまったく識別できなくなってしまうし、また、メッセージ毎にメッセージ用のクラスを用意すると、それはそれで作りすぎるとかなりカオスな状態を引き起こしてしまう。そのため、Messengerの利用はプロジェクトの規模が大きくなればなるほど計画的に使用するべきだろう。
標準のメッセージクラスは以下の通り。
MessageBase
GenericMessage<T>
NotificationMessage
NotificationMessage<T>
NotificationMessageAction
NotificationMessageAction<T>
DialogMessage
PropertyChangedMessage<T>
ListPage.xaml
ListPage.xamlもMainPage.xamlと同様にDataContextへViewModelLocatorを介してListPageViewModelクラスのBindingを行っている。リストの表示に選択機能は必要ないのでItemsControlでListPageViewModelのBushiListプロパティを単純に表示している。
ListPage.xamlは下記の通り。
<ItemsControl ItemsSource="{Binding BushiList}" >
<ItemsControl.ItemTemplate>
<DataTemplate>
<StackPanel Orientation="Horizontal"
Margin="10">
<Button Content="詳細"
Margin="0 0 10 0"
CommandParameter="{Binding}">
<local:BindingHelper.Binding>
<local:RelativeSourceBinding Path="ShowDetailsCommand" TargetProperty="Command" />
</local:BindingHelper.Binding>
</Button>
<TextBlock Text="{Binding Name}"
VerticalAlignment="Center"/>
</StackPanel>
</DataTemplate>
</ItemsControl.ItemTemplate>
</ItemsControl>
ListPage.xaml.csは下記の通り。
public class ListPageViewModel : ViewModelBase
{
public ListPageViewModel()
{
if (IsInDesignMode)
{
BushiList = new ObservableCollection<Bushi> {
new Bushi{ Name = "Sample1", Age = 10, Address = "Tokyo" },
new Bushi{ Name = "Sample2", Age = 20, Address = "Kyoto" },
new Bushi{ Name = "Sample3", Age = 30, Address = "Osaka" }
};
}
else
{
BushiList = new ObservableCollection<Bushi> {
new Bushi{ Name = "織田 信長", Age = 49, Address = "Kyo-" },
new Bushi{ Name = "羽柴 秀吉", Age = 46, Address = "Himeji" },
new Bushi{ Name = "徳川 家康", Age = 40, Address = "Mikawa" },
new Bushi{ Name = "明智 光秀", Age = 55, Address = "Tanpa" }
};
}
ShowDetailsCommand = new RelayCommand<Bushi>(x =>
{
Messenger.Default.Send<Bushi>(x);
Messenger.Default.Send<NotificationMessage>(new NotificationMessage(Notifications.ToDetails));
});
}
public ObservableCollection<Bushi> BushiList { get; set; }
public RelayCommand<Bushi> ShowDetailsCommand { get; private set; }
}
BushiListは名前の通りBushiクラスのリストだ。それをItemsControlのItemsSourceとしている。注目して欲しいのはDataTemplate内のButtonの定義だ。実はSilverlight4からButtonBaseクラスはCommandを実装するようになったので、ButtonBaseから派生しているButtonは本来ならばCommand="{Binding ShowDetailsCommand}"といったような記述が可能なのだが、今回はItensControlのDataTemplate内ということで、個々のアイテムのDataContextはBushiになってしまう。そのため単純に前述の定義を行ってもListPageViewModel内で定義されたShowDetailsCommandプロパティは見つからない。SL4ではRelativeSourceがWPFほど強力ではないので、それを補うため今回は下記のブログポストで見つけたBindingHelperクラスを使用している。
RelativeSource Binding with FindAncestor mode in Silverlight
CommandParameterにBindingのみを指定することで個々のアイテムのDataContextであるBushiを渡している。これを受けるのはPateListViewModelのShowDetailsCommandだ。ShowDetailsCommandはRelayCommandのGenericを使用してBushiクラスを受け取るようになっている。ShowDetailsCommand内で、BushiをMessengerでDetailsPageViewModelクラスへと発信している(実際にはTargetを設定していないのでBushiをRegisterしている対象へとばらまいている)。ついでNotificationMessageも発信して詳細ページへの遷移を促している。
一点注目して欲しいのがIsInDesignModeだ。このフラグを使用してデザインモード時に仮のデータを渡してやることにより、アプリケーションを実際に動作させてWCF経由などでデータを取得、画面に表示させなくともExpression BlendやVisual StudioのXamlビューで実際に動作させた場合と同等の画面確認が行えるようになっている。これを容易に可能にするのがMVVMパターンを使うことによってもたらされる恩恵の一つでもあり、Expression Blendとの親和性が高いことからBlendabilityが高いとも表現される。
DetailsPage.xaml
DetailsPage.xamlはGridタグでListPage.xamlで選択されたBushiの詳細を受け取り表示するだけである。また戻るボタン押下時にListPage.xamlへの遷移をNotificationMessageを発信することによりMainViewModelへと通知している。DetailsPage.xaml, DetailsPageViewModel.csの詳細はここまで説明してきたこととほぼ同じなので省略する。
まとめ
前回と今回で、MVVMパターン開発手法のMVVM Light Toolkit版を解説してきた。MVVM Light Toolkitは大きなライブラリではないけれど、MVVMパターンに必要な要素はすべて盛り込まれているので、MVVM Light Toolkitを使えばすぐにでもMVVMパターンで開発を行えるのが理解できたと思うし、容易に使える実感を持てたのではないだろうか。
この解説を通して、MVVMパターンを使用してUIとビジネスロジックの切り離しを明確にすることにより、ビジネスロジックの単体テストが容易になり、それにあわせてアプリケーション全体の保守性もあがり、またデザイナとの共同作業を行う上で重要なExpression Blendとの親和性も高まる、ということが伝わったら幸いだ。
2010年9月26日日曜日
MVVMパターンでSilverlightアプリを開発する その1
WPFかSilverlightで開発する場合に非常に有用なデザインパターンがMVVMだ。MVVMが最初に提唱され始めたのが2006年ごろらしいので、かれこれ4年ほどたち、その間にMVVM Light ToolkitやPrismなどかなりこなれたライブラリ群が多数出たおかげで、現在はMVVMにのっとった開発が容易になっている。今回はPrismよりも簡易に使い始められるMVVM Light ToolkitでMVVMでの開発方法を紹介する。
MVVM Light Toolkitの導入
MVVM Light Toolkitの公式サイト
MVVM Light Toolkitのインストール方法
上記2つ目のリンクから「Binaries (WPF3.5SP1/SL3/WPF4/SL4/Windows Phone 7)」のリンクをクリックしてDLL群をダウンロードしよう。解凍するとProgram Files配下のフォルダができるのでそれをコピーしてProgram Files配下へと配置する。
あわせて
「Templates for Visual Studio 2010 (WPF3.5SP1/SL3/WPF4/SL4/Windows Phone 7)」
「Snippets for Visual Studio 2008, Visual Studio 2010 and Visual Studio 2010 Express (WPF3.5SP1/SL3/WPF4/SL4/Windows Phone 7)」
からテンプレートとコードスニペットをダウンロードしておくと良いだろう(私の環境はVS2010なのでそれようのファイルをダウンロードしている。自分の環境にあったものを選択してほしい)。配置方法はZipファイルを解凍後、それぞれ所定の位置にコピーすればよい。所定の位置は下図を参考にしてほしい。
例)C:\Users\Yoo\Documents\Visual Studio 2010\Templates
例)C:\Users\Yoo\Documents\Visual Studio 2010\Code Snippets\Visual C#\My Code Snippets
セットアップが完了したらVisual Studio 2010を起動し、新規プロジェクトの作成を選択し、Silverlightの項目を選択しよう。テンプレートをコピーしている場合は下図のようにMvvm Lightという項目があるはずなのでSL4のほうを選択しよう。
プロジェクトのスケルトンは下図のようになる。
MVVMについて
ここでMVVMパターンについて簡単に説明しておこう。
MVVMはModel View ViewModelの略称でMVC(Model View Controller), MVP(Model View Presenter)の流れから来ている。このMVVMを理解するうえで最も重要なのはVMの部分で、ViewModelがなんぞや、というのを理解すればおのずとMVVMがどういうものか理解できる。
※ここでViewModelのやりとりしている矢印がData Access Layerだけなのは、ViewとのやりとりはBindingを介して行うのでMVVMパターンの建前上ViewとViewModelの間にはやり取りが発生しない(Code Behindにイベントハンドラを記述する必要がなくなる)。
ここで上の微妙な図を使って図解する。図を見てもらうと分かると思うが、ViewModelはViewとModelの中間に位置する。ViewModelの存在意義はいくつがあるが、そのうちもっとも重要なのは、ModelとViewの間にある必要な情報の差を埋める部分にある。アプリケーションは多種多様な情報を扱うが、大体バックエンドのデータストアにはSQL ServerなりOracleなどのデータベースを使うのが一般的だろう。そのため、バックエンドにデータを流し込んだり、取得する単位はテーブルエンティティ毎になりやすい。しかし、RDBのテーブル構成はデータ保持の観点からは大変優秀だが、UIにそのまま表示する情報の形式としては足りなかったり、過剰であったりする。そこで、View(ここでいうUI)とModel(ここでいうテーブルエンティティ)の間を取り持つのにViewModelが存在する。つまりViewModelには、多様なデータを取得しViewに必要な情報を形成する役割とユーザのインプットをModelにしデータアクセスレイヤーに渡す役割という2つの大きな役割がある。
また、ViewModelにはそれ以外にもCommandとしてユーザのアクションハンドラーを公開することが求められる。ユーザのアクションハンドラー(要するにイベントハンドラー)をCommandとして公開する理由は下記の通り。
以下に簡単にまとめる。
MVVM Light Toolkitの説明
ここで簡単にMVVM Light Toolkitの説明をする。基本となる要素は下記の通りだ。
MessengerはViewModel間に限らず、ありとあらゆる場所への通知が可能だ。画面遷移やViewModel間の値変更の通知などはこのクラスが担うことになる。
RelayCommandはMVVM Light Toolkitが提供するCommandクラスだ。これの他にもEventToCommandというかなり強力なCommandクラスがあるので、SelectionChangedイベントなどCommandとしてハンドルできないUI要素のイベントがある場合はこちらを使うことになる。
と、ここまでで結構長くなってしまったのでコードを使っての解説は次回以降に持ち越すことにする。
MVVM Light Toolkitの導入
MVVM Light Toolkitの公式サイト
MVVM Light Toolkitのインストール方法
上記2つ目のリンクから「Binaries (WPF3.5SP1/SL3/WPF4/SL4/Windows Phone 7)」のリンクをクリックしてDLL群をダウンロードしよう。解凍するとProgram Files配下のフォルダができるのでそれをコピーしてProgram Files配下へと配置する。
あわせて
「Templates for Visual Studio 2010 (WPF3.5SP1/SL3/WPF4/SL4/Windows Phone 7)」
「Snippets for Visual Studio 2008, Visual Studio 2010 and Visual Studio 2010 Express (WPF3.5SP1/SL3/WPF4/SL4/Windows Phone 7)」
からテンプレートとコードスニペットをダウンロードしておくと良いだろう(私の環境はVS2010なのでそれようのファイルをダウンロードしている。自分の環境にあったものを選択してほしい)。配置方法はZipファイルを解凍後、それぞれ所定の位置にコピーすればよい。所定の位置は下図を参考にしてほしい。
例)C:\Users\Yoo\Documents\Visual Studio 2010\Templates
例)C:\Users\Yoo\Documents\Visual Studio 2010\Code Snippets\Visual C#\My Code Snippets
セットアップが完了したらVisual Studio 2010を起動し、新規プロジェクトの作成を選択し、Silverlightの項目を選択しよう。テンプレートをコピーしている場合は下図のようにMvvm Lightという項目があるはずなのでSL4のほうを選択しよう。
プロジェクトのスケルトンは下図のようになる。
MVVMについて
ここでMVVMパターンについて簡単に説明しておこう。
MVVMはModel View ViewModelの略称でMVC(Model View Controller), MVP(Model View Presenter)の流れから来ている。このMVVMを理解するうえで最も重要なのはVMの部分で、ViewModelがなんぞや、というのを理解すればおのずとMVVMがどういうものか理解できる。
※ここでViewModelのやりとりしている矢印がData Access Layerだけなのは、ViewとのやりとりはBindingを介して行うのでMVVMパターンの建前上ViewとViewModelの間にはやり取りが発生しない(Code Behindにイベントハンドラを記述する必要がなくなる)。
ここで上の微妙な図を使って図解する。図を見てもらうと分かると思うが、ViewModelはViewとModelの中間に位置する。ViewModelの存在意義はいくつがあるが、そのうちもっとも重要なのは、ModelとViewの間にある必要な情報の差を埋める部分にある。アプリケーションは多種多様な情報を扱うが、大体バックエンドのデータストアにはSQL ServerなりOracleなどのデータベースを使うのが一般的だろう。そのため、バックエンドにデータを流し込んだり、取得する単位はテーブルエンティティ毎になりやすい。しかし、RDBのテーブル構成はデータ保持の観点からは大変優秀だが、UIにそのまま表示する情報の形式としては足りなかったり、過剰であったりする。そこで、View(ここでいうUI)とModel(ここでいうテーブルエンティティ)の間を取り持つのにViewModelが存在する。つまりViewModelには、多様なデータを取得しViewに必要な情報を形成する役割とユーザのインプットをModelにしデータアクセスレイヤーに渡す役割という2つの大きな役割がある。
また、ViewModelにはそれ以外にもCommandとしてユーザのアクションハンドラーを公開することが求められる。ユーザのアクションハンドラー(要するにイベントハンドラー)をCommandとして公開する理由は下記の通り。
- ViewのUI要素のCommand(Button.Commandなど)とViewModel.CommandをBindingすることが可能となり、Code Behindにイベントハンドラを記述する必要がなくなる(保守性がアップ)
- イベントハンドラも含めてビジネスロジックはすべてViewModel上にあるので単体テストを行うことが容易になる(Testabilityがアップ)
以下に簡単にまとめる。
- View:UI要素の集合。プレゼンテーション層
- Model:テーブルエンティティだったり、DTOだったり、ビジネスエンティティだったり
- ViewModel:ViewとModelの中間層。ビジネスロジックはここ。Commandもここ
MVVM Light Toolkitの説明
ここで簡単にMVVM Light Toolkitの説明をする。基本となる要素は下記の通りだ。
- ViewModelBase
- Messenger
- RelayCommand
MessengerはViewModel間に限らず、ありとあらゆる場所への通知が可能だ。画面遷移やViewModel間の値変更の通知などはこのクラスが担うことになる。
RelayCommandはMVVM Light Toolkitが提供するCommandクラスだ。これの他にもEventToCommandというかなり強力なCommandクラスがあるので、SelectionChangedイベントなどCommandとしてハンドルできないUI要素のイベントがある場合はこちらを使うことになる。
と、ここまでで結構長くなってしまったのでコードを使っての解説は次回以降に持ち越すことにする。
2010年9月16日木曜日
Silverlightで複数ページを印刷する PrintDocument
Silverlightで単一ページを印刷するのは至極簡単でPrintDocumentを使用する。コード例は下記になる。
PrintPageイベント引数のPageVisualプロパティにVisual要素を渡すとその内容をそのまま印刷してくれる。ここで一点注意が必要なのだが、Print関数はユーザのアクション(ボタンクリックなど)をハンドルした関数内で呼び出さないとSecurityExceptionがThrowされる。
ついで複数ページを印刷する方法を解説する。元ネタは下記から。
Silverlight Business Apps: Module 6.2 - Multi Page Printing
PrintPageイベント引数にPrintableAreaに印刷可能範囲の縦横サイズが入っている。このサイズより外にあるものは印刷されないので、こちら側で制御してやる必要があり、二枚目以降の印刷が必要な場合は再度PrintPageイベントが発生しないといけないのでHasMorePagesにtrueを設定しフレームワークに印刷がすべて終わっていないことを伝えておく必要がある。
Measure関数で実際に描画されるコントロールのサイズを計測する。Measure関数を呼び出しておくとDesiredSizeにコントロールに必要なサイズが設定されるのでそれを参照して、印刷可能範囲との比較を行っていく。
一点はまった点としてinsideStackの存在理由を説明しておく。一見無駄なコーディングに見えるが、これがないと実際に印刷されるサイズとDesiredSizeで取得されるサイズに差異が生じる場合があり、予期せぬ印刷結果につながることがある。
というのも、ResultControlは内部的にGridを保持し、さらにRowDefinitionで3行保持している。ただ、ある特定の場合は最後の1行にデータが設定されないので上2行分のHeight40ピクセルほどで事足りる。しかしDesiredSizeでは毎回3行分のHeight60ピクセルが返却され、さらに始末の悪いことに描画は40ピクセル分で行われる。そのためプログラム上はHeight60ピクセルで計算している部分が実はHeight40ピクセルが正しく、その20ピクセル分の差異がitemsSourceの項目が多くなるほど積もり積もって大きくなり、正しい印刷制御が行えなくなってしまう。それを防ぐためにinsideStackを使用している。insideStackのHeightにDesiredHeightで取得したHeightを設定し、必ずその高さを保証することにより、実際に印刷されるものと、プログラム上で取得できるサイズの差異が発生しないようにしている。
var printDoc = new PrintDocument();
printDoc.PrintPage += (s, eArgs) =>
{
eArgs.PageVisual = this;
};
printDoc.Print("Print page");
PrintPageイベント引数のPageVisualプロパティにVisual要素を渡すとその内容をそのまま印刷してくれる。ここで一点注意が必要なのだが、Print関数はユーザのアクション(ボタンクリックなど)をハンドルした関数内で呼び出さないとSecurityExceptionがThrowされる。
ついで複数ページを印刷する方法を解説する。元ネタは下記から。
Silverlight Business Apps: Module 6.2 - Multi Page Printing
var printDoc = new PrintDocument();
bool firstPage = true;
var index = 0;
var itemsSource = new List<Item>{ 項目多数 };
printDoc.PrintPage += (s, eArgs) =>
{
var itemHost = new StackPanel { Width = eArgs.PrintableArea.Width };
if (firstPage)
{
itemHost.Children.Add(new HeaderControl());
firstPage = false;
}
while (index < itemsSource.Count)
{
var item = itemsSource[index];
var control = new ResultControl { Text = item.Text };
control.Measure(new Size(eArgs.PrintableArea.Width, double.PositiveInfinity));
var desiredHeight = control.DesiredSize.Height;
var insideStack = new StackPanel { Height = desiredHeight };
insideStack.Children.Add(control);
itemHost.Children.Add(insideStack);
itemHost.Measure(new Size(eArgs.PrintableArea.Width, double.PositiveInfinity));
if (itemHost.DesiredSize.Height > eArgs.PrintableArea.Height)
{
itemHost.Children.Remove(insideStack);
eArgs.HasMorePages = true;
break;
}
index++;
}
eArgs.PageVisual = itemHost;
};
printDoc.Print("Print Page");
PrintPageイベント引数にPrintableAreaに印刷可能範囲の縦横サイズが入っている。このサイズより外にあるものは印刷されないので、こちら側で制御してやる必要があり、二枚目以降の印刷が必要な場合は再度PrintPageイベントが発生しないといけないのでHasMorePagesにtrueを設定しフレームワークに印刷がすべて終わっていないことを伝えておく必要がある。
Measure関数で実際に描画されるコントロールのサイズを計測する。Measure関数を呼び出しておくとDesiredSizeにコントロールに必要なサイズが設定されるのでそれを参照して、印刷可能範囲との比較を行っていく。
一点はまった点としてinsideStackの存在理由を説明しておく。一見無駄なコーディングに見えるが、これがないと実際に印刷されるサイズとDesiredSizeで取得されるサイズに差異が生じる場合があり、予期せぬ印刷結果につながることがある。
というのも、ResultControlは内部的にGridを保持し、さらにRowDefinitionで3行保持している。ただ、ある特定の場合は最後の1行にデータが設定されないので上2行分のHeight40ピクセルほどで事足りる。しかしDesiredSizeでは毎回3行分のHeight60ピクセルが返却され、さらに始末の悪いことに描画は40ピクセル分で行われる。そのためプログラム上はHeight60ピクセルで計算している部分が実はHeight40ピクセルが正しく、その20ピクセル分の差異がitemsSourceの項目が多くなるほど積もり積もって大きくなり、正しい印刷制御が行えなくなってしまう。それを防ぐためにinsideStackを使用している。insideStackのHeightにDesiredHeightで取得したHeightを設定し、必ずその高さを保証することにより、実際に印刷されるものと、プログラム上で取得できるサイズの差異が発生しないようにしている。
2010年9月15日水曜日
Dynamic LinqをLinq To Xmlで使うときの注意点 in Silverlight
Linq To SQLでDynamic LINQを良く使っていたのだが、先日Silverlight上でLinq To Xmlを同じように使ったところ結構はまったので紹介しておく。
問題のコードは下記。
上記は意味の無いDynamic Linqの使い方だがサンプル目的なので分かりやすく記述している。上記のコードを実行するとContainsの部分でMethodAccessExceptionがThrowされる。どうやらAnonymousクラスのプロパティに対してReflectionから実行しようとすると駄目なようだ。回避方法は下記の通り。
一時的にデータを保持するクラスを定義して、それをAnonymousクラスの代わりにインスタンス化すればよい。なんだかなぁ、という感じだがDynamic Linqが処理の重要な部分を占める場合は致し方ない。
問題のコードは下記。
var list = doc.Descendants("Row").Select(x => new {
Original=x,
Text=x.Element("FirstName").Value + x.Element("LastName").Value + x.Element("Address").Value
})
.Where("Text.Contains(@0)", new string[]{ "何か" }).ToList();
上記は意味の無いDynamic Linqの使い方だがサンプル目的なので分かりやすく記述している。上記のコードを実行するとContainsの部分でMethodAccessExceptionがThrowされる。どうやらAnonymousクラスのプロパティに対してReflectionから実行しようとすると駄目なようだ。回避方法は下記の通り。
public class TemporaryDataHolder
{
public XElement Original { get; set; }
public string Text { get; set; }
}
var list = doc.Descendants("Row").Select(x => new TemporaryDataHolder {
Original=x,
Text=x.Element("FirstName").Value + x.Element("LastName").Value + x.Element("Address").Value
})
.Where("Text.Contains(@0)", new string[]{ "何か" }).ToList();
一時的にデータを保持するクラスを定義して、それをAnonymousクラスの代わりにインスタンス化すればよい。なんだかなぁ、という感じだがDynamic Linqが処理の重要な部分を占める場合は致し方ない。
Linq To XmlでXNamespaceを指定する
前回SqlMetalの使い方を説明したが、今回は前回出力したマッピングファイルの書き換えをLinq To XMLで行う方法を紹介する。
マッピングファイルを書き換える理由は次の通り。複数のDBをまたいだクエリをLinq To Sqlで行う場合、マッピングファイルのTable要素は下記のようにServerName、DBNameを含んだ記述にしなければならない。
dbo.users → ServerName.DBName.dbo.users
SQL Server 2008で複数のDBを単一クエリで扱うための設定は下記を参照してほしい。
Linked Serverの設定方法
sp_addlinkedserver (Transact-SQL)
で、Linq To Xmlを使用してのマッピングファイルの読み込みなのだが、下記のようにXNamespaceを指定しないと予期したようにTable要素は取得できない。
Linq To Xmlに限らずXmlDocumentやXPathでもXmlファイルを操作する場合は、名前空間の指定のある要素にはそれぞれXNamespaceを明示的に指定しなければ予期したように動作しないので注意しよう。
マッピングファイルを書き換える理由は次の通り。複数のDBをまたいだクエリをLinq To Sqlで行う場合、マッピングファイルのTable要素は下記のようにServerName、DBNameを含んだ記述にしなければならない。
dbo.users → ServerName.DBName.dbo.users
SQL Server 2008で複数のDBを単一クエリで扱うための設定は下記を参照してほしい。
Linked Serverの設定方法
sp_addlinkedserver (Transact-SQL)
で、Linq To Xmlを使用してのマッピングファイルの読み込みなのだが、下記のようにXNamespaceを指定しないと予期したようにTable要素は取得できない。
var doc = XDocument.Load(mappingFilePath); XNamespace ns = "http://schemas.microsoft.com/linqtosql/mapping/2007"; var table = doc.Descendants(ns+"Table").Where(x => 条件).FirstOrDefault(); // 省略
Linq To Xmlに限らずXmlDocumentやXPathでもXmlファイルを操作する場合は、名前空間の指定のある要素にはそれぞれXNamespaceを明示的に指定しなければ予期したように動作しないので注意しよう。
登録:
投稿 (Atom)























