阿里巴巴Java规约扫描-云效(对外)版使用文档

原理

集团编码规约扫描rdc版本，是基于阿里巴巴JAVA开发手册中需要遵守的规则，转化为实际自动化扫描的规约条目纳入rdc实验室检测范围，完成后将扫描报告上传，最后把解析结果数据展示给用户。目前对外，共包括51条规则的检测。

包括2种方式接入，2种方式对比：测试服务接入更简单，适应于只做单种测试类型的扫描；实验室接入稍复杂，适应于作多种测试类型集合。比如同时做单元测试和代码规约扫描，需要把包含2个阶段的.rdcci.yml放代码库根目录，云效-实验室文档参考。

云效-测试服务使用步骤

进入云效-测试，选择阿里巴巴JAVA代码规约扫描，填写code.aliyun.com代码库地址，保存，运行即可开始扫描。

云效-实验室步骤

1.编写配置文件放代码库

[阿里巴巴编码规约扫描]的.rdcci.yml配置文件示例如下,将其放到code.aliyun.com代码根目录。
另配置文件生成方式，也可参考【构建配置文件】-》【编写帮助】-》表单-》源码 生成配置文件。

pipeline:
 - 阿里巴巴集团编码规约扫描
stage:
 阿里巴巴集团编码规约扫描:
   env:
     cluster: rdc
   plugin:
     -
       param:
         source_root: '${source_root}'
         exec: 'java -cp p3c-pmd.jar net.sourceforge.pmd.PMD '
         pipelineId: '${pipeline_id}'
       name: p3c_rdc
       pos: back
     -
       param:
         url: '${repo}'
         branch: '${branch}'
         path: '${source_root}'
       name: checkout
       pos: front
   exec:
     - 'echo ''start alibaba code scanning~'''

添加示例，如下图

ps: 如果同时做单元测试，有多个阶段的情况，请参考实验室rdc手册

## 2.新建扫描实验室
新建,如下图填写对应参数，完后即可点新建(运行)实验室

## 3.实验室详情查看
### 3.1 运行中
详情页，可取消构建 及 再次运行。

### 3.2 运行完成
完成后，会出现扫描结果指标， 点击指标数字即可进入报告详情查看更多。
问题级别说明：目前扫描出的问题共分为三个级别——Blocker、Critical、Major。
且严重程度依次为：Blocker > Critical > Major，因此建议在修复问题时的顺序也是从Blocker级的开始。

### 3.3 报告详情(带权限验证)
只有对应实验室负责人权限，才能查看扫描报告。

## 4.FAQ
### 4.1 样例——构建配置错误
出现这个错误，可能情况有2种：
1.说明代码根目录.rdcci.yml不存在，请按[编写配置文件]放代码库。

2.语法不合法，请在【编写帮助】-【源码模式】中进行验证。

### 4.2 扫描报告无法打开
请确认您是否有相应实验室负责人权限。