设计资产系统


在交易系统中,用户资产是指用户以各种方式将USD、BTC充入交易所后的余额。本节我们来实现一个用户资产系统。

用户在买入BTC时,需要花费USD,而卖出BTC后,获得USD。当用户下单买入时,系统会先冻结对应的USD金额;当用户下单卖出时,系统会先冻结对应的BTC。之所以需要有冻结这一操作,是因为判断能否下单成功,是根据用户的可用资产判断。每下一个新的订单,就会有一部分可用资产被冻结,因此,用户资产本质上是一个由用户ID和资产ID标识的二维表:

用户ID资产ID可用冻结
101USD8900.31200
101BTC5000
102USD128000
103BTC050

上述二维表有一个缺陷,就是对账很困难,因为缺少了一个关键的负债账户。对任何一个资产管理系统来说,要时刻保证整个系统的资产负债表为零。

对交易所来说,用户拥有的USD和BTC就是交易所的系统负债,只需引入一个负债账户,记录所有用户权益,就可以保证整个系统的资产负债表为零。假设负债账户以ID为1的系统用户表示,则用户资产表如下:

用户ID资产ID可用冻结
1USD-22900.30
1BTC-5500
101USD8900.31200
101BTC5000
102USD128000
103BTC050

引入了负债账户后,我们就可以定义资产的数据结构了。

在数据库中,上述表结构就是资产表的结构,将用户ID和资产ID标记为联合主键即可。

但是在内存中,我们怎么定义资产结构呢?

可以使用一个两层的ConcurrentMap定义如下:

  1. // 用户ID -> (资产ID -> Asset)
  2. ConcurrentMap<Long, ConcurrentMap<AssetEnum, Asset>> userAssets = new ConcurrentHashMap<>();

第一层Map的Key是用户ID,第二层Map的Key是资产ID,这样就可以用Asset结构表示资产:

  1. public class Asset {
  2. // 可用余额:
  3. BigDecimal available;
  4. // 冻结余额:
  5. BigDecimal frozen;
  6. public Assets() {
  7. this(BigDecimal.ZERO, BigDecimal.ZERO);
  8. }
  9. public Assets(BigDecimal available, BigDecimal frozen) {
  10. this.available = available;
  11. this.frozen = frozen;
  12. }
  13. }

下一步,我们在AssetService上定义对用户资产的操作。实际上,所有资产操作只有一种操作,即转账。转账类型可用Transfer定义为枚举类:

  1. public enum Transfer {
  2. // 可用转可用:
  3. AVAILABLE_TO_AVAILABLE,
  4. // 可用转冻结:
  5. AVAILABLE_TO_FROZEN,
  6. // 冻结转可用:
  7. FROZEN_TO_AVAILABLE;
  8. }

转账操作只需要一个tryTransfer()方法,实现如下:

  1. public boolean tryTransfer(Transfer type, Long fromUser, Long toUser, AssetEnum assetId, BigDecimal amount, boolean checkBalance) {
  2. // 转账金额不能为负:
  3. if (amount.signum() < 0) {
  4. throw new IllegalArgumentException("Negative amount");
  5. }
  6. // 获取源用户资产:
  7. Asset fromAsset = getAsset(fromUser, assetId);
  8. if (fromAsset == null) {
  9. // 资产不存在时初始化用户资产:
  10. fromAsset = initAssets(fromUser, assetId);
  11. }
  12. // 获取目标用户资产:
  13. Asset toAsset = getAsset(toUser, assetId);
  14. if (toAsset == null) {
  15. // 资产不存在时初始化用户资产:
  16. toAsset = initAssets(toUser, assetId);
  17. }
  18. return switch (type) {
  19. case AVAILABLE_TO_AVAILABLE -> {
  20. // 需要检查余额且余额不足:
  21. if (checkBalance && fromAsset.available.compareTo(amount) < 0) {
  22. // 转账失败:
  23. yield false;
  24. }
  25. // 源用户的可用资产减少:
  26. fromAsset.available = fromAsset.available.subtract(amount);
  27. // 目标用户的可用资产增加:
  28. toAsset.available = toAsset.available.add(amount);
  29. // 返回成功:
  30. yield true;
  31. }
  32. // 从可用转至冻结:
  33. case AVAILABLE_TO_FROZEN -> {
  34. if (checkBalance && fromAsset.available.compareTo(amount) < 0) {
  35. yield false;
  36. }
  37. fromAsset.available = fromAsset.available.subtract(amount);
  38. toAsset.frozen = toAsset.frozen.add(amount);
  39. yield true;
  40. }
  41. // 从冻结转至可用:
  42. case FROZEN_TO_AVAILABLE -> {
  43. if (checkBalance && fromAsset.frozen.compareTo(amount) < 0) {
  44. yield false;
  45. }
  46. fromAsset.frozen = fromAsset.frozen.subtract(amount);
  47. toAsset.available = toAsset.available.add(amount);
  48. yield true;
  49. }
  50. default -> {
  51. throw new IllegalArgumentException("invalid type: " + type);
  52. }
  53. };
  54. }

