移动开发平台 mPaaS 服务定义与开发

此文档只针对集成了网关 SPI 的系统，如对外暴露 mpaaschannel 或 dubbo 类型 API 服务的业务系统。对于使用 HTTP API 的业务系统无需查看此文档。

网关管控平台

引入网关二方包

在项目的主 pom.xml 文件中引入如下二方包（若原工程已经有依赖，请忽略）。

基础依赖都需要引用，请根据实际需要集成的 API 类型，选择 MPC、Dubbo、HRPC 或 TR 依赖。

说明：引入依赖前，请确认您完成了 Maven 的配置。详情参见
配置 Maven。

基础依赖

  
   <dependency>
    <groupId>com.alipay.gateway</groupId>
    <artifactId>mobilegw-unify-spi-adapter</artifactId>
    <version>1.0.5.20200930</version>
   </dependency>
   <dependency>
    <groupId>com.alipay.gateway</groupId>
    <artifactId>mobilegw-unify-log</artifactId>
    <version>1.0.5.20200930</version>
   </dependency>
   <dependency>
    <groupId>com.alipay.hybirdpb</groupId>
    <artifactId>classparser</artifactId>
    <version>1.2.2</version>
   </dependency>
   <dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>3.5</version>
   </dependency>
   <dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.69_noneautotype</version>
   </dependency>

MPC 依赖

  
   <dependency>
    <groupId>com.alipay.gateway</groupId>
    <artifactId>mobilegw-unify-spi-mpc</artifactId>
    <version>1.0.5.20200930</version>
   </dependency>
   <dependency>
    <groupId>com.alipay.mpaaschannel</groupId>
    <artifactId>common</artifactId>
    <version>2.3.2018071001</version>
   </dependency>
   <dependency>
    <groupId>com.alipay.mpaaschannel</groupId>
    <artifactId>tenant-client</artifactId>
    <version>2.3.2018071001</version>
   </dependency>

Dubbo 依赖

  
   <dependency>
    <groupId>com.alipay.gateway</groupId>
    <artifactId>mobilegw-unify-spi-dubbo</artifactId>
    <version>1.0.5.20200930</version>
   </dependency>
   <dependency>
    <groupId>org.apache.dubbo</groupId>
    <artifactId>dubbo</artifactId>
    <version>2.7.8</version>
   </dependency>

说明：dubbo 请使用原生版本，不要使用 dubbox（不兼容）。

HRPC 依赖

  
   <dependency>
    <groupId>com.alipay.gateway</groupId>
    <artifactId>mobilegw-unify-spi-hrpc</artifactId>
    <version>1.0.5.20200930</version>
   </dependency>
   <dependency>
    <groupId>com.alipay.gateway</groupId>
    <artifactId>mobilegw-unify-registry</artifactId>
    <version>1.0.5.20200930</version>
   </dependency>
   <dependency>
    <groupId>hessian</groupId>
    <artifactId>hessian</artifactId>
    <version>3.3.6</version>
   </dependency>

TR 依赖

  
   <dependency>
    <groupId>com.alipay.gateway</groupId>
    <artifactId>mobilegw-unify-spi-sofa</artifactId>
    <version>1.0.5.20200930</version>
   </dependency>

定义服务接口并实现

按照业务需求，定义服务接口：com.alipay.xxxx.MockRpc；并提供该接口的实现 com.alipay.xxxx.MockRpcImpl。

说明：

方法定义中的入参尽量定义为 VO，后期添加参数，就可以在 VO 中添加参数，而不改变方法的声明格式。
服务接口定义的相关规范，请参见业务接口定义规范。

定义 operationType

在服务接口的方法上添加 @OperationType 注解，定义发布服务的接口名称。@OperationType 有三个参数成员：

value：RPC 服务的唯一标识，定义规则为 组织.产品域.产品.子产品.操作。
name：接口中文名称。
desc：接口描述。

说明：

