Java代码审查工具

# Clone or download this repository
cd java-code-review-mcp

# Create virtual environment
python -m venv .venv

# Activate (Linux/Mac)
source .venv/bin/activate

# Activate (Windows)
.venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

uv venv
uv add "mcp[cli]" fastmcp javalang rich pyyaml

max_line_length: 120
indent_size: 4
use_spaces: true
max_method_length: 30
max_class_length: 500
max_parameters: 5

security:
  check_hardcoded_secrets: true
  check_sql_injection: true
  check_logging_sensitive: true

jdk17_features:
  recommend_records: true
  recommend_sealed_classes: true
  recommend_switch_expressions: true
  recommend_text_blocks: true
  recommend_var_keyword: true
  recommend_pattern_matching: true

jdk21_features:
  recommend_virtual_threads: true
  recommend_structured_concurrency: true
  recommend_string_templates: true

spring_enabled: true   # Enable Spring Boot rule checks

spring_rules:
  transactional: true        # SPRING-TX-01
  field_injection: true      # SPRING-DI-01
  circular_autowired: true   # SPRING-DI-02
  missing_stereotype: true   # SPRING-STEREO-01
  rest_return_types: true    # SPRING-REST-01
  value_fallback: true       # SPRING-CONFIG-01

jbct_profile: basic   # disabled | basic | full

jbct_rules:
  return_types: true      # RET-01 to RET-05
  exceptions: true        # EX-01, EX-02
  value_objects: true     # VO-01, VO-02
  lambda_rules: true      # LAM-01, LAM-02, LAM-03, NEST-01
  patterns: true          # PAT-01, PAT-02, SEQ-01
  architecture: true      # MIX-01
  naming: true            # NAM-01, NAM-02, ACR-01
  zones: true             # ZONE-01, ZONE-02, ZONE-03
  style: true             # STY-01 to STY-06
  logging: true           # LOG-01, LOG-02
  static_imports: true    # STATIC-01
  utilities: true         # UTIL-01, UTIL-02
  sealed_types: true      # SEAL-01
  usecase: true           # UC-01

jbct_packages:
  domain_patterns:
    - "**.domain.**"
    - "**.usecase.**"
  adapter_patterns:
    - "**.adapter.**"
    - "**.io.**"

zone2_verbs:
  - validate
  - process
  - handle
  - execute

zone3_verbs:
  - get
  - fetch
  - parse
  - load

# With Python
python src/server.py

# With uv
uv run python src/server.py

JAVA_REVIEW_CONFIG=/path/to/config.yaml python src/server.py

{
  "mcp": {
    "java-code-review": {
      "type": "local",
      "command": ["python", "path/to/java-code-review-mcp/src/server.py"],
      "enabled": true
    }
  }
}

Review the Java file src/main/java/com/example/MyService.java
Check this file for JBCT compliance: src/main/java/com/example/MyService.java
Do a full code review of this project
Run JBCT compliance check on the src/main/java directory
Analyze Spring Boot issues in this project
Show me the current code review configuration

{
  "mcpServers": {
    "java-code-review": {
      "command": "python",
      "args": ["path/to/java-code-review-mcp/src/server.py"]
    }
  }
}

Review this Java file for issues
Review my uncommitted Java changes
Run a quick review of the project (critical issues only)
Check for Spring Boot problems in src/main/java
Run JBCT compliance check on this directory
What JBCT rules are enabled?
Show the current config

{
  "mcpServers": {
    "java-code-review": {
      "command": "python",
      "args": ["path/to/java-code-review-mcp/src/server.py"]
    }
  }
}

# config/code_review_config.md (or your YAML config)
spring_enabled: true

Analyze Spring Boot issues in src/main/java/com/example/

Analyze the architecture of this Java project
Check for circular dependencies in the codebase

Do a full code review of this Java project

name: Java Code Review

on: [pull_request]

jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'
      - name: Install dependencies
        run: pip install -r requirements.txt
      - name: Run JBCT Check
        run: |
          python -c "
          from src.tools.code_review import review_jbct_project
          from src.tools.report_generator import generate_report
          from src.config.loader import load_config, get_config
          import asyncio

          load_config()
          config = get_config()
          config['jbct_profile'] = 'basic'

          result = asyncio.run(review_jbct_project('src/main/java', config))
          print(generate_report(result, 'sarif'))
          " > results.sarif
      - name: Upload SARIF
        uses: github/codeql-action/upload-sarif@v3
        with:
          sarif_file: results.sarif

# Quick summary
python -m pytest tests/ -q

# Verbose with test names
python -m pytest tests/ -v

# Single module
python -m pytest tests/test_spring_analyzer.py -v