iServer 配置文件说明

发送反馈

SuperMap iServer 的主要配置信息位于 WEB-INF（【SuperMap iServer 安装目录】\webapps\iserver\WEB-INF）文件夹下，关于目录说明请参考：安装后目录说明。

配置文件简介
服务配置文件
- 服务接口配置文件
- 示范服务实例配置文件
系统配置文件

配置文件简介

WEB-INF 文件夹下存储了服务器及其所提供服务的配置信息，文件夹结构如下：

其中：

backup 文件夹：存放服务器配置信息的备份，详见备份与恢复服务器配置。
cacheScheme 文件夹：缓存方案，包括适用于 Bing Maps、天地图、云服务等的缓存方案。
lib 文件夹：存放 SuperMap iServer 运行时所依赖的 jar 文件。

各个配置文件的主要内容如下表所示：

配置文件的内容

文件名	描述
iserver-log4j.properties	日志的配置文件。
iserver-preCacheConfig.xml	预缓存配置，使用预缓存服务时默认生成。
kmlStyles.xml	保存用户设置的 KML 显示风格。
iserver-rest-appContext.xml	REST 应用配置文件，其中定义了表述类型与 URI 后缀的映射关系。
iserver-rest-resources.xml	扩展资源的资源配置文件，用户可在其中指定扩展资源的名称、URI、类型、表述生成器名称、参数解析器名称等等。
iserver-services-interfaces.xml	服务接口实例，包含 iserver-services-samples.xml 和 iserver-services-user.xml 中所用到的接口实例，如：rest、restjsr、wms111、wms130、wfs100、wmts100、wmts-china、wcs111、wcs112、handler、gpserver。
iserver-services-samples.xml	产品提供的示例服务的配置信息。
iserver-services.xml	用户发布的服务的配置信息。此文件命名时只要以“iserver-services”开头，服务器即可识别为服务配置文件，且支持多个用户自定义服务配置文件，如 iserver-services-1.xml，iserver-services-2.xml。
iserver-system.xml	SuperMap iServer 系统级配置，包括元信息、集群、kml 样式配置等。
web.xml	SuperMap iServer 的初始化配置文件，定义了功能与类的映射关系。

服务配置文件

SuperMap iServer 的服务均由服务提供者、服务组件、服务接口三个层次组成，所有服务的配置信息存储于服务配置文件中，主要是用于提供接口实例的服务接口配置文件（iserver-services-interfaces.xml）、示例服务的配置文件（iserver-services-samples.xml）以及用户发布服务的配置文件（iserver-services.xml）。其中后两者结构类似，此不赘述。

通过服务配置文件，您可以：

服务接口配置文件

服务接口配置文件 iserver-services-interfaces.xml，包含服务接口实例，根节点为 <application> 元素，包括<interfaces>子节点元素，其中的每一个 interface 元素用于配置一个具体的服务接口，包含以下属性：

name 属性，服务接口的名称。
class 属性，服务接口的实现类。
config 元素，服务接口的配置信息。

示范服务实例配置文件

示范服务实例配置文件 iserver-services-samples.xml，包含产品提供的示范服务实例的配置信息，根节点为 <application> 元素，包括以下子节点元素：

1. <components>

其中的每一个 component 元素用于配置一个具体的服务组件。

name 属性，服务组件的名称。
alias 属性，服务组件的别名，可设置为中文，如“京津土地利用”。
class 属性，服务组件的实现类。
interfaceNames 属性，服务组件绑定的服务接口。
providers 属性，服务组件所使用的服务提供者。
config 元素，服务组件的配置信息。它包含 class、outputPath、outputSite、workspacePath 等属性，具体请参见通过 XML 文件配置服务组件。当不包含 outputPath 和 outputSite 属性时，系统会采用<properties>元素中的相应值。数据服务组件中还包含 editable 属性，它用来设置数据服务组件是否可编辑。当 editable 为 true 时可编辑。

2. <providers>

其中的每一个 provider 元素用于配置一个具体的服务提供者。

name 属性，服务提供者的名称。
class 属性，服务提供者的实现类。
inner-providerNames 元素，当使用集群服务提供者或者聚合服务提供者时，分别用来设置集群服务提供者所集群的服务提供者，和聚合服务提供者所聚合的服务提供者。
config 元素，服务提供者的配置信息，包括对工作空间的设置。它包含 class、outputPath、outputSite 等属性，具体请参见通过 XML 文件配置服务提供者。当不包含 outputPath 和 outputSite 属性时，系统会采用<properties>元素中的相应值。

