完全コンストラクタパターンのコレクションをDataGridで編集するには

Question

社内でツールなどを作っている者です、他に訪ねる宛てもなく
この方法が正しいのか間違っているのかわかりません
一般的な方法など教えて頂ければと思います

C# + WPF + Prism な環境で DDD的手法で開発を行っています

DataGridにデータクラスのコレクションをバインドして表示、編集を行いたいと考えております

データクラスは完全コンストラクタパターンにするため、各プロパティは読み取り専用ですので
ViewでのバインディングモードをOneWayやOneTimeとしたところテキストボックスの編集は可能ですが
DataGridのRowChanged後に編集前のテキストに戻ってしまいます

幸い入力値はDataGridのLostFocusイベントのRoutedEventArgs引数のOriginalSourceプロパティにありましたので
これを元にデータクラスを新たに作成しDataGridのItemSourceを再指定することで、データクラス、Viewが入力したものに
なることをできたのですが、Viewの編集が無効になる点、LostFocusイベントでしか入力値を取得出来ない点を考えると
そもそもDataGridでの編集に読み取り専用のデータクラスは利用しないほうがいいのかと思えます

その他に考えられる方法は
１DataGridの編集にのみ利用するクラスなのだから読み取り専用にしない
２読み書き可能なデータクラスを作っておき、ViewModeで載せ替える
ぐらいしか思いつかないのですが、このような場合はどのようにするのが一般的なのでしょうか

Comments

[Zuishin]

編集するのに読み取り専用にする意味がわかりません。

[kawaguti]

読み取り専用とすることで他からのデータの変更をできないようにしたいのです
DataGrid用に書き可能な点のみ違うクラスを別途作成ほうが良いのでしょうか

Answer 1

私はアマチュアなので一般的な方法はわかりませんが、C# 9.0でレコード型が入ったことですしちょっとやってみました。

• C# 9.0以上
• Prism（面倒なのでDIしません）
• ReactiveProperty（後片付けしてません）

<Window
 x:Class="Questions305906.Views.MainWindow"
 xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
 xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
 Width="525"
 Height="350">
 <DockPanel>
  <StackPanel DockPanel.Dock="Top" Orientation="Horizontal">
   <Button Command="{Binding AddCommand}" Content="アイテム追加" />
   <Button Command="{Binding DispCommand}" Content="モデル確認" />
  </StackPanel>
  <DataGrid AutoGenerateColumns="False" ItemsSource="{Binding Items}">
   <DataGrid.Columns>
    <DataGridTextColumn Binding="{Binding Id}" Header="ID" IsReadOnly="True" />
    <DataGridTextColumn Width="200" Binding="{Binding Name}" Header="名前" />
    <DataGridTextColumn Width="100" Binding="{Binding Price}" Header="値段" />
   </DataGrid.Columns>
  </DataGrid>
 </DockPanel>
</Window>

namespace Questions305906.Models
{
    using System.Collections.ObjectModel;
    using System.Diagnostics;
    using System.Linq;

    public record ItemModel(int Id, string Name, int Price);

    public class Provider
    {
        public ReadOnlyObservableCollection<ItemModel> Items { get; }
        private readonly ObservableCollection<ItemModel> items;

        public Provider()
        {
            items = new()
            {
                new(Id: 1, Name: "aaa", Price: 123),
                new(Id: 2, Name: "bbbb", Price: 456),
                new(Id: 3, Name: "ccccc", Price: 7890),
            };

            Items = new(items);
        }

        public void Replace(ItemModel oldValue, ItemModel newValue)
        {
            var index = items.IndexOf(oldValue);
            items.Remove(oldValue);
            items.Insert(index, newValue);
        }

        public void Add()
        {
            var id = items.Max(x => x.Id) + 1;
            items.Add(new(Id: id, Name: "", Price: 0));
        }

        public void Disp()
        {
            foreach (var item in items) Debug.WriteLine(item);
        }
    }
}

namespace Questions305906.ViewModels
{
    using Prism.Mvvm;
    using Questions305906.Models;
    using Reactive.Bindings;
    using Reactive.Bindings.Extensions;
    using System;

    public class ItemViewModel : BindableBase
    {
        public int Id { get; }

        private string _Name;
        public string Name { get => _Name; set => SetProperty(ref _Name, value); }

        private int _Price;
        public int Price { get => _Price; set => SetProperty(ref _Price, value); }

