SuperMap iPortal 内置的服务代理配置

SuperMap iPortal 内置的服务代理是指 iPortal 产品包自带的服务代理功能，iPortal 产品包默认启用内置的服务代理功能；另外，iPortal 还提供了多种可选的功能扩展配置，包括：服务访问统计功能、以 HTTPS 协议启用服务代理的功能、服务代理缓存功能。在启用服务代理功能时，为了使服务代理性能更优，建议您选用 MySQL/Oracle/PostgreSQL 数据库存储门户数据，关于数据库的配置请参见：数据库配置。

• 服务代理配置
• 服务访问统计配置
• 以 HTTPS 协议启用服务代理的配置
• 服务代理缓存配置
  • Ehcache 缓存配置
  • Redis 缓存配置
• iPortal 与服务代理的 session 共享配置
  • Ehcache 缓存配置
  • Redis 缓存配置

服务代理配置

iPortal 门户管理员可以通过 %SuperMap iPortal_HOME%/webapps/iportal/WEB-INF 目录下的 iportal.xml 文件中的 <serviceProxy> 子节点元素，设置服务代理相关配置。详情请参见：iPortal 配置文件说明。

具体示例如下所示：

   ...

<IportalConfig>

   <serviceProxy>

       <enable>true</enable>

       <enableBuiltinProxy>true</enableBuiltinProxy>

       <port>8195</port>

       <rootUrlPostfix>portalproxy</rootUrlPostfix>

       <httpConnPoolInfo>

            <maxTotal>100</maxTotal>

            <defaultMaxPerRoute>10</defaultMaxPerRoute>

            <connectionTimeout>30000</connectionTimeout>

            <socketTimeout>30000</socketTimeout>

      </httpConnPoolInfo>

   ...

   </serviceProxy>

</IportalConfig>

• <enable>：设置是否启用服务代理，这里的服务代理是指内置的服务代理或独立部署的服务代理，默认值：true，启用服务代理功能。
• <enableBuiltinProxy>：设置是否启用内置的服务代理，默认值：true，启用内置的服务代理。
• <port>：设置服务代理地址的端口号，默认值：8195。您也可以自定义设置该端口号，只要保证您设置的端口号没有被占用即可。
• <rootUrlPostfix>：为服务代理根地址设置统一的后缀名，默认的后缀名为：portalproxy，完整的服务的代理地址例如：http://192.168.120.40:8195/portalproxy/iserver/services/map-changchun/rest，您可以根据实际需要设置该后缀名，也可以设置为空值，即不设置后缀名。
• <httpConnPoolInfo>：服务代理的连接池设置项，用于设置服务代理内部的 HttpClient 连接池。调整该节点下的各个设置项，从而提升服务代理的并发性能。
• <maxTotal>：设置整个连接池最大连接数。默认值是：100。您可以根据门户最大并发访问用户数来设置。
• <defaultMaxPerRoute>：对于一个路由地址，设置最多存在几个连接。默认值是：10。例如：您可以根据门户中单个服务的最大并发访问用户数来设置。
• <connectionTimeout>：代理转发请求时，与服务器间建立连接的超时时间，单位为 ms。默认值是：30000。您可以根据网络环境设置。
• <socketTimeout>：代理转发请求时，从服务器读取数据的超时时间，单位为 ms。默认值是：30000。您可以根据网络环境设置。

如果您的 iPortal 运行在双网卡或多网卡的网络环境中，希望通过不同 ip 访问 iPortal 时，服务代理地址可以动态显示 ip 地址，则需在以上配置的基础上，在<serviceProxy>节点下增加<proxyServerRootUrl>子节点（粗体部分代码），具体配置如下：

