功能示例 React版使用介绍

Mars3D 5/8/2023

功能示例项目，是基于Mars3D 平台 (opens new window)做的一个按每个单独功能进行单页面展示、并且支持修改编辑代码实时运行的一个演示功能的系统。主要用于开发人员学习了解 Mars3D 每个功能的使用、用于业务人员了解体验 Mars3D 具备的功能点。

首先建议您学习浏览一遍我们功能示例的源码（源码中会有大量注释），阅读源码时可以结合查阅API文档来理解类及方法的作用和参数说明等。

# 项目介绍

这是一个基于 React 开发的 Mars3D 功能示例演示项目。

如果您不熟悉React，也可以阅读：功能示例原生JS版、功能示例Vue版。三个版本的 map.js 是相同的，区别是 UI 面板(index.vue、index.jsx、index.html)不同，UI 面板只是为了服务于功能操作和演示。

# 项目特性

最新技术栈：使用 React/Vite 等前端前沿技术开发
TypeScript: 应用程序级 JavaScript 的语言

# 视频讲解

建议先看一遍视频讲解，再实际操作，您可以

视频预览：

# 下载运行项目

# 下载代码

Github (opens new window)

git clone https://github.com/marsgis/mars3d-react-example.git

Gitee (opens new window)：国内码云，下载速度快些。

git clone https://gitee.com/marsgis/mars3d-react-example.git

# 运行环境

推荐使用 vscode，安装参考开发环境搭建教程
安装 vscode 插件，ESlint 、 Prettier
配置 vscode 参数， setting.json 相关配置