除了用户存入资产时,需要调用tryTransfer()并且不检查余额,因为此操作是从系统负债账户向用户转账,其他常规转账操作均需要检查余额:

  1. public void transfer(Transfer type, Long fromUser, Long toUser, AssetEnum assetId, BigDecimal amount) {
  2. if (!tryTransfer(type, fromUser, toUser, assetId, amount, true)) {
  3. throw new RuntimeException("Transfer failed");
  4. }
  5. }

冻结操作可在tryTransfer()基础上封装一个方法:

  1. public boolean tryFreeze(Long userId, AssetEnum assetId, BigDecimal amount) {
  2. return tryTransfer(Transfer.AVAILABLE_TO_FROZEN, userId, userId, assetId, amount, true);
  3. }

解冻操作实际上也是在tryTransfer()基础上封装:

  1. public void unfreeze(Long userId, AssetEnum assetId, BigDecimal amount) {
  2. if (!tryTransfer(Transfer.FROZEN_TO_AVAILABLE, userId, userId, assetId, amount, true)) {
  3. throw new RuntimeException("Unfreeze failed");
  4. }
  5. }

可以编写一个AssetServiceTest,测试各种转账操作:

  1. public class AssetServiceTest {
  2. @Test
  3. void tryTransfer() {
  4. // TODO...
  5. }
  6. }

并验证在任意操作后,所有用户资产的各余额总和为0

最后是问题解答:

为什么不使用数据库?

因为我们要实现的交易引擎是100%全内存交易引擎,因此所有用户资产均存放在内存中,无需访问数据库。

为什么要使用ConcurrentMap?

使用ConcurrentMap并不是为了让多线程并发写入,因为AssetService中并没有任何同步锁。对AssetService进行写操作必须是单线程,不支持多线程调用tryTransfer()

但是读取Asset支持多线程并发读取,这也是使用ConcurrentMap的原因。如果改成HashMap,根据不同JDK版本的实现不同,多线程读取HashMap可能造成死循环(注意这不是HashMap的bug),必须引入同步机制。

如何扩展以支持更多的资产类型?

我们在AssetEnum中以枚举方式定义了USD和BTC两种资产,如果要扩展到更多资产类型,可以以整型ID作为资产ID,同时需要管理一个资产ID到资产名称的映射,这样可以在业务需要的时候更改资产名称。

参考源码

可以从GitHubGitee下载源码。

GitHubmichaelliaowarpexchange/

▸ build)

▸ sql)

▤ schema.sql)

▤ docker-compose.yml)

▤ pom.xml)

▸ common)

▸ src/main)

▸ java/com/itranswarp/exchange)

▸ enums)

▤ AssetEnum.java)

▸ support)

▤ LoggerSupport.java)

▸ resources)

▤ logback-spring.xml)

▤ pom.xml)

▸ config)

▸ src/main)

▸ java/com/itranswarp/exchange/config)

▤ ConfigApplication.java)

▸ resources)

▤ application.yml)

▤ pom.xml)

▸ config-repo)

▤ application-default.yml)

▤ application-test.yml)

▤ application.yml)

▤ push.yml)

▤ quotation.yml)

▤ trading-api.yml)

▤ trading-engine.yml)

▤ trading-sequencer.yml)

▤ ui-default.yml)

▤ ui.yml)

▸ parent)

▤ pom.xml)

▸ push)

▸ src/main)

▸ java/com/itranswarp/exchange/push)

▤ PushApplication.java)

▸ resources)

▤ application.yml)

▤ pom.xml)

▸ quotation)

▸ src/main)

▸ java/com/itranswarp/exchange)

▤ QuotationApplication.java)

▸ resources)

▤ application.yml)

▤ pom.xml)

▸ trading-api)

▸ src/main)

▸ java/com/itranswarp/exchange)

▤ TradingApiApplication.java)

▸ resources)

▤ application.yml)

▤ pom.xml)

▸ trading-engine)

▸ src)

▸ main)

▸ java/com/itranswarp/exchange)

▸ assets)

▤ Asset.java)

▤ AssetService.java)

▤ Transfer.java)

▤ TradingEngineApplication.java)

▸ resources)

▤ application.yml)

▸ test/java/com/itranswarp/exchange/assets)

▤ AssetServiceTest.java)

▤ pom.xml)

▸ trading-sequencer)

▸ src/main)

▸ java/com/itranswarp/exchange)

▤ TradingSequencerApplication.java)

▸ resources)

▤ application.yml)

▤ pom.xml)

▸ ui)

▸ src/main)

▸ java/com/itranswarp/exchange)

▤ UIApplication.java)

▸ resources)

▤ application.yml)

▤ pom.xml)

▤ .gitignore)

▤ LICENSE)

▤ README.md)

小结

本节我们讨论并实现了一个基于内存的高性能的用户资产系统,其核心只有一个tryTransfer()转账方法,业务逻辑非常简单。

读后有收获可以支付宝请作者喝咖啡:

设计资产系统 - 图1