开发小技巧系列 - 如何避免NullPointerException?(一)

开发小技巧系列文章,是本人对过往平台系统的设计开发及踩坑的记录与总结,给初入平台系统开发的开发人员提供参考与帮助。

在搬砖的过程中,很多小伙伴遇到最多的问题可能就是 NullPointerException(以下简称NPE)了,大部分的程序代码,都是在组装对象或转换对象上(至少业务系统开发都是这样)。

比如前端的操作界面向后台传入的各种参数,后台接收到参数后,对参数进行简单或者复杂的处理后,构造成另外一个对象,保存到数据库或者传递给下一个处理方法等等。

再比如从后台的数据库中查出某些数据,经过程序的加工处理,转化成另外一个对象,输出到前端的界面上或者输出到其他的方法上等。

这里涉及到java的数据类型:基本类型包装数据类型对象

案例一:

开发的小伙伴应该都知道java有“基本数据类型”,如int, long, float, boolean, short, double等,也知道与其对应的“包装类型”,如Integer, Long, Float, Boolean, Short, Double等。在使用这2种类型时,如果不注意,可能就会为以后埋下“坑”。

来看下面的场景,小伙伴A 在程序中编写了一个方法,用于将类型转变成名称,如下一段代码:ProgramerA.java

        /**
         * 通过输入的类型,来输出男女
         * 程序设定1 - 男, 2-女, 其他-未设置
         */
        public String getGender(int gender){
            if(gender == 1){
                return "男";
            }else if(gender == 2){
                return "女";
            }else {
                return "未设置";
            }
        }

      这段代码从定义上看,没有什么问题。 另外有个小伙伴B在程序的开发过程中,需要调用到上面的代码,他的编写了如下代码:

    ProgramerB.java

          /**
           *  模拟小伙伴B调用小伙伴A的方法
           */
          public void getMemberInfo(Integer memberId){
              //从数据库中获取某个会员的信息,
              Member member = memberService.getMember(memberId);
              String genderName = ProgrammerA.getGender(member.getGender());
      
      MemberDTO memberDTO = new MemberDTO() .setMemberId(member.getMemberId()) .setGender(member.getGender()) .setGenderName(genderName) .setNickName(member.getNickName()) .setRealName(member.getRealName());
      return memberDTO; }

      小伙伴B在写上面代码的前面,写了个单元测试,代码如下:

      ProgrammerBTest.java

            @Test
            public void getGenderTest(){
                //假设不是从数据库中获取数据,而是在程序处理过中,
                Member member = new Member();
                member.setId(1);
                member.setMemberId(1000);
                member.setNickName("测试");
                member.setGender(1);
                log.debug("{}", ProgrammerA.getGender(member.getGender()));
            }

        执行这个单元测试后,得到的结果是:

          [main] DEBUG net.jhelp.demo.ProgrammerBTest - 男

          小伙伴B通过单元测试的结果,检查了接口没有问题(参数传对),提交代码合并。然而某一天,在测试的过程中产生了异常,从异常的堆栈信息来看是NPE, 小伙伴B看了半天的代码及单元测试都没问题,最后找到组长,通过查找会员的数据记录,发现数据表上的gender字段没有设置默认值,存的值是null,然后通过对代码进行排查,最终解决问题。

          那些上面的代码有什么问题呢?先来写一个简单的测试例子:

                @Test
                public void getGenderWithNull(){
                    Integer gender = null;
                    log.debug("{}", ProgrammerA.getGender(gender));
                }

            运行一下上面的测试用例,发现程序出现了异常,但是从异常的信息上看,又没指示程序是哪里出错了(没有打印具体是那个类的那行代码出问题,只是打印了一个调用的入口),如果没有经验的人,估计很难想到是哪里的问题。而聪明的读者,可能一眼就看到了初始化是null,然后getGender()的入参是int,这里就是“包装类型”向“基本类型”转换的“坑”

              java.lang.NullPointerException
                at net.jhelp.demo.ProgrammerBTest.getGender2(ProgrammerBTest.java:32)
                at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
                at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
                at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
                at java.lang.reflect.Method.invoke(Method.java:497)
              
              

              将小伙伴A写的方法的代码调整如下,在执行上面的测试用例,程序可以正常输出,没有报异常信息,主要调整以下的地方:1、 入参调整为“Integer”, 使用对象类型;2、 将"==" 换成 Objects.equals;ProgrammerA.java

                    /**
                     * 通过输入的类型,来输出男女
                     * 程序设定1 - 男, 2-女, 其他-未设置
                     */
                    public static String getGender2(@NotNull Integer gender){
                        if(Objects.equals(gender, 1)){
                            return "男";
                        }else if(Objects.equals(gender, 2)){
                            return "女";
                        }else {
                            return "未设置";
                        }
                    }
                      //ProgrammerBTest.java
                      /**
                       * 测试getGender方法调整后的情况
                       */
                      @Test
                      public void getGenderWithNull2(){
                          Integer gender = null;
                          log.debug("{}", ProgrammerA.getGender2(gender));
                      }
                    09:33:42.568 [main] DEBUG net.jhelp.demo.ProgrammerBTest - 未设置

                    上面的程序只是一个例子,在其它“包装类型”和“基本类型”的转换时,如果不注意,同样也会产生这样的问题。这是因为“包装类型”是对象,对象是允许为NULL,而“基本类型”不是对象(不允许值为NULL),当“包装类型”自动拆包转换成“基本类型”时,如果赋值给“基本类型”时,就会报出NPE的异常。

                    总结上面问题的解决过程,在开发的过程中,要制定好设计和开发的规范,能更好地保证不埋下“坑”。

                    • 数据表的字段设计时,设置好默认值(比如数字类型给出0,字符串为空),而不是NULL(这个对于SQL查询也是有益处的,后续文章来介绍)。


                    • 程序中的方式的入参,尽理使用“对象”类型,不要使用“基本类型”,使用对象类型,即使报错,从堆栈信息上,也能看出是那行代码出问题,而不会出现信息指向不明

                    • 程序中定义变量时,要给出初始值,初始值最好不要使用NULL。

                    思考一下:

                    1、 这段程序为什么不用“==”号了? “==” 在数字较大时会有什么问题?2、 @NotNull 有什么作用?

                    如果想要上面的代码,可以访问此仓库。

                    https://gitee.com/TianXiaoSe_admin/java-npe-demo

                    在接下来的文章中,会对“对象类型”在程序中怎么去避免NPE,怎么减少 null != obj的判断的场景进行介绍(还会对上面思考进行解答)。

                    方法(思路)比结论重要,希望你能从中有所收获。

                    更多内容与交流,欢迎关注公众号:

                    image.png


                    开发小技巧系列文章:

                    1、 开发小技巧系列 - 库存超卖,库存扣成负数?

                    2、开发小技巧系列 - 重复生成订单

                    3、开发小技巧系统 - Java实现树形结构的方式有那些?

                    本文链接:https://www.jhelp.net/p/AjcErPkRYg9FAiBC (转载请保留)。
                    关注下面的标签,发现更多相似文章