ali p3c规则扩展-集成sonar

绝地灬酷狼 2022-10-06 05:49 121阅读 0赞

最近公司需要完善检测机制，所以我这边对于原有的ali p3c的类进行了一次扩展，扩展主要分为两个部分。

**第一：对于规则的编写**

可以在github上面找到最新的p3c-master项目，之前老的p3c只有40多条rule，现在新的增加到了50多条。打开项目，然后对其进行扩展。在扩展之前需要去pmd官网下载一个pmd下载一个code analyzer用于分析代码结构的。解压pmd包里面有一个bin目录，win系统可以直接点击开bat文件，对于mac用户需要终端进入到bin目录下运行 ./run.sh designer 命令，然后可以看到如下界面：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70][]

通过这个抽象语法树结构分析我们可以更快的开发相应的规则，接下来我们需要在p3c-master上面进行对于rule的扩展。

**第一步**编写规则：

在p3c-master下面的p3c-pmd下面src -> main -> java -> com.alibaba.p3c.pmd.lang.java.rule里面编写规则，可以新加一个package也可以使用里面的other package；

eg：在pojo类里面不允许出现isXX与getXX同时出现

public class PojoPropertyMethodRule extends AbstractPojoRule {
    
        private static final String METHOD_XPATH = "//MethodDeclaration";
    
        private static final String VIOLATION_MESSAGE = "java.oop.PojoPropertyMethodRule.violation.msg";
    
        @Override
        public Object visit(ASTClassOrInterfaceDeclaration node, Object data) {
            if (!isPojo(node)) {
                return super.visit(node, data);
            }
            try {
                List<Node> methods = node.findChildNodesWithXPath(METHOD_XPATH);
                Set methodNameSet = new HashSet();
                for (Node method : methods) {
                    ASTMethodDeclaration astMethod = (ASTMethodDeclaration) method;
                    if (astMethod.getMethodName().startsWith("get")) {
                        int methodNameLength = astMethod.getMethodName().length();
                        String methodName = astMethod.getMethodName().substring(3, methodNameLength);
                        if (methodNameSet.contains(methodName)) {
                            addViolationWithMessage(data, node, VIOLATION_MESSAGE, new Object[]{astMethod.getMethodName()});
                        } else {
                            methodNameSet.add(methodName);
                        }
                    }
                    if (astMethod.getMethodName().startsWith("is")) {
                        int methodNameLength = astMethod.getMethodName().length();
                        String methodName = astMethod.getMethodName().substring(2, methodNameLength);
                        if (methodNameSet.contains(methodName)) {
                            addViolationWithMessage(data, node, VIOLATION_MESSAGE, new Object[]{astMethod.getMethodName()});
                        } else {
                            methodNameSet.add(methodName);
                        }
                    }
                }
            } catch (JaxenException e) {
                throw new RuntimeException(e.getMessage(), e);
            }
            return super.visit(node, data);
        }
    
    }

里面的代码结构，比如获取某个节点某个方法名或者参数名称都可以根据上面点PMD分析工具去写。

**第二步**将规则错误信息加入到message.xml上面，在resources文件夹里面有一个文件夹放message.xml，需要将代码里面的报错信息 java.oop.PojoPropertyMethodRule.violation.msg 对应加入到message里面去。里面有中文和英文版，看要求添加，添加eg：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 1][]

第一条表示某个地方有规则问题，第二条是描述这个规则是什么。

**第三步**将规则注册resources下面的rulesets -> java 下面的某个xml里面去，**注意：千万不要去新加一个xml，复用这里面有的，因为这些是在ali的包里面注册好的，新加一个xml是没有效果的！！**

注册格式如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 2][]

**到这里一个规则的添加就结束了！**

下面是对于这个规则的test，因为我的规则是写在oop package里面的，所以我等会也是使用oop里面的test进行测试；

第一步先打开test文件夹java下面的包目录的oop包，里面有一个OopRuleTest，打开可以看到有一个setUp里面包含了之前上面ali-oop.xml里面注册的所有规则，我们需要将我们这条新的规则加入到setUp方法里面，然后再写一个test方法，eg：

public class OopRuleTest extends SimpleAggregatorTst {
    
        // 加载CLASSPATH下的rulesets/java/ali-oop.xml
        private static final String RULESET = "java-ali-oop";
    
        @Override
        public void setUp() {
            addRule(RULESET, "EqualsAvoidNullRule");
            addRule(RULESET, "WrapperTypeEqualityRule");
            addRule(RULESET, "PojoNoDefaultValueRule");
            addRule(RULESET, "PojoMustUsePrimitiveFieldRule");
            addRule(RULESET, "PojoMustOverrideToStringRule");
            addRule(RULESET, "StringConcatRule");
            addRule(RULESET, "BigDecimalAvoidDoubleConstructorRule");
            addRule(RULESET, "PojoPropertyMethodRule");
        }
        
        @Test
        public void testMain(){
            Rule rule = this.findRule(RULESET,"PojoPropertyMethodRule");
            runTests(rule,"PojoPropertyMethodRule");
        }
    }

在testMain里面有2行代码，第一行就是说使用Ruleset里面的哪个规则，第二行就是这个规则需要检测的example，接下来，我们需要写一个单元测试的example；

同样是在test包里面的resources里面下有一个oop.xml包，在里面新增加一个PojoPropertyMethodRule.xml文件，然后里面的内容是eg：

