DDD-领域驱动设计示例

一、DDD概述

  • DDD,即领域驱动设计,核心是不断提炼通用语言并用于与领域专家等团队所有成员交流,并用代码来表达出一个与通用语言一致的领域模型

  • 通用语言:通过团队交流达成共识的能够简单清晰准确传递业务规则的语言(可以是文字、图片等)

  • 领域:软件系统要解决的问题域,是有边界的。领域一般包含多个子域,子域根据其功能划分为核心域、通用域、支撑域。

  • 限界上下文:描述领域边界,一个限界上下文可能包含多个子域,但一般实践上都以一对一为好。应用单元和部署单元一般也与限界上下文一致。


    领域与限界上下文.png
  • 限界上下文映射:多个上下文之间如何进展系统交互集成。


    上下文映射.png
  • 领域模型:对我们软件系统中要解决问题的抽象表达(解决方案)。模型一般在一个限界上下文中有效。

    • 模块
    • 聚合根
    • 实体
    • 值对象
    • 领域事件
    • 仓储定义
    • 领域服务
    • 工厂
    • 限界上下文映射的反腐层定义


      限界上下文中的领域模型.png
  • 领域实现:

    • 领域模型
    • 应用服务
    • 基础设施
      • 服务暴露
      • 仓储实现
      • 反腐层实现
  • 实践步骤为:

    • 找到子域
    • 识别核心域、通用域、支撑域
    • 确定限界上下文映射
    • 在每个子域内设计领域模型
    • 实现领域模型和应用

二、示例需求分析

要实现多规格商品的创建和查询。

spu domain

Spu相关操作如下:

@RestController
@RequestMapping("/v1/spu")
public class SpuRestApi {
  
  //spu创建
  @PostMapping("/create")
  public Result<Long> create(@RequestBody SpuCreateParam param){

  }

  //spu详情
  @GetMapping("/detail")
  public Result<SpuVO> findSpuById(Long shopId, Long spuId){
      
  }
}

SpuCreateParam的定义如下:
其中spuNo,skuNo,barCodes等要求唯一

{
  "shopId": 0, //店铺ID
  "categoryId": 0,//分类ID
  "unitId": 0,//单位ID
  "name": "string",//SPU名称,长度20,不能为空
  "spuNo": "string",//SPU编码,不可变更,用于各系统间传递
  "barCodes": [//SPU条码列表,最多10个,用于搜索
    "string"
  ],
  "photoTuple": {//图片列表,最多10张
    "photos": [
      {
        "url": "string" //必须为合法url,每个url长度最大为120
      }
    ]
  },
  "specDefineTuple": {//规格定义,项与值都不能重复,相对顺序用于sku列表的排序
    "defines": [//规格项列表,如【颜色+尺寸】
      {
        "key": "string",//规格项,如颜色
        "values": [//规格值列表,如红色、白色等
          "string"
        ]
      }
    ]
  },
  "skus": [//SKU列表,要符合规格定义的笛卡尔积
    {
      "skuNo": "string",//SKU编码
      "barCodes": [//SKU条码,用于SKU维度搜索,最多10个
        "string"
      ],
      "retailPrice": 0,//零售价,分,最大为 100w*100
      "specTuple": {//与规格定义笛卡尔积中每一个组合对应,如【红色 + 20号】
        "specs": [
          {
            "key": "string", //规格项,如颜色
            "value": "string" //规格值,如红色
          }
        ]
      }
    }
  ]
}

三、分层架构 + 面向过程设计

特征:

  • 包划分上以功能为准,如所有model放一个包,所有service放另一个
  • 服务依赖:SpuApi -> SpuService -> SpuMapper -> Mybatis
  • 创建时数据流向:SpuSaveParam -> Spu -> table
  • 查询时数据流向:SpuVO <- Spu <- table
  • 整个SpuService只包含简单的CRUD操作,尤其是更新操作,一般倾向于只有一个万能的Update。从方法名称,你看不出任何的业务含义。
  • SpuService:一个服务方法几乎包含了所有的逻辑,负责校验、获取外部信息、组装、转换SpuSaveParam为Spu、并调用SpuMapper保存到数据库。
  • Spu为失血模型,只包含字段,没有get/set之外的方法,Spu与table的字段几乎一一对应。

优缺点:

  • 在逻辑很简单场景下,crud迭代最快,面向过程与人类思考的方式相近。
  • 在复杂场景下,如spu创建涉及大量的校验组装等,很快SpuService.save方法就会过于庞大。另外,有大量的校验逻辑,在更新场景下是可以复用的。

四、pipeline设计

checker pipeline

