你的代码中的技术细节和业务逻辑分开了么?

什么是技术细节,业务逻辑?

业务人员和开发人员对需求的时,常常会出现下面这段对话。

业务人员:我希望加一个用户注册的功能,用户要填入自己的用户电话,邮箱,还有头像,我们保存图片需要进行大小缩放,以便符合我们的要求,同时电话,邮箱要有效。
开发人员1:好的,当用户注册的时候,需要前端检查电话号码,邮箱是否正确。然后获得头像图片,进行图片处理,最后存到MySQL中的user和account表中。

用户注册操作代码实现如下

class UserService {
  public void createUser(String username, String avatar,  String phone, String email, String password){
      if(password == null){
        return;
      }
      if(password.contains("*")){
        return;
      }
      ...
      String uploadUrl = getPicture(avatar)
      User user = new User(username, phone, email, uploadedUrl);
      userRepo.save(user);
  }
  private void getPicture(String avatar){
      File avatarFile = processPicture(avatar)
      // uploadFile 实现逻辑
    ...
  }
 // 图片处理,使得图片大小在一个规定的值
  private File processPicture(String avatar){
    //下载图片
    //判断图片大小是否符合标准
    //当图片过大,进行图片裁剪
    //当图片过小,进行图片放大
    ...
  }
}
class User{
  private String username;
  private String phone;
  private String email;
  private String uploadedUrl;
  private String avatar;
}

可以看到,上面的对话和代码实现,包含2类内容。技术细节和业务逻辑。

  • 技术细节:它们和业务无关,仅仅代表应用中的一种技术能力。如,我的数据库表如何设计,验证谁来做,是前后端分离还是不分离,数据是从前端来,还是从后端给。
  • 业务逻辑:它们和业务相关,代表应用中的一种业务能力。如,填入电话,邮箱,头像图片,图片大小的规定。

再看看UserService,主要实现注册功能的类。processPicture方法中存在了处理图片的逻辑(裁剪图片,放大图片等技术细节),也包含了业务逻辑(规定的图片大小)。当我们想从UserService中了解业务逻辑时,我们需要读懂processPicture方法。我们需要花很长的时间去理解processPicture方法中的技术细节是在做什么(如何做图片裁剪,如何做放大图片操作)。然而,过多的技术细节展现对于了解业务逻辑没有任何帮助,反而会使人凌乱。使得代码不那么清晰。

用户注册操作代码修改

class UserService {
  private int WIDTH_PIXEL = 1024;
  private int HIGHT_PIXEL = 1024;

  public void createUser(String username, String avatar,  String phone, String email, String password){
      if(password == null){
        return;
      }
      if(password.contains("*")){
        return;
      }
      ...
      String uploadedUrl = FileUtils.processPictureTo(avatar, WIDTH_PIXEL, HIGHT_PIXEL)
      User user = new User(username, phone, email, uploadedUrl);
      userRepo.save(user);
  }
}

class User{
  private String username;
  private String phone;
  private String email;
  private String uploadedUrl;
  private String avatar;
}
class FileUtil {
  public String processPictureTo(String avatar,WIDTH_PIXEL, HIGHT_PIXEL){
    //下载图片
    //判断图片大小是否符合标准
    //当图片过大,进行图片裁剪
    //当图片过小,进行图片放大
    //上传图片
  }
}

再看修改后,我们将技术细节封装到了个新的类FileUtil中,同时将图片缩放的大小这个业务逻辑放在UserService中。这样,我们在读UserService的时候,就可以更清晰的了解业务逻辑。

为什么要区分?

大脑的短期记忆无法一次容纳约7个以上的记忆项目 —— 《金字塔原理》