value 在网关为全局唯一，尽量定义详细，否则可能会和其他业务方的 value 值一样，导致无法注册服务。
为便于维护，请务必填写完整 @OperationType 的三个字段。

样例：

  
   public interface MockRpc {
   
    @OperationType("com.alipay.mock")
    Resp mock(Req s);
   
    @OperationType("com.alipay.mock2")
    String mock2(String s);
   }
   
   public static class Resp {
    private String msg;
    private int code;
   
    // ignore getter & setter
   }
   
   public static class Req {
    private String name;
    private int age;
   
    // ignore getter & setter
   }

注册 API 服务

通过网关提供的 SPI 包，将定义好的 API 服务注册到指定的注册中心。

注册 MPC API 服务

registryUrl：该值为注册中心的地址，共享式金融科技注册中心地址为 116.62.81.246。
appName：该值为业务方的应用名，与 API 分组名相同。
workspaceId：应用所处环境的 workspaceId。
projectName：应用所属租户的 projectName，与 API 分组里的 Project Name 相同。
privateKeyPath：存放 RSA 私钥的 ClassPath，与 mpaaschannel 建立连接时用于校验合法性。
- 推荐: 放置在 /META-INF/config/rsa-mpc-pri-key-{env}.der 中，{env} 为不同的环境，如 dev、sit、prod 等。

配置公钥

前往对应环境的控制台，从左侧导航栏点击 接口密钥 > 配置，配置私钥对应的 RSA 公钥。

RSA 公私钥的方法如下，其中公钥在控制台上配置，私钥文件在后端应用的 ${privateKeyPath} 中配置：

  
   * the way to generate key pair : 
   * ### Generate a 2048-bit RSA private key 
   * 
   * $ openssl genrsa -out private_key.pem 2048 
   * 
   * ### Convert private Key to PKCS#8 format (so Java can read it) 
   * 
   * $ openssl pkcs8 -topk8 -inform PEM -outform DER -in private_key.pem -out private_key.der -nocrypt 
   * 
   * ### Output public key portion in DER format (so Java can read it) 
   * 
   * $ openssl rsa -in private_key.pem -pubout -outform DER -out public_key.der 
   * 
   * ### change to base64:
   * 
   * ## 生成的私钥，后端应用中配置
   * $ openssl base64 -in private_key.der -out private_key_base64.der
   * 
   * ## 生成的公钥，在控制台 接口密钥 中配置
   * $ openssl base64 -in public_key.der -out public_key_base64.der
   * 
   * ### remember to clear the whitespace chars and line breaks before submit!!!

spring 方式

在对应 bundle 的 spring 配置文件中，声明定义好的服务的 spring bean。

    
      <bean id="mockRpc" class="com.alipay.gateway.spi.mpc.test.MockRpcImpl"/>

在对应 bundle 的 spring 配置文件中，声明暴露服务的 starter bean。

MpcServiceStarter：该接口会将所有带有 OperationType 的 bean 通过 mpaaschannel 协议注册到指定的注册中心。

    
     <bean id="mpcServiceStarter" class="com.alipay.gateway.spi.mpc.MpcServiceStarter">
      <property name="registryUrl" value="${registy_url}"/>
      <property name="appName" value="${app_name}"/>
      <property name="workspaceId" value="${workspace_id}"/>
      <property name="projectName" value="${project_name}"/>
      <property name="privateKeyPath" value="${privatekey_path}"/>
     </bean>

spring-boot 方式

spring-boot 和 spring 本质上一样，只是注册的方式改为注解的方式，不用配置 xml 文件。

通过注解的方式，将定义的服务注册成 bean：

    
     @Service
     public class MockRpcImpl implements MockRpc{
     }

以注解的方式，定义暴露服务的 starter：

    
     @Configuration
     public class MpaaschannelDemo {
      @Bean(name="mpcServiceStarter")
      public MpcServiceStarter mpcServiceStarter(){
      MpcServiceStarter mpcServiceStarter = new MpcServiceStarter();
      mpcServiceStarter.setWorkspaceId("${workspace_id}");
      mpcServiceStarter.setAppName("${app_name}");
      mpcServiceStarter.setRegistryUrl("${registy_url}");
      mpcServiceStarter.setProjectName("${project_name}");
      mpcServiceStarter.setPrivateKeyPath("${privatekey_path}");
      return mpcServiceStarter;
      }
     }

