SonarQube 7.0中Java自定义规则分析示例代码无效求助

Let’s walk through the most common reasons your custom rule isn’t triggering on your sample code, and how to dig into each one step by step:

1. Double-Check Your Rule’s Implementation Logic #

First, make sure your rule’s code actually targets the issues in your Example class. For instance, if your rule is supposed to flag empty methods (like foo()) or methods that return fixed values regardless of input (like bar()):

• Confirm you’re properly traversing the AST (Abstract Syntax Tree) — are you registering a listener for MethodTree nodes?
• For empty methods: Did you add logic to check if methodTree.body().statements().isEmpty()?
• For bar()-style methods: Are you verifying that the return statement is a constant with no relation to the method’s parameters?

Don’t skip writing unit tests for your rule (as covered in the official guide)! Local tests will quickly confirm if your logic works as expected before deploying to the server.

2. Ensure the Rule is Activated in Your Quality Profile #

Just seeing the rule in SonarQube doesn’t mean it’s being used during scans:

• Log into your SonarQube 7.0 instance and go to the Quality Profiles page.
• Locate the Java quality profile your project is using (either the default Sonar Way or a custom one).
• Search for your custom rule — make sure its status is Active (not Inactive).
• If it’s inactive, click the activate button and save the profile.

3. Verify Your Scan Configuration #

A misconfigured scan can prevent your rule from running:

• Check that your SonarScanner version is compatible with SonarQube 7.0 (stick to versions 2.8 through 3.x; newer versions may break compatibility).
• Ensure your scan command specifies the correct quality profile with the sonar.qualityprofile parameter (pointing to the profile where your rule is active).
• Confirm your Example.java isn’t being excluded from scans — check the sonar.exclusions setting in your scan config to make sure the file isn’t listed there.

4. Validate the Plugin Deployment #

Even if the rule appears in the UI, there might be hidden deployment issues:

• Check SonarQube’s web server logs (sonarqube/logs/web.log) for errors when loading your plugin — look for missing classes, dependency conflicts, or version mismatches.
• Confirm your plugin was compiled for SonarQube 7.0 specifically. SonarQube’s API changes between versions, so using a plugin built for a newer version might cause silent failures on 7.0.
• Try restarting the SonarQube server to ensure the plugin is fully loaded.

5. Test with an Explicit, Rule-Matching Test Case #

Sometimes your sample code might not meet all the implicit conditions in your rule:

• For example, if your rule only flags public methods, your default-access foo() and bar() won’t trigger it. Try modifying them to public and re-scanning.
• Adjust the sample code to perfectly match your rule’s intended trigger scenario — if your rule targets empty void methods, make sure foo() has no statements at all, with no comments or whitespace tricks that might throw off the AST check.

内容的提问来源于stack exchange，提问作者W.celine