ipfs私有链环境搭建与java-sdk调用

环境准备

ipfs镜像文件

docker pull ipfs/go-ipfs

私有链密钥生成工具生成密钥文件

go get github.com/Kubuxu/go-ipfs-swarm-key-gen
cd $GOPATH/src/github.com/Kubuxu/go-ipfs-swarm-key-gen
go build
$GOPATH/src/github.com/Kubuxu/go-ipfs-swarm-key-gen > ~/swarm.key

在宿主机创建ipfs 的data、export目录

mkdir -p ~/ipfs/ipfs1/data ~/ipfs/ipfs1/export ~/ipfs/ipfs2/data ~/ipfs/ipfs2/export

把第2步生成的密钥文件分别拷贝至 ipfs 对应的 data 文件夹下

cp ~/swarm.key ~/ipfs/ipfs1/data 
cp ~/swarm.key ~/ipfs/ipfs2/data 

环境配置

分别启动 ipfs 两个容器

docker run -d --name ipfs_host1 --privileged=true --entrypoint="sh" -v ~/ipfs/ipfs1/export:/export -v ~/ipfs/ipfs1/data:/data/ipfs -p 4001:4001 -p 127.0.0.1:8085:8080 -p 5001:5001 ipfs/go-ipfs:latest -c "while true; do sleep 1;done"
docker run -d --name ipfs_host2 --privileged=true --entrypoint="sh" -v ~/ipfs/ipfs2/export:/export -v ~/ipfs/ipfs2/data:/data/ipfs -p 4011:5001 -p 127.0.0.1:9085:8080 -p 5011:5001 ipfs/go-ipfs:latest -c "while true; do sleep 1;done"

注意：启动命令中的参数说明。--entrypoint="sh" 由于 ipfs 容器的 dockerfile 中注明了 entrypoint 执行的命令，当直接运行容器后，容器会根据默认配置文件启动 ipfs 服务，并连接 ipfs 公网环境。由于我们需要搭建自己的私有链环境所以需要改写entrypoint执行我们制定的命令，并在容器中修改相应的配置文件，运行私有链环境。这里我们设置 entrypoint 运行 sh命令，并执行上诉命令最后部分的参数 -c "while true; do sleep 1;done"，启动一个主进程来保持 ipfs 容器运行。

修改 ipfs 服务默认配置

分别进入ipfs_host1与ipfs_host2容器中执行以下命令

进入 ipfs_host容器

docker exec -it ipfs_host1 sh

初始化节点配置

ipfs init

运行初始化命令后，会在/data/ipfs目录下创建启动配置信息，并且在屏幕中出现以下初始化信息

initializing IPFS node at /data/ipfs
generating 2048-bit RSA keypair...done
peer identity: QmcLnHDuhN7bCbdv5FRbYiTNKuqNhs1WSCUezFPt7F4vHJ
to get started, enter:

    ipfs cat /ipfs/QmcLnHDuhN7bCbdv5FRbYiTNKuqNhs1WSCUezFPt7F4vHJ/readme

记住ipfs_host1中的peer identity: QmcLnHDuhN7bCbdv5FRbYiTNKuqNhs1WSCUezFPt7F4vHJ信息，在后面启动 ipfs_host2服务的时候需要用到

删除默认配置中的引导节点信息

ipfs bootstrap rm --all

修改接口调用地址

打开服务启动配置文件

vi config

修改配置文件中 Addresses中的 API值：

"API": "/ip4/127.0.0.1/tcp/5001" --> "API": "/ip4/0.0.0.0/tcp/5001"

注意，修改后调用 sdk 初始化 IPFS 对象的时候才能远程访问 ipfs 服务。如果没有修改则初始化 IPFS 对象的时候则会出错。

环境启动

启动 ipfs 服务

启动 ipfs_host1服务

ipfs daemon

启动 ipfs_host2服务，注意下面的命令使用到ipfs_host1初始化时生成的peer identity

ipfs bootstrap add /ip4/宿主机ip/tcp/4001/ipfs/QmcLnHDuhN7bCbdv5FRbYiTNKuqNhs1WSCUezFPt7F4vHJ
ipfs daemon

环境验证

进入 ipfs_host1容器中执行以下命令

创建测试文件

cd ~
echo test > test.txt

上传文件

ipfs add text.txt

ipfs 上传文件后会有如下提示信息反馈

added QmeomffUNfmQy76CQGy9NdmqEnnHU9soCexBnGU3ezPHVH test.txt

其中QmeomffUNfmQy76CQGy9NdmqEnnHU9soCexBnGU3ezPHVH就是文件test.txt的hash值

ipfs 是根据文件内容进行 hash 只要文件内容不变，只修改文件名是不会影响最终的上链文件 hash 值的。

进入 ipfs_host2容器中验证上传文件
执行文件查看命令，查看文件内容

ipfs cat QmeomffUNfmQy76CQGy9NdmqEnnHU9soCexBnGU3ezPHVH

执行命令后，控制台会返回查询结果：test

至此，ipfs 私有网络搭建成功。

有兴趣的朋友可以改写 dockerfile 的内容重写 entrypoint执行命令的内容，减少修改 ipfs 服务默认配置部分的操作步骤。

java-ipfs-http-client的使用

pom.xml中添加依赖，这里需要根据 github 上的版本修改$LATEST_VERSION的值

  <repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
  </repositories>

  <dependencies>
    <dependency>
      <groupId>com.github.ipfs</groupId>
      <artifactId>java-ipfs-http-client</artifactId>
      <version>$LATEST_VERSION</version> 
    </dependency>
  </dependencies>

使用ipfs上传文件以及下载文件

// 实例化ipfs对象
IPFS ipfs = new IPFS("/ip4/10.121.60.26/tcp/5001");

//保存上传文件
NamedStreamable.FileWrapper savefile = new NamedStreamable.FileWrapper(new File("/Users/song/Documents/book/test1.pdf"));
MerkleNode result = ipfs.add(savefile).get(0);
System.out.println(result.toJSONString());//返回结果里面获取保存文件的唯一hash，基于文件内容的 hash


//下载文件
Multihash filePointer = Multihash.fromBase58("Qmc51yHGyaxdRsUwBozP9tQuTRQuXLkZv3sPEcpSgb8BxP");//参数为文件 hash
byte[] fileContents = ipfs.cat(filePointer);

//保存文件
File downloadfile = new File("/Users/song/Documents/aaa.pdf");

if(!downloadfile.exists()) {
    downloadfile.createNewFile();
}

FileOutputStream fop = new FileOutputStream(downloadfile);
fop.write(fileContents);
fop.flush();
fop.close();

结语

ipfs 并不仅仅只用于分布式文件存储，如果想要深入了解 ipfs 功能可以参考ipfs - 命令手册。