Windows环境Java8项目SpotBugs预提交钩子脚本问题求助

针对你遇到的空报告、执行语法错误问题，以下是可直接使用的修复方案，核心解决路径配置、代码编译前置步骤、命令语法这几个关键点：

前置准备 #

1. 确保Java 8已配置环境变量，Git Bash中执行java -version能正常输出版本信息
2. 确认SpotBugs 4.7.3的jar路径正确，比如D:/spotbugs-4.7.3/lib/spotbugs.jar
3. 定位到Git仓库的.git/hooks目录，将默认的pre-commit.sample复制并重命名为pre-commit（删除.sample后缀）

完整预提交钩子脚本 #

替换pre-commit文件的全部内容为以下代码，根据你的项目结构调整参数：

#!/bin/bash

# 配置参数（根据你的项目修改）
SPOTBUGS_JAR="D:/spotbugs-4.7.3/lib/spotbugs.jar"
REPORT_FILE="./spotbugs-precommit-report.xml"
# Maven项目用target/classes，Eclipse项目用bin，其他项目自行调整
CLASS_DIR="./target/classes"
SOURCE_DIR="./src/main/java"

# 1. 先编译最新代码（必须步骤，SpotBugs扫描编译后的class文件）
echo "Compiling latest code..."
mvn compile
# 如果是Ant项目替换为：ant compile
# 如果是其他构建工具，替换为对应的编译命令

# 2. 检查SpotBugs jar是否存在
if [ ! -f "$SPOTBUGS_JAR" ]; then
    echo "[ERROR] SpotBugs jar未找到，请检查路径：$SPOTBUGS_JAR"
    exit 1
fi

# 3. 检查class文件目录是否存在
if [ ! -d "$CLASS_DIR" ]; then
    echo "[ERROR] 编译后的class目录未找到，请检查路径：$CLASS_DIR"
    exit 1
fi

# 4. 执行SpotBugs扫描（修复语法错误，确保路径用双引号包裹）
echo "Running SpotBugs code analysis..."
java -jar "$SPOTBUGS_JAR" -textui -xml -output "$REPORT_FILE" "$CLASS_DIR"

# 5. 检查报告是否有效（解决空报告问题）
if [ ! -f "$REPORT_FILE" ] || [ ! -s "$REPORT_FILE" ]; then
    echo "[ERROR] SpotBugs报告为空或未生成，请检查扫描路径是否正确"
    exit 1
fi

# 6. 统计Bug数量并判断是否阻止提交
BUG_COUNT=$(grep -c "<BugInstance" "$REPORT_FILE")

if [ "$BUG_COUNT" -gt 0 ]; then
    echo "[FAILED] SpotBugs检测到 $BUG_COUNT 个代码问题，提交已阻止"
    echo "详细报告请查看：$REPORT_FILE"
    exit 1
else
    echo "[PASSED] SpotBugs代码审查通过，允许提交"
    exit 0
fi

关键修复点说明 #

• 路径处理：Windows路径使用正斜杠，并用双引号包裹避免空格导致的语法错误
• 前置编译：添加mvn compile确保扫描的是最新编译的class文件，这是解决空报告的核心原因（之前脚本可能未编译，扫不到有效class）
• 命令语法：修正java -jar的执行格式，确保参数传递正确
• 有效性检查：增加对SpotBugs jar、class目录、报告文件的存在性检查，提前排查错误

脚本权限设置 #

在Git Bash中执行以下命令给脚本添加执行权限：

chmod +x .git/hooks/pre-commit

内容的提问来源于stack exchange，提问作者Hitesh Kumar