IntelliJ IDEA使用Alibaba Java Coding Guidelines编码规约扫描插件

news/2024/10/30 21:26:36/

代码规范和编码规约扫描插件使用

  • 为什么要有代码规范?
  • 1.代码规范插件
  • 2.idea插件安装
  • 3.插件使用介绍
    • 编码规约扫描使用
    • 编码规约扫描结果
  • 4.扫描结果严重级别
    • Blocker
    • Critical
    • Major
  • 5.《阿里巴巴Java开发手册(终极版)》

为什么要有代码规范?

个人理解:

项目的开发需要团队合作,就像篮球比赛需要五个人齐心合力才能赢得比赛一样。如果存在某个球员(程序员)过分的炫技,单打独斗,而毁掉整个团队的气氛,无论是比赛还是项目都不会能取得好的结果。简单来说,简洁易懂可读性高的程序可以提高代码维护的效率和成本,同时也可以很轻松的定位到bug的位置,提升可维护性和扩展性

关于此问题在我买的《阿里巴巴Java开发手册》的前言部分中,各位大佬给出了代码规范的见解

毕玄:一个优秀的工程师和一个普通的工程师的区别,不是满天飞的架构图,他的功底体现在所写的每一行代码上

多隆:工程师对于代码,一定要精益求精,不论从性能,还是简洁优雅,都要具备精益求精的工匠精神,认真打磨自己的作品

孤影:对程序员来说,关键是骨子里意识到规范也是生产力,个性化尽量表现在代码可维护性和算法效率的提升上

1.代码规范插件

Alibaba Java Coding Guidelines 是编码规约扫描插件,专注于Java代码规范,目的是让开发者更加方便、快速规范代码格式。该插件主要有以下特点

  1. 扫描代码后,将不符合规约的代码按 Blocker、Critical、Major 三个等级显示出来,并且给出编码修改建议
  2. 基于 Inspection 机制提供了实时检测功能,编写代码的同时也能快速发现问题所在

2.idea插件安装

首先ctrl+alt+s打开在Settings,然后找到Plugins搜索Alibaba Java Coding Guidelines最后点击lnstall,安装完成后重启idea生效
在这里插入图片描述

3.插件使用介绍

编码规约扫描使用

重启后会出现下图的图标,点击即可进行编码规约扫描(或者快捷键ctrl+alt+shift+j)
在这里插入图片描述

编码规约扫描结果

扫描完成后显示结果如下,扫描结果主要分为 Blocker、Critical、Major三个大类,它们表示的是问题的严重程度,严重程度由高到低为:Blocker(崩溃) > Critical(严重) > Major(一般)

在这里插入图片描述

4.扫描结果严重级别

Blocker

即系统无法执行、崩溃或严重资源不足、应用模块无法启动或异常退出、无法测试、造成系统不稳定。并且Blocker必须进行修改!!!

  • 严重花屏

  • 内存泄漏

  • 用户数据丢失或破坏

  • 系统崩溃/死机/冻结

  • 模块无法启动或异常退出

  • 严重的数值计算错误

  • 功能设计与需求严重不符

  • 其它导致无法测试的错误, 如服务器500错误

Critical

即影响系统功能或操作,主要功能存在严重缺陷,但不会影响到系统稳定性。

  • 功能未实现

  • 功能错误

  • 系统刷新错误

  • 数据通讯错误

  • 轻微的数值计算错误

  • 影响功能及界面的错误字或拼写错误

  • 安全性问题

Major

即界面、性能缺陷、兼容性。

  • 操作界面错误(包括数据窗口内列名定义、含义是否一致)

  • 边界条件下错误

  • 提示信息错误(包括未给出信息、信息提示错误等)

  • 长时间操作无进度提示

  • 系统未优化(性能问题)

  • 光标跳转设置不好,鼠标(光标)定位错误

  • 兼容性问题

5.《阿里巴巴Java开发手册(终极版)》

登录后可在线阅读或者下载,链接:https://developer.aliyun.com/ebook/386
在这里插入图片描述


http://www.ppmy.cn/news/104077.html

相关文章

leecode

leecode128,最长连续子序列,哈希表枚举,要注意技巧,判断num-1是否在哈希表中,可以降低时间复杂度。 class Solution:def longestConsecutive(self, nums: List[int]) -> int:nums_set set(nums)long_path 0for num in nums_…

有这个证书,网络安全工程师找工作不用愁

想要成为网络安全工程师,满足企业的用人要求。最基本的,你需要熟悉TCP/IP协议,熟悉sql注入原理和手工检测、熟悉内存缓冲区溢出原理和防范措施、熟悉信息存储和传输安全、熟悉数据包结构、熟悉Ddos攻击类型和原理。并且有一定的ddos攻防经验&…

给一个有序数组生成平衡搜索二叉树(java)

给一个有序数组生成平衡搜索二叉树 给一个有序数组生成平衡搜索二叉树递归生成二叉树专题 给一个有序数组生成平衡搜索二叉树 给定一个有序的数组,用这个数组生成一个平衡搜索二叉树. 这个题还是很简单的,知道什么时平衡搜索二叉树就行了, 左边值小于头节点值,头节点值小于右边…

Linux部署jumpserver堡垒机及问题汇总

部署过程相对复杂!请耐心浏览! 目录 一、jumpserver堡垒机简介 1.1 为什么需要使用堡垒机? 1.2 堡垒机主要功能 二、准备工作 2.1 关闭防火墙以及SElinux 1.2 时间同步 1.3 更改主机名 1.4 yum源备份及准备 1.5 安装初始工具 1.6 修改系统字…

对于后端Linux的入门知识

为什么使用Linux 文章来自https://librehunt.org/,在这个网站里,你可以根据它提供的选项,最终选出适合你的Linux版本 It’s safe and private. No tracking. No company watching over you, no “big brother is watching you” nonsense. Ju…

jmeter接口工具使用详解之基础介绍

目录 一、优点 二、安装及下载 三、基础构成 jmeter是一款优秀的开源性能测试工具, 一、优点 1、开源工具,可扩展性非常好 2、高可扩展性,用户可自定义调试相关模块代码 3、精心简单的GUI设计,小巧灵活 4、完全的可移植性…

App 软件开发《单选2》试卷及答案解析(订正)

App 软件开发《单选2》试卷及答案解析(订正) 注:本文章部分答案及解析来自 ChatGPT 的回答,正确性请自行甄辨。(这玩意儿经常一本正经的胡说八道) 文章目录 App 软件开发《单选2》试卷及答案解析&#xff0…

ASRT语音识别系统的部署以及模型的使用(运用篇)

ASRT语音识别系统的部署以及模型的使用(运用篇) 前言 ASRT是一个中文语音识别系统,由AI柠檬博主开源在GitHub上。 GitHub地址:ASRT_SpeechRecognition 国内Gitee镜像地址:ASRT_SpeechRecognition 文档地址:ASRT语音识别工具文…