3. <componentSets>

其中的每一个 componentSet 元素用于配置一个服务组件集合，每个服务组件集合可以引用多个服务组件。

4. <providerSets>

其中的每一个 providerSet 元素用于配置一个服务提供者集合，每个服务提供者集合可以引用多个服务提供者。

系统配置文件

iserver-system.xml 包含了系统的配置信息，根节点为 <server> 元素，<server>节点目前主要包含 <properties> 、<management>、<hosts>、<clustering>、<harLog>、<queryFilter> 子节点元素。

1. <properties> 元素

用于设置 SuperMap iServer 配置系统中全局性质的属性信息，如服务的默认输出路径和访问站点、环境检查与否的设置：

<outputPath>：缓存图片的输出路径，其值为../webapps/iserver/output。当未给具体的服务指定缓存图片输出路径时，SuperMap iServer 会采用该默认值。
<outputSite>：地图图片的发布站点，即访问缓存图片的根目录 URI，其值为 http://{ip}:{port}/iserver/output/。当未给具体的服务指定图片发布站点时，SuperMap iServer 会采用该默认值。
<realspaceSecurityEnabled>：三维数据安全控制是否启用，默认为 true。
<realspaceCacheAccessKey>：三维数据密码。
<envCheckEnabled>：设置是否进行环境检查，默认为 true。
<restartWhenCrash>：服务非正常关闭后是否自动重启服务，默认为 true。
<checkDatasourceConnectionInterval>：iServer 检查“数据库型工作空间”是否改变或“数据库型数据源”是否断开的时间间隔，单位为秒，小于或等于0时表示从不检查，默认为30秒。
<{iServerData1}>、<{iServerDataPath1}>：代表工作空间文件或者路径的变量。详见预设本地工作空间路径

其中，全局属性 outputPath、outputSite 也可以通过服务管理器 WebManager 来设置，请参考全局属性设置。

2. <management>元素

用于配置 SuperMap iServer 的元数据信息，iServer 的元数据信息含服务组件类型元数据（<component-types>）、服务提供者类型元数据（<provider-types>）和服务接口类型元数据（<interface-types>），以及安全配置（<security>）。

安全配置节点示例如下所示：

    <security> 
      <accessControl> 
        <SecuritySetting> 
          <isSecurityEnabled>true</isSecurityEnabled>  
          <tokenKey>4da7ef8f2e734f56ab2ecfae20cce49a</tokenKey>  
          <!-- 密码防暴力破解设置 -->
          <passwordProtectedSetting> 
            <passwordDiffCount>5</passwordDiffCount>  
            <userPasswordErrorCounterSetting> 
              <passwordErrorProtectEnable>false</passwordErrorProtectEnable>  
              <lockedTime>1200000</lockedTime>  
              <periodLength>600000</periodLength>  
              <allowFailCountPerPeriod>5</allowFailCountPerPeriod> 
            </userPasswordErrorCounterSetting> 
          </passwordProtectedSetting>  
          <!-- 安全信息存储配置 -->
          <storage class="com.supermap.server.config.SQLSecurityInfoStorageSetting"> 
            <type>MYSQL</type>  
            <connInfo> 
              <username>root</username>  
              <password>super123.</password>  
              <dbType>MYSQL</dbType>  
              <driverClass>com.mysql.jdbc.Driver</driverClass>  
              <jdbcUrl>jdbc:mysql://192.168.120.44:3306/supermap?useUnicode=true&characterEncoding=UTF-8</jdbcUrl>  
              <maxPoolSize>30</maxPoolSize>  
              <initialPoolSize>5</initialPoolSize>  
              <minPoolSize>5</minPoolSize>  
              <maxIdleTime>0</maxIdleTime>  
              <maxWait>3000</maxWait> 
            </connInfo> 
          </storage> 
          <!-- 会话存储配置 -->         
          <session class="com.supermap.server.config.RedisSessionSetting"> 
          <type>Redis</type>  
          <host>127.0.0.1</host>  
          <port>6379</port>  
          <maxActive>1024</maxActive>  
          <maxIdle>200</maxIdle>  
          <maxWait>10000</maxWait>  
          <timeout>10000</timeout>  
          <testOnBorrow>true</testOnBorrow> 
         </session> 
        </SecuritySetting> 
      </accessControl> 
    </security>