<?xml version="1.0" encoding="UTF-8"?>
    <test-data xmlns="http://pmd.sourceforge.net/rule-tests"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests https://pmd.sourceforge.io/rule-tests_1_0_0.xsd">
    
        <code-fragment id="pojo-property-method-rule">
            <![CDATA[
    	public class FooDO {
    		private boolean enable;
    
            public boolean isEnable(){
                return enable;
            }
            public boolean getEnable(){  //BAD
                return enable;
            }
    	}
    		]]>
        </code-fragment>
        <test-code>
            <description>POJO has primitive type fields</description>
            <expected-problems>1</expected-problems>
            <expected-linenumbers>7</expected-linenumbers>
            <code-ref id="pojo-property-method-rule" />
        </test-code>
    
    </test-data>

接下来可以看下运行test的效果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 3][]

可以看到在控制台上面显示出了检测的问题，这就说明规则是没有问题的，到这里对于p3c规则的扩展开发就结束了；

## **新开发的p3c集成到sonar上** ##

为什么还需要开发sonar项目才可以集成？

原因是p3c项目无法继承到sonar检测系统上面，需要给它包装一层外壳，所以可以去github上面找sonar-pmd项目，eg:[https://github.com/mrprince/sonar-p3c-pmd][https_github.com_mrprince_sonar-p3c-pmd],或者其他的git有这个项目的都可以。

**第一步**导入p3c的jar包，将之前开发的p3c的jar放入到maven私服上面，然后在sonar-pmd项目里面pom文件引用，从git上面下载的sonar-p3c项目都是引用了ali的包，可以改成自己的包

<dependency>
          <groupId>com.alibaba.p3c</groupId>
          <artifactId>p3c-pmd</artifactId>
          <version>2.2.6</version>
        </dependency>

里面的版本是我自己扩展后自己升级的；

**第二步**是在sonar-pmd-plugin里面的resources里面的org.sonar/l10n/pmd.rules下面的pmd.properties文件将非ali规则全部注释了，注意：带了param.xxx结尾的不要注释；

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 4][]

然后全部注释完成后，在下面加入ali-p3c的所有规则，目前下载的这个sonar-pmd已经把ali的规则写在里面了，只需要加入新扩展的，如下面图片的最后一条，则是新扩展的；

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 5][]

**第三步**注释掉pmd-model.xml里面的非ali-p3c配置，然后把扩展的配置也加入进去；注释掉就意味着屏蔽规则，而在这里我们只是需要ali-p3c及我们扩展的规则，其他都不需要；

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 6][]

**第四步**是将resources -> org.sonar -> plugins.pmd ->rules.xml注释了，然后添加阿里的开发规则，为了区别阿里的p3c规则，这里新建了一个rules-p3c.xml文件，然后在PmdRulesDefinition类中指定一下rules-p3c.xml 路径；

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 7][]

这个项目提前建立好了这个文件，可以直接在项目里面查看，然后把扩展的规则添加进去：

<rule key="PojoPropertyMethodRule">
        <priority>MAJOR</priority>
        <configKey><![CDATA[rulesets/java/ali-oop.xml/PojoPropertyMethodRule]]></configKey>
      </rule>

**第五步**添加相应的描述文件html，在这里我比较懒就没有写描述文件，只是加了一个空的，但是注意这个一定要加，不然sonar会保错的！

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 8][]

现在整个p3c就被sonar外壳包装好了，接下来可以直接使用maven打一个jar包上传到sonarqube上面去，然后为了区分sonarqube目前整个规则的名称，可以修改 sonar-p3c-pmd 工程中的PmdConstants类  Sring REPOSITORY\_NAME 名字。这样就整个sonar扫描规则开发结束了。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70]: /images/20221005/e67ccad4c41f4bc69add23011e526a12.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 1]: /images/20221005/b87f80e85e144d139c2d0b7968912813.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 2]: /images/20221005/3026f1c99aa249579714211bd541a8c1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 3]: /images/20221005/5a8517bc49ef4541b70448eb799ba88f.png
[https_github.com_mrprince_sonar-p3c-pmd]: https://link.jianshu.com/?t=https%3A%2F%2Fgithub.com%2Fmrprince%2Fsonar-p3c-pmd%25EF%25BC%258C%25E6%25AD%25A4%25E6%25BA%2590%25E7%25A0%2581%25E5%25B7%25A5%25E7%25A8%258B%25E5%25B7%25B2%25E7%25BB%258F%25E5%259C%25A8pmd%25E6%258F%2592%25E4%25BB%25B6%25E7%259A%2584%25E9%25BB%2598%25E8%25AE%25A4268%25E6%259D%25A1%25E8%25A7%2584%25E5%2588%2599%25E4%25B8%258A%25E6%25B7%25BB%25E5%258A%25A0%25E4%25BA%2586%25E9%2598%25BF%25E9%2587%258C%25E7%259A%258448%25E6%259D%25A1%25E8%25A7%2584%25E5%2588%2599%25EF%25BC%258C%25E5%25B0%2591%25E4%25BA%2586%25E4%25B8%2580%25E6%259D%25A1AvoidManuallyCreateThreadRule
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 4]: /images/20221005/c07fc3b28aab4042b1c3a779c26393f8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 5]: /images/20221005/8f98a68fd556400fb6bae471de6d0a73.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 6]: /images/20221005/b9e41798a5c94d6e89f7d92f10f838a4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 7]: /images/20221005/17c65a55773c46e5b9a64dc00e5b3c23.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JhaWR1XzMyNDkyODQ1_size_16_color_FFFFFF_t_70 8]: /images/20221005/29a929e3acf342778e7f5155054fd054.png