# spring-fabric-gateway

**Repository Path**: angryred/spring-fabric-gateway

## Basic Information

- **Project Name**: spring-fabric-gateway
- **Description**: 基于Hyperledger Fabric的Gateway项目，结合Spring MVC做出的一套框架，简化Fabric区块链项目的开发。
Spring boot stater for fabric-gateway-java (https://github.com/hyperledger/fabric-gateway-java)
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://ecsoya.github.io/fabric/
- **GVP Project**: No

## Statistics

- **Stars**: 8
- **Forks**: 2
- **Created**: 2021-05-06
- **Last Updated**: 2025-08-25

## Categories & Tags

**Categories**: distributed-service

**Tags**: None

## README

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.ecsoya/spring-fabric-gateway/badge.svg?style=plastic)](https://maven-badges.herokuapp.com/maven-central/io.github.ecsoya/spring-fabric-gateway) [![](https://jitpack.io/v/ecsoya/spring-fabric-gateway.svg)](https://jitpack.io/#ecsoya/spring-fabric-gateway)




# Spring Fabric Gateway

Provided Spring MVC services and spring boot starters based on [fabric-gateway-java](https://github.com/hyperledger/fabric-gateway-java), more info can be found from [https://ecsoya.github.io/fabric/](https://ecsoya.github.io/fabric/)(中文).

### Dependencies

1. Build your fabric network with Hyperledger Fabric v2.3.0.

2. Optional, install the default common chaincode [go](https://github.com/ecsoya/spring-fabric-gateway/raw/master/spring-fabric-gateway/src/chaincode/common/chaincode.go) or [Java](https://github.com/ecsoya/spring-fabric-gateway/spring-fabric-gateway-chaincode).

### Springboot Starters

1. `fabric-gateway-spring-boot-starter`: A spring MVC boot starter.
2. `fabric-explorer-spring-boot-starter`: A simple fabric explorer starter.

### How to use

##### Spring Boot Configure:

Firstly, add the following dependency to your project's `pom.xml` file:

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.ecsoya/spring-fabric-gateway/badge.svg?style=plastic)](https://maven-badges.herokuapp.com/maven-central/io.github.ecsoya/spring-fabric-gateway)

```
<dependency>
	<groupId>io.github.ecsoya</groupId>
	<artifactId>fabric-gateway-spring-boot-starter</artifactId>
	<version>${latest_version}</version>
</dependency>
```

or


```
<dependency>
	<groupId>io.github.ecsoya</groupId>
	<artifactId>fabric-explorer-spring-boot-starter</artifactId>
	<version>${latest_version}</version>
</dependency>
```

*Snapshots*

```
<repositories>
	<repository>
		<id>ecsoya.io</id>
		<url>https://repo.rdc.aliyun.com/repository/42210-snapshot-BITvCn/</url>
	</repository>
</repositories>
```

[![](https://jitpack.io/v/ecsoya/spring-fabric-gateway.svg)](https://jitpack.io/#ecsoya/spring-fabric-gateway)


step1

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

step2

```
<dependency>
	<groupId>com.github.ecsoya.spring-fabric-gateway</groupId>
	<artifactId>spring-fabric-gateway</artifactId>
	<version>${latest_version}</version>
</dependency>
```

Secondly, configure fabric network in `application.yml`

```
# Fabric Network Configure      
spring:         
   fabric:
      chaincode: 
         identify: your chaincode id
         name: Common chaincode
         version: 1.0
      channel: your channel name
      organizations:
      - org1
      - org2
      name: your fabric network name
      gateway:
         wallet:
            identify: admin
      network:
         file: network/connection.yml //your fabric network config file.
         name: fabric network name
# Fabric explorer
      explorer: 
         title: Fabric Explorer
         logo: img/logo.png
         copyright: Ecsoya (jin.liu@soyatec.com)
         hyperledger-explorer-url: http://www.hyperleder.org

```

Finally, enjoy to use the following spring components:

1. `FabricContext`: wrapper class for fabric gateway.
2. `IFabricInfoService`: query fabric infos such as blocks, transaction and so on.
3. `IFabricService`: CRUD FabricObject if you install the default common [Chaincode](https://github.com/ecsoya/spring-fabric-gateway/raw/master/spring-fabric-gateway/src/chaincode/common/chaincode.go).

```
@Autowired
private FabricContext fabricContext;
```

### Fabric Network Config File

The `Fabric Network Config File` is the core configuration file of fabric network, both `FabricContext` and `Gateway` are built with this kind of file. It holds details of network and channel configurations typically loaded from an external config file. 

Please look at the `org.hyperledger.fabric.sdk.NetworkConfig` to get more details.

You can also look at my project [Fabric Network Builder](https://github.com/ecsoya/fabric-network-builder) to learn how to create a fabric network config file.

### Default common chaincode

The default common chaincode provided useful functions such as `create`, `get`, `update`, `query`. It used a CompositeKey with `id` and `type` to identify different objects, it also support pagination query.

The chaincode source can be found from [here](https://github.com/ecsoya/spring-fabric-gateway/raw/master/spring-fabric-gateway/src/chaincode/common/chaincode.go).

### Fabric Explorer Starter

This will help you to build a simple fabric explorer with few codes.

![Fabric Explorer](https://ecsoya.github.io/fabric/img/explorer-1.png)

### References

1. [Fabric开发手册](https://ecsoya.github.io/fabric/)
2. [Hyperledger Fabric Gateway SDK for Java](https://github.com/hyperledger/fabric-gateway-java)
3. [Java SDK for Hyperledger Fabric](https://github.com/hyperledger/fabric-sdk-java)