工程技术规范

服务接口规范

作为一家互联网公司,并且大部门属于电商部门,系统必须支持根据业务的扩张,实现横向扩展,因此系统基础采用分布式横向扩展方式设计,使用OpenApi实现统一外部接入接口规范,使用dubbo实现内部服务负载规范,使用Restful实现内部管理接口规范

采用API开发

系统基于领域驱动开发,根据业务划分,研发部门按照各自负责的领域并行开发,系统之间存在提供或者依赖基础服务的情况。
传统:采用SOA/WebService服务,有SOAP、WSDL等语法定义服务规范,需要存在SA/BA的角色先按照业务需求定义好WSDL,WSDL定义完整,但是由于定义完整,存在严格的规范限制,制约了性能,每次都需要通过SAX等工具生成客户端,每次提供的WSDL有变更都需要额外生成对应的客户端代码。(还有存在自身不具备负载的能力,需要依赖F5、Nginx等实现前置负载,虽然有类似于Oracle公司的ESB等集成工具,但是很贵,很贵,很贵!!!)
当下:基于敏捷开发,快速迭代,横向扩展的形势下,采用基于定义接口,提供API依赖包,轻依赖,接口变更只需要更新依赖版本,变动较少,语法没有强约束,性能损耗少,由于存在较少约束,不会受限于业务变更。

工程规范

对外提供的服务接口以及内部处理的业务逻辑,在工程上划分为

project
- project-biz (实现对外暴露接口业务逻辑)
  - main
    - common(aop,convert,util)
    - conf
    - dao
      - mapper(对每一张表具体实体操作)
        - single
        - tddl
      - repo(集成封装了mapper成为业务级实体变更,外部只能应用repo)
        - single
          - impl
          - XXXInterface
        - tddl
    - diamond
    - exceptions
    - manager
      - impl(XXXInterfaceImpl, 只能操作dao.repo,common,diamond)
      XXXInterface
    - model
    - service(只能操作manager,diamond实例)
    - mq
    - task(定时任务)
  ApplicationMain
  - test
    - ut (单元测试)
    - it (集成测试)
- project-client (对外暴露接口)
 - api (接口)
  - dubbo
  - gw
  - web
 - model (数据模型)
  - enumus
  - dubbo
  - gw
  - web
 - util

DTO,DO,PO,DAO,POJO数据域使用

在数据域这块有两个分歧点,纠结点来源于dao层的技术选型以及对domain的理解,一方使用 JPA(部分部门) 做持久层操作,一方使用 mybatis(部分部门) 做持久层操作。
下方是2套技术的比较,在持久化层面的区别只是基于对持久层的理解,但是在manager-> service 领域层的理解,出现了较大的理解偏差。本身不是JPA(spring-data)和mybatis技术的问题,而是2个项目的成员对于domain分层上面理解程度存在偏差。

  • mapper:
    JPA -> Repository,请求/响应对象 PO
    mybatis -> xml mapper,请求/响应对象 DAO
  • repo:
    JPA -> 操作 mapper 层, 请求/响应对象 PO
    mybatis -> 操作 mapper 层, 请求对象 DTO,响应对象 DO,对数据的整合在此层完成,主表-子表的封装在这层实现
  • manager:
    JPA -> 操作 repo, common, manager 等层,请求基础类型、DO、DTO、POJO,响应基础类型、DO、DTO、POJO, 这里非常混乱,没有一个标准的规范,manager之间允许相互调用
    mybatis -> 操作 repo, common 等层,请求 XxxParam、XxxQuery、DTO,响应 Result/Batch/PageDTO<DO>、基础类型,manager类型不允许相互调用。即使多个manager存在调用同样的外部service问题,也作为冗余,如果有大量这种情况,有必要抽象成基础的AbstractBaseManager。
    DO作为领域对象,可以囊括领域中所有的数据
  • service:
    JPA -> gw入参是primitive类型,dubbo入参是DTO,http入参是DO,gw出参是DTO/Collection,dubbo出参是POJO,http出参是POJO
    mybatis -> gw入参primitive类型,dubbo入参是primitive类型,web入参是XxxParam,gw出参是业务类型命名的XxxGW,dubbo出参是Result/Batch/PageDTO<DTO>,web出参是DTO
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容