其中，<isSecurityEnabled>用于设置安全控制是否启用，<tokenKey>用于设置Token的共享密钥，<passwordProtectedSetting>用于设置密码保护以防暴力破解，具体参数包括：

<passwordDiffCount>：密码不可与前N次重复次数，默认为5次。
<userPasswordErrorCounterSetting>：包括是否启用密码防暴力破解的<passwordErrorProtectEnable>参数，以及在时间周期（<periodLength>，默认6000000毫秒，即10分钟）内允许连续失败次数（<allowFailCountPerPeriod>，默认为5次），自动解锁时间（ <lockedTime>，单位为毫秒，默认1200000，即20分钟）。

<storageSetting>用于设置安全信息的存储位置，包含用于指定存储类型的<type>字段，目前支持SQLITE、MYSQL，以及配置数据库连接信息的<connInfo>。以MYSQL数据库为例，连接信息具体参数包括：

<driverClass>：数据库的连接驱动类，为com.mysql.jdbc.Driver
<jdbcUrl>：连接数据库驱动的URL连接形式为 jdbc:mysql://{ip}:{port}/{database}?useUnicode=true&characterEncoding=UTF-8。其中，{ip}为MySQL 所在机器的 IP 地址，{port}为 MySQL 的服务端口，默认为3306，{database}为数据库名，可设置为您已经创建的用来存储用户信息的数据库。这些参数您可以根据您安装的 MySQL 的实际情况来配置。
<username>：用户名，具有数据库{database}访问权限的用户。
<password>：该用户的密码。
<initialPoolSize>初始化的连接池大小，即初始化的连接数。默认值为5。
<maxPoolSize>：连接池在同一时刻内所提供的最大活动连接数。您可以根据 MySQL 服务器的性能来设置该值，默认为最多30个活动连接。
<minPoolSize>：连接池在同一时刻内所提供最小活动连接数。默认值为5。
<maxIdleTime>：空闲连接的等待时间，即当前连接空闲下来时，可保留的时间，单位为毫秒。超过该时间未操作，则自动关闭当前连接。默认值为3000。如果设为0，则永远保留空闲连接。
<maxWait>：异常连接的等待时间，即连接异常时，可等待的时间，单位为毫秒。在该时间段内连接异常未恢复，则自动关闭当前连接。默认值为300000。
<useStoredAdmin>：针对数据库中已经存储了初始化管理员（例如：admin1）的情况，两种选择：默认设为False，则将使用当前iServer的初始化管理员（admin2），同时覆盖数据库中存储的初始化管理员（数据库中存储的管理员将被改写为 admin2）；如果为True，将使用数据库中已经存储的初始化管理员（admin1），而不是当前 iServer 的管理员（例如:admin2）。

<session>用于指定会话信息的存储位置，包含了 Redis 数据库连接池的配置。具体参数如下：

<type>：数据库类型。
<host>：Redis 数据库所在机器的 IP。
<port>：Redis 数据库服务端口号。
<MaxActive>：连接池在同一时刻内所提供最大活动连接数。
<maxIdle>：最大空闲连接数。数据库空闲连接的最大数量。
<maxWait>：当没有可用连接时，最大等待时间，单位毫秒，超时后将抛出异常。
<timeout>：客户端与数据库连接后，处于空闲状态的时间，单位毫秒。超时后，将断开连接。
<testOnBorrow>：使用连接时，检测连接是否可用；为true时，得到的连接均是可用的。

3. <hosts>元素

用于配置 SuperMap iServer 服务的宿主。可包含多个<host>，一个 host 的示例如下：

<host port="8090" type="webapp" uriBase="/services">
        <interface-type>com.supermap.services.wms.WMSServlet</interface-type>
        <interface-type>com.supermap.services.rest.RestServlet</interface-type>
        <interface-type>com.supermap.services.wfs.WFSServlet</interface-type>
        <interface-type>com.supermap.services.wmts.WMTSServlet</interface-type>
</host>

其中，<interface-type>表示服务宿主中包含的服务类型，<host>的各项属性含义如下：

port 属性，服务宿主的端口号，用户通过该端口访问服务宿主包含的服务，跟 servlet 容器的端口号一致，并在访问 SuperMap iServer 服务时与 servlet 容器的端口号实时同步。
type 属性，服务宿主的类型，“webapp”表示这是一个 Web 服务（Web Service），还可取值 rmi、soap，表示其他宿主类型。
uriBase 属性，服务宿主的根路径，从 servlet 的根目录算起。

