草庐IT

javascript - 如何在多页项目中使用RequireJS构建配置文件+ r.js

coder 2023-07-05 原文

我目前正在学习RequireJS基础知识,并且对构建概要文件,主文件以及RequireJS在多页项目中的使用有一些疑问。

我的项目的目录结构如下:

httpdocs_siteroot/
    app/
        php files...
    media/
        css/
            css files...
        js/
            libs/
                jquery.js
                require.js
                mustache.js
            mains/
                main.page1.js
                main.page2.js
                main.page3.js
            plugins/
                jquery.plugin1.js
                jquery.plugin2.js
                jquery.plugin3.js
            utils/
                util1.js
                util2.js
        images/

Since this project is not a single-page app, I have a separate main file for each page (although some pages use the same main file).

My questions are:

  1. Is RequireJS even practical for projects that are not single-page?

  2. Without using the optimizer, each of my main files start with essentially the same config options:

    requirejs.config({
      paths: {
        'jquery': 'http://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min'
      },
      baseUrl: '/media/js/',
      // etc...
    });
    require(['deps'], function() { /* main code */ });
    

    有办法避免这种情况吗?就像让每个主文件都包含相同的构建配置文件而无需实际构建它一样?
  3. r.js是否应该进入httpdocs_siteroot的父目录?
  4. 我的应用程序目录结构或使用RequireJS是否存在明显错误?

最佳答案

首先,这不是一个独特解决方案的问题。我将说明使用对我有用的RequireJS的方法,并且可能对您有用:)

其次,英语不是我的母语。有关该语言的更正和提示将不胜感激。随意,伙计们:)

1) Is require js even practical for projects that are not single-page?



这取决于。例如,如果您的项目在页面之间没有共享代码,则RequireJS帮助将不多。 RequireJS的主要思想是将应用程序模块化为可重用的代码块。如果您的应用程序仅使用特定于页面的代码,则使用RequireJS可能不是一个好主意。

2) Without using the optimizer, each of my main files start with essentially the same config options. Is there a way to avoid this? Like having each main file include the same build profile without having to actually build it?



我看到的唯一方法是在主文件上进行配置,或者创建一个将配置RequireJS的模块,然后将该模块用作对main.js的第一个依赖项。但这可能很棘手。我在应用程序中没有使用许多main.js文件。我仅使用一个充当加载程序的工具(请参见下文)。

3) Should r.js go in httpdocs_siteroot's parent directory?



不必要。您可以将其放在/media目录中,因为所有客户端内容均已存在。

4) Is there something glaringly wrong with my app dir structure or my use of requirejs?



我不会那么说。另一方面,结构可能过于分散。例如,您可以将所有“第3方资料”放在/vendor目录中。但这只是糖。您的结构会运作良好,而且看起来不错。我认为主要问题是在多个主文件中的requirejs.config()调用。

我遇到了与您现在同样的问题,最终得到以下解决方案:

1)不要将非AMD兼容文件包含定义。尽管有效,但是您可以使用requirejs.config中的“shim”属性获得相同的结果(请参见下文)。

2)在多页应用程序中,对我而言,解决方案是不需要来自优化的main.js文件中的特定于页面的模块。相反,我需要主文件中的所有共享代码(第3方和我自己的),而将特定于页面的代码保留在每个页面上。主文件最终只是一个加载器,该加载器在加载所有共享/lib文件后启动页面特定的代码。

这是我用于使用requirejs构建多页应用程序的样板

目录结构:

/src-我将所有客户端内容放入src目录中,因此可以在该目录(这是您的媒体目录)中运行优化程序。

/src/vendor-在这里放置所有第3方文件和插件,包括require.js。

/src/lib-在这里,我放置了所有自己的代码,这些代码由整个应用程序或某些页面共享。换句话说,不是页面特定的模块。

/src/page-module-xx-然后,我为每个页面创建一个目录。这不是严格的规则。

