Spring框架代码审查：规范、复审与问题点分析,-优快云博客

本文链接：https://blog.youkuaiyun.com/weixin_50584850/article/details/137739706

作业1：针对本小组项目，选一段已编写的代码，回答如下问题：

以下代码截取自本项目的客户实现类中：

    @Autowired
    private GuestsMapper guestsMapper;

    @Override
    @Transactional
    public int addGuests(Guests guests) {
        if(guests.getGuestIdcard() == null || "".equals(guests.getGuestIdcard())){
            return 0;
        }
        //查看该顾客是否存在
        Guests newGuest = new Guests();
        newGuest.setGuestIdcard(guests.getGuestIdcard());
        List<Guests> list = guestsMapper.getGuestsList(newGuest);
        if(list.size() != 0){
            guests.setGuestId(list.get(0).getGuestId());
            return 0;
        }else {
            return guestsMapper.addGuests(guests);
        }
    }

    @Override
    @Transactional
    public int updateGuests(Guests guests) {
        return guestsMapper.updateGuests(guests);
    }

（1）代码规范采用什么方式？

该代码采用了Spring框架中的注解@Autowired和@Transactional，以及Java中的@Override注解。这表明它遵循了Spring框架的规范，并且覆盖了父类或接口中的方法。

（2）参考附录中所给的模板，设计本小组项目的“代码复审核查表”

概要部分

·1)代码符合需求和规格说明么?

从代码中看，它遵循了一般的逻辑需求，即添加客户时需要先检查参数是否正常，以及检查顾客是否已存在，如果已存在则不执行添加操作（通过使用客户id去数据库查询是否已存在相同的客户，去判断是否进行添加客户操作）。

2)代码设计是否考虑周全?

代码设计考虑了顾客是否存在的情况，并采取了相应的处理方式。

3)代码可读性如何?

代码的可读性一般，通过方法名和变量名可以大致理解其功能，但缺乏注释说明具体逻辑和用途，可以通过添加注释来提高可读性。

4)代码容易维护么?

代码在一定程度上易于维护，尤其是采用了注解和传统的Java语法结构，使得代码结构清晰。但是如果未来需求变更或者需要优化，可能需要进一步重构或修改。

5)代码的每一行都执行并检查过了吗 ?

代码中的逻辑大部分是简单的条件判断和数据库操作，但仍需要确保每一行代码都执行正确，并且需要检查是否有遗漏的边界情况没有考虑到。特别是需要确保数据库操作的事务性，以及异常处理等方面的完整性。

设计规范部分

·1)设计是否遵从已知的设计模式或项目中常用的模式 ?

代码没有直接使用已知的设计模式，但遵循了Spring框架的一些设计模式，如依赖注入等

·2)有没有硬编码或字符串/数字等存在?

代码中似乎没有明显的硬编码存在

·3)代码有没有依赖于某一平台，是否会影响将来的移植(如win32到 win64)?

代码没有显式依赖于特定的平台，因此移植性可能较好。然而，如果数据库操作或事务处理依赖于特定的数据库或平台特性，则可能需要进行适当的调整。

·4)开发者新写的代码能否用已有的uibrary/sDK/Framework中的功能实现?在本项目中是否存在类似的功能可以调用而不用全部重新实现?

从代码中看，代码可以利用已有的数据库操作库或框架来实现类似的功能，例如使用MyBatis等。这样可以避免重新实现相似的功能，并提高开发效率和代码复用性。

·5 )有没有无用的代码可以清除 ?

代码中似乎没有明显的无用代码，但可以进一步审查是否有不必要的注释、临时调试代码或者已经被废弃但未删除的代码。对于未使用的变量或方法，也可以考虑删除以提高代码的清晰度和可维护性。

具体代码部分

1)有没有对错误进行处理?对于调用的外部函数，是否检查了返回值或处理了异常?

上述代码中，没有显式处理错误或异常情况，如数据库操作失败、事务处理异常等。需要添加适当的错误处理机制，如try-catch块或者throws语句来处理异常情况，确保程序的稳定性和健壮性

2)参数传递有无错误，字符串的长度是字节的长度还是字符(可能是单/双字节)的长度，是以0 开始计数还是以1 开始计数?

代码中没有明确指定字符串的长度是字节长度还是字符长度，也没有说明计数是从0开始还是从1开始。

3 )边界条件是如何处理的?switch语句的default分支是如何处理的?循环有没有可能出现死循环 ?

代码中未显示处理边界条件

4 )有没有使用断言(Assert)来保证我们认为不变的条件真的得到满足?

代码中没有使用断言来保证不变条件

5 )对资源的利用，是在哪里申请,在哪里释放的?有无可能存在资源泄漏(内存、文件、各种GUI资源、数据库访问的连接，等等)?有没有优化的空间 ?

资源的申请和释放在代码中并没有明确体现

6)数据结构中有没有用不到的元素 ?

代码中未涉及到具体的数据结构，因此无法确定是否存在用不到的元素。

效能

·1)代码的效能(Performance)如何?最坏的情况是怎样的?

从代码中无法准确评估效能，但可以看出存在一些潜在的效能问题。例如，每次添加顾客时都会进行数据库查询操作，这可能会影响性能，特别是在顾客数据量很大的情况下。最坏情况可能是每次添加顾客都需要进行完整的数据库扫描，导致性能急剧下降。

·2)代码中，特别是循环中是否有明显可优化的部分(C++中反复创建类，C#中string的操作是否能用stringBuilder来优化)

代码中没有循环或字符串操作，但如果存在循环操作，并且在循环内反复创建对象或进行字符串拼接等操作，可以考虑使用更高效的方法来优化，如在循环外创建对象、使用StringBuilder等。

·3)对于系统和网络的调用是否会超时?如何处理?

代码中未涉及系统和网络调用，因此无法确定是否会超时。如果存在系统和网络调用，需要考虑异常情况的处理，如设置超时时间、捕获异常并进行重试或回退等策略。

·可读性
·代码可读性如何?有没有足够的注释?

代码的可读性一般，但缺乏足够的注释来解释代码逻辑和处理流程，可以添加注释以提高可读性。

·可测试性
·代码是否需要更新或创建新的单元测试?针对特定领域的开发(如数据库、网页、多线程等)，可以整理专门的核查表。

代码是否需要更新或创建新的单元测试取决于项目的要求和团队的实践，但通常情况下，对于涉及业务逻辑的代码都应该编写相应的单元测试来验证其正确性。针对特定领域的开发，可以整理专门的核查表，例如针对数据库操作、网页开发、多线程处理等领域，以确保代码质量和可维护性。

（3）运用“代码复审核查表”，回顾本小组项目这段代码

a 确认代码是否容易理解?

代码相对容易理解，尤其对于熟悉Spring框架的开发者来说。它按照一般的逻辑顺序执行，首先检查顾客身份证是否为空，然后查询数据库是否存在相同的顾客。

b 是否符合代码规范？

代码基本符合代码规范，但可能缺少一些注释来解释代码逻辑和方法的作用。在注释方面还有改进的空间。

c 代码是否正确?

代码是正确的，但缺乏对异常情况的处理。特别是在数据库查询时可能发生异常，需要相应的错误处理机制来保证程序的健壮性。

d 对于各种边界情况能否正确处理？

代码在边界情况的处理上似乎不够完善。例如，如果身份证为空或者数据库查询返回的列表为空，代码只是简单地返回0，而没有给出更详细的处理方式。可能需要进一步考虑如何处理这些边界情况，以确保程序的正确性和完整性。