独家视频教程,玩转《阿里巴巴Java开发手册》P3C扫描插件-阿里云开发者社区

开发者社区> 阿里巴巴云研发> 正文

独家视频教程,玩转《阿里巴巴Java开发手册》P3C扫描插件

简介: 《阿里巴巴Java开发手册》IDE插件(包括PMD规则实现库)正式对外开源,如何快速掌握插件使用技巧,快速体验令人激动的自动化、智能化的插件协同工作?阿里巴巴Java开发手册P3C项目IDE插件主要开发者骏烈和云效在线扫描主要开发者胜燕,在云栖社区直播间,首次为大家提供视频教程,教大家玩转插件和在线扫描。
974713679d5fc7d1263f5038169b3d6461fec5e4
扫码或点我直达 免费领

《阿里巴巴Java开发手册》IDE插件(包括PMD规则实现库)正式对外开源,如何快速掌握插件使用技巧,快速体验令人激动的自动化、智能化的插件协同工作?阿里巴巴Java开发手册P3C项目IDE插件主要开发者骏烈和云效在线扫描主要开发者胜燕,在云栖社区直播间,首次为大家提供视频教程,教大家玩转插件和在线扫描。

点击收看直播视频

插件操作

操作演示:大家结合文档《阿里巴巴Java开发手册》IDEA插件与Eclipse插件使用指南直播视频一起看,效果会更好!

常见问题:

1.Code Style配置问题

很多用户提出希望能够提供一份统一的Code Style配置,但通过Eclipse、IDEA自己的配置无法做到两个平台完全统一。在各种取舍的情况下仍然会有几个不同点,如下:
  • 分号,IDEA设置的After Semicolon 会对for所有分号后面加空格,Eclipse 设置insert space after Semicolon in for则不会。
  • 缩进策略不一致,如方法调用折行后的缩进。
  • 类注释 IDEA会对描述进行缩进,Eclipse有配置项,但是同时对方法、类注释生效。

解决办法有两个:

  • 提供一份Eclipse的配置,IDEA端使用Eclipse Code Formatter之类的插件来做到格式化统一。但对于IDEA用户不够友好,也不够灵活。
  • 提供类似Google Code Format插件的功能,这个目前暂时还未做支持,感兴趣的同学可以联系我们。

2.Eclipse体验优化

目前已经有Eclipse方面的专家加入进来,各方面的优化、改进事项都在规划中,非常欢迎大家提出自己的宝贵意见或者加入进来。

3.eclipse-plugin、idea-plugin和p3c-pmd三个工程之间的关系

  • p3c-pmd提供大部分规则实现,基于PMD框架开发,如果想实现自己的规则,可以先看看PMD相关文档。
  • eclipse-plugin依赖p3c-pmd的实现,并且实现了4条需要跨文件扫描的规则。
  • IDEA与eclipse类似,也是依赖p3c-pmd的实现,同时实现了4条需要跨文件扫描的规则。

点击详情咨询


在线扫描

云效怎么做在线扫描,怎么与code集成?集成之后,怎么通过多维度的报表数据,来提升代码质量,最终达到公司代码规范统一?

案例分享:

首先,用IDE插件本地扫描的一个Demo。

b22e92cb6d15e2aa6c02534afee2831f579c5642

然后,我们会看到云效扫描的问题数,对应的扫描问题,以及在对应的代码多少行,都能够在云效系统看的清清楚楚。

026a105682b962903c967a38111a14c835e7114a

有时候开发只想知道增量有没有问题?历史问题太多修复不过来,我们需要保证新增的代码有没有问题。可以将P3C规则集成在code系统中,在阿里内部已经进行了这样一个集成。如下图所示,提交code review的时候,会自动将增量代码扫描,然后知道增量代码的质量是怎样的。

c1ca79abbc15d26ed850a15c9a74faf2def43179

这些都做完以后,我们可以将各类应用的代码扫描数据做成报表,每周可以发代码质量报告。俗话说得好,只有数据才能促进研发效能的提升。我们通过这份报表,看到谁做得好或不好,一目了然,逐渐地就可以将公司的代码规范,真正的工具化落地实施。

695315073f18bdfd136f01d838f8ff580f464354

在线扫描演示:(可结合直播视频

首先,打开云效-测试服务在线扫描入口,点击测试服务,然后点击阿里巴巴Java代码规约扫描,输一个测试任务名称,填写一下阿里云的代码库地址,将这个code代码库地址复制粘贴过来,代码分支不填的话默认是master分支,然后点击确定,确定以后在右上角点运行,就可以对这个代码库进行一个扫描。不仅可以扫描自己的代码,还可以扫描别人公开的代码。

195f1cd1140453356dde8f713f636da1fcb33b02

然后,刷新一下页面,大概等几十秒吧,可以看到下图显示的结果。可以看到这个代码库总共有62个问题,blockers是0,critical是1,然后major是61。点开可以看到报告的具体详情,比如哪些文件违反了哪些规则,以及哪些规则违反了多少次,都一目了然,接着可以对照这个报告来修复问题。当然我们会建议用户直接在本地进行修复。

60dac8357e2a8e87efb5bd541ce0fbdff3d7aa6a

除了提供扫描工具,云效还提供从“需求->开发->测试->发布->运维->运营”端到端的协同服务和研发工具支撑。在发布流程中,也可以加规约扫描。打开流水线项目,点击流水线,打开一个配好的,先构建然后进行代码规约的扫描,扫描后自动做一个单元测试,然后自动部署。

29e7bcd65f18a7ef43015df761ae940388233add

流水线有很多属性
可以扫描/长按识别下图二维码体验!
f85a34baedf7118487f1e7b06d70dc07742de56a


常见问题:

1.P3C怎么与gradle集成?
2.P3C怎么与maven集成?
3.P3C怎么与sonar集成?

其实很容易集成,因为P3C插件是基于PMD规则开发,可以参考PMD规则与gradle,maven,sonar集成代码。

参考链接:
*https://github.com/ajoberstar/gradle-plugins/tree/master/src/main/groovy/org/ajoberstar/gradle/pmd 
*https://github.com/apache/maven-plugins/tree/trunk/maven-pmd-plugin 
*https://github.com/SonarQubeCommunity/sonar-pmd

如有其他问题,可以在本文留言哦~


版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

分享:

云效,企业级一站式DevOps平台,源于阿里巴巴先进的研发理念和工程实践,致力于成为数字企业的研发效能引擎!云效提供从“需求→开发→测试-→发布→运维→运营”端到端的协同服务和研发工具,支持公共云、专有云和混合云多种部署形态,通过人工智能、自动化技术的应用提升开发者的研发效能,持续交付有效价值。

官方博客
【产品与服务】
【友情链接】