ArcGIS API for JavaScript代码框架理解

时间:2024-11-16 15:16:46

相信很多才开始接触ArcGIS API for JavaScript编程的人对下面这段代码都不陌生,本文主要讲这些是什么,为什么这么写,即What?Why?以知其然并知其所以然。

    <script>
      var map;
      require(["esri/map", "dojo/domReady!"], function(Map) {
        map = new Map("map", {
          basemap: "topo",  //For full list of pre-defined basemaps, navigate to /1JVo6Wd
          center: [-122.45, 37.75], // longitude, latitude
          zoom: 13
        });
      });
    </script>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10

一、为什么要用?
最早的时候,所有Javascript代码都写在一个文件里面,只要加载这一个文件就够了。后来,代码越来越多,一个文件不够了,必须分成多个文件,依次加载。如下面代码所示:

<script src=""></script>
<script src=""></script>
<script src=""></script>
<script src=""></script>
<script src=""></script>
<script src=""></script>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

这段代码依次加载多个js文件。
这样的写法有很大的缺点。首先,加载的时候,浏览器会停止网页渲染,加载文件越多,网页失去响应的时间就会越长;其次,由于js文件之间存在依赖关系,因此必须严格保证加载顺序(比如上例的要在的前面),依赖性最大的模块一定要放到最后加载,当依赖关系很复杂的时候,代码的编写和维护都会变得困难。
的诞生,就是为了解决这两个问题:
(1)实现js文件的异步加载,避免网页失去响应;
(2)管理模块之间的依赖性,便于代码的编写和维护。
二、的加载
使用的第一步,是先去官方网站下载最新版本。
下载后,假定把它放在js子目录下面,就可以加载了。

<script src="js/"></script>
  • 1

有人可能会想到,加载这个文件,也可能造成网页失去响应。解决办法有两个,一个是把它放在网页底部加载,另一个是写成下面这样:

<script src="js/" defer async="true" ></script>
  • 1

async属性表明这个文件需要异步加载,避免网页失去响应。IE不支持这个属性,只支持defer,所以把defer也写上。
加载以后,下一步就要加载我们自己的代码了。假定我们自己的代码文件是,也放在js目录下面。那么,只需要写成下面这样就行了:

<script src="js/" data-main="js/main"></script>
  • 1

data-main属性的作用是,指定网页程序的主模块。在上例中,就是js目录下面的,这个文件会第一个被加载。由于默认的文件后缀名是js,所以可以把简写成main。
三、主模块的写法
“主模块”,意思是整个网页的入口代码。它有点像C语言的main()函数,所有代码都从这儿开始运行。
如果我们的代码不依赖任何其他模块,那么可以直接写入javascript代码。

// 
alert("加载成功!");
  • 1
  • 2

但这样的话,就没必要使用了。真正常见的情况是,主模块依赖于其他模块,这时就要使用AMD规范定义的的require()函数。

// 
require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){
// some code here
});
  • 1
  • 2
  • 3
  • 4

require()函数接受两个参数。第一个参数是一个数组,表示所依赖的模块,上例就是[‘moduleA’, ‘moduleB’, ‘moduleC’],即主模块依赖这三个模块;第二个参数是一个回调函数,当前面指定的模块都加载成功后,它将被调用。加载的模块会以参数形式传入该函数,从而在回调函数内部就可以使用这些模块。
require()异步加载moduleA,moduleB和moduleC,浏览器不会失去响应;它指定的回调函数,只有前面的模块都加载成功后,才会运行,解决了依赖性的问题。
下面,我们看一个实际的例子。
假定主模块依赖esri/map、esri/tasks/query和esri/tasks/QueryTask这三个模块,就可以这样写:

require(['esri/map', 'esri/tasks/query', 'esri/tasks/QueryTask'], function (Map, Query, QueryTask){
// some code here
});
  • 1
  • 2
  • 3

会先加载esri/map、esri/tasks/query和esri/tasks/QueryTask,然后再运行回调函数。主模块的代码就写在回调函数中。
四、模块的加载
如果主模块的依赖模块是[‘jquery’, ‘underscore’, ‘backbone’]。默认情况下,假定这三个模块与在同一个目录,文件名分别为,和,然后自动加载。
使用()方法,我们可以对模块的加载行为进行自定义。()就写在主模块()的头部。参数就是一个对象,这个对象的paths属性指定各个模块的加载路径。

require.config({
paths: {
"jquery": "",
"underscore": "",
"backbone": ""
}
});
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

上面的代码给出了三个模块的文件名,路径默认与在同一个目录(js子目录)。如果这些模块在其他目录,比如js/lib目录,则有两种写法。一种是逐一指定路径。

require.config({
paths: {
"jquery": "lib/",
"underscore": "lib/",
"backbone": "lib/"
}
});
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

另一种则是直接改变基目录(baseUrl)。

require.config({
baseUrl: "js/lib",
paths: {
"jquery": "",
"underscore": "",
"backbone": ""
}
});
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

如果某个模块在另一台主机上,也可以直接指定它的网址,比如:

require.config({
paths: {
"jquery": "/ajax/libs/jquery/1.7.2/"
}
});
  • 1
  • 2
  • 3
  • 4
  • 5

要求,每个模块是一个单独的js文件。而在ArcGIS API中,init就是主模块,esri/map、esri/tasks/query和esri/tasks/QueryTask,就是主模块,各个模块在跟同路径下的esri文件夹中:
这里写图片描述

(完)