Mobile Platform as a Service:Service definition and development

Register an MPC API service

Registering an MPC API service requires the following parameters:

• registryUrl: The address of the registry. The address for the shared financial technology registry is mpcpub.mpaas.cn-hangzhou.aliyuncs.com.

• appName: The name of your application. This must be the same as the API group name.

• workspaceId: The workspace ID of the environment where the application is located.

• projectName: The project name of the tenant that the application belongs to. This must be the same as the Project Name in the API group.

• privateKeyPath: The classpath for the RSA private key. This key is used to verify the connection to mpaaschannel. We recommend that you place it in /META-INF/config/rsa-mpc-pri-key-{env}.der, where {env} represents different environments, such as dev, sit, or prod.

Configure the public key

In the console for the corresponding environment, choose Code Management > Interface Keys > Configure in the navigation pane on the left. Configure the RSA public key that corresponds to your private key.

The following commands show how to generate an RSA key pair. Configure the public key in the console. Configure the private key file in the ${privateKeyPath} of your backend application:

* 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:
* 
* ## The generated private key, to be configured in the backend application
* $ openssl base64 -in private_key.der -out private_key_base64.der
* 
* ## The generated public key, to be configured in Interface Keys in the console
* $ openssl base64 -in public_key.der -out public_key_base64.der
* 
* ### remember to clear the whitespace chars and line breaks before submit!!!

Spring method

1. In the spring configuration file of the corresponding bundle, declare the Spring bean for the defined service.

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

2. In the spring configuration file of the corresponding bundle, declare the starter bean that exposes the service.

   The MpcServiceStarter interface registers all beans that have the OperationType annotation with the specified registry using the mpaaschannel protocol.

   <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 method

The Spring Boot method is essentially the same as the Spring method. The only difference is that you use annotations for registration instead of an XML configuration file.

1. Use an annotation to register the defined service as a bean:

   @Service
   public class MockRpcImpl implements MockRpc{
   }

2. Use an annotation to define the starter that exposes the service:

   @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;
    }
   }

Configure MPC logs

To facilitate troubleshooting, you can configure MPC-related logs. The following example shows a log4j configuration:

<!-- [MPC Logger] tenant link, records connection establishment and settings information -->
    <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] records data related to a stream (including a pair of 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 log -->
    <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 log -->
    <logger name="STREAM-DATA-DIGEST" additivity="false">
        <level value="INFO" />
        <appender-ref ref="MPC-STREAM-DATA-APPENDER" />
        <appender-ref ref="ERROR-APPENDER" />
    </logger>