ViewModelのメソッド名はイベントを表す命名にしたいという話

Viewから呼び出すViewModelのメソッド名は、例えば save のようなアクションを表す命名ではなく onSaveButtonClick のようなイベントを表す命名にしたい、という趣旨のお話です。

これには、「ViewはViewModelを操作する」のではなく、「ViewはViewModelへイベントを伝搬する」という責務を明確にしたいという意図があります。

具体例

例えば、プロフィール編集画面を例に考えてみましょう。
この画面ではユーザーのアイコン, 名前などを編集でき、保存ボタンを押下すると編集されたプロフィールが保存されます。

この保存ボタン押下時にViewModelの save メソッドを呼び出して、編集されたプロフィールを保存するとします。

ここで、入力されたプロフィール情報のバリデーション結果に応じてエラーのアラートを表示することを考えます。(ボタン押下前にバリデーション結果を表示できた方がUX上は良いですが...)

ViewModelの save メソッドはプロフィールを「保存する」というアクションを表す命名になっており、「バリデーションが成功したら save メソッドを呼び出してプロフィールを保存するようにしよう」という思考へ派生しやすく、そうするとView側でバリデーションの処理を書きたくなってしまいます。

本来バリデーションのようなロジックは責務の観点からViewで書くべきではなく、ViewModel(あるいはより上のModel層)で実装されるべきです。

このように、「アクションを表す命名」でViewModelにメソッドを追加してしまうと、View側でViewModelを操作する余地が生まれやすく、ロジックがViewへ漏れ出てしまう可能性が高まると思っています。

これを防ぐために、ViewModelのメソッドは イベントを表す命名 にしたいと考えています。

今回の例だと、 save ではなく onSaveButtonClick のような命名に変更できれば、Viewの責務は ViewModelへイベントを伝搬すること のみであるということを明確にすることができ、バリデーションのロジックも自然とViewModelの onSaveButtonClick 内で書く流れが生まれやすいと思います。

また、ViewModelのメソッド名をイベントを表す命名にすることで、ViewModelをみた時に、Viewでどのような操作が行われたらViewModelはどういった状態になるのかを把握しやすくなるというメリットもあるかと思っています。

一方で、多少の冗長性が発生することも事実です。
例えば初回の画面表示時にコンテンツの読み込んで表示する画面があるとします。
読み込みに失敗した場合はリトライ導線を表示して再読み込みできるようにします。
この場合、ViewModelのメソッド名がアクションを表す命名であれば、画面表示時とリトライ時に同一の load メソッドをViewから呼び出してあげれば良いですが、イベントを表す命名の場合は画面表示とリトライという二つのイベントに対応するメソッドをViewModelへ追加する必要があるでしょう。

トレードオフにはなりますが、自分はそれでもイベントを表す命名の方がメリットは大きいかなと感じていて、好んでそのように命名しています。

---

今回の主張は絶対的な強い意志があるわけではなく、自分はこのような考えを持ってViewModelのメソッドにはイベント名を冠する命名をしている、というフワッとした意見です。

(実際、 Androidのアプリアーキテクチャガイド ではViewModelのメソッド名はアクションを表す命名がなされており、自分の意見が完全に正しいという自信は持てていません。)

みなさんの意見についても何らかフィードバックいただけると幸いです。