强提示与弱提示

在今天介绍以下内容
强提示:

  1. Optional
  2. 其他强提示手段 :接口实现

弱提示:

  1. 注释
  2. 注解

强提示

强提示, 这是我自己想的一个术语。 强提示,我在这里定义为需要在编译时或通过类型来提示信息,。 那么相对于强提示, 也就是弱提示, 例如注释给出的提示, 我定义为弱提示。
在项目开发或协助开发中, 我们会去调用其他人写的代码或api, 其实我们无需关心该代码是具体如何实现的, 仅需要知道被调用的方法是执行什么功能, 参数是什么, 返回结果是什么。

强提示之Optional

java中出现NullPointerException 应该算是最常见的了, 对于类型的返回值为null,调用者有时候很苦恼, 返回的值会不会为null, 要不要进行非空校验, 经常我们可能忘了非空校验,这时候NullPointerException 就可能出现了

那么java 8中提供了Optional类,Optional 可谓是解决NullPointerException 的强类型提示。通过获取Optional封装, 调用者就能很清楚知道该
在guava 中也提供了Optional相应的api(非java8)。guava和java8中的Optional用法基本相同。

java8 Optional用法

以下是Optional的方法


idea Optional.png
  1. 创建Optional实例
 方式一: Optional.empty(); 
 方式二: Optional.of(Object) 接收一个非null的对象, 否则运行时报错
 方式三: Optional.ofNullable(Object) 接受一个可以为空的对象。
  1. 获取值
    如果得到的是Optional对象, 我们就知道返回的内容中可能为null,这时候就会记得先判断值是否存在,
值是否存在:
>>> optional.isPresent() true说明封装的内容不为null
接着我们就可以获取值了
>>> optional.get()
当然我们也可以通过获取默认值(也就是未获取到的值为空的化返回的值)
>>> optional.orElseGet(Supplier) 注意这里的参数是Supplier接口
或者抛出一个指定的异常
optional.orElseThrow()
  1. 转换值
    通过链式调用及在optional中转换, 我们可以在Optional内将值进行转换, 从而避免过多的isPresent的判断
Optional<Object> o = Optional.ofNullable(null).filter(new Predicate<Object>() {
          @Override
            public boolean test(Object o) {
                return o.equals(null);
            }
        });
Object c = o.orElseGet(() -> 1);

这样当值为null时, 就不会进行Predicate 中的计算, 返回的为Optional.Empty对象。

强提示是之接口实现

其实该内容是我在看源码的时候, 认为很符合今天的注意, 将之归为强提示一类。
下面是hamcrest 的Matcher接口, 省略了注释

public interface Matcher<T> extends SelfDescribing {
    boolean matches(Object item);
    void describeMismatch(Object item, Description mismatchDescription);
    @Deprecated
    void _dont_implement_Matcher___instead_extend_BaseMatcher_();
}

我们可以看到该接口有一个方法很奇怪void _dont_implement_Matcher___instead_extend_BaseMatcher_(); 仔细一看意思为请不要实现该接口,请继承BaseMatcher抽象类

虽然这种写法比较奇怪, 但我认为是一种非常不错的提示方式, 当我们使用该Api时,如果实现了该接口, 就必须实现该方法, 自然我们就看到了该提示, 同时以@Deprecated注释, 更加让使用者注意不要直接实现该接口。

以上就是我想到的强提示的一些例子, 当然以后还可能会有其他的, 强提示我认为更多的是一种代码风格, 给用户更加明显的提示, 从而避免出现不必要的错误或失误。如果大家认为还有什么可以归为强提示, 可以私信我。

弱提示

相对于强提示的是弱提示, 弱提示往往对代码没有侵入性, 但程序员再编写程序的时候可能会忽视掉这些提示从而造成一些错误。
下面就来讲一讲我认为的若提示

弱提示之注释

最常见的莫过于注释了,java 种有3种注释, 分别是行注释//, 多行注释/* */以及/** */ 文档注释, 其中第三种可以通过javadoc 将文档注释写进生成的文档。 同时第三种注释可以在IDEA 通过快捷Ctrl+Q(当然可以改成其他快捷键) 快速查看

文档注释快速查看Ctrl+Q

那么我们在调用方法时, 如果文档注释写明返回值为空的情况, 我们则可以根据注释进行相应的处理。

弱提示之Annotation

仔细的人一定会发现, 在使用idea编写代码时, 有时在方法边上会出现@ 符号,如下图

image.png

我们将鼠标放上时, 则提示

可用的被推断的注解, 完整签名:
private ResolvableType resolveDefaultEventType(@NotNull ApplicationEvent event)

annotation 推断

在点击@ 符号后, 出现下列选项

  1. 将方法标注注解@NotNull
  2. 将方法标注注解@Deprecated
  3. 将方法标注注解@Nullable
  4. 给方法添加比较(其实是@Contract注解)


    image.png

其实这是IDEA 集成JetBrains annotation, 我们可以在项目pom文件中加入来显示的使用该注解

        <dependency>
            <groupId>org.jetbrains</groupId>
            <artifactId>annotations</artifactId>
            <version>version</version>
        </dependency>

这样, 我们可以通过显式地加入注解

private ResolvableType resolveDefaultEventType(@NotNull ApplicationEvent event)

虽然程序员依然可以加入传入null的值, 并且不会在编译时报错, 但是IDEA如果我们传入为null时会友好的给出提示


传入null值

当然程序员应该在调用方法时仔细查看方法的签名, 对于jetbrains.annotations 的注解 诸如@NotNull自然意识到该处参数不能为null

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,602评论 18 399
  • Optional 本章内容 如何为缺失的值建模 Optional 类 应用Optional的几种模式 使用Opti...
    追憶逝水年華阅读 1,789评论 0 0
  • WRAP决策流程是根据希思兄弟的畅销书《决断力》总结的,个人觉得他们应用了许多心理学与经济学的决策技巧和基本理论,...
    IsabelCHE阅读 2,060评论 0 4
  • 1.意想不到:今天一上午的模特没白当,火疗,九宫格脏腑按摩,加上艾灸,下午胃里就不太胀!结束九次保健灸,接下来的调...
    国粹堂1阅读 196评论 0 0