在ASP.NET MVC項目中使用RequireJS庫的用法示例
RequireJS 是一個前端模塊化開發(fā)的流行工具，本身是一個Javascript的庫文件，即require.js 。
RequireJs的主要功能：
（1）實現(xiàn)js文件的異步加載，避免網頁失去響應；
（2）管理模塊之間的依賴性，便于代碼的編寫和維護。
前端模塊化開發(fā)現(xiàn)在有好多的工具，大體上分為兩類，一類是像dojo之類的高大全，dojo v1.8之后已經內置了模塊化開發(fā)組件；另一類是像require.js，sea.js 這種專心做模塊化開發(fā)的工具。
從模塊化劃分的規(guī)則來區(qū)分，主要分為AMD、CMD兩類，dojo、require.js 遵從前者，而sea.js 依循CMD規(guī)范。
require在單頁面應用中能夠如魚得水，然而對于傳統(tǒng)的多頁面應用，使用require多少會有些困惑和不方便。
本文講解如何在ASP.NET MVC的結構中應用require，并且給出了壓縮腳本，實現(xiàn)半自動化壓縮。
將js代碼分離
一般而言ASP.NET MVC的一個路由對應一個視圖，視圖的文件結構可能如下：
Views |--Shared |--_layout.cshtml |--Home |--Index.cshtml |--Blog |--Create.cshtml |--Edit.cshtml |--Detail.cshtml |--Index.cshtml
這里假設_layout.cshtml是所有頁面共享的。一般情況下，我們會在_layout中引用公共的js類庫，比如jQuery，bootstrap等，這樣的話其他的頁面就不需要對這些類庫再引用一遍，提高了編碼的效率。然而，不同的頁面終究會依賴不同的js，尤其是實現(xiàn)頁面本身功能的自定義的js，這樣我們不得不在其他頁面中再引用特殊的js，甚至將js直接寫在頁面中，例如下面的代碼經常會出現(xiàn)在View中：
<script type="text/javascript">
$(function(){...});
</script>
這樣會導致頁面比較混亂，而且頁面<script>標簽中代碼不能被瀏覽器緩存，增加了頁面代碼的長度。更為重要的缺陷是，諸如jQuery之類的類庫會在加載到頁面后執(zhí)行匿名函數(shù)，這需要一些時間，而如果有些頁面根本不需要jQuery的話，只要頁面把_layout作為布局頁面，那么jQuery的初始化代碼將不可避免的執(zhí)行，這是一種浪費。事實上，javascript的模塊化加載的思想就是為了解決這些問題的。
接下來我們來用require規(guī)劃我們的js，構建諸如下面結構的js目錄
js |--app |--home.index.js |--blog.create.js |--blog.edit.js |--blog.detail.js |--blog.index.js |--jquery.js |--bootstrap.js |--underscore.js |--jquery.ui.js |--jquery.customplugin.js |--config.js |--require.js
把公共的類庫級別的js模塊直接放在js目錄下，而把頁面級別的js放在一個app的子目錄下。注意，在app中，每個頁面一個js文件，這意味著我們需要把頁面各自的js提取出來，雖然這樣增加了結構復雜度，但是避免了在頁面中隨手寫<script>標簽的陋習。另外，在js目錄下的公共庫，除了第三方的庫，還包括自己開發(fā)的庫，還有一個叫config.js的文件，這個文件很關鍵，稍后會說到。
然后，我們可以刪除_layout中所有的js引用，并使用@RenderSection的命令要求子頁面提供js引用，_layout.cshtml:
<head>
...
@RenderSection("require_js_module", false)
...
</head>
這樣對js的需求就下放到每個view頁面中了，根據require的用法，我們需要在各個子View中引用require.js，并指定主模塊，而這些主模塊就是上面app目錄下的一個個js
@section require_js_module{
<script src="@Url.Content("~/js/require.js")" data-main="@Url.Content("~/js/app/home.index.js")" ></script>
}
所有的js代碼都將寫到app下的js中，這樣規(guī)范了js，使得頁面更干凈，更為重要的是這些js還可以經過壓縮，以及被瀏覽器緩存等，進一步提高執(zhí)行效率
公共的config
我們知道主模塊除了使用require方法外，經常需要通過require.config來配置其他模塊的路徑，甚至需要shim，例如下面的代碼經常會出現(xiàn)在主模塊的開頭：
require.config({
paths: {
"jquery": "lib/jquery.min",
"underscore": "lib/underscore.min",
"backbone": "lib/backbone.min"
},
shim: {
'underscore':{
exports: '_'
},
'backbone': {
deps: ['underscore', 'jquery'],
exports: 'Backbone'
}
}
});
requirejs.config({
paths: {
"jquery": "/js/jquery.min",
"bootstrap": "/js/bootstrap"
},
shim: {
'bootstrap': {
deps: ['jquery'],
exports: "jQuery.fn.popover"
}
}
});
config.js的寫法沒有什么特別的，接下來只要在home.index.js中引用
require(['../config','jquery', 'bootstrap'], function () {
//main module code here
});
不過這樣寫還是不對的，因為，被主模塊依賴的模塊(這里的config,jquery,bootstrap)，在加載的時候，加載順序是不確定的，但是又需要config模塊在其他模塊之前加載，怎么辦呢？一個折衷的方案是修改home.index.js，成為如下代碼：
require(['../config'], function () {
require(['home.index2']);
})
, define("home.index2", ['jquery', 'bootstrap'], function () {
//main module code here
})
使用一個命名的模塊home.index2作為過渡，在主模塊中手動require，這樣可以保證config在主模塊執(zhí)行之前加載，也就使得home.index2在加載的時候已經加載了config了。
壓縮
require提供一個壓縮工具，用于壓縮和合并js，詳情請移步至http://requirejs.org/docs/optimization.html。簡單的說，require提供一個叫r.js的文件，通過本地的node程序（Node.js），執(zhí)行這個r.js并傳入一些參數(shù)，即可自動分析模塊互相之間的依賴，以達到合并和壓縮的目的。同樣的，這對于單頁面應用來說是容易的，因為主模塊只有一個，但是對于多頁面又如何做呢？好在這個壓縮工具支持用一個配置文件來指導壓縮，這樣的話，我們可以編寫下面的配置腳本build.js：
var build = {
appDir: '../js',
baseUrl: '.',
dir: '../js-built',
mainConfigFile: '../js/config.js',
modules: [
//First set up the common build layer.
{
//module names are relative to baseUrl
name: 'config',
//List common dependencies here. Only need to list
//top level dependencies, "include" will find
//nested dependencies.
include: ["bootstrap", "config","jquery"]
},
//Now set up a build layer for each page, but exclude
//the common one. "exclude" will exclude nested
//the nested, built dependencies from "common". Any
//"exclude" that includes built modules should be
//listed before the build layer that wants to exclude it.
//"include" the appropriate "app/main*" module since by default
//it will not get added to the build since it is loaded by a nested
//require in the page*.js files.
{
name:"app/home.index",
exclude:["config"]
},
{
name:"app/blog.create",
exclude:["config"]
},
...
]
}
通過這個命令來執(zhí)行壓縮，壓縮的結果將被保存到js-build目錄：
node.exe r.js -o build.js
build.js腳本實際上是一個js對象，我們將config加入公共模塊，而在各個主模塊中將其排除。這樣，所有的公共庫包括config將壓縮成一個js，而主模塊又不會包含多余的config。這樣可想而知，每個頁面在加載時最多只會下載兩個js，而且公共模塊的代碼會“按需執(zhí)行”。
執(zhí)行上面的腳本壓縮，需要安裝有node?？梢栽趶倪@里下載。
自動腳本
但是，隨著主模塊的增加，需要隨時跟蹤和修改這個build文件，這也是很麻煩的。于是，筆者基于node.js開發(fā)了一個叫build-build.js的腳本，用來根據目錄結構自動生成build.js：
fs = require('fs');
var target_build = process.argv[2];
//console.log(__filename);
var pwd = __dirname;
var js_path = pwd.substring(0,pwd.lastIndexOf('\\')) + '\\js';
console.log('js path : ' + js_path);
var app_path = js_path + '\\app';
console.log('js app path : ' +app_path);
var app_modules = [];
var global_modules = [];
//build json object
var build = {
appDir: '../js',
baseUrl: '.',
dir: '../js-built',
modules: [
//First set up the common build layer.
{
//module names are relative to baseUrl
name: 'config',
//List common dependencies here. Only need to list
//top level dependencies, "include" will find
//nested dependencies.
include: []
}
]
}
fs.readdir(app_path,function (err,files) {
// body...
if (err) throw err;
for(var i in files){
//put module in app_modules
var dotindex = files[i].lastIndexOf('.');
if(dotindex >= 0){
var extension = files[i].substring(dotindex+1,files[i].length);
if(extension == 'js'){
app_modules.push({
name: 'app/' + files[i].substring(0,dotindex),
exclude: ['config']
});
}
}
}
for(var j in app_modules){
build.modules.push(app_modules[j]);
}
fs.readdir(js_path,function (err,files){
if (err) throw err;
for(var i in files){
//put module in app_modules
var dotindex = files[i].lastIndexOf('.');
if(dotindex >= 0){
var extension = files[i].substring(dotindex+1,files[i].length);
if(extension == 'js'){
global_modules.push(files[i].substring(0,dotindex));
}
}
}
build.modules[0].include = global_modules;
//console.log(build);
var t = pwd + '\\' + target_build;
console.log(t);
var fd = fs.openSync(t, 'w');
fs.closeSync(fd);
var json = JSON.stringify(build);
fs.writeFileSync(t, json);
});
});
這里的代碼并不復雜，主要是遍歷目錄，生成對象，最后將對象序列化為build.js。讀者可以自行閱讀并修改。最后，編寫一個bat，完成一鍵壓縮功能，build.bat：
@echo off set PWD=%~p0 set PWD=%PWD:\=/% cd "D:\node" node.exe %PWD%build-build.js build.js node.exe %PWD%r.js -o %PWD%build.js cd %~dp0
這樣，我們就簡單實現(xiàn)了一個方便的多頁面require方案，最后項目目錄可能是這樣的：
Views |--Shared |--_layout.cshtml |--Home |--Index.cshtml |--Blog |--Create.cshtml |--Edit.cshtml |--Detail.cshtml |--Index.cshtml build |--build.js |--r.js |--build-build.js |--build.bat js |--app |--home.index.js |--blog.create.js |--blog.edit.js |--blog.detail.js |--blog.index.js |--jquery.js |--bootstrap.js |--underscore.js |--jquery.ui.js |--jquery.customplugin.js |--config.js |--require.js
相關文章
這篇文章主要介紹了JavaScript實現(xiàn)打字效果的方法,可實現(xiàn)文字陸續(xù)出現(xiàn)的打字效果,涉及javascript時間函數(shù)及頁面元素獲取的相關技巧,需要的朋友可以參考下2015-07-07
本文是小編基于js實現(xiàn)的520表白代碼，代碼簡單易懂非常不錯，具有一定的參考借鑒價值，需要的朋友參考下吧2018-05-05
這篇文章主要為大家詳細介紹了JS輪播圖的具體實現(xiàn)方法，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2020-08-08
這篇文章介紹了JS格式化時間的方法，文中通過示例代碼介紹的非常詳細。對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-04-04
這篇文章主要為大家介紹了uni-app實現(xiàn)全局水印示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2023-07-07
這篇文章主要介紹了技術男用來對妹子表白的百度首頁,非常有創(chuàng)意、有意思,需要的朋友可以參考下2014-07-07
JavaScript中函數(shù)聲明優(yōu)先于變量聲明的實例分析
同一個標示符，先后用var和function聲明它。最后它是什么呢2012-03-03
這篇文章主要介紹了javascript密碼強度校驗的實現(xiàn)方法，并給出了詳細代碼，需要的朋友可以參考下2015-11-11
這篇文章主要為大家詳細介紹了js實現(xiàn)3D粒子酷炫動態(tài)旋轉特效，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2020-09-09
javascript和jquery實現(xiàn)設置和移除文本框默認值效果代碼
這篇文章主要介紹了javascript和jquery實現(xiàn)設置和移除文本框默認值效果代碼,本文實現(xiàn)的是類似html5 placeholder（空白提示）一種效果,需要的朋友可以參考下2015-01-01