<IportalConfig>

   ...

   <serviceProxy>

       <enable>true</enable>

       <enableBuiltinProxy>true</enableBuiltinProxy>

       <port>8195</port>

       <rootUrlPostfix>portalproxy</rootUrlPostfix>

       <proxyServerRootUrl>http://{ProxyHost}[:port]</proxyServerRootUrl>

       <httpConnPoolInfo>

            <maxTotal>100</maxTotal>

            <defaultMaxPerRoute>10</defaultMaxPerRoute>

            <connectionTimeout>30000</connectionTimeout>

            <socketTimeout>30000</socketTimeout>

      </httpConnPoolInfo>

   ...

   </serviceProxy>

</IportalConfig>

其中，{ProxyHost} 是占位符，会动态显示 ip 地址，[:port] 变量表示端口，填写代理后的服务监听端口即可，例如：<proxyServerRootUrl>http://{ProxyHost}:8195</proxyServerRootUrl>

注意：

• 启用服务代理后，在浏览器窗口输入 iPortal 门户首页地址：http://<server>:<port>/iportal， 即可访问 iPortal 首页。其中，server 取决于部署 iPortal 的服务器的 IP，port 取决于 server.xml 文件（位于%SuperMap iPortal_HOME%\conf\server.xml ）中配置的端口号，与上述代理配置项无关。

• 停用服务代理后，需要重启 iPortal 服务，设置才会生效。

服务访问统计配置

iPortal 启用服务代理功能后，还支持对服务进行访问统计，记录服务的访问次数。管理员通过 iportal.xml 配置文件中<serviceProxy>子节点下的<enableAccessStatistics> 子节点元素，设置是否开启服务访问统计功能。详情请参见：iPortal 配置文件说明。

<IportalConfig>

   ...

   <serviceProxy>

       <enable>true</enable>

       <enableBuiltinProxy>true</enableBuiltinProxy>

       ...

      <!-- “代理访问统计”功能设置，默认开启 -->

      <enableAccessStatistics>true</enableAccessStatistics>

   </serviceProxy>

</IportalConfig>

• <enableAccessStatistics>：设置是否开启服务访问统计功能，默认值：true，开启。

以 HTTPS 协议启用服务代理的配置

SuperMap iPortal 默认使用的是 http 协议启用服务代理，也就是说，如果您注册的是 https 服务，那么该服务经 iPortal 代理后，将以 http 协议启用。门户管理员可以通过如下设置使用 https 协议启用服务代理：

将 iportal.xml 配置文件中<serviceProxy>元素中的如下注释部分打开：

<serviceProxy>

      ...

        <!-- 设置使用什么协议启动服务代理，默认使用http协议。若设置https协议，需设置httpsSetting-->

        <!-- <scheme>http</scheme>

                   <httpsSetting>

                         <keyStorePath>D:\key.keystore</keyStorePath>

                         <keyStorePassword>123456</keyStorePassword>

                   </httpsSetting>  -->

    ...

</serviceProxy>

打开注释后，做如下修改（加粗部分）：

<serviceProxy>

      ...

        <!-- 设置使用什么协议启动服务代理，默认使用http协议。若设置https协议，需设置httpsSetting-->

        <scheme>https</scheme>

                 <httpsSetting>

                        <keyStorePath>D:\key.keystore</keyStorePath>

                        <keyStorePassword>123456</keyStorePassword>

                 </httpsSetting>

    ...

</serviceProxy>

• <scheme>：设置使用什么协议启用服务代理，默认值：http，即：使用 http 协议。如果您希望使用 https 协议启用服务代理，那么此处需设置为：https。
• <keyStorePath>：指定证书的存放位置，可以任意指定。该证书是用于 iPortal 以 HTTPS 协议启用服务代理，关于如何生成服务器证书，请参见：生成服务器证书（公钥）。
• <keyStorePassword>：设置证书的密码，即证书 key.keystore 的密码。

注意：

• 若您的 iPortal 配置为以 https 协议启动，则必须将服务代理一同设置为以 https 协议启动，方可正常访问代理服务地址。

服务代理缓存配置

