Spring Boot 整合 Fisco Bcos(部署、呼叫區塊鏈合約)

齊行超發表於2022-01-04

簡介

在上一節,介紹了Spring Boot 整合 Fisco BCOS的最最基礎的案例(SpringBoot成功連線Fisco BCOS,並訪問其節點網路 --> 文章連結)。

本節,我們們繼續介紹Spring Boot 整合 Fisco BCOS的最最重要的技術點:部署、呼叫區塊鏈合約(基於上一節的工程案例)。

主要流程

--> 1、合約開發(省略,因為是案例演示,直接使用 Fisco BCOS自帶的 HelloWorld合約即可,預設已包含的get、set方法)
--> 2、合約編譯(需要編譯成java檔案,才能在Spring Boot工程中使用)
--> 3、Spring Boot配置合約(將編譯好的合約檔案,配置到Spring Boot工程中)
--> 4、合約呼叫的功能實現
--> 5、功能測試

1、合約開發

Fisco BCOS 預設自帶了一些合約參考案例,我們就不用自己開發了(原因是比較懶,能不做的就要堅持不做?),直接使用HelloWorld.sol即可:

看一下該合約的程式碼實現,只包含了一個變數,以及該變數的get、set方法(現階段不用考慮solidity語法,相信有過程式設計經驗的同學都能看得懂):

2、合約編譯

合約HelloWorld.sol想在SpringBoot中使用,需要先將合約檔案進行編譯,得到.java檔案。
編譯合約,最簡單的方式是通過 Fisco BCOS提供的Console控制檯程式進行編譯,
官方文件:--> 請參考:第四步. 準備智慧合約
比較簡單,此處不再複述。

注意:如果是自己開發的合約,需要先將合約拷貝到 ~/fisco/console/contracts/solidity目錄下,再執行編譯合約的命令。
編譯成功後,可以在/contracts/sdk/java/org/com/fisco/目錄中找到編譯後的java檔案 :

其中,HelloWorld.java 就是我們需要的檔案。

3、Spring Boot配置合約

將HelloWorld.java拷貝到SpringBoot工程中,注意:在應用中所放的位置要與我們設定的包名相同(即:編譯後存放java檔案的目錄結構):

這樣就算配置好了,接下來我們直接編碼呼叫合約就可以了~

4、合約呼叫的功能實現

BcosController完整程式碼:
package com.qxc.demo_bcos.controller;

import org.com.fisco.HelloWorld;
import org.fisco.bcos.sdk.BcosSDK;
import org.fisco.bcos.sdk.client.Client;
import org.fisco.bcos.sdk.client.protocol.response.BlockNumber;
import org.fisco.bcos.sdk.crypto.keypair.CryptoKeyPair;
import org.fisco.bcos.sdk.model.TransactionReceipt;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.web.bind.annotation.*;

/**
 * Bcos 演示案例:
 * 齊行超
 * 2022-01-04
 */
@RestController
public class BcosController {
    private BcosSDK bcosSDK;
    private Client client;
    private HelloWorld helloWorld;

    private void initSDK() throws Exception {
        System.out.println("-----init BcosSDK:------");
        @SuppressWarnings("resource")
        ApplicationContext context = new ClassPathXmlApplicationContext("classpath:fisco-config.xml");
        System.out.println("-----init config ok------");
        bcosSDK = context.getBean(BcosSDK.class);
        System.out.println("-----init BcosSDK ok------");
        // 為群組1初始化client
        client = bcosSDK.getClient(Integer.valueOf(1));
        System.out.println("-----init client ok------");
        // 向群組1部署HelloWorld合約
        CryptoKeyPair cryptoKeyPair = client.getCryptoSuite().getCryptoKeyPair();
        helloWorld = HelloWorld.deploy(client, cryptoKeyPair);
        System.out.println("-----deploy HelloWorld ok------");
    }

    @GetMapping("/test")
    public String test() {
        System.out.println("-----test------");
        return "this is bcos demo";
    }

    @GetMapping("/block")
    public String getBlockNumber() throws Exception {
        System.out.println("-----getBlockNumber------");
        if(bcosSDK == null){
            initSDK();
        }
        if(bcosSDK == null || client == null){
            System.out.println("-----init BcosSDK failed------");
            return "-----init BcosSDK failed----";
        }
        BlockNumber blockNumber = client.getBlockNumber();
        return "block number is : " + blockNumber.getBlockNumber().toString();
    }

    @GetMapping("/get")
    public String getHelloworld() throws Exception {
        System.out.println("-----getHelloworld------");
        if(bcosSDK == null){
            initSDK();
        }
        if(bcosSDK == null || helloWorld == null){
            System.out.println("-----init BcosSDK failed------");
            return "-----init BcosSDK failed----";
        }
        // 呼叫HelloWorld合約的get介面
        String getValue = helloWorld.get();
        System.out.println("-----call HelloWorld get success------:" + getValue);
        return getValue;
    }

    @GetMapping("/set")
    public String setHelloworld(@RequestParam(value="val",required = false,defaultValue = "default val")String val) throws Exception {
        System.out.println("-----setHelloworld------");
        if(bcosSDK == null){
            initSDK();
        }
        if(bcosSDK == null || helloWorld == null){
            System.out.println("-----init BcosSDK failed------");
            return "-----init BcosSDK failed----";
        }
        // 呼叫HelloWorld合約的set介面
        TransactionReceipt receipt = helloWorld.set(val);
        System.out.println("-----call HelloWorld get success------:" + receipt.getMessage());
        return "setHelloworld success";
    }
}

程式碼中除了合約的呼叫,還有BCOS SDK初始化等功能,對應的技術講解請在上一節中檢視,本節不再複述哈--> 文章連結

5、功能測試

我這邊有兩臺電腦:
電腦1:本地的Mac電腦,沒有區塊鏈環境,只是用於SpringBoot工程的開發;
電腦2:阿里雲上的CentOS伺服器,配置了區塊鏈環境,合約部署、編譯、SpringBoot工程的jar包執行都是在該電腦上;

大家可根據自己的電腦環境,對比著進行功能測試即可。

5.1、編譯SpringBoot工程,生成jar包:

5.2、傳送到伺服器上執行:

5.3、在mac電腦上遠端訪問服務端程式(也可在服務端通過curl自己訪問自己):

測試get:

測試set:

再測試get:

測試塊高(我這邊反覆set了幾次,塊高已累計到9了? ):

總結

至此,Spring Boot 整合 Fisco Bcos(部署、呼叫區塊鏈合約)的案例講解已結束。
Fisco Bcos 的使用還是很簡單的,如果有問題大家可以直接查詢官方技術文件,也歡迎留言討論,我們們共同學習、共同進步,哈哈~~。

相關文章