本文主要介绍如何在Vue项目中使用ArcGIS JS API进行开发,文中使用的JS API是目前最新版本的ArcGIS JS API 4.14,主要是在Vue项目demo中用JS API实例化了一张二维地图。
概述
在之前很长的一段时间中,使用ArcGIS JS API(以下简称“JS API”)开发WebGIS系统的时候,还是基于传统的前端框架和各种前端技术来开发,这些框架和技术各位使用过的大概有这些:Dojo、jQuery、Bootstrap、CommonJS等。用这些传统的技术框架结合JS API去开发的时候,我们引入JS API是在系统的HTML页面中通过<script>
和<style>
标签来引入,通常的做法是在主页(index.html)中引入,代码如下所示:
<link rel="stylesheet" href="http://localhost/4.14/esri/themes/light/main.css" />
<script src="http://localhost/4.14/init.js"></script>
目前,随着前端技术的不断发展,React和Vue等前端开发技术已经成为了一名前端开发者的标配,作为GISer的我们也毫无例外,在开发许许多多的WebGIS项目系统时,我们都会去选择目前主流的这些开发技术,其中使用最多的就是React和Vue这两种。所以本文就主要介绍下我们如何使用Vue结合JS API去开发我们的项目系统。
开始前的技术基础
- 有一定的Vue基础知识,熟悉ES6(能看懂一个Vue文件中HTML标签、CSS代码、JS代码之前的联系就行)
- 计算机安装了NodeJS,听说过npm这个东西
操作步骤
环境准备
在开始今天的介绍之前,我们要准备下开发环境,本文对开发环境有两个要求:NodeJS环境和Vue环境。如果各位没有这两个环境的话,请看下文进行安装;如果机子上有这两个环境,请跳过此节,从第二节开始阅读。
NodeJS环境安装
1.1.1、进入到NodeJS官网(https://nodejs.org/en/
)下载最新版的NodeJS,此处推荐下载LTS版本,这是稳定的并且官方长期支持更新的一个版本,如图:
1.1.2、下载完安装包之后,双击安装包,弹出安装界面,选择相应的安装目录后,我们一路点击【Next】按钮即可,中间过程并没有特别需要注意的地方。 1.1.3、安装完成后,我们打开命令行窗口,通过以下命令查看是否安装成功,如果出现以下版本号信息,则表示NodeJS环境安装部署成功:
代码语言:javascript复制node -v
npm -v
在这里可能有人会问NodeJS和npm的关系,其实NodeJS就是javaScripe的一个运行环境,它对谷歌V8引擎做了封装,是一个服务器端的JS解释器。npm是NodeJS的一个包管理器。我们在开发时如果要用到什么插件,需要先搜索、下载、安装到NodeJS环境中,然后才可以使用这个插件来开发完成某个需求,这个过程是相当繁琐的。有了npm包管理器,我们只需要在项目根目录下运行命令行,然后通过npm的安装命令将需要的插件一键安装到此项目或者NodeJS环境中,这是非常便捷的一件事情,而且很多大神将自己开发好的轮子上传到了npm网站上面,所以我们需要哪个插件,直接npm安装即可,不需要再去进行搜索、下载、安装这么麻烦的过程。 1.1.4、在此处我们安装NodeJS环境,说白了也是为了安装npm这个包管理器才进行的操作。
Vue环境搭建
Vue环境搭建其实就做两件事情,安装Vue和Vue脚手架工具。这两个安装都是通过npm来安装的,详细过程如下: 1.2.1、打开命令行工具,通过以下两个命令来分别安装Vue环境和Vue的脚手架工具,如下:
代码语言:javascript复制npm install vue
npm install -g @vue/cli
1.2.2、安装完成后,通过以下命令进行测试,出现版本号信息,则说明安装成功:
代码语言:javascript复制vue --version
到此处为止,我们的环境准备工作已经完成,接下来我们进入今天的正题,使用Vue结合JS API来开发。
初始化项目demo
2.1、在合适的目录下新建文件夹,然后在此文件夹中打开命令行工具,通过以下命令来创建一个基础的Vue项目demo,如下:
代码语言:javascript复制vue create vuejsapi414demo
以上命令使用了Vue的脚手架工具来初始化一个项目demo,demo名称为“vuejsapi414demo”,此名称可以自己随意取名。输入以上命令按回车之后,会出现项目初始化窗口,在此处需要我们选择项目中使用的插件,此处选择第一个默认的即可:
选择之后按回车,会进行插件安装和项目初始化工作,如下:
2.2、项目初始化结束后,我们使用命令行中提示的命令进入到项目根目录,然后通过提示命令来启动项目,并且在浏览器中通过地址“localhost:8080”来查看,如下:
代码语言:javascript复制cd .vuejsapi414demo
npm run serve
2.3、此时,初始化项目操作已经完成。我们通过vue脚手架来创建了一个基础的vue项目demo,接下来我们通过这个demo来介绍JS API如何跟Vue结合来开发使用。
ArcGIS JS API和Vue结合开发
以上过程已经完成了环境安装部署和项目初始化工作,接下来就要进行JS API的开发介绍了。 3.1、在Vue项目中使用JS API时已经不像传统的开发方式那样在index.html中引入JS和CSS文件来使用JS API,而是通过一个叫“esri-loader”的中间件,将我们的JS API和Vue项目做一个无缝衔接。 3.2、在命令行中通过Ctrl C来停止项目的运行,然后通过以下命令来安装esri-loader,如下:
代码语言:javascript复制npm install esri-loader --save-dev
3.3、安装结束后,通过命令npm run serve
重新启动项目,然后用编辑器打开我们初始化的这个项目代码,此处使用的是VS Code编辑器,各位可以使用Hbuilder、SublimeText3、
webStrom等编辑器,不做强制要求,如下:
3.4、然后打开项目根目录下的package.json文件,在这个文件中我们可以看到刚才安装的esri-loader插件,此时使用的是V2.13.0版本,如下所示:
3.5、接下来我们就在项目根目录下的src文件夹中,通过修改App.vue这个文件夹来介绍如何在Vue中使用JS API开发。如下,我们先删除App.vue这个文件中多余的HTML标签和一些JS代码,最后这个文件代码如下所示:
3.6、在此处我们就不新建标签了,直接在id为“app”的这个div中来实例化一个地图。接下来我们修改下body标签和id为“app”这个div的标签样式。代码如下:
代码语言:javascript复制body {
margin: 0; /**主要是去除谷歌浏览器默认的8像素的外边距 */
}
#app {
position: absolute; /**使这个div的大小撑满整个屏幕 */
width: 100%;
height: 100%;
}
3.7、然后加载引入我们安装的esri-loader插件,如下:
代码语言:javascript复制import {loadModules} from 'esri-loader';
3.8、引入esri-loader之后,接下来就让我们的项目系统和JS API做一个衔接。在这里大家一定要理解一个概念:我们在Vue中使用JS API时,调的接口这些还是我们传统开发调的那些接口API,esri-loader在这里仅仅是充当一个桥梁的作用,所以大家不要误认为esri-loader也是一个开发包哈。也就是说,你最终使用的JS API开发包还是我们本地部署或者JS API官网的开发包,并不是esri-loader里面的开发包。 做衔接之前,我们先创建一个mounted生命周期函数,然后在这个函数里调用创建地图的函数,代码如下:
代码语言:javascript复制import {loadModules} from 'esri-loader';
export default {
name: 'app',
methods: {
//创建地图
_createMapView: function() {
const _self = this; //定义一个_self防止后续操作中this丢失
const option = { //定义一个包含有JS API中js开发包和css样式文件的对象
url: 'http://localhost/4.14/init.js',
css: 'http://localhost/4.14/esri/themes/light/main.css',
};
//通过loadModules来做衔接
loadModules([], option)
.then(([]) => {
//业务代码在此处编写
}).catch((err) => {
_self.$message('地图创建失败,' err);
});
},
},
mounted: function() {
this._createMapView();
}
}
通过以上的代码,就将我们的项目系统代码和JS API做了一个衔接,其实就是在我们Vue项目中引入了JS API。接下来进行JS API的开发。 3.9、本文主要是通过实例化一张地图来介绍如何使用JS API开发。接下来的操作跟我们传统的开发方式就变得类似了,先是加载相应的JS API模块,然后在实例化各个模块,如下所示:
代码语言:javascript复制//通过loadModules来做衔接
loadModules(['esri/Map',
'esri/views/MapView'], option)
.then(([Map, MapView]) => {
//业务代码在此处编写
const map = new Map({ //实例化地图
basemap: "streets"
});
const view = new MapView({ //实例化地图视图
container: "app",
map: map,
zoom: 11,
center: [104.072044,30.663776]
});
view.ui.components = []; //清除掉地图左上角默认的缩放图标
}).catch((err) => {
_self.$message('地图创建失败,' err);
});
3.10、通过以上步骤,就实例化了一张二维地图,最终的效果如下所示:
总结
本文沿着Vue基础项目demo搭建到JS API的引入,并最终生成一张二维地图的过程进行了详细的介绍。本篇文章适合有一定Vue基础和JS API开发基础的人员查看学习,在本文中我们使用的JS API是本地部署的JS API,大家也可以将API地址换成官网的,只需要修改option这个对象的属性值即可,类似于下面:
代码语言:javascript复制const option = { //定义一个包含有JS API中js开发包和css样式文件的对象
url: 'https://js.arcgis.com/4.14/init.js',
css: 'https://js.arcgis.com/4.14/esri/themes/light/main.css',
};
通过修改如上的代码,就将JS API的引用地址换成了官网地址,只不过在此处运行的时候需要注意下跨域的问题。如果遇到跨域问题,可以通过配置Vue的配置文件来解决,具体操作不在本文范围内,可自行百度解决。大家在Vue和JS API结合开发时如果遇到什么问题,请联系博主解答。
附:
项目demo全部代码:
代码语言:javascript复制https://github.com/xuqwCloud/use_of_arcgis_js_api_in_vue
App.vue全部代码:
代码语言:javascript复制<template>
<div id="app">
</div>
</template>
<script>
import {loadModules} from 'esri-loader';
export default {
name: 'app',
methods: {
//创建地图
_createMapView: function() {
const _self = this; //定义一个_self防止后续操作中this丢失
const option = { //定义一个包含有JS API中js开发包和css样式文件的对象
url: 'http://localhost/4.14/init.js',
css: 'http://localhost/4.14/esri/themes/light/main.css',
};
//通过loadModules来做衔接
loadModules(['esri/Map',
'esri/views/MapView'], option)
.then(([Map, MapView]) => {
//业务代码在此处编写
const map = new Map({ //实例化地图
basemap: "streets"
});
const view = new MapView({ //实例化地图视图
container: "app",
map: map,
zoom: 11,
center: [104.072044,30.663776]
});
view.ui.components = []; //清除掉地图左上角默认的缩放图标
}).catch((err) => {
_self.$message('地图创建失败,' err);
});
},
},
mounted: function() {
this._createMapView();
}
}
</script>
<style>
body {
margin: 0; /**主要是去除谷歌浏览器默认的8像素的外边距 */
}
#app {
position: absolute; /**使这个div的大小撑满整个屏幕 */
width: 100%;
height: 100%;
}
</style>