java微服务代码结构

前言
微服务开发中很重要的rpc功能,实现上不管是springcloud还是dubbo方式,代码结构上看,都是分为api层和service层。
前者就是纯粹接口定义+数据对象,轻量打包。后者就是对api的实现。
然后注入api,然后各自去注册中心获取需要的服务实现。
结构上一般如下:


代码结构.png

一、api或者interface
这个module就是包含接口定义和数据定义,没有任何实现。注意:也不能引用其他业务单元的api
1,api
实际操作中会用业务(比如订单order)关键字命名,定义一个xxxApi,只有接口的定义。
2、数据对象
比如BO, DTO或者其他重要枚举等,复杂的业务操作需要一个模型,或者说就是给1api中提供出入参的包装。
二、service
以springcloud为例,有如下几层。
1、controller
这层就是对api的实现,主要是对出入参的检查,或者从上下文中获取特定参数,然后调用底层服务进行功能实现,千万不可在这一层进行复杂业务处理,这一层不支持事务回滚。
2、service层
主要的业务实现层,这里建议在分为两层
2.1 基础服务层(entityService)
对应对entity,对单表的基础操作,而且这些操作建议是用api中定义的数据对象来进行,而不用entity对象。
可以各种省去entity dto的转化。
2.2 聚合服务层(XXXFacadeService)
就是对2.1 entityService的各种聚合,这些entityService不止包括自己模块,也可以引用其他模块,完成特定的业务功能。
3、dao层
现在有很多的orm框架,比如mybatis plus ,也提供了较好的集成方式,不在展开。
4、sql层
逻辑上其实没有这一层,只是物理上它一般放在resource里了,作为dao实现的重要组成。
三、类图


类图.png

如图,上图就是一个具体的实现。
该类图中重要的一个补充是,把entityService和bizService的区分开来。
实际开发中,每个微服务模块负责人的理解及习惯有差,无法做到真正的高内聚,低耦合。比如你就只需要查询或者修改其中一个表的某个状态,但就是没有这个接口。
针对这种单表的操作,其实是可以定制统一接口,要求统一提供对单表的操作的。对于复杂多变的业务,也许是未来的,都可以使用这些基础服务来操作。
比如OrderEntityApi 针对Order单表的操作,OrderCountApi,订单统计相关的api。
四、其他补充

不同的状态,应当用枚举定义。
xxBizUtills,用来做静态类的业务工具(没有注入任何springbean,且都是publish static)。
xxBizHelper,用来做动态注入的帮助类(允许注入其他springbean)。
entityService应当多用对象参数。争取最大复用。
bizFacadeService 建议多用基础类型参数,简化调用人的学习负担,重要的是,应当对业务进行重要提炼,
cache也在这一层处理,如果有多个模块都能调用这层的某个方法,说明业务设计很精湛了。
待补充。。。

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

推荐阅读更多精彩内容