        internal ItemModel Item;
        internal ItemModel NewItem => Item = Item with { Name = Name, Price = Price };


        public ItemViewModel(ItemModel item) => (Item, Id, Name, Price) = (item, item.Id, item.Name, item.Price);
    }

    public class MainWindowViewModel : BindableBase
    {
        public ReadOnlyReactiveCollection<ItemViewModel> Items { get; }
        public ReactiveCommand AddCommand { get; } = new();
        public ReactiveCommand DispCommand { get; } = new();

        private readonly Provider provider = new();


        public MainWindowViewModel()
        {
            Items = provider.Items.ToReadOnlyReactiveCollection(x => new ItemViewModel(x));
            Items.ObserveElementPropertyChanged().Subscribe(x => provider.Replace(x.Sender.Item, x.Sender.NewItem));

            AddCommand.Subscribe(() => provider.Add());
            DispCommand.Subscribe(() => provider.Disp());
        }
    }
}
// .NET5でない場合
//namespace System.Runtime.CompilerServices
//{
//    public class IsExternalInit { }
//}

同値があるとおかしくなるのは目に見えているので、Idをユニークにしました。
DataGridのプレースホルダも使用しませんでした（方法はありそうですが未調査）

結局どうにかして詰め替えるしかないわけですが、ReactivePropertyのおかげでそれほど面倒というわけでもなかったです（M→VMの詰め替え・Provider.Itemsの入れ替え、どちらも）
しかしこれは筋がいいとは思えないです（NewItemの雑さ^^;

レコード型が浸透してきてライブラリ等のサポートが入ってくれば、また変わると思います。まあこれからですね^^

---

追記
.NET Core 3.1でのcsproj（↑提示コードの最下段System.Runtime.CompilerServices.IsExternalInitのコメントを外してください）

<Project Sdk="Microsoft.NET.Sdk.WindowsDesktop">
  <PropertyGroup>
    <OutputType>WinExe</OutputType>
    <TargetFramework>netcoreapp3.1</TargetFramework>
    <UseWPF>true</UseWPF>
    <AssemblyName>Questions305906</AssemblyName>
    <LangVersion>9.0</LangVersion>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="Prism.DryIoc" Version="8.0.0.1909" />
    <PackageReference Include="ReactiveProperty" Version="7.5.1" />
  </ItemGroup>
</Project>

Comments

[kawaguti]

NET5.0 ですか
私の職場は来年には１０になりそうですが未だ７が現役なのでまったく調べていませんでした
レコード型いいですね、これにWith式や提示して頂いたObserveElementPropertyChangedなどで載せ替えが簡単にできそうです

今できる対応としてReactivePropertyを積極的に使うようにしてみます

参考になるコードを提示していただきましてありがとうございます

[TN8001]

念のため（私も最初間違ってしまったのですが^^;

.NET5でなくても
<LangVersion>9.0</LangVersion>
とすれば使えます。
その際「IsExternalInit がないよ」と怒られますが、回答コード最後のように自分で空定義します。

[kawaguti]

言語使用だけなので
Windows7で使えるということでしょうか

提示して頂いたコードをWindows10,Core2.1の環境でプロジェクトファイルを書き換えて実行して見ましたが、「リモート言語サーバー C#/Visual Basic 言語サーバー クライアント をアクティブにする処理でエラーが発生しました。 For more details, please examine the 以下ファイルパス」とエラーが出ました。
すごく興味はありますが本件とは外れてしまいますのでお構い無ければ参照先URLなど教えて頂けましたら助かります

[TN8001]

WPFは .NET Core 3.0 からじゃなかったでしたっけ？
[.NET Core 3.0 の新機能 | Microsoft Docs](https://docs.microsoft.com/ja-jp/dotnet/core/whats-new/dotnet-core-3-0

.NET Core 3.1
.NET Framework 4.8
で（Prismレスで）ざっと確認しましたが動きました。
Windows7は手元にないので確認できませんが、おそらく動くと思うのですが。

record自体は不変なデータクラスを簡単に作れるようにするってだけですので、自分でクラスを書いても同じです。

C#9の確認がてら回答しましたが、
[C# 9.0 の新機能 - C# ガイド | Microsoft Docs](https://docs.microsoft.com/ja-jp/dotnet/csharp/whats-new/csharp-9

* レコード
* init 専用セッター（withで使用）
* ターゲット型の新しい式（new()の事）
を使わないように書き換えれば、C#9すら必要なくなります。
C#8版を上げてもいいのですが、せっかくスッキリしていたものをゴチャつかせるようで乗り気しないですね（逆だったら気分が良いのですが^^;

[kawaguti]

アプリケーションの追加と削除でみたところCore2.1とあったんですがバッタ物かもしれませんね

こちらで動作しないと言うことはcsprojファイルの書き方が悪いのかもしれません。
レコードももちろんですが、new() の見やすさで C# 9.0に変更したくてしょうがないです。ググってもあまり情報がなかったのとエラーで諦めていましたがもう一度検索してみます

が、もし、もしお構い無ければcsprojの内容を教えて頂けたら幸いです

C#8はまたググってみます
ありがとうございました

[kawaguti]

あぁ、気づかないうちにサンプルまで・・・
何から何までありがとうございます

[kawaguti]

頂いたサンプル動きました!
環境はWindows7 + Core3.1 + C# 9.0です

これで手間はかかりますが現状のアプリケーションをC#9.0に移行できそうです。
ここまでご指導くださったおかげです、ありがとうございました

Answer 2

こんばんは。

Prismを利用されているとのことなので、MVVMパターンに従って開発しているということで宜しいでしょうか。
完全コンストラクタを遵守するとして私が作るとしたら、

• Model…完全コンストラクタのクラス
• ViewModel…DataGridにバインドし、書き換えられたらModelのクラスを更新するクラス

とすると思います。
多分これが一番綺麗にまとまります。

##サンプルコード
###Model (C#)

// 参照関連面倒なので構造体にしてあります。クラスに書き換える場合は参照渡しになるので注意して下さい。
public struct NameIndexPair
{
    // プロパティの名前は適当です
    public string Name { get; }
    public int Index { get; }
    
    public NameIndexPair(string name, int index)
    {
        Name = name;
        Index = index;
    }
}

public class MainClass
{
    public MainClass()
    {
        public List<NameIndexPair> NameIndexPairs { get; } = new List<NameIndexPair>()
        {
            new NameIndexPair("あああ", 123),
            new NameIndexPair("いいい", 456),
        };
    }
}

###MainWindow (XAML)

<Window …略…>
    <StackPanel>
        <DataGrid ItemsSource="{Binding Items}" />
    </StackPanel>
</Window>

###MainWindow (C#)

public class MainWindow : Window
{
    public MainWindow()
    {
        InitializeComponent();
        DataContext = new MainWindowViewModel();
    }
}

###ViewModel

//using Prism.Mvvm;
//using Prism.Commands;

public class MainWindowViewModel : BindableBase
{
    public MainClass M { get; } = new MainClass();
    public ObservableCollection<NameIndexPair> Items { get; } = new ObservableCollection<NameIndexPair>();
    
    public MainWindowViewModel()
    {
        M.NameIndexPairs.ForEach(p => Items.Add(p));
        Items.CollectionChanged += (sender, e) =>
        {
            M.NameIndexPairs = new List();
            Items.ForEach(p => M.NameIndexPairs.Add(p));
        };
    }
}

実行環境が手元に無いので動作確認出来ていません。ごめんなさい。
もし動かなかったら言って下さい。

Comments

[kawaguti]

こんばんは。

Modelでは完全コンストラクタのクラスを作成して、ViewModelでは書き換え可能なクラスを定義し、コレクションとすることで、Modelから載せ替え先とする。それをDataGridでバインディングして利用するということでしょうか

確かにViewModel内でのみ書き換え可能な一時的なクラスを用意すれば不用意なデータの修正の可能性は下がりそうです
ですが、一度読み込んだデータの変更を認めず、変更はクラスのコンストラクタのみとする完全コンストラクタパターンからは少し外れているような気もします

これば普通だよと言われればそれまでですが

ともあれご回答ありがとうございます

[Automatic9045]

読み直しましたが、言葉不足で意味不明な回答になってましたね……すみません。
サンプルコードを追記しようと思います。

[kawaguti]

ご回答ありがとうございます

わかりやすいコードをありがとうございます
ViewModelでの載せ替えが肝ですね

やはりMVVMパターンでありながらも完全コンストラクタを利用する場合では積み替えする方法がわかりやすいようですね

雑な質問文にコードまで提示頂きまして感謝いたします