4. <clustering> 元素

包含集群配置等应用。关于集群子节点相关元素的详细内容，请参考集群专题中利用配置文件管理集群。

5. <harLog> 元素

用于配置服务访问日志，如是否启用服务访问日志，服务访问日志的文件名称，监控的服务 URI 地址的设置：

<enabled>：设置是否开启服务访问日志，默认为 false。
<name>：输出的服务访问日志的文件名称，默认名称为 iServerHTTPArchive，支持用户自定义。
<monitorURLs>：需要被监控的 SuperMap iServer 的服务 URL 地址。

6. <queryFilter> 元素

用于 SQL 查询过滤配置，防止 SQL 注入。这里的 SQL 注入，是指在进行 data 或 map 的 SQL 查询时，通过把非法的或违背用户意愿的字符串插入到 SQL 查询表达式中，欺骗服务器执行恶意的 SQL 命令。

<enabled>：设置是否启用 SQL 查询过滤，默认为 true。
<filterString>：设置 SQL 查询过滤的字符串，支持任意字符串（数据操作语言（DML）、表达式、通配符、特殊字符等），以分号隔开，如：设置 <filterString>delete;SMID=.</filterString> 。用户在进行 data 或 map 的 SQL 查询时，如果在 SQL 查询表达式中出现了 ‘delete 或 SMID=任意值’ 字符串，系统会默认该条查询表达式非法并返回400参数异常，防止执行恶意的 SQL 命令，从而保护用户的数据安全。如果没有设置 SQL 查询过滤的字符串，在 SQL 查询表达式中系统会默认屏蔽掉分号。

7. <repository>

用于设置临时资源的存储位置。详细信息请参考：临时资源的生命周期。

8. <relayService> 元素

用于 iExpress 的中继服务配置，仅在 iExpress 产品中使用。

<enabled>：是否开启中继服务。
<isLocalPriority>：对于同名服务，是否优先使用本地服务。如果为 true，则优先使用本地服务，中继服务器中的同名服务将被隐藏；如果为 false，则优先使用中继服务，本地同名服务将被隐藏。
<remoteServices>：中继服务中的远程服务列表地址，格式如：http://<server>:<ip>/iserver/services。
<updateInterval>：中继服务动态更新的时间间隔，如果远程服务列表有变更，则中继服务会根据此时间间隔动态更新。单位为毫秒（ms），默认为60000ms。

9.<license>元素

用于保存当前iServe的许可信息，包括正在使用的版本及扩展服务许可。详见在iServer中选择许可。示例如下：

  <license> 
    <enabledmodules> 
      <string>CHART</string>  
      <string>NETWORK</string>  
      <string>SPACE</string>  
      <string>SPATIAL</string>  
      <string>TRAFFIC_TRANSFER</string>  
      <string>ADVANCED</string> 
    </enabledmodules> 
  </license>

其中，<enabledmodules> 中包含了使用的许可名称，具体包括：

"ADVANCED"：高级版
"PROFESSIONAL"：专业版
"STANDARD"：标准版
"CHART"：海图模块
"NETWORK"：网络分析服务
"NETWORK3D"：三维网络分析服务
"SPACE"：三维服务
"SPATIAL"：空间分析服务
"SPATIAL3D"：三维空间分析服务
"TRAFFIC_TRANSFER"：交通换乘服务

10.<multiworkers>元素

用于配置多进程服务的相关信息。如进程数量、端口范围等，示例如下：

  <multiworkers>
    <enabled>true</enabled> 
    <workerCount>4</workerCount>
    <workerIP>127.0.0.1</workerIP> 
    <workerPortStart>8900</workerPortStart>
    <workerPortEnd>9000</workerPortEnd> 
    <workerBaseDir>../../workers</workerBaseDir>
    <xmx>1024m</xmx> 
    <communicationPort>8100</communicationPort>
  </multiworkers>

具体参数描述如下：

<enabled>：是否启用多进程模式。
<workerCount>：进程数量。
<workerIP>：设置主进程与子进程间的通信IP。
<workerPortStart>：Worker进程端口范围的起始端口号。
<workerPortEnd>：Worker进程端口范围的终止端口号。
<workerBaseDir>：子进程的工作目录。
<xmx>：Java虚拟机内存设置。
<communicationPort>：设置主进程与子进程间的通信端口号。