强提示与弱提示

2018-04-27 本文已影响0人朱万宇

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

Optional
其他强提示手段：接口实现

弱提示：

注释
注解

强提示

强提示，这是我自己想的一个术语。强提示，我在这里定义为需要在编译时或通过类型来提示信息,。那么相对于强提示，也就是弱提示, 例如注释给出的提示, 我定义为弱提示。
在项目开发或协助开发中，我们会去调用其他人写的代码或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

创建Optional实例

 方式一： Optional.empty(); 
 方式二： Optional.of(Object) 接收一个非null的对象， 否则运行时报错
 方式三： Optional.ofNullable(Object) 接受一个可以为空的对象。

获取值
如果得到的是Optional对象，我们就知道返回的内容中可能为null，这时候就会记得先判断值是否存在，

值是否存在：
>>> optional.isPresent() true说明封装的内容不为null
接着我们就可以获取值了
>>> optional.get()
当然我们也可以通过获取默认值(也就是未获取到的值为空的化返回的值）
>>> optional.orElseGet(Supplier) 注意这里的参数是Supplier接口
或者抛出一个指定的异常
optional.orElseThrow()

转换值
通过链式调用及在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 推断
在点击@ 符号后，出现下列选项

将方法标注注解@NotNull
将方法标注注解@Deprecated
将方法标注注解@Nullable
给方法添加比较（其实是@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