外来规范水土不服？手把手教你怎么扩展阿里规范idea插件

 1//前方swagger葫芦娃预警
 2@RequestMapping("/hehe")
 3public String sayHeHe() {
 4    return "hehe";
 5}
 6//仅GET、POST方法
 7@RequestMapping(value = "/hehe",method = {RequestMethod.GET,RequestMethod.POST})
 8public String sayHeHe() {
 9    return "hehe";
10}

 1package com.test.rest.controller;
 2
 3import lombok.extern.slf4j.Slf4j;
 4import org.springframework.beans.factory.annotation.Autowired;
 5import org.springframework.web.bind.annotation.RequestMapping;
 6import org.springframework.web.bind.annotation.RestController;
 7import java.util.List;
 8
 9@Slf4j
10@RestController
11@RequestMapping("/test")
12public class TestController {
13    @RequestMapping(value="/hehe",method = {RequestMethod.GET,RequestMethod.POST})
14    public String sayHeHe() {
15        return "hehe";
16    }
17    @RequestMapping("/heihei")
18    public String sayHeiHei() {
19        return "heihei";
20    }
21    @RequestMapping(value="/haha")
22    public String sayHaHa() {
23        return "haha";
24    }
25}

1//ClassOrInterfaceBody//Annotation[@AnnotationName='RequestMapping']

 1public class RequestMappingRule extends AbstractAliRule {
 2    private static final String IMPORT_XPATH = "//ImportDeclaration[@ImportedName='org.springframework.web.bind.annotation.RequestMapping']";
 3    private static final String REQUESTMAPPING_XPATH = "//ClassOrInterfaceBody//Annotation[@AnnotationName='RequestMapping']";
 4    private static final String METHOD_XPATH = "MemberValuePairs/MemberValuePair[@MemberName='method']";
 5    @Override
 6    public Object visit(ASTCompilationUnit node, Object data) {
 7        try {
 8            List<Node> importNodes = node.findChildNodesWithXPath(IMPORT_XPATH);
 9            if (null != importNodes && importNodes.size() > 0) {
10                List<Node> resquestMappingNodes = node.findChildNodesWithXPath(REQUESTMAPPING_XPATH);
11                Node annotation = null;
12                for (Node resquestMappingNode:resquestMappingNodes) {
13                    annotation = resquestMappingNode.jjtGetChild(0);
14                    if(annotation instanceof ASTSingleMemberAnnotation){
15                        addViolationWithMessage(data, resquestMappingNode, "java.oop.RequestMappingRule.rule.msg", new Object[]{});
16                    }else if(annotation instanceof ASTNormalAnnotation){
17                        if(!annotation.hasDescendantMatchingXPath(METHOD_XPATH)){
18                            addViolationWithMessage(data, resquestMappingNode, "java.oop.RequestMappingRule.rule.msg", new Object[]{});
19                        }
20                    }
21                }
22            }
23        } catch (Exception e) {
24        }
25        return super.visit(node, data);
26    }
27}

 1<rule name="RequestMappingRule"
 2          language="java"
 3          message="java.oop.RequestMappingRule.rule.msg"
 4          class="com.alibaba.p3c.pmd.lang.java.rule.oop.RequestMappingRule">
 5        <description>java.oop.StringConcatRule.rule.msg.desc</description>
 6        <!--级别，1强制，2推荐，3参考-->
 7        <priority>2</priority>
 8        <example>
 9            <![CDATA[
10        Negative example:
11            @RequestMapping("/heihei")
12            @RequestMapping(value="/haha")
13        ]]>
14        </example>
15        <example>
16            <![CDATA[
17        Positive example:
18            @RequestMapping(value="/hehe",method = {RequestMethod.GET,RequestMethod.POST})
19        ]]>
20        </example>
21    </rule>

 1<?xml version="1.0" encoding="UTF-8"?>
 2<test-data xmlns="http://pmd.sourceforge.net/rule-tests"
 3           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4           xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests https://pmd.sourceforge.io/rule-tests_1_0_0.xsd">
 5    <code-fragment id="RequestMapping-use">
 6        <![CDATA[
 7package com.test.rest.controller;
 8
 9import lombok.extern.slf4j.Slf4j;
10import org.springframework.beans.factory.annotation.Autowired;
11import org.springframework.web.bind.annotation.RequestMapping;
12import org.springframework.web.bind.annotation.RestController;
13import java.util.List;
14@Slf4j
15@RestController
16@RequestMapping("/test")
17public class TestController {
18    @RequestMapping(value="/hehe",method = {RequestMethod.GET,RequestMethod.POST})
19    public String sayHeHe() {
20        return "hehe";
21    }
22    @RequestMapping("/heihei")
23    public String sayHeiHei() {
24        return "heihei";
25    }
26    @RequestMapping(value="/haha")
27    public String sayHaHa() {
28        return "haha";
29    }
30}
31        ]]>
32    </code-fragment>
33    <test-code>
34        <description>RequestMapping use rule</description>
35        <expected-problems>0</expected-problems>
36        <expected-linenumbers>21,27</expected-linenumbers>
37        <code-ref id="RequestMapping-use"/>
38    </test-code>
39</test-data>

1mvn -DskipTests=true clean install

1cd p3c-idea
2gradle clean buildPlugin