spu的校验可以根据spu的内聚信息块划分成多个checker,然后将多个checker组合成一个pipeline流,从而可以更好的重用,并快速应对新增的校验(加个checker就行了)。
另外,获取外部信息,如category、unit等,也可以用rxjava等并发去做,以加快速度。

缺点:

  • 但是pipeline要求设计出一个好的context,用于上下文传递,一般会出现context的腐化。
  • 另外,service的主逻辑不清晰,读代码的成本变高。

五、六边形架构 + 面向对象设计

六边形架构层级

示例实现的github地址

特征:

  • 采用分治法,将数据、约束、行为等划分到最能表达它的领域模型中。
  • 包划分上以业务模块为准,同业务的identity、valueObject、event、repository、service等放在一个包下。
  • SpuAppService:为应用服务,只是调用领域服务和仓储等来串流程,不包含业务逻辑,如校验等。
  • 领域服务:本实例中没有领域服务,如果有的话,会定义为SpuXxxService(Xxx指明业务操作)
  • Spu: 包含字段和行为,如校验在构造和set时内置,方法体现业务操作如changeName,不是单一的update动作。
  • SpuRepo:定义了仓储的操作,实现在infra中基于mybatis等
  • MybatisSpuRepo: 实现
  • SpuMapper:基于mybatis访问数据库

具体包划分如下:

  • domain
    • shop
    • category
    • unit
    • spu
      • sku
      • spec
      • code
      • event
      • Spu
      • SpuRepo
      • SpuService
  • infra
    • repo
    • proxy

具体代码实现如下:

class SpuAppService{ //应用服务

  @Transactional
  public SpuId save(SpuCreateParam param){
    
    ShopId shopId = new ShopId(param.getShopId());
    
    //调用外部服务获取关联信息,并验证了关联信息的合法性
    Category category = categoryService.findById(param.getShopId(), param.getCategoryId());
    Unit unit  = unitService.findById(param.getShopId(), param.getUnitId());
    
    //调用Repo生成ID,后续流程中很有可能需要它
    SpuId spuId = spuRepo.nextId();
    
    //SpuNo构造时验证参数的合法性,不包含特殊字符,不会超长等
    //lockSpuNo, 用于保证编码的唯一性,注意要实现为可重入锁
    SpuNo spuNo = codeLockService.lockSpuNo(new SpuNo(shopId, spuId, param.getSpuNo()));
    
    //与SpuNo相似
    SpuBarCodeTuple spuBarCodeTuple = codeLockService.lockSpuBarCodes(new SpuBarCodeTuple(shopId,spuId,param.getBarCodes()));
    
    //用于根据参数生成对应的sku列表
    List<Sku> skus = skuService.buildSkus(shopId, spuId, param.getSkus());
    
    Spu spu = Spu.builder()
        .shopId(shopId)
        .spuId(spuId)
        .no(spuNo)
        .barCodes(spuBarCodeTuple)
        .name(param.getName())
        .photoTuple(param.getPhotoTuple())
        .category(category)
        .unit(unit)
        .specDefineTuple(param.getSpecDefineTuple())
        .skus( skus) //构造时触发笛卡尔积相关校验
        .build(); //当实例化Spu时会调用构造函数来校验以上各信息的约束条件
    
    //在本步骤前,spu和sku都未生成
    //spu是聚合根,其包含sku的实体的创建。
    //因为sku的规格组与spu的规格定义是有对应约束的。
    spuRepo.save(spu);
    
    return spuId;
  }
}
class MybatisSpuRepo implements SpuRepo{//仓储实现
  @Override
  public void save(Spu spu) {
    spuMapper.create(spu);
    skuMapper.batchCreate(spu.getSkuTuple().getSkus());
  }
}

@Mapper
public interface SpuMapper { //Mybatis实现数据库访问
  @Options(useGeneratedKeys = true, keyProperty = "id")
  @InsertProvider(type = SpuMapper.class, method = "createSql")
  void create(Spu spu);
  
  @Results(
      id = "spuDetail",
      value = {
          @Result(property = "shopId.id", column = "shop_id"),//复杂对象映射
          @Result(property = "barCodes", column = "bar_codes", typeHandler = SpuBarCodeTupleHandler.class)) //复杂对象JSON化为字符串
      }
  )
  @Select("select * from spu where shop_id = #{shopId} and spu_id = #{spuId}")
  Spu findById(@Param("shopId") Long shopId, @Param("spuId") Long spuId);
}
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
@Getter
@Setter(AccessLevel.PROTECTED)
@Accessors(chain = true)
@Builder
@Slf4j
public class Spu extends IdentifiedEntity {//实体,同时也是聚合根
  
