如何在Spring Boot中玩转智能合约【修订版】

本文是由链博科技 ChainBoard.IO 为大家带来的web3j 对智能合约的调用。让 java 程序可以和我们的智能合约愉快的交互起来~

一、 什么是 web3j

web3j是一个高度模块化、响应式、类型安全的Java和Android库，用于与智能合约交互，并与Ethereum网络的客户端(节点)集成。

二、准备工作

1.新建一个spring-boot的项目，在 pom 文件中添加

1. <dependency>

2.    <groupId>org.web3j</groupId>

3.    <artifactId>web3j-spring-boot-starter</artifactId>

4.    <version>1.6.0</version>

5. </dependency>

2.打开以太坊客户端 （如果有可以直接连接的客户端，可以忽略此步骤）注意：打开客户端的时候需要加上 --rpc 参数。否则无法调用。并且需要打开你的矿工，来完成智能合约部署调用等工作。

1. geth --rpc --datadir "./chain" --nodiscover console 2>>ouput.log

2. miner.start()

3.生成智能合约的封装器 (1) 下载 web3j 的 Command Line Tool： Homebrew

1. brew tap web3j/web3j

2. brew install web3j

下载zip文件：下载地址

1. unzip web3j-<version>.zip

2. ./web3j-<version>/bin/web3j

(2) 生成封装器 需要先用 solc 编译生成 .bin .abi 文件

solc 安装命令： npm install-g solc

命令：

1. > solcjs <Solidity文件地址>.sol --bin --abi --optimize -o <输出文件夹路径>/

实例：这里以 Compute.sol 文件为例，示例合约见文章最后一节

1. > solcjs Compute.sol --abi --bin -o ./

会生成四个文件，如下：

注意：因为合约中有 Compute、Owner 两个函数，所以两个函数的文件都会生成出来。但是，由于 Compute 函数继承了 Owner 函数的方法，所以实际上我们只需要用到 ComputesolCompute.abi ComputesolCompute.bin 这两个文件。

用 web3j 生成 java 封装器 命令：

1. web3j solidity generate --solidityTypes <智能合约编译之后的.bin文件的地址>.bin <智能合约编译之后的.abi文件的地址>.abi -o /path/to/src/main/java -p com.your.organisation.name

-o 后接生成好的java文件放置的位置， -p 后接生成的java文件的包名注意：.bin .abi文件顺序不能反，否则会报错

实例：使用我们之前生成的文件，将 java 文件生成到我们的项目中：

1. web3j solidity generate --solidityTypes Compute_sol_Compute.bin Compute_sol_Compute.abi -o ./project/src/main/java -p com.demo

输出如下信息后，可以在我们指定的路径看见生成好的 java 文件 Compute_sol_Compute.java：

三、web3j 基础命令

1.建立以太坊连接

1. Web3j web3j = Web3j.build(new HttpService());

默认的连接地址是 http://localhost:8545/，也可以改变地址，连接其他客户端。

2.加载账户信息 账户文件可以在私链数据文件夹中的 keystore 文件夹中找到

1. Credentials credentials = WalletUtils.loadCredentials(

2.                "123",

3.                "/datadir/chain/keystore/UTC--2018-03-14T14-46-38.646997441Z--c2acba996f709d4b806d3330996f49d50f088258");  

第一个变量填入账户的密码，第二个变量填入账户文件的 path

3.获取账户余额

1. Web3j web3j = Web3j.build(new HttpService());

2. String address = "0xa6fd2ebac389773f5bd34d0738bc5fdbd1bea01b";

3. EthGetBalance ethGetBalance = web3j.ethGetBalance(address, DefaultBlockParameterName.LATEST).send();

4. if(ethGetBalance!=null){

5.        // 打印账户余额

6.       System.out.println(ethGetBalance.getBalance());

7.        // 将单位转为以太，方便查看

8.       System.out.println(Convert.fromWei(ethGetBalance.getBalance().toString(), Convert.Unit.ETHER));

9. }

四、使用 Java 部署智能合约

部署智能合约的命令：

1. YourSmartContract contract = YourSmartContract.deploy(

2.        <web3j>, <credentials>, GAS_PRICE, GAS_LIMIT,

3.        [<initialValue>,]

4.        <param1>, ..., <paramN>).send();

实例：部署 Compute_sol_Compute.java

1. // 创建一个 web3j 的连接

2. Web3j web3j = Web3j.build(new HttpService());

3. // 部署的时候需要用到该账户的 gas，务必保证该账户余额充足

4. Credentials credentials = WalletUtils.loadCredentials(

5.                "123",

6.                "/datadir/chain/keystore/UTC--2018-03-14T14-46-38.646997441Z--c2acba996f709d4b806d3330996f49d50f088258");

7. // 部署合约      

8. Compute_sol_Compute compute_sol_compute

9.                = Compute_sol_Compute.deploy(web3j, credentials, BigInteger.valueOf(200000), BigInteger.valueOf(20000000)).send();

10. // 部署完成后打印合约地址

11. System.out.println(compute_sol_compute.getContractAddress());

五、使用 Java 调用智能合约

这里，我们还是使用第二篇中编写的智能合约为例

