草庐IT

javascript - 如何使用 NodeJS 组织构建、服务器、客户端和共享 JavaScript 代码

coder 2023-05-30 原文

我一直认为在服务器上使用 NodeJS 的一大好处是可以在服务器端和客户端之间共享代码位(例如输入验证)。现在我实际上正在使用 NodeJS 进行开发,我发现的一个困难是确定执行每个代码主体的责任和上下文。下面我将列出我遇到的一些困难,希望能对我可能忽略的惯例或指导有所启发,以帮助提升这些问题。

构建时间代码

以遵循基本文档的方式为使用 Gulp、Grunt 或 vanilla NPM 的项目构建时间代码通常很容易遵循。大多数较小的项目倾向于将所有代码保存在一个文件中,并且该文件倾向于命名为 gulpfile.js 之类的传统名称,但是在较大的项目中,我看到这些脚本开始被拆分。我见过一些将 gulp 文件拆分为多个文件并放置在单独目录下的情况。更糟糕的是,我发现 gulpfile.js 文件甚至没有被命名为这样的情况,导致新开发人员四处寻找 gulpfile 所在的位置,一旦找到 gulp 命令总是必须使用特定的 - -gulpfile 选项。

运行时服务器端代码

基本 Node 应用程序的入口点似乎只需要在运行 Node 命令时指出特定的 JavaScript 文件(例如 node script.js )。对于 Web 服务器应用程序,例如使用 Express 的那些应用程序,我注意到按照惯例,入口点文件通常称为 server.js,通常可以在应用程序的根目录中找到。然而,在其他一些情况下,例如在开发人员环境中运行 Web 服务器时,我已经看到 gulp 任务承担了启动 Node.js 的责任。在这些情况下,似乎有多种方法可以包含入口点,但我发现的一个例子是刚刚启动 webpack 编译器,然后是入口点脚本的 require 语句。弄清楚如何结合关于如何完成典型的常规指导 node debug命令在这种类型的设置中非常重要。除了应用程序的入口点之外,似乎没有关于 NodeJS/Express 应用程序目录结构的任何通用指南,这些指南将服务器端特定代码保留在其位置以帮助定位它并将其与构建时间和客户端代码。

如果服务器端代码既用于提供静态内容、服务器端生成的 View (例如使用 MVC),又用于向客户端提供 API,则服务器端的情况会变得更加复杂边。我的偏好是将 API 与应用程序项目分开,但我从其他人那里得到的感觉是,这样做有一种过于复杂的感觉,我认为这是一种合理的关注点分离。

运行时客户端代码

由于客户端代码通常可以根据请求的第一页具有不同的入口点,因此这可能很棘手。然而,由于 URL 的一般透明性以及它们如何映射到典型情况下的资源以及调试工具在现代浏览器中变得多么强大,遵循脚本并没有太多麻烦。对于典型的构建过程来说,客户端代码的困难反而更多,这些过程通常最终会复制文件并将它们以不同的名称放入类似产品的结构中。一个例子是一个项目,它有一个名为 src 或 js 的文件夹,其中包含混合的客户端和服务器端代码,除了只有一部分文件碰巧包含在构建任务中,该任务转换并经常连接文件和将它们放在分发文件夹中。我见过的这些分发文件夹的通用名称是 dist、public、www 和 wwwroot。通常,如果不总是这些目录位于项目的根目录,这至少可以更容易地定位而无需询问构建脚本。

我希望有一些关于如何以理智的方式将所有这些放在一起的一般指导,也许是权威来源,主要是为像我这样可能想要正确开始的人提供指导。作为一个副作用,也许能够引用某种标准,即使它是一个松散的标准,也可以减少团队在开始时必须发明和讨论的样板数量。在上面列出的每个上下文中,显然会有一些特定于技术的约定,例如客户端上的 AngularJS、Meteor 或 ReactJS 遵循的约定。我正在寻找的约定更具体地用于分离端到端 JavaScript 应用程序中的主要高级上下文,其中语言和平台不再成为区分两者的明显方式。

最佳答案

构建时间代码

恕我直言,如果您有太多的构建时代码,以至于超过 1000 行并且需要多个文件,那么有些事情已经出轨了。要么你不知道如何充分利用 npm 中的现有包,要么你不了解如何重构通用代码并作为独立的 npm 包发布。如果你觉得你需要关于项目构建时代码的指导,因为它是如此庞大和复杂,我的建议是模块化并拆分成单独的项目 - 每个项目独立发布到 npm。也只需检查您的整体方法。你在做什么这么定制,需要这么多机器?

运行时服务器端代码

请参阅我对 ExpressJS How to structure an application? 的其他回答

通常,我宁愿看到客户端代码和服务器端代码完全独立的 npm 包(单独的 git repos、单独的 package.json 文件、独立发布)(如果它们足够大)或以其他方式混合在同一模块中并分组通过耦合(与功能相关的所有代码保存在一起,包括前端和后端代码),特别是如果您的代码库有大量可在两种环境中运行的代码。

我有一个名为 mjournal 的开源全栈 Node/JS 应用程序将浏览器代码和 Node 代码保持在一起。您可以查看一下,看看您是否觉得合乎逻辑并且易于理解代码所在的位置。这绝不是一种流行的方法,所以很多人会不喜欢它,但我个人感觉很好,因为我已经接受了“通过耦合分组”作为一般原则。

Figuring out how to incorporate normal guidance on how to accomplish a typical node debug command is non-trivial in this type of setup



是的,那是废话。您的应用程序应该以 npm start 开头或类似 node server.js .使新开发人员感到困惑的精心设计的 gulp/grunt 设置是您应该消除的不必要的复杂性。

The server-side story becomes even more complex in cases where the server side code is used both for the purpose for serving up static content



根据我的经验,提供静态内容的代码归结为 5 行或更少,所以没什么大不了的。如果您有处理静态内容的非微观代码量,那么某些事情又出轨了。

运行时客户端代码

My hope is that there is that there is some general guidance on how to put all of this together in a sane way perhaps by an authoritative source mainly to give guidance to those like myself who may want start off on the right foot.



Node 社区中有一些人采用了 Ruby on Rails、EmberJS 和其他一些大型项目所使用的“约定优于配置”的方法。如果您喜欢这种方法,请查看使用它的工具,如 SailsJS、EmberJS、Yeoman 生成器等。

但总的来说,寻找“标准”并不是 node.js/javascript/web 社区的滚动方式。小型 npm 包。由于小而被迫显而易见的文件布局。我在这里感到您的沮丧,因为前端工具链是如此复杂,但归根结底是因为浏览器中的 JavaScript 花了太多的时间来创建一个合理的模块系统。由于 ES6 模块是官方规范,因此在接下来的几年内事情可能会开始标准化,但是有这么多代码已经用 CommonJS 编写,而且它是像 RequireJS/AMD 这样可怕的前身,我们可能会在可预见的 future 处理它们。

关于javascript - 如何使用 NodeJS 组织构建、服务器、客户端和共享 JavaScript 代码,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/33337722/

有关javascript - 如何使用 NodeJS 组织构建、服务器、客户端和共享 JavaScript 代码的更多相关文章

  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. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  4. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  5. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

  6. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外,还有什么方法可以访问C和m中的其他内容?我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)?如何在使用完匿名模块后将其删除,使其定义的常量不再存在? 最佳答案 三个答案:是的,使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  7. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

    我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封,在我看来soap请求没有正确的命名空间。任何人都可以建议我

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

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

  9. 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

  10. 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

随机推荐