/src/main.js :这是整个应用程序的唯一主文件。它会:
  • 配置RequireJS,包括垫片
  • 加载共享库/模块
  • 加载页面特定的主模块

  • 这是requirejs.config调用的示例:
    requirejs.config({
            baseUrl: ".",
            paths: {
                // libraries path
                "json": "vendor/json2",
                "jquery": "vendor/jquery",
                "somejqueryplugion": "vendor/jquery.somejqueryplufin",
                "hogan": "vendor/hogan",
    
                // require plugins
                "templ": "vendor/require.hogan",
                "text": "vendor/require.text"
            },
            // The shim section allows you to specify 
            // dependencies between non AMD compliant files.
            // For example, "somejqueryplugin" must be loaded after "jquery".
            // The 'exports' attribute tells RequireJS what global variable
            // it must assign as the module value for each shim.
            // For example: By using the configutation below for jquery, 
            // when you request the "jquery" module, RequireJS will 
            // give the value of global "$" (this value will be cached, so it is
            // ok to modify/delete the global '$' after all plugins are loaded.
            shim: {
                "jquery": { exports: "$" },
                "util": { exports: "_" },
                "json": { exports: "JSON" },
                "somejqueryplugin": { exports: "$", deps: ["jquery"] }
            }
        });
    

    然后,在配置之后,我们可以发出第一个require()请求
    对于所有这些库,然后对我们的“页面主要”模块进行请求。
    //libs
    require([
        "templ",     //require plugins
        "text",
        "json",      //3rd libraries
        "jquery",
        "hogan", 
        "lib/util"  // app lib modules
     ],
        function () {
            var $ = require("jquery"),
                // the start module is defined on the same script tag of data-main.
                // example: <script data-main="main.js" data-start="pagemodule/main" src="vendor/require.js"/>
                startModuleName = $("script[data-main][data-start]").attr("data-start");
    
            if (startModuleName) {
                require([startModuleName], function (startModule) {
                    $(function(){
                        var fn = $.isFunction(startModule) ? startModule : startModule.init;
                        if (fn) { fn(); }
                    });
                });
            }
        });
    

    正如您在上面require()的正文中所看到的,我们期望require.js脚本标记上具有另一个属性。 数据启动属性将保存当前页面的模块名称。

    因此,在HTML页面上,我们必须添加以下额外属性:
    <script data-main="main" data-start="pagemodule/main" src="vendor/require.js"></script>
    

    这样,我们将得到一个优化的main.js,该文件包含“/vendor”和“/lib”目录(共享资源)中的所有文件,但不包含特定于页面的脚本/模块,因为它们不是在main.js中硬编码为依赖项。页面特定的模块将分别加载到应用程序的每个页面上。

    “页面主程序”模块应返回一个function(),该代码将由上述“应用程序主程序”执行。
    define(function(require, exports, module) {
        var util = require("lib/util");
    
        return function() {
            console.log("initializing page xyz module");
        };
    });
    

    编辑

    这是如何使用构建配置文件来优化具有多个文件的特定于页面的模块的示例。

    例如,假设我们有以下页面模块:

    /page1/main.js

    /page1/dep1.js

    /page1/dep2.js

    如果我们不优化此模块,那么浏览器将发出3个请求,每个脚本一个。
    我们可以通过指示r.js创建一个包并包含这3个文件来避免这种情况。

    在构建配置文件的“模块”属性上:
    ...
    "modules": [
       { 
          name: "main"  // this is our main file
       },
       {
            // create a module for page1/main and include in it
            // all its dependencies (dep1, dep2...)
            name: "page1/main",
            // excluding any dependency that is already included on main module
            // i.e. all our shared stuff, like jquery and plugins should not
            // be included in this module again.
            exclude: ["main"]
       }
    ]
    

    通过这样做,我们创建了另一个具有所有依赖关系的每页主文件。但是,由于我们已经有一个主文件可以加载所有共享的内容,因此我们无需在page1/main模块中再次包含它们。
    配置有点冗长,因为您必须为每个具有多个脚本文件的页面模块执行此操作。

    我将样板代码上传到GitHub:https://github.com/mdezem/MultiPageAppBoilerplate
    这是一个工作样板,只需为节点安装节点和r.js模块并执行build.cmd(在/build目录中,否则将失败,因为它使用相对路径)

    我希望我已经清楚了。让我知道是否听起来有些奇怪;)

    问候!

    关于javascript - 如何在多页项目中使用RequireJS构建配置文件+ r.js,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/11674824/

    有关javascript - 如何在多页项目中使用RequireJS构建配置文件+ r.js的更多相关文章

    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 - 使用 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

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

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

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

    5. 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$/)}当然这取决于

    6. ruby - 其他文件中的 Rake 任务 - 2

      我试图在一个项目中使用rake,如果我把所有东西都放到Rakefile中,它会很大并且很难读取/找到东西,所以我试着将每个命名空间放在lib/rake中它自己的文件中,我添加了这个到我的rake文件的顶部:Dir['#{File.dirname(__FILE__)}/lib/rake/*.rake'].map{|f|requiref}它加载文件没问题,但没有任务。我现在只有一个.rake文件作为测试,名为“servers.rake”,它看起来像这样:namespace:serverdotask:testdoputs"test"endend所以当我运行rakeserver:testid时

    7. ruby - 如何在 Ruby 中顺序创建 PI - 2

      出于纯粹的兴趣,我很好奇如何按顺序创建PI,而不是在过程结果之后生成数字,而是让数字在过程本身生成时显示。如果是这种情况,那么数字可以自行产生,我可以对以前看到的数字实现垃圾收集,从而创建一个无限系列。结果只是在Pi系列之后每秒生成一个数字。这是我通过互联网筛选的结果:这是流行的计算机友好算法,类机器算法:defarccot(x,unity)xpow=unity/xn=1sign=1sum=0loopdoterm=xpow/nbreakifterm==0sum+=sign*(xpow/n)xpow/=x*xn+=2sign=-signendsumenddefcalc_pi(digits

    8. ruby-on-rails - 在 Rails 中将文件大小字符串转换为等效千字节 - 2

      我的目标是转换表单输入,例如“100兆字节”或“1GB”,并将其转换为我可以存储在数据库中的文件大小(以千字节为单位)。目前,我有这个:defquota_convert@regex=/([0-9]+)(.*)s/@sizes=%w{kilobytemegabytegigabyte}m=self.quota.match(@regex)if@sizes.include?m[2]eval("self.quota=#{m[1]}.#{m[2]}")endend这有效,但前提是输入是倍数(“gigabytes”,而不是“gigabyte”)并且由于使用了eval看起来疯狂不安全。所以,功能正常,

    9. 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请求没有正确的命名空间。任何人都可以建议我

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

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

    随机推荐