Skip to main content
【Soul gateway version2.2.0 release】Make high-performance gateways so easy!

【Soul gateway version2.2.0 release】Make high-performance gateways so easy!

xiaoyuAbout 6 minSoul

Let's take a look at the new features first, and then I would like to share my story.

  • Completely pluggable architecture design, plug-in hot swap.
  • Fully supports all versions of Dubbo, Alibaba-Dubbo, Apache-Dubbo.
  • Support Dubbo generalization call, multi-parameter, complex parameter interface.
  • Enhance the monitor plug-in and remove the Influxdb, add metrics such as memory, CPU, QPS, TPS, response delay, and support access to Prometheus.
  • The SpringCloud plugin supports Eureka and Nacos two registration centers.
  • The waf plugin is enhanced to support black or white lists and mixed modes.
  • Remove the Hystrix circuit breaker to be an independent plug-in.
  • Fix the Zookeeper data synchronization bug, and add the data synchronization method implemented by Nacos.
  • Support multiple kinds of soul-client, such as traditional Spring and Springboot.
  • Optimize the soul-admin user interface.
  • Fix load balancing algorithm bug.
  • Fix uploading large files bug.
  • etc.

Experience the new architecture and get a high-availability and high-performance gateway in 10 minutes!

Bootstrap soul-admin

> wget
> java -jar soul-admin.jar --spring.datasource.url="jdbc:mysql://你的url:3306/soul?useUnicode=true&characterEncoding=utf-8&useSSL=false"
  --spring.datasource.username='you username'  --spring.datasource.password='you password'

Build your own gateway

  • Firstly, you should create an empty Springboot project, please refer to soul-bootstrap. You can also visit the Spring official website :[ in new window]
  • Secondly, please add Maven dependency like follows:


  <!--soul gateway start-->

   <!--soul data sync start use websocket-->
  • Please add the following configuration to your application.yaml:
     allow-bean-definition-overriding: true
      enabled: false
soul :
        websocket :
             urls: ws://localhost:9095/websocket  //Set to youe soul-admin address.

Experience plug-in hot swap under the new architecture

  <!-- soul hystrix plugin start-->
  <!-- soul hystrix plugin end-->
  • Q: How can I use Dubbo service?
  • A: If you are using Alibaba-Dubbo, then you should add the following dependencies in pom.xml.
   <!--soul alibaba dubbo plugin start-->
   <!-- soul alibaba dubbo plugin end-->

If you are using Apache-Dubbo, then you should add the following dependencies in pom.xml.

   <!--soul apache dubbo plugin start-->
   <!-- soul apache dubbo plugin end-->

For your inference: in new window.

  <!-- soul ratelimiter plugin start-->
  <!-- soul ratelimiter plugin end-->

  • Q: What should I do if I don’t want to use some plug-ins?
  • A: You can disable or enable the plug-in in the soul-admin. That is hot pluggable.

All in all, If you want to use some plug-ins, then you can add the Maven dependency in pom.xml, but this is not called hot pluggable.

Features of Soul Gateway

  • I think the biggest feature is traffic screening and control. No matter how complex the request is, traffic can be filtered, and processed according to various selectors, rules, and matching methods. This process is completely visualized, customized and effective immediately, without any changes to the program.
  • Configurations is configured in the soul-admin and will be synchronized to the JVM memory of each Soul gateway node. This is also one of the keypoints to the high performance of the Soul gateway cluster. By the way, Http long polling, websocket, and Zookeeper are used to implement cache synchronization between Soul admin and Soul gateway.
  • Soul gateway uses Reactor code to achieve the independent thread scheduling with low consumption. When we open 10 plug-ins, the delay of all traffic passing through the gateway is 1~2ms.
  • The plug-in mechanism provides functions such as rate limiting, circuit breaker, black and white list, authentication, etc.
  • Soul gateway supports A/B test, blue and green release (because all traffic is controlled, this is easy to do).

