web3sdk 是什么 Spring Boot Starter怎么用

2024-09-03 08:58

本文主要是介绍web3sdk 是什么 Spring Boot Starter怎么用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

一、Web3SDK是什么

Web3SDK为FISCO BCOS提供Java API。

利用FISCO BCOS JAVA SDK可以简单快捷的基于FISCO-BCOS进行区块链应用开发。

此版本只支持FISCO BCOS 2.0+。

 

 

 

关键特性

  • 实现FISCO BCOS的JSON-RPC的Java API。
  • 支持预编译合约管理区块链。
  • 支持链上信使协议为联盟链提供安全高效的消息信道。
  • 支持使用国密算法发送交易。

 

源码编译

环境要求:

  • JDK8及以上

一定要安装java8

https://shijianfeng.blog.csdn.net/article/details/116152884

 

  • Gradle 5.0及以上

 

编译运行如下命令:

$ cd web3sdk
$ ./gradlew build

编译结果: 编译的web3sdk jar位于:

web3sdk/dist/apps/web3sdk.jar

文档

  • 英文
  • 中文

快速入门

提供基于SDK的spring boot starter示例项目,示例项目使用了SDK的核心特性, 包括:

  • 如何连接FISCO BCOS区块链节点。
  • 在区块链网络中部署合约。
  • 读取部署合约的变量值。
  • 更新部署合约的变量值。
  • 提供SDK API接口的测试案例。

 

https://gitee.com/FISCO-BCOS/web3sdk/

 

 

二、怎么用

Spring Boot Starter

  该项目是基于Web3SDK的spring boot版本的示例项目。提供FISCO BCOS区块链应用开发的基本框架和基本的测试案例,帮助开发者基于FISCO BCOS区块链快速进行应用开发。此版本只支持FISCO BCOS 2.0+。

 

快速启动

前置条件

搭建FISCO BCOS区块链,具体步骤参考这里。

 

获取源码

git clone https://github.com/FISCO-BCOS/spring-boot-starter.git

 

节点证书配置

将节点所在目录nodes/${ip}/sdk下的ca.crtsdk.crtsdk.key文件拷贝到项目的src/main/resources录下供SDK使用