为了进一步提高代理后 GIS 服务的访问速度，iPortal 提供了服务代理缓存功能，是对数据库查询结果的缓存（关于数据库的配置请参见：数据库配置），分别对使用很频繁且耗时的权限验证的结果和查询的代理服务地址与对应的原始服务地址的映射关系进行缓存，将查询结果存储在缓存中。

SuperMap iPortal 提供了两种缓存方式，Ehcache 缓存和 Redis 缓存。默认开启的是 Ehcache 缓存，您无需进行任何配置，可直接使用。详情请参见：iPortal 配置文件说明。

Ehcache 缓存配置

Ehcache 缓存的配置信息如下所示：

<serviceProxy>

    ...

    <cacheConfig>

        <enable>true</enable>

        <type>EHCACHE</type>

        <cacheServerConfig>

            <ehcacheConfigPath>./WEB-INF/iportal-ehcache.xml</ehcacheConfigPath>

            ...

        </cacheServerConfig>

    </cacheConfig>

</serviceProxy>

• <enable>：设置是否开启服务代理缓存功能，默认值：true，开启
• <type>：设置缓存类型，字符需要大写，默认值：EHCACHE，使用 Ehcache 缓存，您还可设置为：REDIS，使用 Redis 缓存
• <cacheServerConfig>：缓存服务器配置
• <ehcacheConfigPath>：设置 Ehcache 配置文件的路径，默认指向系统自带的 Ehcache 缓存的配置文件 iportal-ehcache.xml，位于【SuperMap iPortal 安装目录】\webapps\iportal\WEB-INF 目录下，当然，您也可以自己编写独立的缓存配置文件。

Redis 缓存配置

在配置 Redis 缓存之前，需要先安装 Redis，关于 Linux 版本的 Redis 下载和安装请参见：https://redis.io/download。

本示例使用的是 Windows 版的 Redis。Redis 没有官方的 Windows 版本，但是微软开源技术团队（Microsoft Open Tech group）开发和维护着这个 Win64 的版本，下载地址：https://github.com/MicrosoftArchive/redis/releases。

在下载后的 Redis 文件夹中双击 redis_server.exe 文件，启动 Redis 服务，为保证 iPortal 服务代理可用，Redis 服务需一直保持运行状态。

Redis 安装完成后，管理员可通过 iportal.xml 文件中的 <cacheConfig> 子节点元素，设置使用 Redis 缓存。其中，Redis 缓存配置已经写好，直接打开注释即可。如下所示，您只需将 <cacheName>和<ehcacheConfigPath> 子节点注释掉或者删掉，将 Redis 缓存配置信息的注释符号去掉即可。

<serviceProxy>

    ...

    <cacheConfig>

        <enable>true</enable>

        <type>REDIS</type>

        <cacheServerConfig>

            <server>

               <nodes>192.168.112.231:7001</nodes>

               <timeout>3000</timeout>

               <password></password>

            </server>

            <jedisPoolConfig>

               <maxTotal>2048</maxTotal>

               <maxIdle>128</maxIdle>

               <maxWaitMillis>-1</maxWaitMillis>

               <testOnBorrow>true</testOnBorrow>

            </jedisPoolConfig>

        </cacheServerConfig>

    </cacheConfig>

</serviceProxy>

• <enable>：设置是否开启服务代理缓存功能，默认值：true，开启
• <type>：设置缓存类型，字符需要大写，默认值：EHCACHE。此处服务代理的独立部署使用 Redis 缓存，因此需要将该值设置为：REDIS
• <cacheServerConfig>：缓存服务器配置
• <nodes>：设置 Redis 服务节点，Redis 若要使用集群，nodes节点可以配置多个 host:port，以“|”分隔，否则只需配置一个 host:port
• <timeout>：Redis 服务连接超时时间，单位：ms
• <password>：Redis 服务的访问密码
• <maxTotal>：可用连接 Redis 实例的最大数目
• <maxIdle>：控制一个 Pool（连接池）最多有多少个状态为 idle（空闲的）的 Jedis 实例
• <maxWaitMillis>：等待可用连接的最大时间，单位：ms，默认值：-1，表示永不超时
• <testOnBorrow>：在 borrow 一个 Jedis 实例时，是否提前进行 validate 操作，默认值：true，表示得到的 Jedis 实例均是可用的。不建议对该参数进行修改。