{
  "eslint.format.enable": true,
  "[json]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[typescript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[html]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[typescriptreact]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

下载最新 lib（可选）建议从http://mars3d.cn/download.html (opens new window)下载最新 mars3d 类库后覆盖至public/lib/目录下，更新 mars3d 为最新版本。

# 运行命令

请将机器Node版本升级到v16及以上版本

# 首次运行前安装依赖

npm install  

//或使用代理
npm i --registry=http://registry.taobao.org

1
2
3
4

注意：尽量使用 npm 安装依赖

# 启动开发环境

npm run serve

# 编译构建

npm run build //编译后生成在dist目录，拷贝出去发布即可
npm run serve:dist  //测试dist运行状态

// 或者将dist文件夹发布在自己的服务数据上

1
2
3
4

# 运行效果

在线体验 (opens new window)

# 如何反馈问题？

发现您发现项目中存在的问题或者需要优化的地方；
如果您有一些自己全新编写的示例，希望也开源与大家分享。

提交方式：

欢迎在 github 或 gitee 上提交 PR (opens new window)
如果对 git 不熟悉，也可以整理示例代码发送邮件到 wh@marsgis.cn 由我们来整理集成。

# 项目架构

# 主要技术选型

# 基础技术环境

Node (opens new window) 和 git (opens new window) ：运行环境(了解npm、git命令)
ES6+ (opens new window) ：熟悉 es6 基本语法
Vite (opens new window)：开发环境
ESlint (opens new window)：代码检查工具

# 主要目录说明

mars3d-react-example
└───src                 主要项目代码
│   └───components      react组件代码【重要】
│   └───example         示例代码【重要】
│   └───misc            主要存放ts相关的模块定义
│   └───pages           页面入口
│   └───styles          样式文件
│   └───utils           工具方法
└───public              无需编译构建的静态资源【重要】
│   └───config          项目和功能的配置文件
│   └───img             图片资源
│   └───lib             示例依赖资源
│   └───temp            示例的公共基础代码
│───.eslintrc.js        eslint配置文件
│─── package.json       项目配置信息
└─── vite.config.ts     vite 配置文件
└─── index.html         列表页入口
└─── editor-react.html        编辑器页面入口

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

与示例相关的 3 个主要目录是：src\example、public、src\components(部分功能依赖)。

# 示例主目录

位置 src/example
项目中的每一个示例对应了本目录下的一个 map.js 文件，如果包含 ui 面板，需要创建一个 index.tsx
一些情况下可以将 example 视为 public 下的一个目录

# 依赖资源

配置的依赖会在 html 中按配置顺序加载，注意配置时依赖之间的先后顺序。

libs 依赖，公共的通用依赖，统一放在public/lib/目录下，并由 includeLibs.js 统一配置。 libs 中通常会是一些开源的 js 库，如果示例只依赖 mars3d 相关资源，可省略 libs 字段。

{
  "name": "天地图地形",
  "main": "terrain/terrainTDT",
  "reactPanel": true,
  "libs": ["mars3d", "mars3d-tdt"],
  "thumbnail": "b10_terrain_tdt.jpg"
}

1
2
3
4
5
6
7

通过 includeLibs.js 中的 isLocal 变量，手动控制使用本地资源，还是 CDN 资源

resources 依赖，一些个性化的资源,在开发过程中提取封装的文件的依赖资源，比如只是单个示例本身使用的一些 js、css 文件。

{
  "name": "POI兴趣点搜索(Cesium原生)",
  "main": "control/cesium/geocoder",
  "resources": ["cesiumControl.css"],
  "thumbnail": "d10_geocoder.jpg"
}

1
2
3
4
5
6

同级目录下只需要配置文件名，不在同级目录的需配置打包后文件位置的绝对路径如 /example/graphic/apply/typhoon/Typhoon.js

# 单个示例的内部结构

每个示例都是一个单独的文件夹，均放在src\example示例目录下的子目录，因为示例众多，建议多级目录来管理。

# 示例相关文件

示例目录下，一般有 2 个文件（地图业务与 UI 解耦）：

map.js 文件：涉及地图业务的操作均写在 map.js 中；
index.tsx 文件：是一个 React 组件面板，涉及 UI 层面、和地图无关的操作均写在 index.tsx 中；

# 内部构流程图

示例的内部构造处理流程图：

# 添加新的示例

下面我们以src\example\map\sample\为示例说明。

# 1. 配置文件 example.json 中修改配置

在 public/config/example.json 中加上对应的配置项，这样就能在示例列表页面看到对应的示例卡片。

{
  "name": "示例名称",
  "main": "map/sample", //示例的相对路径
  "hasPannel": true, // 可选参数，表示是否存在ui面板，默认false
  "libs": [], // 通用依赖项，可选参数 默认 ["mars3d"]
  "resources": ["cesiumControl.css"], // 个性化依赖项, 可选参数，默认 []
  "thumbnail": "thumbnail.jpg" // 缩略图可选, 默认为 thumbnail.jpg
}

1
2
3
4
5
6
7
8

注：上述配置main为src\example下的相对路径

一个示例所有的配置文件的类型定义如下

interface ConfigSubChildren {
  name: string // 示例名称
  thumbnail?: string // 缩略图
  main: string // 入口，example下的相对路径
  hasPannel?: boolean // 该示例是否存在ui面板
  pannelFiles?: any[] // ui面板的依赖文件数组
  libs?: string[] // 外部依赖
  resources?: string[] // 内部依赖
  params?: string // 此示例的url后面的额外参数
  hidden?: boolean // 列表中隐藏此示例
}

1
2
3
4
5
6
7
8
9
10
11

# 2. 新建示例对应目录

在src\example示例目录下新建对应示例的子目录，因为示例众多，建议多级目录来管理，当前我们新建了src\example\map\sample\目录。

# 3. 新建 map.js 地图业务文件

在目录下新建map.js（文件名固定不可修改）主入口文件 map.js 主要用于处理地图相关业务。在文件中必须加上 initMap 方法来初始化地球和相关业务,比如：

最简结构如下

var map
// 事件对象，用于抛出事件给react
var eventTarget = new mars3d.BaseClass()

// 构造地图主方法【必须】
function initMap(options) {
  // 创建三维地球场景
  map = new mars3d.Map("mars3dContainer", options)
}

1
2
3
4
5
6
7
8
9

在 map.js 中存在以下全局方法, 并且已经预先加载了 mar3d 相关依赖

globalMsg(msg, type, ...args) // message
globalAlert(msg, title, ...args) // alert
globalNotify(msg, disc, ...args) // notify
showLoading(type) // 显示loading
hideLoading(type) // 关闭loading

1
2
3
4
5

完成后我们即可访问 http://localhost:8080/editor-vue.html?id=map/sample (opens new window)来查看示例的效果。

# map.js 中的几个特殊的变量和函数

onMounted：是 ui 整个示例的入口函数，只能在这里获取到地图对象
initMap：覆盖框架默认的初始化地图的方法（较少使用）
mapOptions 覆盖默认的地图配置，可以是一个函数，参数为默认的地图配置，返回值为新的配置

# 4. (按需可选)配置其他依赖资源

按示例本身需要来配置 libs 和 resources 依赖。

# 5. (按需可选)新建`index.tsx`业务窗口面板

在目录下新增index.tsx文件，该文件主要是用于 UI 面板相关的业务代码。创建控件 React 面板，可以参考已有示例加上相关业务面板。此文件必须默认导出一个 react 组件

同时在 example.json 中的对应示例增加配置hasPannel:true

# GUI控件

gui控件是为了快速实现复杂可交互表单的组件
通过 import {MarsGUI} from "@mars/components/MarsUI" 导入后即可使用

# 5.1. `index.tsx`面板操作`map.js`内地图相关对象时。

需要在 react 中加上下面代码进行访问

index.tsx 文件中：

// mapWork是map.js内定义的所有对象,目前在示例框架中做好了封装传递过来的。
import * as mapWork from "./map.js"

// 滑动条修改事件
mapWork.updateBrightness(formState.brightness)

1
2
3
4
5

map.js 文件中：

// map.js中
export function updateBrightness(val) {
  bloomEffect.brightness = val
}

1
2
3
4

# 5.2. `map.js`地图业务中需要操作`index.tsx`面板时。

map.js 文件中：

// 抛出事件
export const eventTarget = new mars3d.BaseClass()

//完成操作或取到相关数据后
eventTarget.fire("loadOk", { 需要传递到react中使用的对象 })

1
2
3
4
5

index.tsx 文件中：

// 取到js中的数据
mapWork.eventTarget.on("loadOk", function (event: any) {})

1
2

# 5.3. `map.js`和`index.tsx`各自代码业务分离的原则

原则：

涉及地图业务的操作均写在 map.js 中
涉及 UI 层面、和地图无关的操作均写在 index.tsx 中,react 中不得使用 mars3d 和 Cesium 开头的类(组件中出除外)

如何区分？

删除 index.tsx 时不影响地图本身业务，map.js 需要正常运行！！！
删除 map.js 时，index.tsx 需要正常展示 UI(除 mapWork 相关操作无响应外) ！！！

# 阅读示例源码和调试学习

示例的目的是演示平台的每个功能点，可以按需求或兴趣去学习每一个示例，

（1）学习中可以查询相关类的 API 文档
（2）尝试修改源码中参数、方法等，来体验不同的呈现效果。

# 开发中常见问题

# 1. 局域网离线使用时注意事项

平台所有代码层面来说支持离线运行和使用的，但需要注意的是离线时的地图服务的相关处理。

如果局域网内有相关地形、卫星底图服务可以按内网服务类型和 URL 地址替换下config.json或构造Map的代码中的默认地形和底图。

如果局域网内没有相关服务，可以按下面处理：

修改 config.json 中terrain配置中，将已有的"show": true配置，改为"show": false
修改 config.json 中basemaps数组配置中，将已有的"show": true的图层，将该值改为"show": false ，并将单张图片或离线地图加上"show": true，并修改相关 URL 地址。
您也可以参考教程发布三维数据服务进行部署离线地图服务，里面也有一些示例离线数据。

# 2. src\example\中增加的资源访问 404

因为新增静态资源涉及拷贝，需要重启服务 npm run serve

Mars3D开发教程

Choose mode