#!/usr/bin/env python3 # -*- coding: utf-8 -*- """花期 APP · 前后端契约静态校验(无需打包即可发现接口/路由/事件类错误)""" import os import re import sys import json ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), '../..')) SERVER_API = os.path.join(ROOT, 'server/application/api/controller') issues = [] notes = [] def add(msg): issues.append(msg) # ---------------- 1. 解析前端 api.js ---------------- api_src = open(os.path.join(ROOT, 'utils/api.js'), encoding='utf-8').read() pattern = re.compile(r"(\w+):\s*(?:\([^)]*\))?\s*=>\s*request\('(/api/[\w/]+)'(?:\s*,\s*(\{[^}]*\}))?") endpoints = [] for m in pattern.finditer(api_src): name, path, opts = m.group(1), m.group(2), m.group(3) or '' method = 'POST' if "'POST'" in opts.replace('"', "'") else 'GET' endpoints.append({'name': name, 'path': path, 'method': method}) print(f"[1] 前端 api.js 定义 {len(endpoints)} 个接口") # ---------------- 2. 校验后端控制器方法存在 ---------------- php_cache = {} for ep in endpoints: parts = ep['path'].strip('/').split('/') # api / controller / action controller, action = parts[1].capitalize(), parts[2] f = os.path.join(SERVER_API, controller + '.php') if f not in php_cache: php_cache[f] = open(f, encoding='utf-8').read() if os.path.exists(f) else None src = php_cache[f] if src is None: add(f"接口 {ep['name']} -> {ep['path']}:后端缺少控制器 {controller}.php") continue if not re.search(r'function\s+' + action + r'\s*\(', src): add(f"接口 {ep['name']} -> {ep['path']}:{controller}.php 缺少方法 {action}()") print(f"[2] 后端控制器映射校验完成(检查 {len(php_cache)} 个控制器文件)") # ---------------- 3. 页面里调用的 api.xxx 是否都已定义 ---------------- defined = {ep['name'] for ep in endpoints} vue_files = [] for dirpath, _, files in os.walk(ROOT): if 'node_modules' in dirpath or '/server' in dirpath or '/.git' in dirpath: continue for fn in files: if fn.endswith('.vue'): vue_files.append(os.path.join(dirpath, fn)) used = {} for f in vue_files: src = open(f, encoding='utf-8').read() for m in re.finditer(r'\bapi\.(\w+)\s*\(', src): used.setdefault(m.group(1), set()).add(os.path.relpath(f, ROOT)) for name, files in sorted(used.items()): if name not in defined: add(f"前端调用了未定义的接口 api.{name}()(使用位置:{', '.join(sorted(files))})") print(f"[3] 页面接口调用校验完成({len(used)} 个被调用接口,覆盖 {len(vue_files)} 个 .vue)") # ---------------- 4. pages.json 路由与文件存在性 ---------------- pages_cfg = json.load(open(os.path.join(ROOT, 'pages.json'), encoding='utf-8')) for page in pages_cfg.get('pages', []): p = os.path.join(ROOT, page['path'] + '.vue') if not os.path.exists(p): add(f"pages.json 声明的页面不存在:{page['path']}.vue") print(f"[4] 路由校验完成({len(pages_cfg.get('pages', []))} 个页面)") # ---------------- 5. 页面跳转目标是否在 pages.json 中 ---------------- declared = {'/' + page['path'] for page in pages_cfg.get('pages', [])} for f in vue_files: src = open(f, encoding='utf-8').read() for m in re.finditer(r"url:\s*'(/pages/[\w/]+)(?:\?[^']*)?'", src): target = m.group(1) if target not in declared: add(f"{os.path.relpath(f, ROOT)}:跳转到未注册页面 {target}") # ---------------- 6. 组件引用与文件存在性 ---------------- for f in vue_files: src = open(f, encoding='utf-8').read() for m in re.finditer(r"from '(@/[\w\-/]+\.vue)'", src): rel = m.group(1).replace('@/', '') if not os.path.exists(os.path.join(ROOT, rel)): add(f"{os.path.relpath(f, ROOT)}:组件文件不存在 {rel}") # 模板中使用的组件是否已注册 script = src.split('')[0] regs = set(re.findall(r'components:\s*\{([^}]*)\}', src)) registered = set() for block in regs: registered |= set(re.findall(r'(\w+)\s*:', block)) # 支持 ES6 简写注册 components: { hqTabbar } registered |= {t.strip() for t in block.split(',') if re.fullmatch(r'\s*\w+\s*', t)} def camelize(name): parts = name.split('-') return parts[0] + ''.join(p.capitalize() for p in parts[1:]) registered_camel = {camelize(r) for r in registered} for tag in set(re.findall(r'<(hq-[a-z\-]+|bloom-calendar)', script)): if camelize(tag) not in registered_camel: add(f"{os.path.relpath(f, ROOT)}:模板使用 <{tag}> 但未在 components 中注册") # ---------------- 7. 模板事件处理函数是否在 methods 中定义 ---------------- HANDLER_RE = re.compile(r'@(?:tap|change|confirm|select|input|submit)="(\w+)"') for f in vue_files: src = open(f, encoding='utf-8').read() if '', 1)[0] for h in set(HANDLER_RE.findall(template)): if not re.search(r'\b' + h + r'\s*\(', script): add(f"{os.path.relpath(f, ROOT)}:模板绑定的处理函数 {h}() 未定义") # ---------------- 8. SFC 结构完整性 ---------------- for f in vue_files: src = open(f, encoding='utf-8').read() blocks = ('template', 'script') for block in blocks: c_open = src.count('<' + block + '>') c_close = src.count('') # App.vue 允许没有 template(uni-app 全局样式/生命周期文件) if os.path.basename(f) == 'App.vue' and block == 'template': if c_open != c_close: add(f"{os.path.relpath(f, ROOT)}: