進行状況を報告しながら、さまざまな形式でオブジェクトをエクスポートする
説明
WinFormsアプリケーションには、次のタイプのオブジェクトをさまざまな形式でエクスポートする機能があります。
class Item
{
public int id { get; set; }
public string description { get; set; }
}
ウィンドウ内のボタンをクリックすると、aSaveFileDialogが表示され、現在、データを.txt、.csv、または.xlsx形式で保存するオプションが提供されています。数百または数千のオブジェクトが存在する場合があり、UIがフリーズしてTaskはならないため、この操作を実行するためにaが使用されます。この実装は機能しますが、改善される可能性があります。
コード
public partial class ExportWindow : Form
{
// objects to be exported
List<Item> items;
// event handler for the "Export" button click
private async void exportButton_click(object sender, System.EventArgs e)
{
SaveFileDialog exportDialog = new SaveFileDialog();
exportDialog.Filter = "Text File (*.txt)|*.txt|Comma-separated values file (*.csv)|*.csv|Excel spreadsheet (*.xlsx)|*.xlsx";
exportDialog.CheckPathExists = true;
DialogResult result = exportDialog.ShowDialog();
if (result == DialogResult.OK)
{
var ext = System.IO.Path.GetExtension(saveExportFileDlg.FileName);
try
{
// update status bar
// (it is a custom control)
statusBar.text("Exporting");
// now export it
await Task.Run(() =>
{
switch (ext.ToLower())
{
case ".txt":
saveAsTxt(exportDialog.FileName);
break;
case ".csv":
saveAsCsv(exportDialog.FileName);
break;
case ".xlsx":
saveAsExcel(exportDialog.FileName);
break;
default:
// shouldn't happen
throw new Exception("Specified export format not supported.");
}
});
}
catch (System.IO.IOException ex)
{
statusBar.text("Export failed");
logger.logError("Export failed" + ex.Message + "\n" + ex.StackTrace);
return;
}
}
}
private delegate void updateProgressDelegate(int percentage);
public void updateProgress(int percentage)
{
if (statusBar.InvokeRequired)
{
var d = updateProgressDelegate(updateProgress);
statusBar.Invoke(d, percentage);
}
else
{
_updateProgress(percentage);
}
}
private void saveAsTxt(string filename)
{
IProgress<int> progress = new Progress<int>(updateProgress);
// save the text file, while reporting progress....
}
private void saveAsCsv(string filename)
{
IProgress<int> progress = new Progress<int>(updateProgress);
using (StreamWriter writer = StreamWriter(filename))
{
// write the headers and the data, while reporting progres...
}
}
private void saveAsExcel(string filename)
{
IProgress<int> progress = Progress<int>(updateProgress);
// EPPlus magic to write the data, while reporting progress...
}
}
質問
これをどのようにリファクタリングして、より拡張可能にすることができますか？つまり、より多くのファイルタイプのサポートを追加したい場合は、簡単かつ迅速に変更できるようにします。switchステートメントは非常に長くなる可能性があります。基本的に、オープン/クローズの原則に準拠する方法は？
回答
実際のエクスポートを独自のクラスに移動することをお勧めします。エクスポート用のインターフェースを作成できます。の線に沿った何か
public interface IExport<T>
{
Task SaveAsync(string fileName, IEnumerable<T> items, IProgress<int> progress = null);
string ExportType { get; }
}
次に、各エクスポートタイプでこのインターフェイスを実装できます。
public class ExportItemsToText : IExport<Item>
{
public Task SaveAsync(string fileName, IEnumerable<Item> items, IProgress<int> progress = null)
{
throw new NotImplementedException();
}
public string ExportType => "txt";
}
次に、ExportWindowのコンストラクターで
public ExportWindow(IEnumerable<IExport<Item>> exports)
{
// if using DI otherwise could just fill in dictionary here
ExportStrategy = exports.ToDictionary(x => x.ExportType, x => x);
}
switchステートメントの代わりに、辞書でキーを検索して、実行する必要のあるエクスポートを見つけることができます。見つからない場合は、デフォルトの場合と同じになります。
IExport<Item> exporter;
if (ExportStrategy.TryGetValue(ext.ToLower(), out exporter))
{
await exporter.SaveAsync(exportDialog.FileName, items, new Progress<int>(updateProgress))
}
else
{
throw new Exception("Specified export format not supported.");
}
将来、より多くのタイプのサポートを追加する場合は、インターフェイスを実装してDIコンテナを更新するだけです。または、DIを使用しない場合は、それをExportWindowのコンストラクターに追加する必要があります。
これは素晴らしいアイデアではないと思いますが、エクスポートごとにクラスを作成したくない場合は、辞書を作成しIDictionary<string, Action<string>>てからメソッドをそこに配置し、新しいタイプを追加するときにcreateを作成できます。メソッドと辞書を更新します。
以前のプロジェクトの1つ（ASP.NET上にあった）でこれ（一種）をすでに実装したので、私が持っているものを共有したいだけですが、他の環境に適用できます。実装はCharlesNRiceの提案と同様でした。ただし、要件は、システムレポート（1つのレポートテンプレートのみが使用される）をPdf、Excel、およびWordにエクスポートするオプションのみを持ち、将来的にはさらに多くのエクスポートオプションを用意することを交渉することでした。だからこれは私がそれをした方法です：
最初のインターフェース：
public interface IExportTo<T>
{
IExportTo<T> Generate();
void Download(string fileName);
void SaveAs(string fileFullPath);
}
次に、コンテナクラス：
public class ExportTo : IDisposable
{
private readonly IList<T> _source;
public ExportTo(IList<T> source)
{
_source = source;
}
public ExportExcel Excel()
{
return new ExportExcel(_source);
}
public ExportPdf Pdf()
{
return new ExportPdf(_source);
}
public ExportWord Word()
{
return new ExportPdf(_source);
}
#region IDisposable
private bool _disposed = false;
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
private void Dispose(bool disposing)
{
if (!_disposed)
{
if (disposing)
{
Dispose();
}
_disposed = true;
}
}
~ExportTo()
{
Dispose(false);
}
#endregion
}
上記のクラスでわかるように、エクスポートタイプごとにクラスを実装しました。1つのクラスを共有します（実際のクラスから単純化します）。
public sealed class ExportPdf : IExportTo<T>, IDisposable
{
private readonly IList<T> _source;
private ExportPdf() { }
public ExportPdf(IList<T> source) : this() => _source = source ?? throw new ArgumentNullException(nameof(source));
public IExportTo<T> Generate()
{
// some implementation
return this;
}
// another overload to generate by Id
public IExportTo<T> Generate(long reportId)
{
// do some work
return this;
}
// Download report as file
public void Download(string fileName)
{
// do some work
}
public void SaveAs(string fileFullPath)
{
throw new NotImplementedException("This function has not been implemented yet. Only download is available for now.");
}
#region IDisposable
private bool _disposed = false;
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
private void Dispose(bool disposing)
{
if (!_disposed)
{
if (disposing)
{
Dispose();
}
_disposed = true;
}
}
~ExportPdf()
{
Dispose(false);
}
#endregion
}
DownloadとSaveAsは異なります（同じではありません）。DownloadエクスポートされたファイルをダウンロードしSaveAs、オブジェクトインスタンスを保存します。しかし、これは依存関係を使用したため、このように実装されました。
今の使用法はこれを望みます：
new ExportTo(someList)
.Pdf()
.Generate()
.Download(fileName);
これは私がそのプロジェクトで実装した方法であり、改善される可能性がありますが、ビジネス要件についてはそれで十分です。
新しいタイプのエクスポートを追加する必要があるときはいつでも、新しいsealedクラスを作成して、IExportTo<T>, IDisposableそのクラスに実装するだけです。最後に、コンテナクラスを新しいタイプで更新し（このメソッドの新しいインスタンスを開くためのメソッドを追加します）、準備は完了です。