配置说明

Broker 配置

主要有三类配置，Spring Boot进程配置、区块链FISCO-BCOS节点配置、WeEvent服务配置。

Spring Boot进程配置

配置文件链接application-prod.properties 。

#web container
server.port=8080
server.servlet.context-path=/weevent
#https
server.ssl.enabled=true
server.ssl.key-store=classpath:server.p12
server.ssl.key-store-password=123456
server.ssl.keyStoreType=PKCS12
server.ssl.keyAlias=weevent
#force to utf8
server.tomcat.uri-encoding=UTF-8
spring.http.encoding.charset=UTF-8
spring.http.encoding.enabled=true
spring.http.encoding.force=true
spring.messages.encoding=UTF-8
#change not found uri status from 404 to exception
spring.mvc.throw-exception-if-no-handler-found=true
spring.resources.add-mappings=false
#actuator
management.endpoints.web.exposure.include=info
management.endpoint.shutdown.enabled=false
#performance
spring.application.admin.enabled=false

以上是Spring Boot标准配置文件，一般不需要修改。细节请参见Spring Boot文档 。

区块链FISCO-BCOS节点配置

配置文件链接applicationContext.xml 。

这个就是FISCO-BCOS的Web3SDK的配置文件，直接从节点上复制过来即可，不用修改。参见Web3SDK配置文件 。

WeEvent服务配置

配置文件链接weevent.properties 。

#fisco
fisco.topic-controller.contract-address=0xddddd42da68a40784f5f63ada7ead9b36a38d2e3
fisco.consumer.idle-time=1000

#ip white list
ip.check.white-table=
#redis server
redis.server.ip=
redis.server.port=
redis.server.password=weevent
#lru.cache.capacity=65536
#restful cgi timeout
restful.subscribe.callback.timeout=5000

#mqtt broker
#mqtt.broker.url=tcp://127.0.0.1:1883
mqtt.broker.user=iot
mqtt.broker.password=123456
mqtt.broker.qos=2
mqtt.broker.timeout=5000
#mosquitto default 20s
mqtt.broker.keep-alive=15

#zookeeper
#broker.zookeeper.ip=127.0.0.1:2181
broker.zookeeper.path=/event_broker
broker.zookeeper.timeout=3000

#user
stomp.user.login=
stomp.user.passcode=
#server heartbeats
stomp.heartbeats=30

参数说明：

  • 合约地址fisco.topic-controller.contract-address

    合约地址是WeEvent访问区块链访问数据的入口，需要用户在初始化WeEvent时部署合约并且修改。Broker安装包里带了部署合约的脚本./deploy-topic-control.sh。

  • fisco.consumer.idle-time

    消费者线程中检测区块链新增块事件的周期，默认为1000毫秒。一般不用修改。

  • IP白名单ip.check.white-table

    WeEvent授权访问的客户端IP列表 ，默认为空时表示允许任何客户端访问。

    用户可以配置多个IP地址，以”;”进行分割。如ip.check.white-table=127.0.0.1;127.0.0.2。

  • Redis缓存配置redis.*

    业务场景中如果有多个Consumer订阅同一个Topic的场景，建议使用Redis缓存来加快事件的通知。

    • redis.server.ip ： Redis 服务的IP地址
    • redis.server.port ：Redis 服务占用的端口
    • redis.server.password ：Redis 服务访问密码
    • lru.cache.capacity：进程中缓存大小，当缓存数据大于这个值时，使用LRU策略淘汰。一般不用修改。

  • RESTful回调接口的超时时间

    • restful.subscribe.callback.timeout：事件通知回调的超时时间，默认为5000毫秒。一般不用修改。

  • MQTT桥接配置mqtt.broker.*

    • mqtt.broker.url：MQTT服务的访问地址（一般是指Mosquitto的访问地址）。
    • mqtt.broker.user/password：MQTT服务的访问权限（没有可以不用填）。

  • Zookeeper配置broker.zookeeper.*

    • broker.zookeeper.ip：Zookeeper的服务IP列表。
    • broker.zookeeper.path：WeEvent的数据存储路径。一般不用修改。
    • broker.zookeeper.timeout：Zookeeper的Session超时时间。默认为3000毫秒，一般不用修改。

  • STOMP协议配置stomp.*

    • stomp.user.login/passcode：建议用户开启STOMP协议的账号/密码校验，以增强安全性。默认为空，表示不校验。
    • stomp.heartbeats：配置心跳时间间隔。默认时间间隔30秒，一般不用修改。

Governance

Governance的配置都在文件application-prod.yml中，配置文件链接application-prod.yml 。

server:
  port: 8082
spring:
  # datasource
  datasource: 
    # mysql的jdbc访问串
    url: jdbc:mysql://127.0.0.1:3306/demo?useUnicode=true&characterEncoding=utf-8&useSSL=false 
    driver-class-name: org.mariadb.jdbc.Driver
    # 数据库用户名
    username: ${username}
    # 数据库密码
    password: ${password}
    type: org.apache.commons.dbcp2.BasicDataSource
    dbcp2:
      max-wait-millis: 10000
      min-idle: 5
      initial-size: 5
      validation-query: SELECT 'x'
  pid:
    fail-on-write-error: true
    file: ./logs/governance.pid

weevent:
  # broker服务的url地址
  url: http://127.0.0.1:8080/weevent
governance:
  influxdb:
    # 如果有配influxdb 填true，如果没有填写false
    enabled: false
    # 用户名
    username: admin
    # 密码
    password: admin
    # influxdb的url
    openurl: http://127.0.0.1:8306
    # 使用的数据库
    database: telegraf
logging:
  config: classpath:log4j2.xml

配置说明:

  • datasource：数据库的JDBC访问串。
  • weevent：broker服务的访问地址。

Nginx 配置说明

反向代理映射

这个文件./conf/conf.d/http.conf主要配置反向代理的映射，一般不需修改。配置文件链接http.conf 。

$ cat ./conf/conf.d/http.conf 
add_header X-Frame-Options "SAMEORIGIN";

server {
    listen          8888;
    server_name     localhost;

    location / {
        root   html;
        index  index.html index.htm;
    }

    location /weevent/ {
        proxy_pass          http://broker_backend/weevent/;
        
        proxy_set_header    Host $host;
        proxy_set_header    X-Real-IP $remote_addr;
        proxy_set_header    X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_http_version  1.1;
        
        proxy_set_header    Upgrade $http_upgrade;
        proxy_set_header    Connection "upgrade";
    }
    
    location /weevent-governance/ {
        proxy_pass          http://governance_backend/weevent-governance/;
        
        proxy_set_header    Host $host:8080;
        proxy_set_header    X-Real-IP $remote_addr;
        proxy_set_header    X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_http_version  1.1;
    }
}

后端子模块配置

配置文件链接rs.conf 。

$ cat ./conf/conf.d/rs.conf 
upstream broker_backend{
    server 127.0.0.1:8081 weight=100 max_fails=3;
    server 127.0.0.2:8081 weight=100 max_fails=3;
    
    ip_hash;
    keepalive 1024;
}

upstream governance_backend{
    server 127.0.0.1:8082 weight=100 max_fails=3;
    server 127.0.0.2:8082 weight=100 max_fails=3;
    
    ip_hash;
    keepalive 1024;
}

Nginx配置文件说明，请参见Nginx配置 。