帮助重构旧版自定义报告模块

Question

我有 Intranet win.forms（单击一次）应用程序，带有自定义内置报告模块（40 多个 WinWord 和 Excel 报告）。模块处于分离的组件中并通过接口进行抽象。我们有消息来源并继续支持它。

常见的界面如下：

IReportProvider {
  // introspection stuff 
  IEnumerable<ReportCategoryInfo> GetReportGroups();
  IEnumerable<ReportInfo> GetReports(Guid categoryId);
  ...

  // common function 
  ReportResult CreateReport(Guid reportId, ReportParamCollection prms, ..)
}

ReportInfo描述了基本信息和信息。所需参数。自动生成 UI，让用户选择报告参数。

class ReportInfo {
  public Guid Id { get; set; }
  public string Title { get; set; }
  public List<ReportParameterInfo> Params { get; set; }
  ...
}

ReportResult提供二进制报告表示以及二进制类型（是Word2003、Excel2003等）

class ReportResult {
  public byte[] Document { get; set; }
  public ReportType DocumentType { get; set; }
  public List<string> Warnings { get; set; }
  ...
}

没有身份验证要求，并且必须使用word/excel表示。 PDF 不受欢迎。

问题是 - 每次添加/更正报告时，我们都会更新报告模块并发布新的应用程序版本（因为它们是捆绑在一起的）。

我想：

• 更新报告时避免使用新的应用程序版本。
• 我们还必须添加 Intranet Web 界面来进行报告。

我将按以下方式重构当前代码：

• 将报告功能提取到单独的 WCF 服务中
• 将报告模板文件（Excel 和 Word 模板）从应用程序中取出，并放入仅报告服务可访问的文件夹中。
• 新的 WCF 服务将提供自省接口（存在哪些报告以及需要哪些参数）以及检索二进制报告表示形式（word 或 excel）的方法
• 应该有两个客户端与 WCF 服务通信：当前客户端的 Win.Forms 和 Web 客户端。客户端将提供报告导航UI界面，让用户填写参数并接收返回的报告文件。 Win.Forms 客户端将执行 WinWord 或 Excel 以显示收到的报告。

你对此有何看法？

Answer 1

首先：内网win.forms？您是在谈论 ClickOnce WinForms 应用程序、MSIE 托管的 WinForms 应用程序、带有嵌入式 Web 浏览器的 WinForms 还是更奇特的东西？我将假设您实际上有一个中央数据存储，因为否则您的 Intranet Web 界面将不会出现...

这实际上取决于您的 WCF 服务的接口（或者您选择托管和连接您的 WCF 服务的任何方式）服务逻辑）。你还没有真正描述过它们。需要思考的一些问题：

1. 它是纯粹基于数据的服务，还是进行一些用户界面处理？后者越多，同时对 Office 和 Web 报告的支持就越差……在一种极端情况下，每个报告必须有两个版本。然后，当您想为移动界面添加单独的 Web 版本时会发生什么？
2. 您如何将报告与服务分离？相同的服务可以支持多个报告吗？
3. 数据接口是笨重的还是冗长的？厚重的界面往往可以更好地扩展，但您会因为简单的查询而付出代价（因为您需要传递的数据比大多数报告所需的数据多）。
4. 您有用户身份验证和授权要求吗？是否有只允许部分用户查看的报告或数据？
5. WinWord 和 Excel 是必需的还是遗留的？用户是否真的需要可编辑的文档：如果不需要，Web 界面或提供 PDF 文件的服务就足够了吗？一般来说，Office 集成并不总是最容易支持的选项，尤其是当下一个 Office 版本或服务包出现时，或者最终用户开始修改他们的模板...

令我有些担心的是，您让 WCF 服务知道关于甚至处理报告模板文件（模板目录、内省接口）。为什么？让模板仅依赖于数据检索服务不是更干净吗？无论如何，您不会与网络报道有这种关系吗？