jjzjj

c# - 如何组织和命名在 WCF Web 服务中用作数据协定的 DTO

coder 2024-05-19 原文

我们在 WCF 网络服务中使用 DTO 作为数据契约。这些 DTO 的目的是仅公开与特定 API 方法相关的信息。

我想从你们那里寻求一些关于最佳实践的建议。

例如,考虑以下简单模型:

class Order
{
    int CreatedBy { get; set; }
    DateTime CreatedOn { get; set; }
    string Description { get; set; }
    int Id { get; set; }
    string Name { get; set; }
}

假设我们的 API 允许消费者创建更新获取 订单,我们创建了以下 DTO。为简单起见,删除了 DataMember 和 DataContract 属性。

Create 方法:用户无法指定 IdCreatedOn 属性,因此 DTO 如下所示:

class CreateOrderData
{
    int CreatedBy { get; set; }
    string Description { get; set; }
    string Name { get; set; }
}

Update 方法:用户无法指定 IdCreatedOnCreatedBy 属性,因此 DTO 看起来像这样:

class UpdateOrderData
{
    string Description { get; set; }
    string Name { get; set; }
}

Get 方法:用户应该能够看到订单的所有内容,因此 DTO 如下所示:

class OrderData
{
    int CreatedBy { get; set; }
    DateTime CreatedOn { get; set; }
    string Description { get; set; }
    int Id { get; set; }
    string Name { get; set; }
}

所以这是我的问题:

  • 假设 Order 模型中有更多属性,并且其中许多属性在“创建”和“更新”DTO 之间共享,那么让这些类从公共(public)基类扩展是否有意义?如果是,“获取”DTO (OrderData) 是否也应该从该类扩展?如果我们这样做,是否会让这些 DTO 过于依赖彼此?

  • 如果“创建”和“更新”DTO 的所有属性都是通用的,我们是否仍应创建两个不同的 DTO?如果是,为什么?如果不是,(现在这只是一个命名问题)“CreateOrUpdate”DTO应该叫什么,这样名字就明显不同于“Get”DTO?

  • 可以为所有 DTO 加上诸如“Data”、“DataObject”或“Dto”之类的后缀吗?

  • 我们走在正确的轨道上吗?如果不是,如何让这个设计变得更好?

更新:

我认为我不喜欢 DTO 中的继承,因为基类也将在 WSDL 中公开,客户端将能够看到它并实例化它,这对我来说似乎很脏(参见:WCF Serialization with object inheritance?) .如何在 DTO 中使用接口(interface)来强制执行公共(public)属性而不是继承?由于 DTO 中不应该有任何行为,因此我们通过替换继承不会损失太多。

最佳答案

由于这与个人喜好有很大关系,所以我会这样做..

  1. 我不会创建通用基类,因为它不符合 SOLID 中的 L。如果您担心 DRY,那么您可以改为创建聚合。

  2. 如果所有属性都是通用的,那么创建一个接受该对象的 Save 才有意义,订单 Dto 类将具有一个关键属性,该属性将指示其是否为现有订单。

  3. 我会用 Dto 作为后缀,因为很多 Dto 类名与域类相同,它们会混淆,因为它们将一起存在于同一个方法中。然后你可以用 DataContract(Name="Order", Namespace="htp://yourdomain/..") 装饰你的 Dtos。这样他们就会根据你自己的喜好暴露给外界。

我参与过多个使用相同通用架构的项目,我通常使用 AutoMapper 将 dto 映射到域。它对我很有用!

关于c# - 如何组织和命名在 WCF Web 服务中用作数据协定的 DTO,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/11979688/

有关c# - 如何组织和命名在 WCF Web 服务中用作数据协定的 DTO的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法? - 2

    总的来说,我对ruby​​还比较陌生,我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础,我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  4. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息? 最佳答案 在Rails3中,update_all不返回任何有意义的信息,除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  5. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

  6. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  7. ruby - 如何指定 Rack 处理程序 - 2

    Rackup通过Rack的默认处理程序成功运行任何Rack应用程序。例如:classRackAppdefcall(environment)['200',{'Content-Type'=>'text/html'},["Helloworld"]]endendrunRackApp.new但是当最后一行更改为使用Rack的内置CGI处理程序时,rackup给出“NoMethodErrorat/undefinedmethod`call'fornil:NilClass”:Rack::Handler::CGI.runRackApp.newRack的其他内置处理程序也提出了同样的反对意见。例如Rack

  8. ruby - 如何每月在 Heroku 运行一次 Scheduler 插件? - 2

    在选择我想要运行操作的频率时,唯一的选项是“每天”、“每小时”和“每10分钟”。谢谢!我想为我的Rails3.1应用程序运行调度程序。 最佳答案 这不是一个优雅的解决方案,但您可以安排它每天运行,并在实际开始工作之前检查日期是否为当月的第一天。 关于ruby-如何每月在Heroku运行一次Scheduler插件?,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questions/8692687/

  9. ruby-on-rails - 如何从 format.xml 中删除 <hash></hash> - 2

    我有一个对象has_many应呈现为xml的子对象。这不是问题。我的问题是我创建了一个Hash包含此数据,就像解析器需要它一样。但是rails自动将整个文件包含在.........我需要摆脱type="array"和我该如何处理?我没有在文档中找到任何内容。 最佳答案 我遇到了同样的问题;这是我的XML:我在用这个:entries.to_xml将散列数据转换为XML,但这会将条目的数据包装到中所以我修改了:entries.to_xml(root:"Contacts")但这仍然将转换后的XML包装在“联系人”中,将我的XML代码修改为

  10. ruby - 如何使用文字标量样式在 YAML 中转储字符串? - 2

    我有一大串格式化数据(例如JSON),我想使用Psychinruby​​同时保留格式转储到YAML。基本上,我希望JSON使用literalstyle出现在YAML中:---json:|{"page":1,"results":["item","another"],"total_pages":0}但是,当我使用YAML.dump时,它不使用文字样式。我得到这样的东西:---json:!"{\n\"page\":1,\n\"results\":[\n\"item\",\"another\"\n],\n\"total_pages\":0\n}\n"我如何告诉Psych以想要的样式转储标量?解

随机推荐