config.xml文件参数分析

在本地项目中添加cordova：http://www.jianshu.com/p/6a16c260851e
创建一个cordova项目：http://www.jianshu.com/p/8773ab98a833
官方文档：http://cordova.apache.org/docs/en/latest/config_ref/index.html

简述：config.xml文件配置项目工程的行文。当CLI创建cordova项目之后就会在根目录中存在一个，当执行cordova plugin add完毕后会在相对应的平台后面自动生成一个，通常情况下是复制根目录下的文件进去的。

参数含义：

• 根元素widget：
  • id/version为必选项，说明神马的略。
  • iOS平台特有参数ios-CFBundleIdentifier、ios-CFBundleVersion应用版本号，会覆盖version项。
• AppStore含义参数:
  • name/shortName:名称，出现在AppStore的APP名称上
  • description:描述，出现在AppStore的APP描述上
  • 通常情况下这三个参数都是不会出现在config.xml文件中的，因为大多都会在appst中自定义
• author:开发者名称及联系方式，如：

<author email="dev@cordova.apache.org" href="http://cordova.io"></author>

• content:定义了启动APP时使用的HTML文件，默认情况下是index.html。在www的文件目录下。
• access:外部访问白名单
  • ios9以后，苹果要求所有的应用默认使用ATS

  <access origin='*' allows-arbitrary-loads-for-media='true' allows-arbitrary-loads-in-web-content='true' allows-local-networking='true' />
  <!---以上写法4.5.0版本以后过期---->
  <access origin='https://cordova.apache.org' minimum-tls-version='TLSv1.2' requires-forward-secrecy='true' requires-certificate-transparency='false' />
  

• allow-navigation:定义webview被访问白名单
• allow-intent:定义允许APP访问的系统URL
  区分平台配置：

  <platform name="android">
       <allow-intent href="market:*" />
   </platform>
   <platform name="ios">
     <allow-intent href="http://*/*" />
     <allow-intent href="https://*/*" />
     <allow-intent href="tel:*" />
     <allow-intent href="sms:*" />
   </platform>

• preference

  • AllowInlineMediaPlayback:默认为false。
    如果设置为Yes,则可以让html5在页面内播放视频而不是调用原生视频播放器。同时要在<video>标签内添加playsinline属性，在iOS10之前使用webkit-playsinline属性。
  • AppendUserAgent:如果设置这个属性，那么webview在加载数据的时候，会将这个参数的值拼接在原有的UA后面，如果使用了OverrideUserAgent则这个参数忽略。
  • BackgroundColor:背景颜色，通用属性。支持十六进制颜色
  • BackupWebStorage:备份属性，默认为cloud，其他参数为：none,local.
  • CordovaWebViewEngine:默认为CDVUIWebViewEngine，也就是说默认情况下cordova使用UIWebView来加载页面。当然也可以使用其他自定义插件，但是需要遵循CDVWebViewEngineProtocol这个协议。如果需要提高性能使用WKWebView，可以添加cordova-plugin-wkwebview-engine插件。并在config.xml中做如下配置：

  <feature name="CDVWKWebViewEngine">
  <param name="ios-package" value="CDVWKWebViewEngine" />
  </feature>
  <preference name="CordovaWebViewEngine" value="CDVWKWebViewEngine" />
  

  • CordovaDefaultWebViewEngine:与CordovaWebViewEngine一致，但是如果两个都配置，则与CordovaWebViewEngine为iOS9及以上使用，CordovaDefaultWebViewEngine为iOS8及以下使用。
  • DisallowOverscroll:是否可滚动，默认为false,可以滚动。
  • EnableViewportScale:默认情况下可缩放，如果需要填满视图，不可缩放，可使用如下代码：

  <meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' />
  

  • ErrorUrl:如果加载视图发生错误，并配置了这个参数，则使用这个值来展示页面。
  • 与WebView的属性相对应
    • GapBetweenPages
    • KeyboardDisplayRequiresUserAction
    • MediaPlaybackAllowsAirPlay
    • MediaPlaybackRequiresUserAction
    • PageLength
    • PaginationBreakingMode
    • PaginationMode

• feature 为特定平台添加plugin，或者指定在webview初始化的时候是否初始化plugin

  • 在使用cordova plugin add指令的时候会自动添加。

  <feature name="Device">
   <param name="ios-package" value="CDVDevice" />
   <param name="onload" value="true" />
  </feature>
  

• platform:为指定平台单独设置属性。

  <platformname="android"><preferencename="Fullscreen"value="true" /></platform>
  

• <font color=#dd1234>待学习使用</font>

  • edit-config
  • engine：准备过程中需要恢复的平台信息
  • plugin：添加平台时如果使用了 --save参数，就会记录下来
  • variable：
  • hook
  • resource-file

  <plugin name="cordova-plugin-device" spec="^1.1.0">
    <variable name="MY_VARIABLE" value="my_variable_value" /></plugin>
  

  Sample config.xml

  <?xml version='1.0' encoding='utf-8'?>
  <widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
  <name>HelloCordova</name>
  <description>
      A sample Apache Cordova application that responds to the deviceready event.
  </description>
  <author email="dev@cordova.apache.org" href="http://cordova.io">
      Apache Cordova Team
  </author>
  <content src="index.html" />
  <plugin name="cordova-plugin-whitelist" spec="1" />
  <access origin="*" />
  <allow-intent href="http://*/*" />
  <allow-intent href="https://*/*" />
  <allow-intent href="tel:*" />
  <allow-intent href="sms:*" />
  <allow-intent href="mailto:*" />
  <allow-intent href="geo:*" />
  <platform name="android">
      <allow-intent href="market:*" />
  </platform>
  <platform name="ios">
      <allow-intent href="itms:*" />
      <allow-intent href="itms-apps:*" />
  </platform>
  </widget>