配置 MPC 日志

为了便于排查问题，可酌情配置 MPC 相关日志，下面以 log4j 配置为例：

  
   <!-- [MPC Logger] tenant link，记录建联，settings 信息 -->
    <appender name="MPC-TENANT-LINK-APPENDER" class="org.apache.log4j.DailyRollingFileAppender">
    <param name="file" value="${log_root}/mpaaschannel/tenant-link.log"/>
    <param name="append" value="true"/>
    <param name="encoding" value="${file.encoding}"/>
    <layout class="org.apache.log4j.PatternLayout">
    <param name="ConversionPattern" value="%d [%X{remoteAddr}][%X{uniqueId}] %-5p %c{2} - %m%n"/>
    </layout>
    </appender>
   
    <!-- [MPC Logger] 记录一个流相关的数据 (包括一对tenant stream <-> component stream) -->
    <appender name="MPC-STREAM-DATA-APPENDER" class="org.apache.log4j.DailyRollingFileAppender">
    <param name="file" value="${log_root}/mpaaschannel/stream-data.log"/>
    <param name="append" value="true"/>
    <param name="encoding" value="${file.encoding}"/>
    <layout class="org.apache.log4j.PatternLayout">
    <param name="ConversionPattern" value="%d [%X{remoteAddr}][%X{uniqueId}] %-5p %c{2} - %m%n"/>
    </layout>
    </appender>
   
   
   <!-- [MPC Logger] tenant 日志 -->
    <logger name="TENANT-LINK-DIGEST" additivity="false">
    <level value="INFO" />
    <appender-ref ref="MPC-TENANT-LINK-APPENDER" />
    <appender-ref ref="ERROR-APPENDER" />
    </logger>
   
    <!-- [MPC Logger] component 日志 -->
    <logger name="STREAM-DATA-DIGEST" additivity="false">
    <level value="INFO" />
    <appender-ref ref="MPC-STREAM-DATA-APPENDER" />
    <appender-ref ref="ERROR-APPENDER" />
    </logger>

注册 Dubbo API 服务

registryUrl：该值为注册中心的地址。
appName：该值为业务方的应用名，与 API 分组名相同。

spring 方式

在对应 bundle 的 spring 配置文件中，声明定义好的服务的 spring bean：

    
      <bean id="mockRpc" class="com.alipay.gateway.spi.mpc.test.MockRpcImpl"/>

在对应 bundle 的 spring 配置文件中，声明暴露服务的 starter bean —DubboServiceStarter，该接口会将所有带有 OperationType 的 bean 通过 Dubbo 协议注册到指定的注册中心。

    
     <bean id="dubboServiceStarter" class="com.alipay.gateway.spi.dubbo.DubboServiceStarter">
      <property name="registryUrl" value="${registy_url}"/>
      <property name="appName" value="${app_name}"/>
     </bean>

spring-boot 方式

spring-boot 和 spring 本质上一样，只是注册的方式改为注解的方式，不用配置 xml 文件。

通过注解的方式，将定义的服务注册成 bean：

    
     @Service
     public class MockRpcImpl implements MockRpc{
     }

以注解的方式，定义暴露服务的 starter:

    
     @Configuration
     public class DubboDemo {
      @Bean(name="dubboServiceStarter")
      public DubboServiceStarter dubboServiceStarter(){
      DubboServiceStarter dubboServiceStarter = new DubboServiceStarter();
      dubboServiceStarter.setAppName("${app_name}");
      dubboServiceStarter.setRegistryUrl("${registy_url}");
      return dubboServiceStarter;
      }
     }

注册 HRPC API 服务

