Apache Cordova 插件 GeoLocation 目录结构及启动配置教程

1. 项目的目录结构及介绍

Apache Cordova 插件 GeoLocation 的目录结构如下：

cordova-plugin-geolocation/
├── README.md             # 项目说明文件
├── LICENSE               # 项目许可证文件
├── package.json          # 插件包描述文件
├── plugin.xml            # 插件配置文件
├── src/
│   ├── android/          # 安卓平台源代码
│   │   ├── Java/         # Java 源代码
│   │   └── res/          # 资源文件
│   ├── ios/              # iOS 平台源代码
│   │   ├── cordova/      # Cordova 桥接代码
│   │   └── Plugins/      # 插件代码
│   └── www/              # 公共 JavaScript 代码
└── test/
    ├── spec/             # 单元测试文件
    └── www/              # 测试用例的网页文件

目录说明：

• README.md: 项目说明文件，介绍了插件的功能、使用方法以及如何贡献代码。
• LICENSE: 项目许可证文件，通常是 Apache License。
• package.json: 插件包描述文件，定义了插件的名称、版本、作者等信息。
• plugin.xml: 插件配置文件，定义了插件的ID、版本、依赖、平台特定配置等。
• src: 源代码目录，包含了不同平台（安卓、iOS）的源代码以及公共的 JavaScript 代码。
  • android: 安卓平台的实现代码。
  • ios: iOS平台的实现代码。
  • www: 公共 JavaScript 代码，可以在任何支持 Cordova 的平台上使用。
• test: 测试目录，包含了单元测试文件和测试用例的网页文件。

2. 项目的启动文件介绍

项目的启动文件主要是 plugin.xml，这是定义插件元数据和配置的地方。

<?xml version="1.0" encoding="UTF-8"?>
<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
        id="cordova-plugin-geolocation"
        version="0.4.0">
    <name>Geolocation</name>
    <description>Cordova Geolocation Plugin</description>
    <dependency id="cordova-plugin-geolocation" url="https://github.com/apache/cordova-plugin-geolocation.git" />
    <engines>
        <engine name="cordova" version="^8.0.0" />
    </engines>
    <js-module src="www/Geolocation.js" name="Geolocation">
        <clobbers target="navigator.geolocation" />
    </js-module>
    <platform name="android">
        <!-- Android-specific configuration -->
    </platform>
    <platform name="ios">
        <!-- iOS-specific configuration -->
    </platform>
</plugin>

启动文件说明：

• <plugin> 标签定义了插件的ID和版本。
• <name> 标签定义了插件的显示名称。
• <description> 标签提供了插件的描述。
• <dependency> 标签定义了插件的依赖。
• <engines> 标签定义了插件支持的 Cordova 引擎版本。
• <js-module> 标签定义了 JavaScript 模块，其中 src 属性指定了模块的路径，name 属性指定了模块的名称。
• <clobbers> 标签用于在全局对象上创建一个别名，这里将插件的 Geolocation 模块映射到 navigator.geolocation。

3. 项目的配置文件介绍

项目的配置文件主要是 config.xml，这是在创建 Cordova 项目时自动生成的，用于配置项目的名称、图标、版本等信息。

<?xml version='1.0' encoding='utf-8'?>
<widget id="io.cordova.hellocordova" version="1.0.0" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
    <name>Hello Cordova</name>
    <description>
        A sample Apache Cordova application that responds to the deviceready event.
    </description>
    <author email="[e-mail]">Apache Cordova Team</author>
    <content src="index.html" />
    <access origin="*" />
    <preference name="fullscreen" value="true" />
    <preference name="Orientation" value="portrait" />
    <platform name="android">
        <icon src="res/icon/android/mipmap-xxxhdpi/ic_launcher.png" />
    </platform>
    <platform name="ios">
        <icon src="res/icon/ios/icon.png" />
    </platform>
</widget>

配置文件说明：

• <widget> 标签定义了应用的ID和版本。
• <name> 标签定义了应用的显示名称。
• <description> 标签提供了应用的描述。
• <author> 标签定义了应用的作者及其联系邮箱。
• <content> 标签指定了应用的启动页面。
• <access> 标签定义了应用的访问权限。
• <preference> 标签定义了应用的偏好设置，例如是否全屏显示、屏幕方向等。
• <platform> 标签用于指定不同平台的特定配置，例如应用图标。