附录

    CentOS环境安装Java

    Ubuntu环境安装Java

    2.   sudo apt install -y default-jdk
    3.   # 查询Java版本
    4.   java -version

    此处给出简单步骤，供快速查阅。更详细的步骤，请参考。

    （1）从官网下载对应版本的Gradle安装包，并解压到相应目录

    1. mkdir /software/
    2. unzip -d /software/ gradleXXX.zip

    （2）配置环境变量

    1. export GRADLE_HOME=/software/gradle-4.9
    2. export PATH=$GRADLE_HOME/bin:$PATH

    （3）查看版本

    1. gradle -version

    • 1：执行shell脚本报错误”permission denied”或格式错误

      1. 赋权限：chmod + *.sh
      2. 转格式：dos2unix *.sh

    • 2：eclipse环境编译源码失败，错误提示如下：

    1. ...
    2. /data/temp/WeBASE-Front/src/main/java/com/webank/webase/front/performance/PerformanceService.java:167: error: cannot find symbol
    3.         log.info("begin sync performance");
    4.         ^
    5.   symbol:   variable log
    6.   location: class PerformanceService
    7. Note: /data/temp/WeBASE-Front/src/main/java/com/webank/webase/front/contract/CommonContract.java uses or overrides a deprecated API.
    8. Note: Recompile with -Xlint:deprecation for details.
    9. Note: Some input files use unchecked or unsafe operations.
    10. Note: Recompile with -Xlint:unchecked for details.
    11. 100 errors
    13. > Task :compileJava FAILED
    14. FAILURE: Build failed with an exception.
    15. ...

    答：问题是不能编译Lombok注解 ，修改build.gradle文件，将以下代码的注释加上

    • 3：节点运行一段时间后新增了一个群组，前置查不到新群组的信息。

      答：调用 方法，即可手动更新。

    • 4：升级1.0.2版本时，数据库报错：

      1. Caused by: org.h2.jdbc.JdbcSQLException: NULL not allowed for column "TYPE"; SQL statement:
      2. alter table key_store_info add column type integer not null [23502-197]
      3.         at org.h2.message.DbException.getJdbcSQLException(DbException.java:357) ~[h2-1.4.197.jar:1.4.197]
      4.         at org.h2.message.DbException.get(DbException.java:179) ~[h2-1.4.197.jar:1.4.197]
      5.         at org.h2.message.DbException.get(DbException.java:155) ~[h2-1.4.197.jar:1.4.197]

      答：将H2数据库删除（在h2目录下），或者配置新数据库名，在 application.yml 文件中的配置如下：

      1. spring:
      2.   datasource:
      3.     url: jdbc:h2:file:./h2/webasefront;DB_CLOSE_ON_EXIT=FALSE // 默认H2库为webasefront
      4. ...

    • 5：日志报以下错误信息：

      1. 2019-08-08 17:29:05.505 [pool-11-thread-1] ERROR TaskUtils$LoggingErrorHandler() - Unexpected error occurred in scheduled task.
      2. org.hyperic.sigar.SigarFileNotFoundException: 没有那个文件或目录
      3.         at org.hyperic.sigar.FileSystemUsage.gather(Native Method) ~[sigar-1.6.4.jar:?]
      5.         at org.hyperic.sigar.Sigar.getFileSystemUsage(Sigar.java:667) ~[sigar-1.6.4.jar:?]

      答：监控目录不存在，需配置节点所在磁盘目录，在 application.yml 文件中的配置如下：

      1. ...
      2. constant:  
      3.   monitorDisk: /            // 要监控的磁盘目录，配置节点所在目录（如：/home）
      4. ...

    • 6：启动报错“nested exception is javax.net.ssl.SSLException”：

    1. ...
    2. nested exception is javax.net.ssl.SSLException: Failed to initialize the client-side SSLContext: Input stream not contain valid certificates.

    答：CentOS的yum仓库的OpenJDK缺少JCE(Java Cryptography Extension)，导致Web3SDK无法正常连接区块链节点，因此在使用CentOS操作系统时，推荐使用OracleJDK。

    • 7：启动报错“Processing bcos message timeout”
    1. ...
    2. [main] ERROR SpringApplication() - Application startup failed
    3. org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'contractController': Unsatisfied dependency expressed through field 'contractService'; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'contractService': Unsatisfied dependency expressed through field 'web3jMap'; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'web3j' defined in class path resource [com/webank/webase/front/config/Web3Config.class]: Bean instantiation via factory method failed; nested exception is org.springframework.beans.BeanInstantiationException: Failed to instantiate [java.util.HashMap]: Factory method 'web3j' threw exception; nested exception is java.io.IOException: Processing bcos message timeout
    4. ...

    答：一些OpenJDK版本缺少相关包，导致节点连接异常。推荐使用。

    • 8：启动失败，日志却没有异常
    1. ...
    2. startWaitTime=600
    3. ...

    3.1. 导入私钥

    支持txt文件和pem文件导入测试用户的私钥信息

    导入.txt私钥内容格式示例：

    1. {
    2.   "address":"0x06f81c8e1cb59b5df2cdeb87a212d17fba79aad7",
    3.   "publicKey":"0x4b1041710a4427dc1c0d542c8f0fd312d92b0d03a989f512d1f8d3cafb851967f3592df0035e01fa63b2626165d0f5cffab15792161aa0360b8dfba2f3a7cf59",
    4.   "privateKey":"71f1479d9051e8d6b141a3b3ef9c01a7756da823a0af280c6bf62d18ee0cc978",
    5.   "userName":"111",
    6.   "type":0  // type为0，不可修改
    7. }

    其中用户类型为0代表用户为WeBASE-Front的本地私钥用户，导入的私钥均为该类型；

    导入.pem私钥内容示例：

    1. -----BEGIN PRIVATE KEY-----
    2. MIGEAgEAMBAGByqGSM49AgEGBSuBBAAKBG0wawIBAQQgC8TbvFSMA9y3CghFt51/
    3. fM/yuDBK2MRfFbfnOYVTNKyOSnmkY+xBfCR8Q86wcsQm9NZpkmFK
    4. -----END PRIVATE KEY-----

    其中pem文件开头的-----BEGIN PRIVATE KEY-----\n和结尾的\n-----END PRIVATE KEY-----\n格式不可更改，否则将读取pem文件失败

    3.2. 导出私钥

    目前仅支持导出测试用户的txt格式私钥

    Java中如何使用导出的私钥

    以上文中的私钥加载：

    1. @Test
    2. public void loadPrivateKeyTest() {
    3.   String privateKey = "71f1479d9051e8d6b141a3b3ef9c01a7756da823a0af280c6bf62d18ee0cc978";
    4.   Credentials credentials = GenCredential.create(privateKey);
    5.   // private key 实例
    6.   BigInteger privateKeyInstance = credentials.getEcKeyPair().getPrivateKey();
    7.   System.out.println(Numeric.toHexStringNoPrefix(privateKeyInstance));
    8.   // public key 实例
    9.   BigInteger publicKeyInstance = credentials.getEcKeyPair().getPublicKey();
    10.   System.out.println(Numeric.toHexString(publicKeyInstance));
    12.   String address = credentials.getAddress();
    13.   System.out.println(address);
    14. }

    在某些业务场景中，应用层需要实时获取链上的事件，如出块事件、合约Event事件等。应用层通过WeBASE连接节点后，由于无法和节点直接建立长连接，难以实时获取链上的消息。

    支持通过消息队列(Message Queue)来获取WeBASE-Front(v1.2.3+)的链上事件的消息推送

    目前支持出块事件与智能合约Event事件的事件Push通知，大致流程为：

    1. WeBASE-Front连接到MQ-Server(目前支持RabbitMQ-Server);
    2. WeBASE-Front接收节点的事件Push后，如出块通知，WeBASE-Front将出块消息发送到消息队列中；
    3. 区块链应用连接MQ-Server，获取消息队列中待消费的消息，即可获得事件通知；

    下面介绍如何搭建RabbitMQ的消息队列服务与WeBASE-Front的配置方法

    安装RabbitMQ服务并启用管理功能

    启用消息队列的事件推送服务，需要

    • 安装RabbitMQ Server

    参考RabbitMQ官网的下载与安装教程，安装并启动RabbitMQ-Server服务

    注：RabbitMQ依赖Erlang环境，可根据官网教程安装Erlang

    • 启动mq服务，并确保RabbitMQ Server服务所在主机的5672, 15672端口可访问；
    • 启用RabbitMQ的rabbitmq_managerment功能

    启用该功能可通过访问localhost:15672页面，可视化管理MQ的队列与用户；否则，需要通过rabbitmqctl命令行工具管理；

    1.   rabbitmq-plugins enable rabbitmq_management

    添加RabbitMQ管理员账户

    若启用了rabbitmq_managerment的功能，可在浏览器访问mq服务所在主机的ip:15672端口，如访问本机localhost:15672

    通过默认用户guest(密码也为guest)登录管理页，在Web页面上方的Admin项中，选择add user，新增tag为Administrator的管理员用户

    注： 可通过RabbitMQ的命令行工具，添加管理员账户(Administrator)，具体可参考

    guest用户不支持远程登录Web管理页，如需远程登录管理页面，需要通过rabbitmqctl新增一个管理员用户

    WeBASE-Front的配置

    通过配置applcation.yml中spring-rabbitmq项，WeBASE-Front即可连接到RabbitMQ-Server，将出块通知与合约Event通知推送到消息队列中：

    需要配置mq服务所在主机与管理员账户密码

    1. spring:
    2.   datasource:
    3.     ...
    4.   jpa:
    5.     ...
    6.   h2:
    7.     ...
    8.   rabbitmq:
    9.     host: 127.0.0.1 # rabbitmq部署所在主机的ip
    10.     port: 5672 # rabbitmq默认连接端口
    11.     username: defaultAccount # 要求具有Administrator权限的用户，本地连接rabbitmq可用guest账户
    12.     password: defaultPassword 
    13.     virtual-host: defaultVirtualHost # 消息队列和Exchange所在虚拟节点，默认为空或"/"
    14.     publisher-confirm: true # 消息发布确认开启
    15.     ssl:
    16.       enabled: false # 是否启用ssl连接，默认false

    客户端（区块链应用/消息消费者）使用说明

    客户端开发流程
    • 申请账号：客户端用户提供自己客户端应用编号appId，向mq-server运维管理员申请MQ服务的账号（可设置账户名和密码、virtual host）。
    • 创建队列与赋予权限：运维管理员创建账号后，管理员以用户提供的客户端应用的appId为名字，创建一个该账户专属的队列，然后赋予该账户read其专属队列的权限( permission-read中设置)。
    • 客户端连接到MQ：用户根据运维管理员提供的MQ账户名和密码、virtual host、消息交换机名（exchangeName），将自己的区块链应用连接到相应队列中，获取消息推送。

    下面简单展示运维管理员通过RabbitMQ的Web工具管理MQ服务：

    创建MQ账户：

    赋予MQ账户访问appId队列的read权限： 赋予read权限

    创建以appId命名的队列

    客户端订阅事件推送流程：
    • 客户端调用WeBASE-Front节点前置服务接口(/event/newBlockEvent和event/contractEvent)，注册事件监听；接口内容请查看接口文档-事件通知

    用户调用注册事件接口之后，实际上WeBASE-Front将以appId+事件名+{randomString}的routingKey，将用户所拥有的的队列Queue绑定到对应的Exchange中：

    appId队列绑定到群组Exchange

    • 用户在客户端以用户名密码连接到对应的virtual host，监听自己队列的消息，接收到消息后解析处理；

    客户端获取事件通知过程需如上进行配置，可参考的消费者客户端的代码实现（Dev分支）

    消费者客户端核心代码逻辑为：