registryUrl：该值为注册中心的地址，必填。
appName：该值为业务方的应用名，必填。
serverPort：该值为 HRPC 服务监听端口，选填，默认 7079。

spring 方式

在对应 bundle 的 spring 配置文件中，声明定义好的服务的 spring bean：

    
      <bean id="mockRpc" class="com.alipay.gateway.spi.mpc.test.MockRpcImpl"/>

在对应 bundle 的 spring 配置文件中，声明暴露服务的 starter bean。

HRpcServiceStarter：该接口会将所有带有 @OperationType 的 bean 通过 HRPC 协议注册到指定的注册中心。

    
     <bean id="hrpcServiceStarter" class="com.alipay.gateway.spi.hrpc.HRpcServiceStarter">
      <property name="registryUrl" value="${registy_url}"/>
      <property name="appName" value="${app_name}"/>
      <property name="serverPort" value="${serverPort可选}"/>
     </bean>

spring-boot 方式

spring-boot 和 spring 本质上一样，只是注册的方式改为注解的方式，不用配置 xml 文件。

通过注解的方式，将定义的服务注册成 bean：

    
     @Service
     public class MockRpcImpl implements MockRpc{
     }

以注解的方式，定义暴露服务的 starter：

    
     @Configuration
     public class HRpcDemo {
      @Bean(name="hrpcServiceStarter")
      public HRpcServiceStarter hrpcServiceStarter(){
      HRpcServiceStarter hRpcServiceStarter = new HRpcServiceStarter();
      hRpcServiceStarter.setAppName("${app_name}");
      hRpcServiceStarter.setRegistryUrl("${registy_url}");
      hRpcServiceStarter.setServerPort("${serverPort可选}");
      return hRpcServiceStarter;
      }
     }

说明：HRPC 使用的注册中心为 ZK，地址可以填一个或者多个，用逗号分割。如 “11.163.193.240:2181” 或 “11.163.193.240:2181,11.163.193.230:2181”。

注册 TR API 服务

appName：该值为业务方的应用名，必填。

spring 方式

在对应 bundle 的 spring 配置文件中，声明定义好的服务的 spring bean：

    
      <bean id="mockRpc" class="com.alipay.gateway.spi.mpc.test.MockRpcImpl"/>

在对应 bundle 的 spring 配置文件中，声明暴露服务的 starter bean。

SofaServiceStarter：该接口会将所有带有 @OperationType 的 bean 通过 TR 协议暴露给网关调用。

    
     <bean id="SofaServiceStarter" class="com.alipay.gateway.spi.sofa.SofaServiceStarter">
      <property name="appName" value="${app_name}"/>
     </bean>

spring-boot 方式

spring-boot 和 spring 本质上一样，只是注册的方式改为注解的方式，不用配置 xml 文件。

通过注解的方式，将定义的服务注册成 bean：

    
     @Service
     public class MockRpcImpl implements MockRpc{
     }

以注解的方式，定义暴露服务的 starter：

    
     @Configuration
     public class TRDemo {
      @Bean(name="sofaServiceStarter")
      public SofaServiceStarter sofaServiceStarter(){
      SofaServiceStarter sofaServiceStarter = new SofaServiceStarter();
      sofaServiceStarter.setAppName("${app_name}");
      return sofaServiceStarter;
      }
     }

结果

完成上述步骤后，就可以通过在网关进行一系列的操作，将定义的 API 服务对客户端进行暴露。具体请参见注册 API。

引入网关二方包

基础依赖

MPC 依赖

Dubbo 依赖

HRPC 依赖

TR 依赖

定义服务接口并实现

定义 operationType

注册 API 服务

注册 MPC API 服务

配置公钥

spring 方式

spring-boot 方式

配置 MPC 日志

注册 Dubbo API 服务

spring 方式

spring-boot 方式

注册 HRPC API 服务

spring 方式

spring-boot 方式

注册 TR API 服务

spring 方式

spring-boot 方式

结果

发表回复 取消回复

发表回复取消回复