当一个开发人员去熟悉一个新模块的时候,首先会从整体去了解这个新模块提供的功能,然后再会去看每个功能具体的实现细节是什么。就像画画一样,一开始要画草图去确定各个部分画什么东西,然后再慢慢补充细节。所谓细节都是魔鬼,如果一开始就进入细节,就容易陷入到细节中去,很难看到全局并找到重点。
因此,从认知的角度,我们其实一开始关注的是业务逻辑,当了解到我们关心的业务逻辑后,才会去做技术细节的展开。因此,我们可以把业务逻辑的代码和具体的技术实现进行分离,这样,可以帮助我们通过整体-细节的方式进行学习。

如何区分业务逻辑和技术细节?

我们可以通过问问题的方式来区分现在做的这个事儿是业务逻辑还是技术细节。

  • 这个事儿业务人员关心么?有业务价值么?
    排序算法业务关心么?把数据存到关系型数据库还是文档型数据库业务关心么?实时计算结果还是提前计算好结果保存下来,业务关心么?是先取A数据进行计算还是先去B数据计算,业务关心么?有价值么?
    如果答案是:Yes,那么这就是业务逻辑,如果答案是:No,那么这些可能就是技术细节,需要封装到别处去
  • 这个事儿换一种方式可以达成么?
    冒泡排序可以换成其他方式?MySQL存储换一种方式可以达成么?实时计算结果换一种方式能达成么?
    如果答案是:Yes,那么这就是技术细节,如果答案是:No,那么就是业务逻辑

区分后该怎么办?

分清了业务逻辑和技术细节后,我们需要把他们进行分区。
将业务逻辑放到一个package中,将技术细节放到一个package中。

三层架构

业务逻辑集中在service层中。业务无关的技术细节按照功能放到其他层。

- Controller
  - TaskRequest
  - TaskController
  - TaskCreateRequest
  - ProjectController
  - ProjectResponse/ProjectVO
- Service
  - Task
    - TaskService
    - Task
  - Project
    - ProjectService
    - Project
  - Picture
    - Picture
    - PictureService
- Repository
- Utils
  - EdocUtils
  - PicutreUtils
- Config
  - LogConfig
  - HealthCheckConfig

六边形架构

- adapter
  - inbound(外部对本服务的访问,UI,controller)
    - rest
      - resources
        - TaskRequest
    - rpc
  - outbound(本服务访问三方系统,db,中间件,服务)
    - persist
- application(用例,用例可以调用多个domain里面的service)
  - usecase 
    - TaskUseCase
    - ProjectUseCase
- domain(业务模型)
  - task
    - Task
    - TaskRepo
  - project
    - Project
    - ProjectService
- config(配置信息)
  - LogConfig
  - HealthCheckConfig
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 229,619评论 6 539
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 99,155评论 3 425
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 177,635评论 0 382
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 63,539评论 1 316
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 72,255评论 6 410
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 55,646评论 1 326
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 43,655评论 3 444
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 42,838评论 0 289
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 49,399评论 1 335
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 41,146评论 3 356
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 43,338评论 1 372
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 38,893评论 5 363
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 44,565评论 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 34,983评论 0 28
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 36,257评论 1 292
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 52,059评论 3 397
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 48,296评论 2 376

推荐阅读更多精彩内容

  • 一、生命周期 一个事物一旦出生,就必然会长大,变异,一旦长大,就面临着衰老,接下来就是消亡了,这个过程就称为一个事...
    ZyBlog阅读 2,680评论 1 11
  • 最近与几个朋友聊天,不知不觉的,大家都聊到了压力巨大。不知道什么时候,压力成了当代年轻人的代名词:生活中买不起房,...
    翘课叔叔好阅读 214评论 2 4
  • 简介 2019年新学期起,决定开始Leetcode刷题,并在博客总结记录。 内容 292 Nim游戏这其实是一个B...
    Zack_H阅读 469评论 0 0
  • “我总觉得自己还是个十三岁的少年,不知道怎样做一个大人。就好像我在假装过自己的人生,做着笔记,等以后真的长大的时候...
    周洲的日常阅读 302评论 0 0
  • 朝思娘, 晚思娘。 昨梦依稀又下房, ...
    宛禾的园子阅读 574评论 6 6