项目代码审查报告

项目代码审查报告

引用

CSDN

1.

https://blog.csdn.net/Areyoustudying/article/details/137609126

本文是一个项目代码审查报告的示例，主要针对一个MovieController类的代码进行审查。文章详细展示了代码审查的标准和具体检查结果，对于从事Java后端开发和Spring框架使用的开发者具有较高的参考价值。

代码审查报告

选定代码如下：

/**
 * 
 * @version 1.0
 * @date 2020/5/1 0001 11:45
 */
@CrossOrigin
@RestController
public class MovieController {
    @Resource
    MovieService movieService;
    /**
     * //添加电影票数据，需要返回电影票全部数据，因为电影票id需要服务端生成
     * export const insertMovie = query=>{
     *     return request({
     *         url:'insertMovie',
     *         method:'post',
     *         params:query
     *     })
     * };
     */
    @RequestMapping("insertMovie")
    public CinemaResult insertMovie(Movie movie){
        return movieService.insertMovie(movie);
    }
    /**
     *  //获取电影票数据，请求参数：pageIndex，pageSize，返回电影列表和总记录数
     * export const movieData = query =>{
     *     return request({
     *         url:'getMovie',
     *         method:'get',
     *         params:query
     *     });
     * };
     */
    @RequestMapping("getMovie")
    public CinemaResult getMovie(String pageIndex,String pageSize){
        //这里使用分页插件pagehelper
        PageResult pageResult = new PageResult();
        PageHelper.startPage(Integer.parseInt(pageIndex),Integer.parseInt(pageSize));
        List lists = movieService.getMovieData();
        PageInfo<Card> pageInfo = new PageInfo<>(lists);
        pageResult.setList(pageInfo.getList());
        pageResult.setPageTotal(pageInfo.getTotal());
        return CinemaResult.ok(pageResult);
    }
    /**
     * //删除电影数据，请求参数：movieId
     * export const delMovie = query=>{
     *     return request({
     *         url:'delMovie',
     *         method:'get',
     *         params:query
     *     });
     * };
     */
    @RequestMapping("delMovie")
    public CinemaResult delMovie(String movieId){
        movieService.delMovie(movieId);
        return CinemaResult.ok();
    }
    /**
     *      * //修改电影数据，请求参数:movieId、name、price、time
     *      * export const modifyMovie = query=>{
     *      *     return request({
     *      *         url:'modifyMovie',
     *      *         method:'get',
     *      *         params:query
     *      *     });
     *      * };
     */
    @RequestMapping("modifyMovie")
    public CinemaResult modifyMovie(Movie movie){
        return movieService.modifyMovie(movie);
    }
}

代码规范采用什么方式？

代码规范采用的是项目内部明确的编程规约，其中涵盖了命名规则、注释规范、格式约定等方面。具体要求根据项目组的技术栈和团队协议来制定，以保证代码的一致性和可维护性。

设计本小组项目的“代码复审核查表”

概要部分

1. 代码符合需求和规格说明么？
2. 代码设计是否考虑周全？
3. 代码可读性如何？
4. 代码容易维护么？
5. 代码的每一行都执行并检查过了吗？

设计规范部分

1. 设计是否遵从已知的设计模式或项目中常用的模式？
2. 有没有硬编码或字符串/数字等存在？
3. 代码有没有依赖于某一平台，是否会影响将来的移植（如win32到Win64）？
4. 开发者新写的代码能否用已有的Library/SDK/Framework中的功能实现？
5. 有没有无用的代码可以清除？

具体代码部分

1. 有没有对错误进行处理？
2. 参数传递有无错误，是以0开始计数还是以1开始计数？
3. 边界条件是如何处理的？
4. 有没有使用断言（Assert）来保证我们认为不变的条件真的得到满足？
5. 对资源的利用，是在哪里申请，在哪里释放的？

效能

1. 代码的效能（Performance）如何？
2. 代码中是否有明显可优化的部分？
3. 对于系统和网络的调用是否会超时？如何处理？

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

可测试性
代码是否需要更新或创建新的单元测试？

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

确认代码是否容易理解?
代码整体上功能分明，命名规则较为合理，逻辑结构也较清晰，但是缺乏必要的注释来解释每个方法和接口的用途，对于理解代码的具体业务逻辑有一定的障碍。

是否符合代码规范？
大体上遵守了一定的命名和格式约定，如方法名insertMovie、getMovie表明了其功能；但在PageInfo<Card>处使用了Card类型，而不是Movie类型，可能不符合实际的业务需求

代码是否正确?
代码在逻辑上看起来是正确的，但没有看到异常处理逻辑，例如parseInt可能会抛出NumberFormatException，如果pageIndex或pageSize不是有效的数字，程序将因为未捕获的异常而崩溃。

对于各种边界情况能否正确处理？
代码中没有显示边界情况的处理，例如pageIndex或pageSize为负数、过大或其他非法情况。此外，在删除电影信息时，如果movieId不存在于数据库中，这种情况的处理也没有在代码中体现出来。