深蓝居
TA的个人档案
深蓝居个人页面-阿里云开发者社区
文章
239
问答
0
个人介绍
关注于区块链技术、跨链、密码学、通证经济、智能合约
擅长的技术
- 容器
- Linux
- 高分内容
- 最新动态
- 文章
- 问答
-
发表了文章 2018-04-13
在比特币的OP_RETURN上，大家都干了些啥？
我在之前的一篇文章中介绍了怎么通过C#将一句话写入到比特币的区块链网络中，最近花了好几天的时间，我终于把比特币的区块链数据载入到了SQLServer（具体做法参加我的这篇博客：http://www.cnblogs.com/studyzy/p/export-bitcoin-blockchain-to-database.html） 由于数据量特别特别的大，而我只是在自己的PC上做的，没有服务器，所以除了主键查询以外，其他查询都会很慢很慢。我花了一些时间，把区块链Output部分的OP_RETURN脚本区域给查询出来了，然后再做了个解码，看看有什么好玩的东西没有。 在OP_RETURN上大家主要干了这么几件事情： 1.文档存在性证明 2.不知道是什么资源的URI 3.各国语言的文字内容 4.各种Hash值 有表白、求婚的。 这里比特币就见证了一场成功的求婚： https://blockchain.info/tx/b17a027a8f7ae0db4ddbaa58927d0f254e97fce63b7e57e8e50957d3dad2e66e https://blockchain.info/tx/e89e09ac184e1a175ce748775b3e63686cb1e5fe948365236aac3b3aef3fedd0 2014-09-07 Tetsu向其女朋友Yuki求婚，而其女友很爽快的答应了。真是虐狗虐到了比特币上！ 有日本人发布自己的愿望的，我怀疑应该是日本那边有人开发了一个软件，帮忙大家把自己的愿望写到区块链上去，因为我看到了大量的日文，而且比较集中，而且基本上都是写的一个心愿。 有的想去夏威夷举行婚礼，有的想和孩子去一趟迪士尼乐园 转账备注 99100146 2 杨靖玉转3.95BTC至张益兵 99100147 2 马祥珍转2.694BTC至张益兵 我也做了一个转账，就是把我所知道的4代人的家谱写到区块链上，我这笔记录已经被永久记录！ 以上是我在几个月前写的博客，不知道当时什么原因，没有写完，就保留成草稿了。今天翻了出来，就发表了吧。【本文章出自博客园深蓝居，转载请注明作者出处,如果您觉得博主的文章对您有很大帮助，欢迎点击右侧打赏按钮对博主进行打赏。】打个招聘广告，博主正在主导开发一个跨链区块链项目：PalletOne，一直在招Go程序员，待遇丰厚，坐标北京酒仙桥，希望有识之士加入！
-
发表了文章 2017-12-14
如何在本地测试Fabric Code
前一篇博客讲到了如何编译本地的Fabric Code成镜像文件，那么如果我们想改Fabric源代码，实现一些Fabric官方并没有提供的功能，该怎么办呢？这时我们除了改源码，增加需要的功能外，还需要能够跑通Fabric的测试。Fabric的测试主要包括单元测试和行为测试，下面分别介绍。 一、单元测试 单元测试是通过testenv这个镜像来完成的，而这个镜像的容器在启动后实际执行的就是unit-test文件夹下面的run.sh脚本。我们使用make unit-test命令即可对整个Fabric的所有单元测试进行运行。 1.单元测试 因为Fabric是用Go写的，所以Fabric的单元测试也是用Go的单元测试命令来完成，也就是go test命令。在Fabric的源代码中，我们看到的所有*_test.go这些就是单元测试的代码。这些代码在正式编译的时候是会被自动忽略的，只有在go test命令的时候才会去运行。 以bccsp为例，这是提供密码学相关方法的接口文件，在bccsp文件夹下的bccsp.go文件，而他的单元测试文件自然就是bccsp_test.go文件。在该单元测试文件中，以Test开头的函数，就是具体的测试用例。我们要跑具体的某一个测试用例，比如其中的TestKeyGenOpts，那么我们的可以使用命令： go.exe test github.com\hyperledger\fabric\bccsp -run ^TestKeyGenOpts$ 这里我们可以看到-run后面跟的是一个正则表达式，我们可以写其他正则表达式来表示一批方法。当然我们也可以不加^$，直接写方法名。 如果我们不指定具体的测试用例，而只指定包，那么就是测试整个包下面的所有用例。 go test -v -timeout 30s github.com\hyperledger\fabric\bccsp 这里我加了2个参数，这两个参数都是在go test的时候很常用的，-v是输出详细信息。-timeout是设置跑完整个测试的时间限制，如果里面有死循环之类的就会超时而退出。 如果我们要测试不是某个包，而是整个文件夹下面的所有包，那么我们可以使用“…”来表示。比如： go test -v -timeout 60s github.com\hyperledger\fabric\bccsp\… 2.性能测试 go test除了提供单元测试外，还有性能测试的功能。前面说到_test.go文件里面Test开头的是单元测试的测试用例入口函数，而性能测试则是以Benchmark开头。 Fabric本身并没有写什么性能测试的代码，但是我们可以从vendor代码中找到例子。比如： github.com\hyperledger\fabric\vendor\github.com\docker\docker\pkg\stdcopy 这里有个BenchmarkWrite函数，用于测试NewStdWriter.Write的性能，我们使用go test命令带上-bench参数就可以执行性能测试。性能测试不仅仅关心执行的时间，也关系内存的分配情况。再加上-benchmem参数，可以查看内存性能测试结果。 go test -benchmem github.com\hyperledger\fabric\vendor\github.com\docker\docker\pkg\stdcopy -bench ^BenchmarkWrite$ 以下是我在本机执行的结果： BenchmarkWrite-4 5000000 283 ns/op 15507.52 MB/s 0 B/op 0 allocs/op PASS ok github.com/hyperledger/fabric/vendor/github.com/docker/docker/pkg/stdcopy 2.406s Success: Benchmarks passed. 3.代码覆盖率 代码覆盖率是度量测试自身完整和有消息的一种手段。通过覆盖率值，我们可以分析测试代码的编写质量。 在go test命令后跟上-cover参数，就可以提供代码覆盖率百分比的结果。 go test -cover github.com\hyperledger\fabric\bccsp 返回结果： ok github.com/hyperledger/fabric/bccsp 2.828s coverage: 100.0% of statements 但是这里返回的结果太少了，我们如果希望得到更详细的覆盖率信息，可以指定covermode和converprofile参数。 go test -cover -covermode count -coverprofile c:\Temp\cover.out github.com\hyperledger\fabric\bccsp 这里是将覆盖率的结果输出到C:\Temp\cover.out这个文件中。同时使用count可以对函数的执行次数进行计数。执行完毕后，我们可以使用以下命令将cover.out转换为html在浏览器中查看： go tool cover -html=C:\Temp\cover.out 在浏览器中，用绿色表示覆盖，而执行次数，是需要把鼠标放上去才会显示。这是我浏览器显示的覆盖率结果： 二、行为测试 我这里翻译成行为测试可能不一定很可取，英文是BDDTests，BDD是敏捷开发中的一个概念，英文是Behavior Driven Development，可以认为是TDD的升级版吧。所有行为测试的代码都在Fabric文件夹下面的bddtests文件夹中。 要进行Fabric的行为测试，需要安装相关的环境，Fabric主要用到的是Behave这个工具，https://github.com/behave/behave 官方给我们提供了安装脚本，直接运行： sudo ./scripts/install_behave.sh 这里需要安装的包比较多，安装完成后我们就可以进行BDD的测试了。 官方的make命令下就为我们提供了执行全部行为测试的命令： make behave 系统就会按照配置的场景，启动对应的Docker容器，进行行为测试。 如果我们想跑某一个行为测试，而不是全部，那么就需要进一步的设置，具体参考：https://github.com/hyperledger/fabric/tree/release/bddtests 依次执行以下代码： sudo pip install virtualenv sudo pip install virtualenvwrapper export WORKON_HOME=~/Envs source /usr/local/bin/virtualenvwrapper.sh mkvirtualenv -p /usr/bin/python2.7 behave_venv 执行完上面命令后，我们可以看到我们的命令行变成了： (behave_venv) studyzy@ubuntu1:~/go/src/github.com/hyperledger/fabric/bddtests$ 接下来再安装以下工具： pip install behave pip install grpcio-tools pip install "pysha3==1.0b1" pip install b3j0f.aop pip install jinja2 pip install pyopenssl pip install ecdsa pip install python-slugify pip install pyyaml 总的来说就是给behave的执行设置了一个虚拟环境，所有代码的执行是在这个虚拟环境中执行，不会影响真实环境。 安装完毕后，我们想要测试某一个BDDTest，那么可以执行： cd bddtests behave -k -D cache-deployment-spec features/bootstrap.feature 这里测试的就是在bddtests\features\bootstrap.feature的这个例子。 测试完成后，使用 deactivate 命令即可退出虚拟环境，回到我们传统的命令行下。 三、总结 如果我们要动Fabric的源码，那么首先保证能够跑通Fabric的单元测试和行为测试，然后再改。如果是新功能模块，那么也需要写自己模块的单元测试代码。写完之后用go test来测试，保证我们的代码能够通过单元测试，而且要注意代码覆盖率，保持较高的覆盖率能够发现很多代码中隐藏的问题。 如果我们的功能涉及到一系列的步骤操作，那么就一定要写行为测试了。行为测试可以保证整个功能串起来运行是正常的。【本文章出自博客园深蓝居，转载请注明作者出处,如果您觉得博主的文章对您有很大帮助，欢迎点击右侧打赏按钮对博主进行打赏。】打个招聘广告，博主正在主导开发一个跨链区块链项目：PalletOne，一直在招Go程序员，待遇丰厚，坐标北京酒仙桥，希望有识之士加入！
-
发表了文章 2017-12-13
如何在本地编译Fabric Code
之前的博客都是拿官方现成的Docker镜像来用，但是并没有自己动手做镜像，也没有说到如何去开发和测试Fabric的代码。这一篇博客就从入门的角度讲解如何编译、测试和开发Fabric。 一、环境准备 要进行相关的开发工作，当然第一步是准备好环境，还是老生常谈，主要是安装Docker、安装Go，下载最新Fabric代码等工作。我这里使用的是VirtualBox里面安装的Ubuntu 16.04，如果您使用的不是这个版本，可能有些命令会有所区别。Fabric开发依赖的工具主要还是参考官方文档：http://hyperledger-fabric.readthedocs.io/en/latest/dev-setup/devenv.html 1. 使用VirtualBox并在其中安装好Ubuntu 这一步其实没啥好说的，下载好最新版的VirtualBox，下载Ubuntu Server，我用的是Ubuntu16.04.2 X64 Server。我使用的用户是studyzy，不建议直接在root下执行命令。在安装完Ubuntu后，需要保证apt source是国内的，不然如果是国外的话会很慢很慢的。具体做法是 sudo vi /etc/apt/sources.list 打开这个apt源列表，如果其中看到是http://us.xxxxxx之类的，那么就是外国的，如果看到是http://cn.xxxxx之类的，那么就不用换的。我的是美国的源，所以需要做一下批量的替换。在命令模式下，输入： :%s/us./cn./g 就可以把所有的us.改为cn.了。然后输入:wq即可保存退出。 sudo apt-get update 更新一下源。 然后安装ssh，这样接下来就可以用putty或者SecureCRT之类的客户端远程连接Ubuntu了。 sudo apt-get install ssh 2. Go的安装 Ubuntu的apt-get虽然提供了Go的安装，但是版本比较旧，最好的方法还是参考官方网站 https://golang.org/dl/ ，下载最新版的Go。具体涉及到的命令包括： wget https://redirector.gvt1.com/edgedl/go/go1.9.2.linux-amd64.tar.gz sudo tar -C /usr/local -xzf go1.9.2.linux-amd64.tar.gz 【注意：不要使用apt方式安装go，apt的go版本太低了！】 接下来编辑当前用户的环境变量： vi ~/.profile 添加以下内容： export PATH=$PATH:/usr/local/go/bin export GOROOT=/usr/local/go export GOPATH=$HOME/go export PATH=$PATH:$HOME/go/bin 编辑保存并退出vi后，记得把这些环境载入： source ~/.profile 我们把go的目录GOPATH设置为当前用户的文件夹下，所以记得创建go文件夹 cd ~ mkdir go 运行以下命令查看当前go的版本，如果能够显示go版本，那么说明我们的go安装成功. go version 3. Docker安装 我们可以使用阿里提供的镜像，安装也非常方便，参考：https://yq.aliyun.com/articles/110806 ，其中Ubuntu的脚本是： # step 1: 安装必要的一些系统工具 sudo apt-get update sudo apt-get -y install apt-transport-https ca-certificates curl software-properties-common # step 2: 安装GPG证书 curl -fsSL http://mirrors.aliyun.com/docker-ce/linux/ubuntu/gpg | sudo apt-key add - # Step 3: 写入软件源信息 sudo add-apt-repository "deb [arch=amd64] http://mirrors.aliyun.com/docker-ce/linux/ubuntu $(lsb_release -cs) stable" # Step 4: 更新并安装 Docker-CE sudo apt-get -y update sudo apt-get -y install docker-ce 安装完成后需要修改当前用户（我使用的用户叫studyzy）权限： sudo usermod -aG docker studyzy 注销并重新登录，然后添加阿里云的Docker Hub镜像： sudo mkdir -p /etc/docker sudo tee /etc/docker/daemon.json <<-'EOF' { "registry-mirrors": ["https://obou6wyb.mirror.aliyuncs.com"] } EOF sudo systemctl daemon-reload sudo systemctl restart docker 不同的版本添加方法是不一样的，官方的文档如下： https://cr.console.aliyun.com/#/accelerator 当然觉得阿里云镜像不好用，喜欢用DaoClound的也可以用DaoClound的镜像。DaoCloud的镜像设置文档为：https://www.daocloud.io/mirror#accelerator-doc 4. Docker-Compose的安装 Docker-compose是支持通过模板脚本批量创建Docker容器的一个组件。 然后是安装docker-compose，我们从官方网站（https://github.com/docker/compose/releases）下载，运行脚本： sudo curl -L https://github.com/docker/compose/releases/download/1.17.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose sudo chmod +x /usr/local/bin/docker-compose 5.Pip的安装 Pip是基于Python的一个工具，需要安装Python-pip，运行脚本： sudo apt-get install python-pip 这个脚本会安装Pip所依赖的Python和各种库，所以安装pip完毕后我们也有了Python的环境。运行以下命令可以检查pip和Python的版本： pip –V apt安装的版本可能不够新，我们使用以下命令可以更新pip版本： pip install --upgrade pip 6. Go Tools安装 Fabric使用GO开发，其中用到了一些官方或者第三方的工具，我们也需要下载。尤其是golang的网址被墙了，我们只有访问GitHub的镜像。 mkdir –p $GOPATH/src/golang.org/x cd $GOPATH/src/golang.org/x git clone https://github.com/golang/tools.git 等tools下载完毕，我们可以运行以下命令来安装Fabric可能用到的Go工具： go get github.com/kardianos/govendor go get github.com/golang/lint/golint go get golang.org/x/tools/cmd/goimports go get github.com/onsi/ginkgo/ginkgo go get github.com/axw/gocov/... go get github.com/client9/misspell/cmd/misspell go get github.com/AlekSi/gocov-xml go get github.com/golang/protobuf/protoc-gen-go 7. 第三方库安装 Fabric依赖的第三方库里面，有些库又依赖了其他库，而这些库是需要我们先手动准备好的。比如libltdl-dev，这是PKCS11用到的一个库，我们需要安装： sudo apt-get install libltdl-dev 8. Fabric源码下载 我们可以使用Git命令下载源码，首先需要建立对应的目录，然后进入该目录，Git下载源码： mkdir -p ~/go/src/github.com/hyperledger cd ~/go/src/github.com/hyperledger git clone https://github.com/hyperledger/fabric.git 等Fabric下载完毕后，我们就切换到Fabric源码的文件夹： cd ~/go/src/github.com/hyperledger/fabric 二、编译Fabric 编译Fabric的代码主要是通过make命令来完成，因为官方已经写好了完整的Makefile，所以我们要编译各个Fabric的组件还是比较简单的。关于make的基础知识，可以参考这篇博客：http://www.ruanyifeng.com/blog/2015/02/make.html 下面我们就分步骤来编译Fabric。 1.Orderer节点的编译 Orderer节点容器里面运行的是orderer服务，我们要生成Orderer镜像，就需要先编译出Orderer程序。执行： make orderer 这是我在CLI下执行的结果： studyzy@ubuntu1:~/go/src/github.com/hyperledger/fabric$ make orderer build/bin/orderer CGO_CFLAGS=" " GOBIN=/home/studyzy/go/src/github.com/hyperledger/fabric/build/bin go install -tags "" -ldflags "-X github.com/hyperledger/fabric/common/metadata.Version=1.0.6-snapshot-a8728bc -X github.com/hyperledger/fabric/common/metadata.BaseVersion=0.3.2 -X github.com/hyperledger/fabric/common/metadata.BaseDockerLabel=org.hyperledger.fabric -X github.com/hyperledger/fabric/common/metadata.DockerNamespace=hyperledger -X github.com/hyperledger/fabric/common/metadata.BaseDockerNamespace=hyperledger" github.com/hyperledger/fabric/orderer Binary available as build/bin/orderer 从日志可以看出，Orderer编译完成后，会把二进制文件放在build/bin/orderer。 2.Peer节点的编译 Peer节点的编译会比Orderer复杂很多，因为墙的原因，我们需要做一些额外的操作。另外链码是运行在Peer所在的机器上，所以需要给ChainCode准备运行基础环境，也就是ccenv和javaenv两个镜像。在make peer之前我们必须先保证本地没有对应的镜像文件，如果有，那么就用docker rmi命令删除之前下载或者编译好的镜像。 还记得前面下载的Go Tools吗，这里需要copy到Fabric目录里面来： mkdir -p build/docker/gotools/bin cp ~/go/bin/* build/docker/gotools/bin 以上操作纯粹是为了绕开墙，如果你本身不存在墙的问题，那么完全可以不用如此多此一举。 接下来直接运行以下命令即可编译生成Peer节点的Docker镜像： make peer 运行该命令后，系统首先会下载hyperledger/fabric-baseimage:x86_64-0.3.2这个镜像到本地，这是所有Fabric镜像的基础镜像文件。 下载后会从官网下载chaintool的jar包，下载地址：https://nexus.hyperledger.org/content/repositories/releases/org/hyperledger/fabric/hyperledger-fabric/chaintool-1.0.0/hyperledger-fabric-chaintool-1.0.0.jar 这个地址没有被墙，一般来说是能够正常下载下来的。 下载chaintool完毕后，接下来就开始创建fabric-ccenv镜像。所有创建Docker镜像都是基于Dockerfile，我们可以在Fabric目录下的images文件夹看到所有Fabric镜像Build的步骤配置。 在创建fabric-ccenv镜像后，接下来是创建java版ChainCode的基础镜像，也就是fabric-javaenv，最后才是build peer程序，运行成功后看到的日志大概是这样的： …… Successfully built b8f69c7b3c4c Successfully tagged hyperledger/fabric-javaenv:latest docker tag hyperledger/fabric-javaenv hyperledger/fabric-javaenv:x86_64-1.0.6-snapshot-a8728bc build/bin/peer CGO_CFLAGS=" " GOBIN=/home/studyzy/go/src/github.com/hyperledger/fabric/build/bin go install -tags "" -ldflags "-X github.com/hyperledger/fabric/common/metadata.Version=1.0.6-snapshot-a8728bc -X github.com/hyperledger/fabric/common/metadata.BaseVersion=0.3.2 -X github.com/hyperledger/fabric/common/metadata.BaseDockerLabel=org.hyperledger.fabric -X github.com/hyperledger/fabric/common/metadata.DockerNamespace=hyperledger -X github.com/hyperledger/fabric/common/metadata.BaseDockerNamespace=hyperledger" github.com/hyperledger/fabric/peer Binary available as build/bin/peer 3.Fabric 工具编译 Fabric除了Orderer和Peer外，还为我们提供了几个很方便的工具，在搭建Fabric网络时我们就用到过。那就是： configtxgen cryptogen configtxlator 这三个工具的编译也很简单，直接运行以下命令即可： make configtxgen make cryptogen make configtxlator 4.Docker镜像的生成 前面三步只是生成了Fabric的二进制文件，我们并不能直接使用，而是需要分别将这些二进制文件打包到Docker镜像中。所以我们接下来需要Build Docker Image。 要生成Orderer镜像，那么需要运行命令： make orderer-docker 由于没有网络文件的依赖，所以这时应该很快就能完成。然后我们继续生成Peer镜像： make peer-docker 再然后是客户端，也就是fabric-tools,对应的命令是： make tools-docker 以上3个最重要的镜像生成完成，我们可以用 docker images 查看当前的镜像列表： 5.其他Docker镜像的编译 除了上面我们看到的这些镜像外，实际上我们可能还会用到CouchDB做状态数据库，用Kafka做共识，用Zookeeper做Kafka的高可用支持，这些工具都有对应的Docker镜像，我们仍然可以使用make命令来生成他们。 运行以下命令，系统会给我们生成一整套的Fabric镜像： make docker 这里一般来说没什么坑，主要是从网上下载一些包下来，会花一些时间。完成后，我们仍然运行 docker images 可以看到我们生成的所有Fabric镜像： 三、总结 如果没有墙的存在，那么我们编译和生成Fabric镜像将非常简单，直接一个make all命令即可。可惜因为墙的存在，所以有些地方需要特殊处理。下一篇博客我会讲到如何运行Fabric中的测试代码。只要我们能够自己编译Fabric，能够跑Fabric的Test，那么我们就可以很方便的对Fabric代码进行修改，并验证我们的修改，更进一步我们就可以将自己的代码提交到社区，为Fabric的壮大添砖加瓦。 最后再补充一句，如果我们对之前生成的镜像不满意，对代码进行调整后需要重新生成，可以使用 make clean 命令删除之前make的所有东西。然后重新执行make命令编译Fabric。【本文章出自博客园深蓝居，转载请注明作者出处,如果您觉得博主的文章对您有很大帮助，欢迎点击右侧打赏按钮对博主进行打赏。】打个招聘广告，博主正在主导开发一个跨链区块链项目：PalletOne，一直在招Go程序员，待遇丰厚，坐标北京酒仙桥，希望有识之士加入！
-
发表了文章 2017-11-09
使用Swagger辅助开发Fabric Application的Web API
前面的几篇博客，我们已经把Fabric环境搭建好了，也可以使用Go开发ChainCode了，那么我们在ChainCode开发完毕后，可以通过CLI来测试ChainCode的正确性，ChainCode开发后，接下来就是关于Application的编写了。 Application分为2部分，一部分是关于后来业务逻辑的，也就是Web API，一般是通过RESTful的形式提供，另外一部分就是UI，当然大多数情况下都是GUI，也就是网站前端，Windows程序，APP之类的。关于前端，我由于没啥艺术细胞，做出来的界面很丑，所以也就扬长避短，很少做前端开发，专注于后台业务逻辑的实现。 一 简介 在Web API的开发中，业内最知名的工具就是Swagger了，这简直就是一件神器啊！我之前在C#开发的时候就使用ABP框架，用到了Swagger，在试着使用Go的Web开发框架Beego的时候也看到了Swagger，现在使用Node开发，想不到又用到Swagger，只能说明Swagger的跨平台跨语言的能力太强了。Swagger可以帮助我们把API文档化，方便进行测试。 Swagger的开发方式有2种： 使用Web开发框架中迁移过来的Swagger库，也就是先代码，后生成API文档的模式。比如ABP框架中就是，我们只需要在ApiController中定义好接口和注释好，其框架就可以帮我们生成Swagger界面。 使用Swagger的yaml文件定义API接口，定义好后，再使用Swagger官方提供的CodeGen生成对应语言的代码。 第一种开发方式要看你使用的Web框架的支持情况，接下来我们要讲的就是第二种开发方式。 二 编写Swagger YAML 官方已经给我提供一个宠物商店的示例，并提供了强大的语法检查和预览功能，那就是Swagger Editor，我们直接访问http://editor.swagger.io/ 就可以看到。如果由于某些神秘的力量，造成访问特别缓慢或者无法访问，我们也可以下载Swagger Editor的Image到本地来运行。 直接在安装了Docker的环境中运行如下命令： docker pull swaggerapi/swagger-editor docker run -p 80:8080 swaggerapi/swagger-editor 然后就可以访问http://{Your_Server_IP}。 不管是在线的Editor或者是本地部署的Docker，我们最终看到是这样一个界面： 左边窗口就是我们要编辑的YAML文件的内容，右边窗口就是预览的API文档的效果。 关于YAML文件，其实可读性还是很强的，大部分都不需要解释就知道是什么意思，下面我来着重介绍以下几个比较重要的元素： 1. host&basePath host是指定了我们的API服务器的地址，也就是我们部署了Web API时，是部署在哪个Server上。如果我们是本地开发，而且使用了自定义端口，比如8080，那么需要改成localhost:8080。 basePath是指定API的虚拟目录，比如我们有个获得所有用户列表的API是：GET /User，如果我们设定了basePath是“/api”，那么我们要访问的路径应该是： GET http://localhost:8080/api/User 当然，如果我们要更规范，比如把API版本也放进去，那么我们可以设置basePath为”/api/v1”，于是我们的访问路径就是： GET http://localhost:8080/api/v1/User 这个basePath参数涉及到服务器端api路由的生成，而host涉及到各个API测试时候的调用地址。 2. tags Tags是用于我们对大量的API进行分区用的，说简单点就是为了大量的API能够更好看，更容易查找。我们可以为tag添加注释，使得API文档更容易读懂。 Tags不涉及到后台的改变，每一个具体的API都可以指定属于哪个（或者哪几个tag），然后在Swagger显示的时候，会将这些API归到所属的Tag下面去。 【注意：YAML文件格式严格要求缩进，就像Python一样，所以如果我们在添加元素的时候一定要注意缩进是否正确。】 比如我们新建一个Tag叫Bank，然后增加一点对这个Tag的描述，接下来我们再到/pet post下面，可以把tags增加一行，写为银行，然后就可以看到右边的预览窗口更新了，显示了银行这个Tag相关的API： 如果没有刷新，我们可以点击上面菜单的Edit->Convert to YAML可以看到效果。 3. paths 这是最主要的配置元素。主要的API配置都在这个环节。下面一级一级的讲解。 第一级是URL，以/开头，URL中可以指定参数。比如我们要获得某个bankId对应的银行信息，那么URL就是 /bank/{bankId} 第二级是HTTP方法，我们在WebAPI中主要用到的方法有：查询get，创建post，修改put和删除delete。因为我们是要查询某个银行ID对应的银行信息，所以我们在这一级输入get 第三级有多个元素，分别是： tags，说明这个API是属于哪个Tag的。 summary，对该接口的简单描述，一句话即可。 description，顾名思义，是接口的介绍，可以写的详细一点。 operationId，这是对应的后台的方法名，Swagger的路由就可以根据URL和这里的operationId找到对应的Action方法。 consumes，是客户端往服务器传的时候，支持什么类型，一般我们只需要保留json即可，可以把xml删除。如果是get方法，不需要该元素。 produces，就是服务器在返回给客户端数据的时候，是什么样式的数据，我们仍然保留json即可。 parameters就是具体的参数，这里的设置比较复杂，包括指定参数是在URL中还是在Body中，传入的参数是什么类型的，是否必须有该参数，对该参数的描述等。如果参数是一个对象，那么需要添加对该对象类型的引用，而对象的定义在后面definitions节点中。 responses是服务器返回的HTTP Code有哪些。每一种状态码表示什么意思。 security是指定该接口的安全检查方式，如果没有设置，那么就是匿名访问。其引用的是securityDefinitions中的定义。 x-swagger-router-controller，这是一个扩展元素，用来指定该URL对应的后台的Controller名。 结合上面介绍的，我们自定义一个根据ID获取Bank对象的YAML内容如下： /bank/{bankId} : get: tags: - Bank summary: 根据银行ID获得银行基本信息 description: 详细描述 operationId: getBankById produces: - application/json parameters: - name: bankId in: path description: 银行对象的主键ID required: true type: integer format: int64 responses: '200': description: 找到银行 schema: $ref: '#/definitions/Bank' '400': description: 无效的ID '404': description: ID对应的银行未找到 4. securityDefinitions 这是安全定义模块，在这里可以定义我们WebAPI的安全认证方式，比如: Basic Authentication API Keys Bearer Authentication OAuth 2.0 OpenID Connect Discovery Cookie Authentication 这里面这么多种认证方式，很多我也没用过，了解不深，我主要用的是Bearer和OAuth 2.0，具体设置大家可以参考文档： https://swagger.io/docs/specification/authentication/ 5. definitions 这里是定义我们在API中会涉及到哪些JSON对象的地方。也就是说我们在API中要POST上去的JSON或者通过GET由服务器返回的JSON，其对象都在这里定义，上面的步骤直接引用这里的定义即可。 比如我们上面需要引用到Bank对象，那么我们在这里定义如下： Bank: type: object properties: id: type: integer format: int32 name: type: string 如果是对象嵌套引用了其他对象，也可以通过$ref的方式引用过去，我们可以参考官方示例中的Pet对象，就引用了Category。 以上各个元素我只是简单的讲解，对于各种深入的用法，大家可以参考官方文档：https://swagger.io/docs/ 三 生成后台代码 只要我们预览右边的代码没有报任何错误，那么我们就可以生成对于的后台代码了。这里因为Fabric SDK是Node的，所以我们的Web API也是使用Node来开发。我们点击Generate Server菜单下的nodejs-server选项： 系统会下载一个压缩包，该压缩包解压后就是我们的Web API Node项目。在安装了Node的机器上，我们使用以下命令，安装项目所依赖的包： npm install --registry=https://registry.npm.taobao.org 安装完毕后，运行以下命令： npm start 我们可以看到网站地址是：http://localhost:8080/docs 打开浏览器，访问这个网站，就可以看到Swagger生成的UI，并看到我们自定义的获取银行对象的方法。 下面，我们来试一试传入参数1，并调用该API，可以看到这样的结果： 这里返回的是Swagger给我们Mock的一个假结果，如果我们要返回真实的结果，那么需要在Controllers文件夹中找到BankService.js,看到如下的内容： 'use strict'; exports.getBankById = function(args, res, next) { /** * 根据银行ID获得银行基本信息 * 详细描述 * * bankId Integer 银行对象的主键ID * returns Bank **/ var examples = {}; examples['application/json'] = { "name" : "aeiou", "id" : 0 }; if (Object.keys(examples).length > 0) { res.setHeader('Content-Type', 'application/json'); res.end(JSON.stringify(examples[Object.keys(examples)[0]] || {}, null, 2)); } else { res.end(); } } 将Mock代码部分删除，将我们真实的业务逻辑写进去即可完成我们的WebAPI的开发工作。 四 总结 Swagger真的不愧是Web API开发的神器，太好用了。另外官方还有SwaggerHub，支持多人协作编写YAML文档，不过是收费的。我们在项目中其实可以通过Git来管理yaml文件，因为该文件存在于WebAPI项目的api文件夹中，所以其实大家可以共同编辑，然后使用Git来合并冲突。另外Swagger还有Client，看了一些支持各种语言，各种框架，各种APP开发，真是太强大了，我由于不开发GUI，所以没怎么接触，需要你去研究了。【本文章出自博客园深蓝居，转载请注明作者出处,如果您觉得博主的文章对您有很大帮助，欢迎点击右侧打赏按钮对博主进行打赏。】打个招聘广告，博主正在主导开发一个跨链区块链项目：PalletOne，一直在招Go程序员，待遇丰厚，坐标北京酒仙桥，希望有识之士加入！
-
发表了文章 2017-09-05
Fabric CA环境的集成
我们前面关于Fabric的所有文章中用到的例子都没有CA Server，都是由cryptogen这个工具根据crypto-config.yaml而生成的。但是在实际生产环境中，我们肯定不能这么做，我们应该为每个Org建立一个CA，由CA来管理其中的用户。下面我们就试着讲Fabric CA集成到整个Fabric网络中，并用CA Client生成新用户，最终使用新用户调用ChainCode，验证新用户的合法性。我们仍然以官方的e2e_cli为例，关于这个例子的环境搭建，可以参考我的上一篇博客：http://www.cnblogs.com/studyzy/p/7437157.html 1.修改docker-compose文件，增加CA容器 我们就以给org1这个组织增加CA容器为例，打开e2e_cli文件夹中的docker-compose-cli.yaml ，增加以下内容： ca0: image: hyperledger/fabric-ca environment: - FABRIC_CA_HOME=/etc/hyperledger/fabric-ca-server - FABRIC_CA_SERVER_CA_NAME=ca0 - FABRIC_CA_SERVER_TLS_ENABLED=false ports: - "7054:7054" command: sh -c 'fabric-ca-server start --ca.certfile /etc/hyperledger/fabric-ca-server-config/ca.org1.example.com-cert.pem --ca.keyfile /etc/hyperledger/fabric-ca-server-config/${PRIVATE_KEY} -b admin:adminpw -d' volumes: - ./crypto-config/peerOrganizations/org1.example.com/ca/:/etc/hyperledger/fabric-ca-server-config container_name: ca0 这里我们注意到，Fabric CA Server启动的时候，带了3个重要的参数：ca.certfile 指定了CA的根证书，ca.keyfile 指定了接下来给新用户签发证书时的私钥，这里我们使用变量${PRIVATE_KEY}代替，这是因为每次network_setup的时候，私钥的名字是不一样的，所以需要从启动脚本中传入。另外就是-b参数，指定了CA Client连接CA Server时使用的用户名密码。 2.修改network_setup.sh启动脚本，将CA容器启动的参数带入 接下来我们需要修改network_setup.sh文件，因为前面我们使用了变量${PRIVATE_KEY}，所以这里我们需要读取变量并带入docker-compose 启动的时候。具体修改如下： function networkUp () { if [ -f "./crypto-config" ]; then echo "crypto-config directory already exists." else #Generate all the artifacts that includes org certs, orderer genesis block, # channel configuration transaction source generateArtifacts.sh $CH_NAME fi folder="crypto-config/peerOrganizations/org1.example.com/ca" privName="" for file_a in ${folder}/* do temp_file=`basename $file_a` if [ ${temp_file##*.} != "pem" ];then privName=$temp_file fi done echo $privName if [ "${IF_COUCHDB}" == "couchdb" ]; then CHANNEL_NAME=$CH_NAME TIMEOUT=$CLI_TIMEOUT docker-compose -f $COMPOSE_FILE -f $COMPOSE_FILE_COUCH up -d 2>&1 else CHANNEL_NAME=$CH_NAME TIMEOUT=$CLI_TIMEOUT PRIVATE_KEY=$privName docker-compose -f $COMPOSE_FILE up -d 2>&1 fi if [ $? -ne 0 ]; then echo "ERROR !!!! Unable to pull the images " exit 1 fi docker logs -f cli } 这里脚本的逻辑很简单，就是去crypto-config/peerOrganizations/org1.example.com/ca这个文件夹中去遍历文件，找到私钥文件的文件名，并把文件名赋值给privName，然后在docker-compse的启动时，指定到PRIVATE_KEY即可。 3.使用CA Client生成新用户 只需要经过前面2步，我们给Org1设置的CA Server就算完成了。 3.1启动Fabric网络 运行 ./network_setup.sh up 启动整个Fabric网络。接下来需要使用CA Client来生成新用户。我们需要以下几步： 3.2下载并安装Fabric CA Client 官方提供的CA Client需要依赖于libtool这个库，所以需要先安装这个库，运行命令： sudo apt install libtool libltdl-dev 然后执行以下命令安装Fabric CA Client： go get -u github.com/hyperledger/fabric-ca/cmd/... 该命令执行完毕后，我们应该在~/go/bin下面看到生成的2个文件： fabric-ca-client fabric-ca-server 3.3注册认证管理员 我们首先需要以管理员身份使用CA Client连接到CA Server，并生成相应的文件。 export FABRIC_CA_CLIENT_HOME=$HOME/ca fabric-ca-client enroll -u http://admin:adminpw@localhost:7054 这个时候我们可以去$HOME/ca目录，看到CA Client创建了一个fabric-ca-client-config.yaml文件和一个msp文件夹。config可以去修改一些组织信息之类的。 3.4注册新用户 接下来我们想新建一个叫devin的用户，那么需要先执行这个命令： fabric-ca-client register --id.name devin --id.type user --id.affiliation org1.department1 --id.attrs 'hf.Revoker=true,foo=bar' 系统会返回一个该用户的密码： 2017/09/05 22:20:41 [INFO] User provided config file: /home/studyzy/ca/fabric-ca-client-config.yaml 2017/09/05 22:20:41 [INFO] Configuration file location: /home/studyzy/ca/fabric-ca-client-config.yaml Password: GOuMzkcGgGzq 我们拿到这个密码以后就可以再次使用enroll命令，给devin这个用户生成msp的私钥和证书： fabric-ca-client enroll -u http://devin:GOuMzkcGgGzq@localhost:7054 -M $FABRIC_CA_CLIENT_HOME/devinmsp 现在新用户devin的私钥和证书就在$HOME/ca/devinmsp目录下，我们可以使用tree命令查看一下： devinmsp/ ├── cacerts │ └── localhost-7054.pem ├── keystore │ └── a044e43ad1fd7cdfd1fd995abaef53895534bd70e8cdfdb665430d12665f2041_sk └── signcerts └── cert.pem 4.编写ChainCode验证当前用户 由于官方提供的example02并没有关于当前用户的信息的代码，所以我们需要编写自己的ChainCode。 这里我们主要是用到ChainCode接口提供的GetCreator方法，具体完整的ChainCode如下： package main import ( "github.com/hyperledger/fabric/core/chaincode/shim" pb "github.com/hyperledger/fabric/protos/peer" "fmt" "encoding/pem" "crypto/x509" "bytes" ) type SimpleChaincode struct { } func main() { err := shim.Start(new(SimpleChaincode)) if err != nil { fmt.Printf("Error starting Simple chaincode: %s", err) } } func (t *SimpleChaincode) Init(stub shim.ChaincodeStubInterface) pb.Response { return shim.Success(nil) } func (t *SimpleChaincode) Invoke(stub shim.ChaincodeStubInterface) pb.Response { function, args := stub.GetFunctionAndParameters() fmt.Println("invoke is running " + function) if function == "cert" {//自定义函数名称 return t.testCertificate(stub, args)//定义调用的函数 } return shim.Error("Received unknown function invocation") } func (t *SimpleChaincode) testCertificate(stub shim.ChaincodeStubInterface, args []string) pb.Response{ creatorByte,_:= stub.GetCreator() certStart := bytes.IndexAny(creatorByte, "-----")// Devin:I don't know why sometimes -----BEGIN is invalid, so I use ----- if certStart == -1 { fmt.Errorf("No certificate found") } certText := creatorByte[certStart:] bl, _ := pem.Decode(certText) if bl == nil { fmt.Errorf("Could not decode the PEM structure") } fmt.Println(string(certText)) cert, err := x509.ParseCertificate(bl.Bytes) if err != nil { fmt.Errorf("ParseCertificate failed") } fmt.Println(cert) uname:=cert.Subject.CommonName fmt.Println("Name:"+uname) return shim.Success([]byte("Called testCertificate "+uname)) } 我们只需要在~/go/src/github.com/hyperledger/fabric/examples/chaincode/go目录下新建一个文件夹，比如test1，然后新建一个文件test1.go并粘贴上面的代码进去即可。 现在ChainCode已经开发完成，我们需要部署并测试该ChainCode的正确性，下面是部署步骤： 首先登陆到cli中： docker exec -it cli bash 然后在cli下面执行以下命令： peer chaincode install -n test1 -v 1.0 -p github.com/hyperledger/fabric/examples/chaincode/go/test1 ORDERER_CA=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem peer chaincode instantiate -o orderer.example.com:7050 --tls true --cafile $ORDERER_CA -C mychannel -n test1 -v 1.0 -c '{"Args":[]}' peer chaincode query -C mychannel -n test1 -c '{"Args":["cert"]}' 系统返回结果，说明我们当前的用户是Admin@org1.example.com root@2d1735e72642:/opt/gopath/src/github.com/hyperledger/fabric/peer# peer chaincode query -C mychannel -n test1 -c '{"Args":["cert"]}' 2017-09-05 14:40:23.175 UTC [msp] GetLocalMSP -> DEBU 001 Returning existing local MSP 2017-09-05 14:40:23.176 UTC [msp] GetDefaultSigningIdentity -> DEBU 002 Obtaining default signing identity 2017-09-05 14:40:23.176 UTC [chaincodeCmd] checkChaincodeCmdParams -> INFO 003 Using default escc 2017-09-05 14:40:23.176 UTC [chaincodeCmd] checkChaincodeCmdParams -> INFO 004 Using default vscc 2017-09-05 14:40:23.176 UTC [msp/identity] Sign -> DEBU 005 Sign: plaintext: 0A95070A6708031A0B08D7EEBACD0510...07120574657374311A060A0463657274 2017-09-05 14:40:23.176 UTC [msp/identity] Sign -> DEBU 006 Sign: digest: B4BB1EE5E6EBA63E50C85831C8820FB0B4490C55F23C247EDE5529DDAB23C273 Query Result: Called testCertificate Admin@org1.example.com 2017-09-05 14:40:23.195 UTC [main] main -> INFO 007 Exiting..... 5.设置新用户的证书和私钥文件夹，验证新用户的可用性 因为我们是给org1设置的CA，用户devin也是在org1下，所以需要把~/ca/devinmsp下面的文件转移到org1下面。org1的用户证书和私钥文件夹在： ~/go/src/github.com/hyperledger/fabric/examples/e2e_cli/crypto-config/peerOrganizations/org1.example.com/users 我们需要新建文件夹devin用于保存新用户的证书和私钥，我们新建一个Ubuntu的命令行窗口，前面已经登录您的cli的窗口保留，我们接下来还会用。 cd ~/go/src/github.com/hyperledger/fabric/examples/e2e_cli/crypto-config/peerOrganizations/org1.example.com/users mkdir devin cp ~/ca/devinmsp/ devin/msp –R 不知道什么原因，Fabric在使用的时候需要用到msp文件夹下的admincerts文件夹，但是CA Client在生成的时候并没有这个文件夹，所以我们需要从signcerts这个文件夹中拷贝一个过来，运行以下命令： mkdir devin/msp/admincerts cp devin/msp/signcerts/cert.pem devin/msp/admincerts/ 好现在我们的新用户的所有证书准备完毕，tree devin看看结果： devin/ └── msp ├── admincerts │ └── cert.pem ├── cacerts │ └── localhost-7054.pem ├── keystore │ └── a044e43ad1fd7cdfd1fd995abaef53895534bd70e8cdfdb665430d12665f2041_sk └── signcerts └── cert.pem 接下来切换到cli窗口，我们把当前cli的用户msp文件夹切换成devin的文件夹，具体命令是： CORE_PEER_MSPCONFIGPATH=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/users/devin/msp 现在我们再来运行一下ChainCode： peer chaincode query -C mychannel -n test1 -c '{"Args":["cert"]}' 我们可以看到结果已经变化了，用户已经由Admin变成了devin： root@2d1735e72642:/opt/gopath/src/github.com/hyperledger/fabric/peer# peer chaincode query -C mychannel -n test1 -c '{"Args":["cert"]}' 2017-09-05 14:53:17.497 UTC [msp] GetLocalMSP -> DEBU 001 Returning existing local MSP 2017-09-05 14:53:17.497 UTC [msp] GetDefaultSigningIdentity -> DEBU 002 Obtaining default signing identity 2017-09-05 14:53:17.497 UTC [chaincodeCmd] checkChaincodeCmdParams -> INFO 003 Using default escc 2017-09-05 14:53:17.497 UTC [chaincodeCmd] checkChaincodeCmdParams -> INFO 004 Using default vscc 2017-09-05 14:53:17.497 UTC [msp/identity] Sign -> DEBU 005 Sign: plaintext: 0AE3070A6808031A0C08DDF4BACD0510...07120574657374311A060A0463657274 2017-09-05 14:53:17.497 UTC [msp/identity] Sign -> DEBU 006 Sign: digest: 21EE9B77A231E22ACB5FDD59C668C1A6E300833A820901DF9E896E22C00FC00F Query Result: Called testCertificate devin 2017-09-05 14:53:17.508 UTC [main] main -> INFO 007 Exiting..... 以上就是关于Fabric CA环境集成的简单测试。关于CA Server有配置文件在CA Server容器内部，可以针对不同的org信息进行修改。而CA Client也有配置文件，也可以在enroll之前进行修改。关于具体的修改方法，参考官方文档：http://hyperledger-fabric-ca.readthedocs.io/en/latest/【本文章出自博客园深蓝居，转载请注明作者出处,如果您觉得博主的文章对您有很大帮助，欢迎点击右侧打赏按钮对博主进行打赏。】打个招聘广告，博主正在主导开发一个跨链区块链项目：PalletOne，一直在招Go程序员，待遇丰厚，坐标北京酒仙桥，希望有识之士加入！
滑动查看更多
暂无更多信息
-
发表了文章
2004-08-22
如何发送表单
-
发表了文章
2004-08-23
这个是我做的计算器,有何建议请大家提。
-
发表了文章
2006-03-18
今天体育课受伤
-
发表了文章
2006-03-25
原来我的综合素质那么低，自评一下你能达到几个？
-
发表了文章
2006-04-16
三级 考后
-
发表了文章
2006-05-01
CSS导圆角，不过这个代码没有怎么看懂，与一般的HTML是不同
-
发表了文章
2006-06-24
又玩起了“数独”
-
发表了文章
2006-08-05
大家都来DIY自己的Blog啦
-
发表了文章
2006-09-09
Web服务器更改
-
发表了文章
2006-09-25
Javascript:郁闷了好久终于找到原因了,原理还不明白
-
发表了文章
2006-10-12
走进SQL Server 2005：十大安全举措
-
发表了文章
2006-10-13
对SMTP协议的一点困惑
-
发表了文章
2006-11-01
Windows 2003系统负载平衡策略全攻略
-
发表了文章
2006-11-17
SPECweb99
-
发表了文章
2006-11-17
集群服务(MSCS)与网络负载均衡 (NLB)
-
发表了文章
2006-12-08
HTC基础
-
发表了文章
2006-12-15
微软产品居然出现中文兼容问题
-
发表了文章
2006-12-26
SQL Server 2005 同义词Bug
-
发表了文章
2007-03-08
c#获取当前应用程序所在路径
-
发表了文章
2007-03-12
用VS2005调试JS
滑动查看更多
暂无更多信息