1.加载你的智能合约 命令：

1. YourSmartContract contract = YourSmartContract.load(

2.        "0x<address>|<ensName>", web3j, credentials, GAS_PRICE, GAS_LIMIT);

实例：

1. // 填入刚才部署后打印出来的合约地址

2. String address = "0x9b0851112b41664171338abaf0df86e040c34d07";

3. Compute_sol_Compute compute_sol_compute = Compute_sol_Compute.load(

4.                address,

5.                web3j,

6.                credentials,

7.                BigInteger.valueOf(200000),

8.                BigInteger.valueOf(20000000));

2.验证合约是否可用 命令：

1. contract.isValid();

实例：验证已部署的智能合约是否可用

1. System.out.println(compute_sol_compute.isValid());

3.调用智能合约 命令：

1. Type result = contract.someMethod(<param1>, ...).send();

实例：调用 Compute_sol_Compute.java 中的方法1.调用 getLCM 方法

1. // 调用是能合约函数

2. Uint256 first = new Uint256(2);

3. Uint256 second = new Uint256(3);

4. TransactionReceipt transactionReceipt = compute_sol_compute.getLCM(first, second).send();

5. System.out.println(transactionReceipt);

执行成功后会返回打印出来本次交易的信息。

2.调用 getRecord 方法

1. Uint256 index = new Uint256(0);

2. List<Uint256> result = compute_sol_compute.getRecord(index).send().getValue();

3. for (Uint256 uint256 : result) {

4.     System.out.println(uint256.getValue());

5. }

结果：

1. 2

2. 3

3. 6

3.使用监听事件，获取合约结果

1. Uint256 first = new Uint256(2);

2. Uint256 second = new Uint256(3);

3. TransactionReceipt transactionReceipt = compute_sol_compute.getLCM(first, second).send();

4. Compute_sol_Compute.GetLCMEventResponse result = compute_sol_compute.getGetLCMEvents(transactionReceipt).get(0);

5. System.out.println(result.first.getValue());

6. System.out.println(result.second.getValue());

7. System.out.println(result.result.getValue());

使用一个监听事件等待到结果返回，因为是同步的，所以执行的时间会比较长。最后，可以拿回本次智能合约执行的结果。

六、示例合约

1. pragma solidity ^0.4.19;

2. contract Owner {

3.    //合约拥有者

4.    address public owner;

5.    //构造函数，将合约的所有权给予发布者

6.    function Owner() public {

7.        owner = msg.sender;

8.    }

9.    //仅有合约的拥有者可以操作

10.    modifier onlyOwner() {

11.        require(msg.sender == owner);

12.        _;

13.    }

14.    //onlyOwner作为函数执行的前置条件，仅有合约拥有者可以更换所属权

15.    function setOwner(address to) public onlyOwner {

16.        if(to != address(0)) {

17.            owner == to;

18.        }

19.    }

20. }

21. //通过is使Compute继承Owner合约

22. contract Compute is Owner {

23.    //建立一个存储于区块链上的二维数组，存储每一次计算的输入以及结果

24.    uint[3][] records;

25.    //比较大小，solidity允许返回两个值

26.    function compare(uint first, uint second) internal pure returns(uint bigOne, uint smallOne) {

27.        if(first > second) {

28.            return (first, second);

29.        }

30.        else {

31.            return (second, first);

32.        }

33.    }

34.    //建立事件去监听每一次计算并记录日志

35.    event GetLCM(uint first, uint second, uint result);

36.    function getLCM(uint first, uint second) external onlyOwner returns(uint) {

37.        if (first == second) {

38.            return first;

39.        }

40.        else {

41.            uint bigOne;uint smallOne;

42.            (bigOne, smallOne) = compare(first, second);

43.            uint i = 1;

44.            while(true) {

45.                uint mul = i * bigOne;

46.                if(mul % smallOne == 0) {

47.                    uint index = records.push([first, second, mul]) - 1;

48.                    //调用事件

49.                    GetLCM(first, second, mul);

50.                    return index;

51.                }

52.                i++;

53.            }

54.        }

55.    }

56.    //根据索引获取游戏记录

57.    function getRecord(uint index) external onlyOwner view returns(uint[3]) {

58.        return records[index];

59.    }

60. }

最后，给大家介绍一下：

ChainBoard 核心团队利用其在区块链技术研发上沉淀的丰富经验，围绕项目的需求持续创新，与合作伙伴开放共赢、深度融合，共同打造在金融科技、游戏、众筹互助、医疗保健、物流等领域的区块链应用。 主要输出智能合约开发、公链开发、联盟链开发及交互应用开发等能力，助力项目迅速取得先发优势。目前团队已经在区块链+游戏及区块链+金融与国内知名游戏运营商和海外金融机构展开深度合作。

欢迎对ChainBoard实战经验感兴趣的朋友和手里有行业资源准备布局区块链的大佬关注我们的公众号并和我们取得联系：（原创文章，转载请注明出处，欢迎读者分享到朋友圈）

推荐阅读

深入交流、更多福利

扫码加入我的知识星球

点击 “阅读原文” 看看本号其他精彩内容