  @NotNull(message = "商家不能为空")
  private ShopId shopId;
  
  @NotNull(message = "ID不能为空")
  private SpuId spuId;
  
  @NotNull(message = "名称不可为空")
  @Size(max = 100, min = 1, message = "名称字符数为1到100个字")
  private String name;
  
  @NotNull(message = "编码不能为空")
  private SpuNo no;
  
  //SpuBarCodeTuple内部保证其合法性,spu不用管理其细节,只要不为空,这个条码组就是合法的。
  @NotNull(message = "条码组不能为空")
  private SpuBarCodeTuple barCodes;
  
  @NotNull(message = "图片不能为空")
  private PhotoTuple photoTuple; 
  
  @NotNull(message = "分类不能为空")
  private CategoryId categoryId;
  
  //导航属性,可空,在某些需要的场景下去加载它
  //如Spu详情中应该包含,而spu列表中可以不存在
  private Category category;

  @NotNull(message = "单位不能为空")
  private UnitId unitId;
  
  private Unit unit;
  
  @NotNull(message = "规格定义不能为空")
  private SpecDefineTuple specDefineTuple;
  
  @ListDistinct(message = "规格不能重复")
  @Size(max = 600, message = "规格数最大不能超过600")
  private List<Sku> skus = new ArrayList<>();
  
  protected Spu(){ //用于使mybatis等框架能正常工作
  
  }
  
  public Spu(
      ShopId shopId,
      SpuId spuId,
      SpuNo no,
      SpuBarCodeTuple barCodes,
      String name,
      PhotoTuple photoTuple,
      Category category,
      Unit unit,
      SpecDefineTuple specDefineTuple,
      List<Sku> skuTuple) {
    this.shopId = shopId;
    this.spuId = spuId;
    this.name = name;
    this.no = no;
    this.barCodes= barCodes;
    this.photoTuple = photoTuple;
    this.category = category;
    this.categoryId = category.getCategoryId();
    this.unit = unit;
    this.unitId = unit.getUnitId();
    this.specDefineTuple = specDefineTuple;
    this.skus = skuTuple;
    
    //整合valiation框架,能基于上面定义的注解去校验,从而让校验以声明式写法来表述
    super.validate();
    
    //发布领域事件
    DomainEventPublisher.publish(new SpuCreatedEvent()
        .setShopId(shopId)
        .setSpuId(spuId)
    );
    
  }

  public Spu loadCategory(){ //加载分类
    if(this.category!=null){
      return this;
    }
    if(categoryId!=null){
      this.category = DomainRegistry.repo(CategoryRepo.class).findByShopIdAndId(shopId, categoryId);
    }
    return this;
  }
}

@ToString
@EqualsAndHashCode
@Getter
@Setter(AccessLevel.PROTECTED)
@Accessors(chain = true)
public class SpuBarCodeTuple extends AssertionConcern {
  
  @NotNull(message = "商家不能为空")
  private ShopId shopId;
  @NotNull(message = "spuID不能为空")
  private SpuId spuId;
  
  @NotNull(message = "条码列表不能为空")
  @ListStringSize(max = 20, message = "条码最多20个字符")
  @ListDistinct(message = "条码列表不能重复")
  @Size(max = 10, min = 0, message = "最多支持10个条码")
  List<String> codes = new ArrayList<>();
  
  public SpuBarCodeTuple(ShopId shopId, SpuId spuId, List<String> codes) {
    this.codes = codes;
    this.shopId = shopId;
    this.spuId = spuId;
    this.validate(); //触发约束校验
  }
  
  protected SpuBarCodeTuple() {
  }
}

@Target({ ElementType.FIELD, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = { ListStringSize.ListStringSizeChecker.class })
public @interface ListStringSize { //自定义约束
  
  int min() default 0;
  int max() default Integer.MAX_VALUE;
  String message() default "列表元素大小不符合定义";
  Class<?>[] groups() default {};
  Class<? extends Payload>[] payload() default {};
  
  public static class ListStringSizeChecker implements ConstraintValidator<ListStringSize, List<String>> {
  
    ListStringSize annotation;
    
    @Override
    public void initialize(ListStringSize constraintAnnotation) {
      annotation = constraintAnnotation;
    }
  
    @Override
    public boolean isValid(List<String> objects, ConstraintValidatorContext constraintValidatorContext) {
      if(objects==null){
        return true;
      }
      return objects.stream().allMatch(s-> s.length()<=annotation.max() && s.length()>=annotation.min());
    }
  }
}

参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350

推荐阅读更多精彩内容