iPortal 与服务代理的 session 共享配置

要保证 iPortal 中的服务代理能够正常访问，您还需对登录用户的 Cookie 信息进行存储配置，实现 iPortal 与服务代理的 session 共享，即：用户登录到 iPortal 门户后，即可访问服务代理。

iPortal 内置的服务代理支持两种方式来存储登录用户的 Cookie 信息：Ehcache 缓存和 Redis 缓存。默认开启的是 Ehcache 缓存，您无需进行任何配置，可直接使用。详情请参见：iPortal 配置文件说明。

Ehcache 缓存配置

Ehcache 缓存的配置信息如下所示：

<IportalConfig>

    ...

    <cookieStorage>

        <type>EHCACHE</type>

        <cacheServerConfig>

            <ehcacheConfigPath>./WEB-INF/iportal-ehcache.xml</ehcacheConfigPath>

            ...

        </cacheServerConfig>

    </cookieStorage>

</IportalConfig>

• <type>：设置缓存类型，字符需要大写，默认值：EHCACHE，使用 Ehcache 缓存，您还可设置为：REDIS，使用 Redis 缓存
• <cacheServerConfig>：缓存服务器配置
• <ehcacheConfigPath>：设置 Ehcache 配置文件的路径，默认指向系统自带的 Ehcache 缓存的配置文件 iportal-ehcache.xml，位于【SuperMap iPortal 安装目录】\webapps\iportal\WEB-INF 目录下，当然，您也可以自己编写独立的缓存配置文件。

Redis 缓存配置

如果您在服务代理缓存配置中，已经下载和安装了 Redis 服务，那只需进行如下配置即可。

管理员可通过 iportal.xml 文件中的 <cookieStorage> 子节点元素，设置使用 Redis 缓存。如下所示，您只需将以下 <cacheServerConfig> 节点中的  Ehcache 的配置注释掉或删掉：

<cacheName>iportalProxyCache</cacheName>

<ehcacheConfigPath>./WEB-INF/iportal-ehcache.xml</ehcacheConfigPath>

Redis 缓存配置已经写好，直接打开注释即可。如下所示：

<IportalConfig>

    ...

    <cookieStorage>

        <type>REDIS</type>

        <cacheServerConfig>

            <server>

               <nodes>127.0.0.1:6379</nodes>

               <timeout>3000</timeout>

               <password></password>

            </server>

            <jedisPoolConfig>

               <maxTotal>512</maxTotal>

               <maxIdle>32</maxIdle>

               <maxWaitMillis>-1</maxWaitMillis>

               <testOnBorrow>true</testOnBorrow>

            </jedisPoolConfig>

         </cacheServerConfig>

      </cookieStorage>

    ...

</IportalConfig>

• <type>：设置缓存类型，字符需要大写，默认值：EHCACHE，使用 Ehcache 缓存。使用 Redis 缓存时，需要将该值设置为：REDIS
• <cacheServerConfig>：缓存服务器配置
• <nodes>：设置 Redis 服务节点，Redis 若要使用集群，nodes节点可以配置多个 host:port，以“|”分隔，否则只需配置一个 host:port
• <timeout>：Redis 服务连接超时时间，单位：ms
• <password>：Redis 服务的访问密码
• <maxTotal>：可用连接 Redis 实例的最大数目
• <maxIdle>：控制一个 Pool（连接池）最多有多少个状态为 idle（空闲的）的 Jedis 实例
• <maxWaitMillis>：等待可用连接的最大时间，单位：ms，默认值：-1，表示永不超时
• <testOnBorrow>：在 borrow 一个 Jedis 实例时，是否提前进行 validate 操作，默认值：true，表示得到的 Jedis 实例均是可用的。不建议对该参数进行修改。