Explicit vs Implicit

TL;DR

In my opinion, dealing with logic explicitly is better than implicitly. Hiding logic is a bad programming practise.

The Story

A user will input some search criteria, and our program will validate the input against some certain rules.

These's already a validation method, and all we need to do is to extend it.

// Original code
void validate(SearchArgs args) {
    List<String> errors;
    validationSomething(args, errors);
    validationSomethingElse(args, errors);
    
    // we need add another validation here

    if (!errors.isEmpty()) {
        throw new ValidationError(args, errors);
    }
}

According to the requirement, there will be one more error message generated if the user input fails our new validation rule.

So we make it straight forward:

Optional<String> validateNewRule(SearchArgs args) {
    // TODO:
}

// And in validate()
validateNewRule(args).ifPresent(error -> {
    errors.add(error);
});

Writing test cases, test case passes, build pipeline passes...

During the code review, another dev raised an idea: shouldn't our new validateNewRule() method return a List of errors?

List<String> validateNewRule(SearchArgs args) {
    // TODO:
}

// And in validate()
errors.addAll(validateNewRule(args));

The Thoughts

I'm not a fan of doing such implementation style argues in a code review, but since somebody raised this, I'd like to list the Pros and Cons of each approach.

The Optional<String> way

Pros
  • The output is explicit, an optional value indicates if there's an error
Cons (I doubt this)
  • Explicit, the method consumer will have logic to tell if there's an error and whether it needs to add the error into error list

The List<String> way

Pros
  • No branch (if, or something similar)
  • Possible future proof if the requirement changes and validateNewRule() needs to return a list of errors
Cons
  • If there's no change to the requirement, the effort of returning a list is wasted
  • Implicit

I don't want to discuss if the 'future proof' is necessary, but I'd like to talk more about why I believe it's implicit and why it's bad.

Nowadays many programmers believe adding more branches increases the program's complexity.

I agree.
But they're going too far. They've started hiding logics.

Let's think about this, by using a list of errors, we presume:
a) Returning an empty list means no errors
b) Returning a non-empty list means validation fails

See? There's a branch.
There's no if in the code only because we have above assumptions, and the logic is implicitly hidden in the assumptions.

This sounds great in this given example, but if you think about reusing this validateNewRule() in a scenario where it's solely used:

List<String> errors = validateNewRule(args);
if (!errors.isEmpty()) {
    // handle errors
}

It's perfectly correct to say, it's very easy to make mistake by forget typing the logic NOT operator.

While the Optional<String>, and explicit version:

Optional<String> error = validateNewRule(args);
if (error.isPresent()) {
    // handle error
}
validateNewRule(args).ifPresent(error -> {
    // handle error
});
validateNewRule(args)
    .map(...);  // handle error

No one's gonna make mistake on all three types of implementations.

I hope this article clearly expresses my idea.
Thoughts?


I care about creating code hard to make mistakes and easy to replace.
I don't focus on creating 'easy to understand' code - it's a programmer's basic capability.

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

推荐阅读更多精彩内容