重庆分公司,新征程启航
为企业提供网站建设、域名注册、服务器等服务
这篇文章给大家介绍sonarqube中怎么添加阿里java开发规范,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。
我们拥有十多年网页设计和网站建设经验,从网站策划到网站制作,我们的网页设计师为您提供的解决方案。为企业提供成都网站设计、成都网站建设、微信开发、微信小程序、手机网站制作、成都h5网站建设、等业务。无论您有什么样的网站设计或者设计方案要求,我们都将富于创造性的提供专业设计服务并满足您的需求。
拉取sonar-pmd源码,切换到3.2.1。修改pom文件添加p3c-pmd依赖:
com.alibaba.p3c p3c-pmd 2.0.0
开始配置阿里Java规范,此处演示配置规则:单个方法的总行数不超过80行,规则名为MethodTooLongRule,此规则名来源于p3c项目p3c\p3c-pmd\src\main\resources\rulesets\java\ali-other.xml文件中配置的规则名。
首先在sonar-pmd项目sonar-pmd-plugin\src\main\resources\org\sonar\l10n\pmd\rules目录下新建pmd-p3c目录用于存放规则说明html,然后新建MethodTooLongRule.html, 添加内容如下:
单个方法的总行数不超过80行。
说明:包括方法签名、结束右大括号、方法内代码、注释、空行、回车及任何不可见字符的总行数不超过80行。
修改sonar-pmd项目sonar-pmd-plugin\src\main\resources\org\sonar\l10n\pmd.properties配置文件,添加MethodTooLongRule规则名如下:
rule.pmd.MethodTooLongRule.name=[p3c]The total number of lines for a method should not be more than 80.
在sonar-pmd项目sonar-pmd-plugin\src\main\resources\org\sonar\plugins\pmd目录下新建rules-p3c.xml规则文件并添加MethodTooLongRule规则配置如下:
MAJOR CODE_SMELL other
修改sonar-pmd项目sonar-pmd-plugin\src\main\resources\com\sonar\sqale\pmd-model.xml配置文件,在文件末尾标签前添加如下代码:
P3C-PMD p3c-pmd P3C_PMD p3c_pmd pmd MethodTooLongRule remediationFunction CONSTANT_ISSUE offset 2 min
添加p3c规则的引入,修改PmdRulesDefinition.java文件,在define方法内添加p3c规则库
@Override public void define(Context context) { NewRepository repository = context .createRepository(PmdConstants.REPOSITORY_KEY, PmdConstants.LANGUAGE_KEY) .setName(PmdConstants.REPOSITORY_NAME); extractRulesData(repository, "/org/sonar/plugins/pmd/rules.xml", "/org/sonar/l10n/pmd/rules/pmd"); // 新增 extractRulesData(repository, "/org/sonar/plugins/pmd/rules-p3c.xml", "/org/sonar/l10n/pmd/rules/pmd-p3c"); repository.done(); }
使用mvn package -Dmaven.test.skip=true打包即可,如果规则的描述文件html中包含中文内容,那么注意文件编码需要是utf-8。
把sonar-pmd-plugin\target目录下的sonar-pmd-plugin-3.2.1.jar放到 sonarqube服务/extensions/plugins目录下重启服务。
登陆sonarqube在质量配置页面点击【创建】按钮新建p3c质量,语言选Java,点击【创建】后跳转到该质量配置的详情界面,然后点击【更多激活规则】,在搜索规则中搜索p3c,然后点击【批量修改】,点击【应用】到刚新建的质量配置, 然后回到【质量配置】页面,将该质量配置Set as Default【设为默认】,然后就可以分析项目质量了。
问题:
1. 分析失败提示缺失类com/google/gson/Gson,在sonar-pmd项目pom文件添加如下依赖:
com.google.code.gson gson 2.8.5
其他:
1. 规则说明html内容来源于p3c\p3c-pmd\src\main\resources下的message.xml文件内配置的msg和desc内容,添加示例代码使用
标签,如果代码内用泛型或代码为xml配置请使用标签,示例如下: Negative example :
List list = new ArrayList (); list.add("22"); //warn List test = (ArrayList ) list.subList(0, 1); 2.规则名来源于p3c\p3c-pmd\src\main\resources下的message_en.xml的配置的规则的msg内容,但存在部分msg过长导致sonar重启失败,请酌情删减。
3. rules-p3c.xml添加规则类型type暂时用了CODE_SMELL和BUG
4. rules-p3c.xml添加规则内的configKey配置要与p3c\p3c-pmd\src\main\resources\rulesets\java目录下的规则配置文件文件名和规则名一一对应。
关于sonarqube中怎么添加阿里java开发规范就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。
网页名称:sonarqube中怎么添加阿里java开发规范
标题路径:http://cqcxhl.com/article/gisshd.html