(FISCO BCOS 2.1以前,证书为ca.crtnode.crtnode.key`)。

 

 

配置文件设置

spring boot项目的配置文件application.yml如下图所示,其中加了注释的内容根据区块链节点配置做相应修改。

encrypt-type: # 0:standard, 1:guomiencrypt-type: 0group-channel-connections-config:caCert: classpath:ca.crtsslCert: classpath:sdk.crtsslKey: classpath:sdk.keyall-channel-connections:- group-id: 1 #group IDconnections-str:- 192.168.64.129:20200 # node listen_ip:channel_listen_port- 192.168.64.131:20200- 192.168.64.132:20200- 192.168.64.130:20200- group-id: 2connections-str:- 127.0.0.1:20202 # node listen_ip:channel_listen_port- 127.0.0.1:20203channel-service:group-id: 1 # The specified group to which the SDK connectsagency-name: agencyA # agency nameaccounts:pem-file: 0xcdcce60801c0a2e6bb534322c32ae528b9dec8d2.pemp12-file: 0x98333491efac02f8ce109b0c499074d47e7779a6.p12password: 123456

 

项目中关于SDK配置的详细说明请参考这里。

 

 

运行

编译并运行测试案例,在项目根目录下运行:

cd spring-boot-starter
./gradlew build
./gradlew test

当所有测试案例运行成功,则代表

  • 区块链运行正常,
  • 该项目通过SDK连接区块链正常。

可以通过这个网址看错误报告file:///home/shijianfeng/fisco/spring-boot-starter/build/reports/tests/test/index.html

开发者可以基于该项目进行具体应用开发。

注:如果在IntelliJ IDEA或Eclipse中运行该demo工程,则使用gradle wrapper模式,此外IntelliJ IDEA需要在设置中开启Annotation Processors功能。

Web3SDK - 常见的异常启动问题错误查看https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/faq/sdk.html?highlight=Web3SDK

 

测试案例介绍

该示例项目提供的测试案例,供开发者参考使用。测试案例主要分为对Web3j API,Precompiled Serveice API、Solidity合约文件转Java合约文件、部署和调用合约的测试。

 

Web3j API测试

提供Web3jApiTest测试类测试Web3j API。示例测试如下:

@Test
public void getBlockNumber() throws IOException {BigInteger blockNumber = web3j.getBlockNumber().send().getBlockNumber();System.out.println(blockNumber);assertTrue(blockNumber.compareTo(new BigInteger("0"))>= 0);
}

温馨提示: Application类初始化了web3j对象,在业务代码需要的地方可用注解的方式直接使用,使用方式如下:

@Autowired
private Web3j web3j

 

Precompiled Service API测试

提供PrecompiledServiceApiTest测试类测试Precompiled Service API。示例测试如下:

@Test
public void testSystemConfigService() throws Exception {SystemConfigSerivce systemConfigSerivce = new SystemConfigSerivce(web3j, credentials);systemConfigSerivce.setValueByKey("tx_count_limit", "2000");String value = web3j.getSystemConfigByKey("tx_count_limit").send().getSystemConfigByKey();System.out.println(value);assertTrue("2000".equals(value));
}

 

Solidity合约文件转Java合约文件测试

提供SolidityFunctionWrapperGeneratorTest测试类测试Solidity合约文件转Java合约文件。示例测试如下:

@Test
public void compileSolFilesToJavaTest() throws IOException {File solFileList = new File("src/test/resources/contract");File[] solFiles = solFileList.listFiles();for (File solFile : solFiles) {SolidityCompiler.Result res = SolidityCompiler.compile(solFile, true, ABI, BIN, INTERFACE, METADATA);System.out.println("Out: '" + res.output + "'");System.out.println("Err: '" + res.errors + "'");CompilationResult result = CompilationResult.parse(res.output);System.out.println("contractname  " + solFile.getName());Path source = Paths.get(solFile.getPath());String contractname = solFile.getName().split("\\.")[0];CompilationResult.ContractMetadata a = result.getContract(solFile.getName().split("\\.")[0]);System.out.println("abi   " + a.abi);System.out.println("bin   " + a.bin);FileUtils.writeStringToFile(new File("src/test/resources/solidity/" + contractname + ".abi"), a.abi);FileUtils.writeStringToFile(new File("src/test/resources/solidity/" + contractname + ".bin"), a.bin);String binFile;String abiFile;String tempDirPath = new File("src/test/java/").getAbsolutePath();String packageName = "org.fisco.bcos.temp";String filename = contractname;abiFile = "src/test/resources/solidity/" + filename + ".abi";binFile = "src/test/resources/solidity/" + filename + ".bin";SolidityFunctionWrapperGenerator.main(Arrays.asList("-a", abiFile,"-b", binFile,"-p", packageName,"-o", tempDirPath).toArray(new String[0]));}System.out.println("generate successfully");
}

该测试案例将src/test/resources/contract目录下的所有Solidity合约文件(默认提供HelloWorld合约)均转为相应的abi和bin文件,保存在src/test/resources/solidity目录下。然后将abi文件和对应的bin文件组合转换为Java合约文件,保存在src/test/java/org/fisco/bcos/temp目录下。SDK将利用Java合约文件进行合约部署与调用。

 

部署和调用合约测试

提供ContractTest测试类测试部署和调用合约。示例测试如下:

@Test
public void deployAndCallHelloWorld() throws Exception {//deploy contractHelloWorld helloWorld = HelloWorld.deploy(web3j, credentials, new StaticGasProvider(gasPrice, gasLimit)).send();if (helloWorld != null) {System.out.println("HelloWorld address is: " + helloWorld.getContractAddress());//call set functionhelloWorld.set("Hello, World!").send();//call get functionString result = helloWorld.get().send();System.out.println(result);assertTrue( "Hello, World!".equals(result));}
}

https://github.com/FISCO-BCOS/spring-boot-starter/blob/master/doc/README_CN.md

这篇关于web3sdk 是什么 Spring Boot Starter怎么用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1132572

相关文章

JAVA保证HashMap线程安全的几种方式

《JAVA保证HashMap线程安全的几种方式》HashMap是线程不安全的,这意味着如果多个线程并发地访问和修改同一个HashMap实例,可能会导致数据不一致和其他线程安全问题,本文主要介绍了JAV... 目录1. 使用 Collections.synchronizedMap2. 使用 Concurren

Java Response返回值的最佳处理方案

《JavaResponse返回值的最佳处理方案》在开发Web应用程序时,我们经常需要通过HTTP请求从服务器获取响应数据,这些数据可以是JSON、XML、甚至是文件,本篇文章将详细解析Java中处理... 目录摘要概述核心问题:关键技术点:源码解析示例 1:使用HttpURLConnection获取Resp

Java的栈与队列实现代码解析

《Java的栈与队列实现代码解析》栈是常见的线性数据结构,栈的特点是以先进后出的形式,后进先出,先进后出,分为栈底和栈顶,栈应用于内存的分配,表达式求值,存储临时的数据和方法的调用等,本文给大家介绍J... 目录栈的概念(Stack)栈的实现代码队列(Queue)模拟实现队列(双链表实现)循环队列(循环数组

Java中Switch Case多个条件处理方法举例

《Java中SwitchCase多个条件处理方法举例》Java中switch语句用于根据变量值执行不同代码块,适用于多个条件的处理,:本文主要介绍Java中SwitchCase多个条件处理的相... 目录前言基本语法处理多个条件示例1:合并相同代码的多个case示例2:通过字符串合并多个case进阶用法使用

Java中的Lambda表达式及其应用小结

《Java中的Lambda表达式及其应用小结》Java中的Lambda表达式是一项极具创新性的特性,它使得Java代码更加简洁和高效,尤其是在集合操作和并行处理方面,:本文主要介绍Java中的La... 目录前言1. 什么是Lambda表达式?2. Lambda表达式的基本语法例子1:最简单的Lambda表

Java中Scanner的用法示例小结

《Java中Scanner的用法示例小结》有时候我们在编写代码的时候可能会使用输入和输出,那Java也有自己的输入和输出,今天我们来探究一下,对JavaScanner用法相关知识感兴趣的朋友一起看看吧... 目录前言一 输出二 输入Scanner的使用多组输入三 综合练习:猜数字游戏猜数字前言有时候我们在

Spring Security+JWT如何实现前后端分离权限控制

《SpringSecurity+JWT如何实现前后端分离权限控制》本篇将手把手教你用SpringSecurity+JWT搭建一套完整的登录认证与权限控制体系,具有很好的参考价值,希望对大家... 目录Spring Security+JWT实现前后端分离权限控制实战一、为什么要用 JWT?二、JWT 基本结构

java解析jwt中的payload的用法

《java解析jwt中的payload的用法》:本文主要介绍java解析jwt中的payload的用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Java解析jwt中的payload1. 使用 jjwt 库步骤 1:添加依赖步骤 2:解析 JWT2. 使用 N

springboot项目如何开启https服务

《springboot项目如何开启https服务》:本文主要介绍springboot项目如何开启https服务方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录springboot项目开启https服务1. 生成SSL证书密钥库使用keytool生成自签名证书将

Java实现优雅日期处理的方案详解

《Java实现优雅日期处理的方案详解》在我们的日常工作中,需要经常处理各种格式,各种类似的的日期或者时间,下面我们就来看看如何使用java处理这样的日期问题吧,感兴趣的小伙伴可以跟随小编一起学习一下... 目录前言一、日期的坑1.1 日期格式化陷阱1.2 时区转换二、优雅方案的进阶之路2.1 线程安全重构2