附录¶
1. 配置参数说明¶
WeBASE-Codegen-Monkey用于生成WeBASE-Collect-Bee组件实例，在WeBASE-Codegen-Monkey组件中配置文件只有一个：application.properties。该配置文件覆盖了数据导出组件所需的所有配置，并提供了详细的说明和样例，开发者可根据需求进行灵活配置。
1.1 Springboot服务配置¶
| 配置项 | 是否必输 | 说明 | 举例 | 默认值 |
|---|---|---|---|---|
| server.port | N | 启动WeBASE-Collect-Bee组件实例的服务端口 | 8082 | 8080 |
1.2 FISCO-BCOS节点配置¶
FISCO-BCOS节点配置用于配置WeBASE-Collect-Bee服务连接的区块链节点，使得WeBASE-Collect-Bee服务能够访问连接节点，并通过该节点获取区块链网络上的数据。
| 配置项 | 是否必输 | 说明 | 举例 | 默认值 |
|---|---|---|---|---|
| system.orgId | N | 组织机构ID，用于区分不同的机构 | 10000 | FB001 |
| system.nodeStr | Y | 连接区块链节点的nodeStr，nodeName@[IP]:[PORT], 其中prot为channel port | node1@ip:8822 | - |
1.3 数据库配置¶
数据导出组件最终会把区块链网络上的数据导出到数据存储介质中，目前版本仅支持MySQL，所以需要进行数据库配置。
| 配置项 | 是否必输 | 说明 | 举例 | 默认值 |
|---|---|---|---|---|
| system.dbUrl | Y | 访问数据的URL | jdbc:mysql://[IP]:[PORT]/[DB]?useSSL=false&serverTimezone=GMT%2b8&useUnicode=true&characterEncoding=UTF-8 | - |
| system.dbUser | Y | 数据库用户名 | admin | - |
| system.dbPassword | Y | 数据库密码 | 123456 | - |
| system.contractName.[methodName or eventName].shardingNO | N | 合约数据分片数：数据库指定数据表的个数 | system.Rule.NewruleEvent.shardingNO = 3 | 1 |
| system.sys.[sysTableName].shardingNO | N | 系统数据分片数 | system.sys.BlockTxDetailInfo.shardingNO=5 | 1 |
| system.nameStyle | N | 数据库表名和字段命名规则，支持下划线命名和原始数据命名 | system.nameStyle=rawCase | underScoreCase |
| system.namePrefix | N | 数据库表字段命名前缀，默认为空 | system.namePrefix=_ | 空 |
| system.namePostfix | N | 数据库表字段命名后缀，默认为空 | system.namePostfix=_ | 空 |
其中sysTableName对应区块数据表和账户数据表，详情见 数据存储模型 章节。
1.4 FISCO-WeBASE-Collect-Bee工程配置¶
| 配置项 | 是否必输 | 说明 | 举例 | 默认值 |
|---|---|---|---|---|
| system.group | Y | 同spring项目的group | com.example | - |
| system.contractPackName | Y | 编译智能合约所输入的包名 | com.webank.blockchain.wecredit.contracts | - |
| monitor.default.frequency | N | 所有method和event的抓取频率，默认几秒轮询一次 | 10 | 5 |
1.5 线程池配置¶
在单机部署下，必须配置线程池参数。数据导出配置用于配置数据导出的频率、线程数及启动多线程条件等。当system.multiLiving=true时，配置文件不会生成线程池相关配置。
| 配置项 | 是否必输 | 说明 | 举例 | 默认值 |
|---|---|---|---|---|
| system.multiLiving | Y | 关闭多活开关 | false | false |
| system.crawlBatchUnit | N | 线程处理单元：多线程任务模式下单个线程一次任务执行完成的区块数 | 100 | 100 |
1.6 集群多活配置¶
在集群多活部署的方案中，必须设置集群多活的配置。集群必须通过zookeeper进行服务注册和任务分发。当system.multiLiving=false时，配置文件不会生成zookeeper相关配置。
| 配置项 | 是否必输 | 说明 | 举例 | 默认值 |
|---|---|---|---|---|
| system.multiLiving | Y | 启动多活开关 | true | false |
| regcenter.serverList | N | 注册中心服务器列表 | [ip1:2181;ip2:2181] | - |
| regcenter.namespace | N | 注册中心命名空间 | wecredit_bee | - |
1.7 其他高级配置¶
| 配置项 | 是否必输 | 说明 | 举例 | 默认值 |
|---|---|---|---|---|
| monitor.[contractName].[methodName/eventName].generated=false | N | 是否抓取特定合约中特定method或event的数据 | on/off | on |
| monitor.[contractName].[eventName].ignoreParam=XXX,XXX | N | 忽略特定合约特定event的特定字段不进行抓取 | xxx,xxx | |
| length.[contractName].[methodName or eventName].paraName | N | 指定特定字段在数据库表中的长度 | 512 |
2. Java安装¶
Ubuntu环境安装Java¶
# 安装默认Java版本(Java 8或以上)
sudo apt install -y default-jdk
# 查询Java版本
java -version
CentOS环境安装Java¶
# 查询centos原有的Java版本
$ rpm -qa|grep java
# 删除查询到的Java版本
$ rpm -e --nodeps java版本
# 查询Java版本，没有出现版本号则删除完毕
$ java -version
# 创建新的文件夹，安装Java 8或以上的版本，将下载的jdk放在software目录
# 从openJDK官网(https://jdk.java.net/java-se-ri/8)或Oracle官网(https://www.oracle.com/technetwork/java/javase/downloads/index.html)选择Java 8或以上的版本下载，例如下载jdk-8u201-linux-x64.tar.gz
$ mkdir /software
# 解压jdk
$ tar -zxvf jdk-8u201-linux-x64.tar.gz
# 配置Java环境，编辑/etc/profile文件
$ vim /etc/profile
# 打开以后将下面三句输入到文件里面并退出
export JAVA_HOME=/software/jdk-8u201-linux-x64.tar.gz
export PATH=$JAVA_HOME/bin:$PATH
export CLASSPATH=.:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar
# 生效profile
$ source /etc/profile
# 查询Java版本，出现的版本是自己下载的版本，则安装成功。
java -version
3. Git安装¶
git：用于拉取最新代码
centos:
sudo yum -y install git
ubuntu:
sudo apt install git
4. Mysql安装¶
此处以Centos/Fedora为例。
（1）切换到root
sudo -s
（2）安装mysql
yum install mysql*
#某些版本的linux，需要安装mariadb，mariadb是mysql的一个分支
yum install mariadb*
（3）启动mysql
service mysqld start
#若安装了mariadb，则使用下面的命令启动
service mariadb start
（4）初始化root用户
mysql -u root
注意，以下语句仅适用于开发环境，不能直接在实际生产中使用！！！ 以下操作仅供参考，请勿直接拷贝，请自定义设置复杂密码。
/*授权test用户本地访问数据库*/
create user 'test'@'localhost' identified by 'test1234';
（5）用SQL语句给root分配密码
GRANT ALL PRIVILEGES ON *.* TO 'test'@'%' IDENTIFIED BY 'test1234' WITH GRANT OPTION;
**注意，以上语句仅适用于开发环境，不能直接在实际生产中使用！！！以上设置会使数据库在所有网络上都可以访问，请按具体的网络拓扑和权限控制情况，设置网络和权限帐号 **
（6）测试是否成功
另开一个ssh测试用户是否可以登陆，并成功授权，登陆数据库
mysql -utest -ptest@2107 -h 127.0.0.1 -P 3306
登陆成功后，执行sql语句，若出现错误，则用户授权不成功
show databases;
use test;
select * from tb_txnByDay;
6. supervisor安装与部署¶
配置脚本¶
cd /etc/supervisord.d 修改/etc/supervisord.conf的[include]部分：
[include]
files = supervisord.d/*.ini
[supervisord]
在/etc/supervisord.d目录下配置以下启动配置文件webasebee_config1.ini（请注意配置文件里需要包含webasebee，否则会导致关闭任务命令失效），注意修改相关的路径。
[program:supervisor_webasebee]
directory =【你的程序路径】/WeBASE-Collect-Bee/dist ; 程序的启动目录
command = nohup java -jar 【你的安装包名，如WeBASE-Collect-Bee0.3.0-SNAPSHOT.jar】 & ; 启动命令，与命令行启动的命令是一样的
autostart = true ; 在 supervisord 启动的时候也自动启动
startsecs = 15 ; 启动 15 秒后没有异常退出，就当作已经正常启动了
autorestart = true ; 程序异常退出后自动重启
startretries = 3 ; 启动失败自动重试次数，默认是 3
user = app ; 用哪个用户启动
redirect_stderr = true ; 把 stderr 重定向到 stdout，默认 false
stdout_logfile_maxbytes = 150MB ; stdout 日志文件大小，默认 50MB
stdout_logfile_backups = 20 ; stdout 日志文件备份数
stderr_logfile=【你的日志路径】/WeBASE-Collect-Bee/dist/log/webase_bee_error.log
stdout_logfile = 【你的日志路径】/WeBASE-Collect-Bee/dist/log/webase_bee_out.log ;日志统一放在log目录下
[supervisord]
启动任务¶
supervisor支持supervisorctl和supervisord启动，可通过systemctl实现开机自启动。 我们建议采用supervisord的方式启动：
supervisord -c /etc/supervisord.d/webasebee_config1.ini
关闭任务¶
ps -ef|grep supervisord|grep webasebee| awk '{print $2}'|xargs kill -9
ps -ef|grep WeBASE-Collect-Bee|grep -v grep| awk '{print $2}'|xargs kill -9