What scenarios of Soul gateway are suitable, and what should you pay attention to?

First of all, I think we should follow pragmatism, when you need to use it , then you have monmentum to know it. Thus, where are you need Soul?

Scenario1: Adimistration back-end

  • First of all, as rising popularity of microservices, our back-end is divided into many micro-services. I believe that your companies has a back-end management system. I guess they generally have the following architecture.

  • It may cause some troubles as follows:

    • The developers of every microservice are developing based on this, which will become more and more cumbersome.

    • How to publish without downtime? If you want to publish the commodity module, all other modules will not be able to work at this time.

    • If a certain module interface requires a lot of requests (multiple deployments are required), and another module does not need it, how can you split it?

  • Some people may say I can disassemble them into a few web projects. But this will bring new troubles, where to do load balance? Where to do unified certification?

  • Soul gateway solves all the above problems very well, just register your microservice to Soul gateway. You can do whatever you want. For example, the order module has 2 nodes, and you want to release a new version, you can send request to one of them in the gateway, and update the version in the other node. When the update complete, let the request go though both two nodes. So Java programmer can also do the jod of system operation engineer.

  • If you need unified authentication, you only need to add an authentication plug-in suitable for your business to the gateway.

Scenario2: Company entrance gateway (open platform)

  • If a company wants to do open-platform or an entrance gateway, authentication, rate limiting, circuit breaker, monitoring are indispensable.
  • If your company is in Dubbo system, when developers have written the Dubbo service, there is no need to add a new web project to provide an interface.
  • If an interface attacked by a large amount of request, how do you deal with it?
  • Soul is here to solve the trouble above, this is the purpose of the design. Let’s take a look at the overall architecture diagram.
  • Soul gateway is implemented using reactive programming. Just look at the weather vane Spring, responsive programming is definitely an important direction in the future. When I was in 2014, I wrote for loop every day. The leader told me to use lambda expressions, which would be the trend of the future. Nowadays, if you are a java programmer but don't know lambda expression, you are out.

My open source story

I started writing open source projects when I was in 2017. At first, I discussed distributed transactions "LCN" with Wang Liang. Later, I wrote distributed transaction middleware such as Hmily, Raincat, Myth, etc., and then wrote the Soul gateway, I have encountered many interesting things along the way, but also suffered from many novice users. The general feeling is that high extensiable, and pluggable design are really important for a good open source project. Here are some cases.

  • Case 1: Soul gateway only supports Zookeeper at the beginning of data synchronization. Some users have reported that we do not have Zookeeper, What should we do?
  • Case 2: Soul gateway supports Dubbo, but some users are Alibaba-Dubbo and some users are Apache-Dubbo, What should we do?
  • Case 3: The clients provided by soul at the beginning are all based on Springboot. Some users are traditional Spring. What should we do?

So plug-in design and SPI pluggable design is imperative.

SPI VS pluggability

It is true that the SPI expansion is the cornerstone of pluggability, but they are not completely equivalent. Give an example: If we store a piece of data first, then you have set the SPI interface, and there are many ways to achieve it, such as Mysql, Mongodb, Elasticseach, Zookeeper, etc. Now you have to consider whether to combine it in the project or put it in different Projects, packaged and loaded on demand? These are all things to be considered, so the SPI method cannot be a sure card.


  • Strict code specification is not only a respect for framework users in source code learning but alos an open source attitude.

  • Strict code specifications make people look comfortable and make it easier for people to understand the entire code.

  • I do hope that when you submit a PR, the local installation should be successful.

Participate in open source

  • At present, I mainly focus on Apache ShardingSphere, which is the first top-level project on database sub-database and sub-table organized by Chinese in Apache. Welcome everyone to participate. in new window.

  • The Chinese people lag far behind in terms of open source and technology as large as chips and as small as MATLAB. I also hope that everyone has an open source mentality, participates in open source, learns technology, propagates ideas, and continues to learn for the future!

Last update:
Contributors: Cicici-Shi