3 Star 5 Fork 6

FISCO-BCOS / spring-boot-crud

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

spring-boot-crud

本示例项目基于Java SDK + Maven + SpringBoot方式来调用智能合约。

前置条件

搭建FISCO BCOS 单群组区块链(Air版本),具体步骤参考这里

注意: 节点rc4版本以后才支持Table的CRUD接口,之前的版本只能用KV接口的功能。

获取源码

# 直接从github克隆代码
git clone https://github.com/FISCO-BCOS/spring-boot-crud.git

# 若网络很慢,可从gitee克隆代码
git clone https://gitee.com/FISCO-BCOS/spring-boot-crud

配置节点证书

将节点所在目录nodes/${ip}/sdk下的ca.crt、sdk.crt和sdk.key文件拷贝到项目的src/main/resources/conf目录下供SDK使用(FISCO BCOS 2.1以前,证书为ca.crt、node.crt和node.key):

设节点路径为~/fisco/nodes/127.0.0.1,则可使用如下命令拷贝SDK证书:

# 进入项目路径
$ cd spring-boot-crud
# 创建证书存放路径
$ mkdir src/main/resources/conf
# 拷贝SDK证书
$ cp ~/fisco/nodes/127.0.0.1/sdk/* src/main/resources/conf/

设置配置文件

spring-boot-crud包括SDK配置文件(位于src/main/resources/applicationContext.xml路径)和WebServer配置文件(位于src/main/resources/application.yml路径)。

需要根据区块链节点的IP和端口相应配置applicationContext.xmlnetwork.peers配置项,具体如下:

...
<property name="network">
    <map>
        <entry key="peers">
            <list>
                <value>127.0.0.1:20200</value>
                <value>127.0.0.1:20201</value>
            </list>
        </entry>
        <entry key="defaultGroup" value="group0" />
    </map>
</property>
...

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

WebServer主要配置了监听端口,默认为45000,具体如下:

server:
  #端口号
  port: 45000

编译和安装项目

可以使用IDEA导入并编译并安装该项目,也可使用提供的mvnw脚本在命令行编译项目如下:

# 编译项目
$ bash mvnw compile

# 安装项目,安装完毕后,在target/目录下生成fisco-bcos-spring-boot-crud-0.0.1-SNAPSHOT.jar的jar包
$ bash mvnw install

启动spring-boot-crud服务

方法一:

打开IDEA导入并编译该项目,编译成功后,运行AppApplication.java即可启动spring boot服务。

方法二:

使用bash mvnw install生成的jar包target/fisco-bcos-spring-boot-crud-0.0.1-SNAPSHOT.jar启动spring-boot-crud服务:

# 启动spring-boot-crud(启动成功后会输出create client for group success的日志)
$ java -jar ./target/fisco-bcos-spring-boot-crud-0.0.1-SNAPSHOT.jar

访问spring boot web服务

访问用户信息上链API(CRUD insert)

spring-boot-crud基于CRUD insert接口实现了用户信息上链的API,将Person类型的用户信息上链,API声明如下:

@Data
public class Person {
    private String name;
    private String age;
    private String tel;
}
@PostMapping("/insert")
public ResponseData insert(@RequestBody Person person)  {
    crudClient.insert(person.getName(),person.getAge(), person.getTel());
    return ResponseData.success("新增成功");
}

使用curl工具访问接口如下

# 这里假设WebServer监听端口为45000
# 将用户fisco的信息上链,其中name为fisco, age为6,tel为123456789
$ curl -H "Content-Type: application/json" -X POST --data '{"name":"fisco", "age":"6", "tel":"123456789"}' http://localhost:45000/insert
# 返回新增成功的信息
{"code":200,"msg":"新增成功","data":null}

访问链上查询用户信息API(CRUD select)

spring-boot-crud基于CRUD select接口实现了链上查询用户信息的API,基于用户名查询用户信息,API声明如下:

@GetMapping("/query/{name}")
public ResponseData query(@PathVariable("name") String name) throws Exception {
    return ResponseData.success(crudClient.query(name));
}

使用curl工具访问接口如下

# 这里假设WebServer监听端口为45000
# 查询用户名为fisco的用户信息
$ curl http://localhost:45000/query/fisco
# 返回用户fisco的具体信息
{"code":200,"msg":null,"data":{"value1":"fisco","value2":"6","value3":"123456789","size":3}}

访问用户信息链上更新API(CRUD update)

spring-boot-crud基于CRUD update接口实现了用户信息链上更新的API,API声明如下:

@PutMapping("/update")
public ResponseData update(@RequestBody Person person){
    crudClient.edit(person.getName(),person.getAge(), person.getTel());
    return ResponseData.success("修改成功");
}

使用curl工具访问接口如下

# 这里假设WebServer监听端口为45000
# 更新fisco用户的信息,将其age修改为10,tel修改为123
$ curl -H "Content-Type: application/json" -X PUT --data '{"name":"fisco", "age":"10", "tel":"123"}' http://localhost:45000/update
# 返回成功信息
{"code":200,"msg":"修改成功","data":null}

# 再次查询fisco信息:
$ curl http://localhost:45000/query/fisco
# 返回信息如下,用户fisco的age成功修改为10,tel成功修改为123
{"code":200,"msg":null,"data":{"value1":"fisco","value2":"10","value3":"123","size":3}}

访问用户信息删除API(CRUD delete)

spring-boot-crud基于CRUD delete接口实现了用户信息链上删除的API,该API根据用户名删除用户信息,API声明如下:

@DeleteMapping("/remove/{name}")
public ResponseData remove(@PathVariable("name") String name){
    crudClient.remove(name);
    return ResponseData.success("删除成功");
}

使用curl工具访问接口如下

# 这里假设WebServer监听端口为45000
# 删除用户fisco的信息:
$ curl -X DELETE http://localhost:45000/remove/fisco
# 返回删除成功的提示
{"code":200,"msg":"删除成功","data":null}

# 再次查询fisco信息:
$ curl http://localhost:45000/query/fisco
# 此时已经无法查询到用户fisco的信息
{"code":200,"msg":null,"data":{"value1":"fisco","value2":"","value3":"","size":3}}

访问用户信息上链API(KV set)

spring-boot-crud基于KV set接口实现了用户信息上链的API,将Person类型的用户信息上链,API声明如下:

@Data
public class Person {
    private String name;
    private String age;
    private String tel;
}
@PostMapping("/set")
public ResponseData set(@RequestBody Person person) {
    kvClient.set(person.getName(), person.getAge());
    return ResponseData.success("新增成功");
}

使用curl工具访问接口如下

# 这里假设WebServer监听端口为45000
# 将用户fisco的信息上链,其中name为fisco, age为6
$ curl -H "Content-Type: application/json" -X POST --data '{"name":"fisco", "age":"6"}' http://localhost:45000/set
# 返回新增成功的信息
{"code":200,"msg":"新增成功","data":null}

访问链上查询用户信息API(KV get)

spring-boot-crud基于KV get接口实现了链上查询用户信息的API,基于用户名查询用户信息,API声明如下:

@GetMapping("/get/{name}")
public ResponseData get(@PathVariable("name") String name) throws Exception {
    return ResponseData.success(kvClient.get(name));
}

使用curl工具访问接口如下

# 这里假设WebServer监听端口为45000
# 查询用户名为fisco的用户信息
$ curl http://localhost:45000/get/fisco
# 返回用户fisco的具体信息
{"code":200,"msg":null,"data":{"value1":"true","value2":"6","size":2}}

贡献代码

加入我们

FISCO BCOS开源社区是国内活跃的开源社区,社区长期为机构和个人开发者提供各类支持与帮助。已有来自各行业的数千名技术爱好者在研究和使用FISCO BCOS。如您对FISCO BCOS开源技术及应用感兴趣,欢迎加入社区获得更多支持与帮助。

相关链接

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

暂无描述 展开 收起
Java 等 2 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/FISCO-BCOS/spring-boot-crud.git
git@gitee.com:FISCO-BCOS/spring-boot-crud.git
FISCO-BCOS
spring-boot-crud
spring-boot-crud
main

搜索帮助

14c37bed 8189591 565d56ea 8189591